Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/angular-translate/grunt-angular-translate
Grunt tasks to extract translation with AngularJS and angular-translate
https://github.com/angular-translate/grunt-angular-translate
Last synced: 3 months ago
JSON representation
Grunt tasks to extract translation with AngularJS and angular-translate
- Host: GitHub
- URL: https://github.com/angular-translate/grunt-angular-translate
- Owner: angular-translate
- License: mit
- Created: 2013-05-14T08:53:58.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-02-28T11:34:45.000Z (over 5 years ago)
- Last Synced: 2024-08-31T01:21:20.112Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 179 KB
- Stars: 91
- Watchers: 5
- Forks: 52
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grunt-angular-translate
[](https://gitter.im/angular-translate/grunt-angular-translate?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Task that extracts all the translation keys for angular-translate
project. It searches all view, and js scripts to find
`angular-translate` calls; such as:
* `{{'KEY_IN_VIEW' | translate }}`
* `$translate.instant('KEY_IN_SCRIPT')`
Each found key is then extracted to json files with translations. For
each local defined in Gruntfile separate json is created:
{
"KEY_IN_VIEW": "",
"KEY_IN_SCRIPT": ""
}
Translation should be provided in the created files. On the next run,
`grunt-angular-translate` will not change keys already translated.
It will only add keys that were added to the source and remove the
ones that are not present anymore in the source.
##Status
[](https://nodei.co/npm/grunt-angular-translate/)
## Getting Started
Install this grunt plugin next to your project. Require [gruntJS][getting_started].
Use `npm install grunt-angular-translate`
Then add this line to your project's `Gruntfile.js` file:
`grunt.loadNpmTasks('grunt-angular-translate');`
grunt-angular-translate provide to your grunt environment a task called i18nextract which need a configuration to rocks (Please read the documentation).
This extraction is made to work with the [angular-translate][angular_translate] project created by [Pascal Precht][pascalPrecht]
## Use cases
### Views
#### Filters
`{{'TRANSLATION' | translate}}`
`{{'TRANSLATION' | translate:XXXXXX}}`
#### Directives
#### Directives plural (custom attribute angular-plural-extract to automatize extraction)
``
### Javascript
#### Filter
`$filter("translate")("TRANSLATION")`
#### Service angular-translate
`$translate('TRANSLATION')`
`$translate.instant('TRANSLATION')`
`$translate(['TRANSLATION', 'TRANSLATION_1'])`
## Configuration
Simple configuration for `i18nextract` task
```
i18nextract: {
default_options: {
src: [ 'src/**/*.js', 'src/**/*.html' ],
lang: ['fr_FR'],
dest: 'tmp'
}
}
```
More examples in [Gruntfile.js](https://github.com/angular-translate/grunt-angular-translate/blob/master/Gruntfile.js)
### Options
Options src and jsonSrc may be specified according to the grunt Configuring tasks guide.
- [src](#src)
- [nullEmpty](#nullempty-v026)
- [namespace](#namespace-v026)
- [interpolation](#interpolation)
- [jsonSrc](#jsonSrc)
- [jsonSrcName](#jsonSrcName)
- [defaultLang](#defaultLang)
- [lang](#lang)
- [prefix](#prefix)
- [suffix](#suffix)
- [dest](#dest)
- [safeMode](#safeMode)
- [stringifyOptions](#stringifyOptions)
- [keyAsText](#keyAsText)
#### src
Type: `Array`
Default: `undefined`
Example: `[ 'src/**/*.js' ]`
Define a file list to parse for extract translation.
#### nullEmpty (v0.2.6)
Type: `Boolean`
Default: `false`
Example: `true`
If set to true, it will replace all final empty translations by *null* value.
#### namespace (v0.2.6)
Type: `Boolean`
Default: `false`
Example: `true`
If set to true, it will organize output JSON like the following.
`````
{
"MODULE": {
"CATEGORY": {
"TITLE": "My Title",
"TITLE1": null
}
}
}
`````
#### interpolation
Type: `Object`
Default: `{ startDelimiter: '{{', endDelimiter: '}}' }`
Example: `{ startDelimiter: '[[', endDelimiter: ']]' }`
Define interpolation symbol use for your angular application.
The angulars docs about ($interpolateProvider)[http://docs.angularjs.org/api/ng.$interpolateProvider] explain how you can configure the interpolation markup.
#### jsonSrc
Type: `Array`
Default: `undefined`
Example: `[ 'config/*.json' ]`
Define a JSON file list to parse for extract translation.
#### jsonSrcName
Type: `Array`
Default: `undefined`
Example: `[ 'label', 'name' ]`
Define the keys to find corresponding values through JSON object.
#### defaultLang
Type: `String`
Default: `undefined`
Example: `"en_US"`
Define the default language. For default language, by default the key will be set as value.
#### customRegex
Type: `Array`
Default: `[]`
Example: `
customRegex: [
'tt-default="\'((?:\\\\.|[^\'\\\\])*)\'\\|translate"'
],
`
Will extract `MY.CUSTOM.REGEX` from the following HTML: ``.
Enjoy your custom regex guys!
#### lang
Type: `Array`
Default: `undefined`
Example: `['fr_FR', 'en_US']`
Define language to be extract (fr__FR, en__US, xxx). xxx will be the output filename wrapped by prefix and suffix option.
#### prefix
Type: `String`
Default: `""`
Example: `"project_"`
Set prefix to output filenames (cf [angular-translate#static-files][https://github.com/PascalPrecht/angular-translate/wiki/Asynchronous-loading#using-extension-static-files-loader]).
#### suffix
Type: `String`
Default: `""`
Example: `".json"`
Set suffix to output filenames (cf [angular-translate#static-files][https://github.com/PascalPrecht/angular-translate/wiki/Asynchronous-loading#using-extension-static-files-loader]).
#### dest
Type: `String`
Default: `""`
Example: `"src/assets/i18n"`
Relative path to output folder.
#### safeMode
Type: `Boolean`
Default: `false`
If safeMode is set to `true` the deleted translations will stay in the output lang file.
#### stringifyOptions
Type: `Boolean` or `Object`
Default: `false`
If stringifyOptions is set to `true` the output will be sort (case insensitive).
If stringifyOptions is an `object`, you can easily check [json-stable-stringify](https://github.com/substack/json-stable-stringify) README.
#### keyAsText
Type: `Boolean`
Default: `false`
If keyAsText is set to `true` translations keys works also as value for this translation.
## Test
You will find the tests files into `test` directory.
To run test use `grunt test`
__to improve ... :-D__
## Contributing
_(Anyone yet)_
## Release History
_(Nothing yet)_
## License
Copyright (c) 2013 Benjamin Longearet
Licensed under the MIT license.
[grunt]: http://gruntjs.com/
[getting_started]: https://github.com/gruntjs/grunt/wiki/Getting-started
[angular_translate]: https://github.com/PascalPrecht/angular-translate
[pascalPrecht]: https://github.com/PascalPrecht
[](http://githalytics.com/firehist/grunt-angular-translate)