Package Exports

i18n-squish

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (i18n-squish) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

i18n-squish

Watch and compile language files into single locales ready to be served to angular-translate using angular-translate-loader-url. Can be used with or without Express and optinally watches files using node-watch to recompile upon changes.

Usage

Require the package with an Express app and optional parameters object: require('i18n-squish')(app, params).

Options

dir (default: 'app/i18n'): the directory where all language files reside
out (default: dir + '/_compiled'): the directory to output compiled locale files
endpoint (default: '/api/lang'): the endpoint to create an Express GET route for fetching locales - this defaults to the angular-translate-loader-url default
whitespace (default: 0): number of spaces to use as whitespace in JSON.stringify call
watch (default: false): boolean indicating whether uncompiled langauge files in dir should be watched and recompiled upon changes
express (default: false): boolean indicating whether the module should create the Express endpoint defined by endpoint

All language files should be named after their respective locale. A language files filepath denotes the property names which will lead to it in the compiled locale file. For example, if a language file exists at /app/i18n/routes/login/en.json, the compiled JSON file en.json will contain routes.login.

Example

Given the following file structure and default options:

/app/i18n
|
└─ /branding
     |
     └─en.json
     └─ fr.json
└─ /routes
     |
     └─ en.json
     └─ fr.json

Compiled files will be created as follows:

/app/i18n
|
└─ ... 
└─ /_compiled
     |
     └─ en.json
     └─ fr.json

Using express: true and default endpoint: '/api/lang' options will mean retrieving the en.json file is as simple as sending a GET request to /api/lang?lang=json. This operation is performed automatically by angular-translate-loader-url when using $translateProvider.useUrlLoader('/api/lang').