evenchange4/react-intl-poPublic

NotificationsYou must be signed in to change notification settings
Fork23
Star88

🚀 Extract POT from react-intl and convert back to json.

License

MIT license

88 stars 23 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 128 Commits
config		config
docs		docs
src		src
test		test
.editorconfig		.editorconfig
.gitignore		.gitignore
.travis.yml		.travis.yml
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
package.json		package.json
renovate.json		renovate.json
yarn.lock		yarn.lock

Repository files navigation

react-intl-po

Extract POT from react-intl and convert back to json.
messages.json → POT → PO → translation.json

Tutorial

Please take a look at standalone repo based on Create-React-App:https://github.com/evenchange4/react-intl-po-example

Installation

$ yarn add react-intl-po

Requirements and Workflow

react-intl^2.0.0
babel-plugin-react-intl^2.0.0

Usage

There are two sub-commands ofreact-intl-po orrip:

json2pot: Convert the json files extracted frombabel-plugin-react-intl into one.pot file.
po2json: Convert translated.po files back to.json format.

json2pot

$ rip json2pot'_translations/src/**/*.json' \    -o ./mcs-public.pot

Arguments	Description
`srcPatterns`	The pattern of.json files extracted frombabel-plugin-react-intl
`-o, --output <path>`	The output pathname of.pot file to be translated
`-k, --message-key [key]`	[Optional] Translation message key (default key is`defaultMessage`)
`-c, --message-context [context]`	[Optional] Translation message context (defaults to no context)

po2json

Case 1: Output one file per locale if a`directory` is set

$ rip po2json'./node_modules/mcs-translation/po/mcs-public*.po' \     -m'./_translations/src/**/*.json' \     -o'./translations'

Case 2: Output one merged file if a`.json file` is set

$ rip po2json'./node_modules/mcs-translation/po/mcs-public*.po'\`     -m'./_translations/src/**/*.json' \     -o'./translations.json'

Arguments	Description
`srcPatterns`	The pattern of translated.po files
`-m, --messages-pattern <path>`	The pattern of.json files extracted frombabel-plugin-react-intl
`-o, --output <path>`	The output pathname of a file / directory
`-k, --message-key [key]`	[Optional] Translation message key (default key is`defaultMessage`)
`-c, --message-context [context]`	[Optional] Translation message context (defaults to no context)
`-l, --lang-mapper-pattern <pattern>`	[Optional] Custom regex to use for lang mapping.PR#122
`-i, --lang-mapper-pattern-index [index]`	[Optional] When specifying a custom lang-mapper-pattern, the index of match to use for the lang mapping. Default is 1, index is ignored if not using a custom lang mapping regex.PR#122
`--indentation <number\|char>`	[Optional] Specify a number of spaces or a set of characters to be used before each entry of the resulting json file. Defaults to`null`, which means the entries are not prefixed with spaces.
`--sort-by-id`	[Optional] If specified, the entries of each language are sorted by id before being output

Property

Q&A

How to translate the same message into two different meanings?

Option 1 (Recommended):

Set themessage-context (-c) to'id' of message object frombabel-plugin-react-intl (there is no context by default).

The advantage of this option over Option 2 (below) is that PO file editors that provide features such as translation suggestions or error-checking often expect the message key to bedefaultMessage.

$ rip po2json'./node_modules/mcs-translation/po/mcs-public*.po' \     -m'./_translations/src/**/*.json' \     -o'./translations' \     -c'id'$ rip po2json'./node_modules/mcs-translation/po/mcs-public*.po'\`    -m'./_translations/src/**/*.json' \    -o'./translations.json' \    -c'id'

Example:https://github.com/evenchange4/react-intl-po-example#option

Option 2: [Maybe deprecated next major release]

Set themessage-key (-k) to'id' of message object frombabel-plugin-react-intl (default key is'defaultMessage'). (#41)

$ rip po2json'./node_modules/mcs-translation/po/mcs-public*.po' \     -m'./_translations/src/**/*.json' \     -o'./translations' \     -k'id'$ rip po2json'./node_modules/mcs-translation/po/mcs-public*.po'\`    -m'./_translations/src/**/*.json' \    -o'./translations.json' \    -k'id'

Development

$ yarn install --pure-lockfile

Ramda.js

You can useR.tap() for developing.

R.pipe(  R.concat(...),+ R.tap(e => console.log(e)),  R.mergeAll,);

Requirements

node >= 9.11.1
yarn >= 1.5.1

Test

$ yarn run format$ yarn run eslint$ yarn run test:watch

NPM Release

Any git tags.

Create a new git tag
UpdateCHANGELOG.md

$ npm version patch

CONTRIBUTING

⇄ Pull requests and ★ Stars are always welcome.
For bugs and feature requests, please create an issue.
Pull requests must be accompanied by passing automated tests ($ yarn run test).

CHANGELOG

LICENSE

MIT:http://michaelhsu.mit-license.org

About

🚀 Extract POT from react-intl and convert back to json.

Releases1

v1.0.2 Latest

Mar 30, 2016

Packages

No packages published

Contributors11

Languages

JavaScript100.0%

Movatterモバイル変換

License

evenchange4/react-intl-po

Folders and files

Latest commit

History

Repository files navigation

react-intl-po

Tutorial

Installation

Requirements and Workflow

Usage

json2pot

po2json

Case 1: Output one file per locale if adirectory is set

Case 2: Output one merged file if a.json file is set

Property

Q&A

How to translate the same message into two different meanings?

Option 1 (Recommended):

Option 2: [Maybe deprecated next major release]

Development

Ramda.js

Requirements

Test

NPM Release

CONTRIBUTING

CHANGELOG

LICENSE

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases1

Packages0

Uh oh!

Contributors11

Uh oh!

Languages

Case 1: Output one file per locale if a`directory` is set

Case 2: Output one merged file if a`.json file` is set

Packages