Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avaragado/riw
A console app and library to help you localise React apps in conjunction with react-intl
https://github.com/avaragado/riw
cli console i18n internationalisation internationalization l10n localisation localization react react-intl terminal translation-management
Last synced: about 1 month ago
JSON representation
A console app and library to help you localise React apps in conjunction with react-intl
- Host: GitHub
- URL: https://github.com/avaragado/riw
- Owner: avaragado
- License: mit
- Created: 2017-03-07T12:53:12.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-20T11:17:27.000Z (over 6 years ago)
- Last Synced: 2024-12-02T10:06:42.195Z (about 2 months ago)
- Topics: cli, console, i18n, internationalisation, internationalization, l10n, localisation, localization, react, react-intl, terminal, translation-management
- Language: JavaScript
- Homepage:
- Size: 521 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# riw
> A console app and library to help you localise React apps in conjunction with [`react-intl`](https://github.com/yahoo/react-intl/)
Use riw to:
- Define target locales for your app: the locales into which you translate the app.
- Extract `react-intl` message descriptors from your React components, directly or indirectly.
- Check for duplicates in your `react-intl` message descriptor ids if you need to.
- Manage translations for each target locale, storing them in a simple translations database.
- Generate JSON files for your translations, to include in your app.
See [Introducing riw](https://medium.com/@avaragado/introducing-riw-854f9a2c9f52) on Medium for background and motivations.
There's an example repository, [`riw-example`](https://github.com/avaragado/riw-example), showing a simple internationalised React app set up for use with riw.
The word "riw" seems to be Welsh for _slope_ or _hill_, and rhymes with the English word _drew_.
This project is not associated with the `react-intl` project.
### Assumptions and prerequisites
riw assumes you're familiar with `react-intl`, and that your app already uses a build system of some kind (for example, webpack).
riw requires node 8.x or later.
### Problems riw doesn't solve
- riw doesn't perform any automated text translation or interface with any translators or translation services. It tells you which messages need translating, lets you update its translations database with the translations once you have them, and produces shippable, `react-intl`-compatible JSON files for each locale you want to support.
- riw doesn't provide its own mechanism for generating unique `react-intl` message descriptor ids. However, by default riw uses `babel-plugin-react-intl-auto` to autogenerate ids. ([See the FAQ](doc/faq.md) and https://github.com/akameco/babel-plugin-react-intl-auto for more.)
- riw doesn't import the generated JSON locale files into your app or plug them into `react-intl`'s `IntlProvider`. You implement this behaviour yourself.
## Install
```bash
$ yarn add --dev riw # OR: npm install --save-dev riw
```
## Usage
Full tutorial: [Installing, configuring and using riw](doc/tutorial.md)
TL;DR:
1. Add to your app's `package.json`:
```json5
"riw": {
"defaultLocale": "en-US", // locale of source strings
"targetLocales": [ // other locales app should support
"fr-FR",
"pt-BR",
...
],
}
```
1. `yarn run riw db init` – initialise empty db at `src/locale/riw-db.json`
1. `yarn run riw app translate` – outputs `src/locale/[locale].json` and `src/locale/TODO-untranslated.json` (you might need to add a `.babelrc` in your app)
1. Update your app to import strings from `src/locale/[locale].json` for each target locale, and plug them into `react-intl`'s `IntlProvider` at the appropriate time.
1. LOOP:
1. Translate everything in the `TODO-untranslated.json` file. Meanwhile, keep developing your app in the usual way.
1. `yarn run riw db import TODO-with-translations.json` if you have a file of them in the right format, or
1. `yarn run riw db update ` to update the db string by string.
1. `yarn run riw app translate`
1. Test and (maybe) ship.
1. Go to LOOP.
Check everything into source control. There are no temporary files.
## More information
- [Configuration settings](doc/config.md)
- [FAQ/troubleshooting](doc/faq.md)
- [Using riw programmatically](doc/library.md) (incomplete)
- [Example repository showing how to add react-intl and riw to a React app](https://github.com/avaragado/riw-example)
## Maintainer
David Smith (@avaragado)
## Contribute
Bug reports, feature requests and PRs are gratefully received. [Add an issue](https://github.com/avaragado/riw/issues/new) or submit a PR.
Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.
## Licence
[MIT](LICENSE.txt) © David Smith