Skip to content

Npm client to import Powo translation into your web project

Notifications You must be signed in to change notification settings

stephanebouget/powo-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

24 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🌐 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.

About

Npm client to import Powo translation into your web project

Resources

Stars

Watchers

Forks

Contributors 2

  •  
  •