Skip to content

README.md

Latest commit

 

History

History
188 lines (132 loc) · 6.56 KB

README.md

File metadata and controls

188 lines (132 loc) · 6.56 KB

🌐 powo-cli

npm version License: MIT

powo-cli is a powerful Node.js module designed to seamlessly import Powo translations into your web projects. Streamline your internationalization workflow with support for multiple platforms and flexible translation management.

283417030-3a0f7dd5-dbc8-42d1-9700-94f4a5ef1342

✨ Features

  • Multi-language support with automatic file generation
  • Flexible configuration options for different project types
  • Cross-platform support (Android, iOS, Web, Robot)
  • Support for global, feature-based, and module-based translation loading
  • Version management (latest approved or draft translations)
  • Module merging capabilities for complex multi-project architectures
  • Proxy support for enterprise environments

📦 Installation

Using Yarn (Recommended)

yarn add powo-cli

Using npm

npm install powo-cli

🚀 Quick Start

Add the powo script to your package.json:

{
  "scripts": {
    "powo": "load-locales --project=MyPowoProject --country=XX --platform=web --version=last --languages=fr,en --location=src/locales/"
  }
}

Then run:

npm run powo
# or
yarn powo

📖 Usage

🌍 Global Translation Files

Load all translations into consolidated language files:

{
  "scripts": {
    "powo:global": "load-locales --project=MyPowoProject --country=XX --platform=web --version=last --languages=fr,en --location=src/locales/"
  }
}

This command generates en.json and fr.json files with all approved translations in your specified location.

🔧 Global Mode Options

Option Description Required Default
project Powo Project's name ✅ -
country Country code ❌ XX
platform Target platform (Android, iOS, web, robot) ✅ -
version Translation version (last or draft) ✅ -
languages Comma-separated list of languages to generate ✅ -
location Destination folder path ✅ -
proxy Proxy URL (format: http://proxy.fr:8080) ❌ -

🎯 Feature-Based Translation Files

Load translations organized by features for better modularity:

{
  "scripts": {
    "powo:features": "load-by-features --project=MyPowoProject --country=XX --platform=web --version=last --location=src/locales/"
  }
}

This command generates separate JSON files for each feature, enabling more granular translation management.

🔧 Feature Mode Options

Option Description Required Default
project Powo Project's name ✅ -
country Country code ❌ XX
platform Target platform (Android, iOS, web, robot) ✅ -
version Translation version (last or draft) ✅ -
location Destination folder path ✅ -
proxy Proxy URL (format: http://proxy.fr:8080) ❌ -

🧩 Module-Based Translation Merging

Combine translations from multiple modules into unified language files:

{
  "scripts": {
    "powo:modules": "load-by-modules --delivery=MyDelivery --modules=ModuleA,ModuleB,ModuleC --platform=web --versions=last --languages=fr,en --location=src/locales/"
  }
}

This command downloads translations from multiple modules and merges them into consolidated language files, perfect for micro-service architectures or multi-team projects.

🔧 Module Mode Options

Option Description Required Default
delivery Delivery identifier for module grouping ✅ -
modules Comma-separated list of module names to merge ✅ -
country Country code ❌ XX
platform Target platform (Android, iOS, web, robot) ✅ -
versions Version for each module (single value or comma-separated) ✅ -
languages Comma-separated list of languages to generate ✅ -
location Destination folder path ✅ -
proxy Proxy URL (format: http://proxy.fr:8080) ❌ -

💡 Examples

Basic Web Project

# Load French and English translations for a web project
load-locales --project=MyWebApp --platform=web --version=last --languages=fr,en --location=src/i18n/

Mobile App with Proxy

# Load translations for iOS app through corporate proxy
load-locales --project=MyMobileApp --platform=iOS --version=draft --languages=en,es,de --location=assets/translations/ --proxy=http://corporate-proxy:8080

Feature-Based Organization

# Generate feature-specific translation files
load-by-features --project=MyLargeApp --platform=web --version=last --location=src/locales/features/

Module Merging for Microservices

# Merge translations from multiple modules into unified files
load-by-modules --delivery=MainApp --modules=AuthModule,PaymentModule,UserModule --platform=web --versions=last --languages=fr,en --location=src/i18n/

🔧 Development

Local Testing

To test the CLI locally:

npm link

This creates a global symlink to your local development version.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.