Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaredleechn/atool-i18n
deprecated, more update in https://github.com/ant-tool/atool-l10n
https://github.com/jaredleechn/atool-i18n
Last synced: 29 days ago
JSON representation
deprecated, more update in https://github.com/ant-tool/atool-l10n
- Host: GitHub
- URL: https://github.com/jaredleechn/atool-i18n
- Owner: jaredleechn
- Created: 2016-06-08T10:38:49.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-06-24T03:45:43.000Z (over 8 years ago)
- Last Synced: 2024-11-07T19:53:14.608Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 17.6 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# intl-translate
automatical workflow to solve intl resource load problem.
- collect intl messages meta data generated by plugin like `babel-plugin-react-intl`
- fetch suggestion for each language
- pick the best translation
- save into local locale files, which are required directly by source code
## Usage
- setup
```bash
$ npm i intl-translate --save-dev
```
- `intl.config.js`
```js
module.exports = function (config) {
return Object.assign({},
config,
{
middleware: {
pre: 'summary?source=i18n-messages',
process: ['youdao?langs[]=cn,langs[]=en', 'reduce?local=locales'],
emit: 'save?dest=locales',
},
}
);
};
```
- run
```bash
$ node_modules/.bin/intl-translate
```
## Options
```bash
Usage: intl-translate [options]
Options:
-h, --help output usage information
-v, --version output the version number
--config where is the config file, default is intl.config.js
```
## Middleware
`intl-translate` middlewares will execute one by one, with three parameters:
```
plugins.reduce((a, b) => {
if (a instanceof Promise) {
return a.then(result => b.plugin(result, b.query, context));
}
return b.plugin(a, b.query, context);
}, Promise.resolve());
```
- result: return value of previous middleware
- query: parameters passed to current middleware, parse from `option.config(default is intl.config.js)`
- context: intl-translate context
#### Life cycle
Middlewares contains three stage, each stage share the same data structure
|middleware stage|default|description|
|:---:|:---:|:---:|
|pre|summary|collect origin data generated from `babel-plugin-react-intl` or something else|
|process|google, pick|loading translation from cloud or translate center and fill into result with key of language|
|emit|save|emit into locales resource|
#### Built-in middlewares
`summary`: collect origin data generated from `babel-plugin-react-intl`
returns:
```
[{
id: 'totalPrice',
description: '展示订单总额',
defaultMessage: '订单全额'
}, {
id: 'count',
description: '显示订单中商品数量',
defaultMessage: '数量'
}]
```
|parameter|default|description|
|:---:|:---:|:---:|
|cwd|context.cwd||
|source|'i18n-messages'|where is the messages folder|
|patten|'**/*.json'|patten of json files|
`google`: add translate result for each language from google
returns:
```
[{
id: 'totalPrice',
description: '展示订单总额',
defaultMessage: '订单全额',
cn: ['订单总价', '订单全额', '订单价格'],
en: ['totalPrices', 'totalPrice']
}, {
id: 'count',
description: '显示订单中商品数量',
defaultMessage: '数量',
cn: ['数量', '数目'],
en: 'count'
}]
```
|parameter|default|description|
|:---:|:---:|:---:|
|langs|[]|languages you need to translate|
`educe`: pick the best translation of each id in terminal
returns:
```
[{
id: 'totalPrice',
description: '展示订单总额',
defaultMessage: '订单全额',
cn: '订单总价',
en: 'totalPrice'
}, {
id: 'count',
description: '显示订单中商品数量',
defaultMessage: '数量',
cn: '数目',
en: 'count'
}]
```
|parameter|default|description|
|:---:|:---:|:---:|
|local|'locales'|add local files into suggestion|
`save`: save into json
returns: true || false
|parameter|default|description|
|:---:|:---:|:---:|
|dest|'locales'|save to where|