Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ladjs/mandarin
Automatic i18n phrase translation using Google Translate
https://github.com/ladjs/mandarin
api automatic convert google i10n i18n javascript keywords localization localize mandarin node phrase phrases sentences service translate translation
Last synced: 7 days ago
JSON representation
Automatic i18n phrase translation using Google Translate
- Host: GitHub
- URL: https://github.com/ladjs/mandarin
- Owner: ladjs
- License: mit
- Created: 2017-12-10T05:43:29.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T16:50:37.000Z (8 months ago)
- Last Synced: 2024-09-27T05:38:11.213Z (about 2 months ago)
- Topics: api, automatic, convert, google, i10n, i18n, javascript, keywords, localization, localize, mandarin, node, phrase, phrases, sentences, service, translate, translation
- Language: JavaScript
- Size: 579 KB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mandarin
[](https://github.com/ladjs/mandarin/actions/workflows/ci.yml)
[](https://github.com/sindresorhus/xo)
[](https://github.com/prettier/prettier)
[](https://lass.js.org)
[](LICENSE)
> Automatic i18n markdown translation and i18n phrase translation using Google Translate
## Table of Contents
* [Install](#install)
* [Requirements](#requirements)
* [Redis](#redis)
* [Google Application Credentials](#google-application-credentials)
* [Usage](#usage)
* [Contributors](#contributors)
* [License](#license)
## Install
[npm][]:
```sh
npm install mandarin
```
## Requirements
### Redis
You will need to have [Redis][] installed in order for caching to work properly.
If you do not plan to use Redis, then set `redis: false` as an option.
### Google Application Credentials
You will also need Google Application Credentials, and you will need to set them as environment variables (e.g. `GOOGLE_APPLICATION_CREDENTIALS=/home/user/Downloads/service-account-file.json`).
For more information on Google Application credentials, see .
## Usage
1. Implement Mandarin and pass it an instance of [i18n][]
```js
const Mandarin = require('mandarin');
const I18N = require('@ladjs/i18n');
const i18n = new I18N();
// you can also pass a custom `logger` option (it defaults to `console`)
const mandarin = new Mandarin({
// REQUIRED:
i18n
// OPTIONAL:
// logger: console,
// OPTIONAL (see index.js for defaults):
// redis: ...
// OPTIONAL (see index.js for defaults):
// redisMonitor: ...
// OPTIONAL:
// see all commented options from this following link:
//
//
// clientConfig: {},
// OPTIONAL (see index.js for defaults):
// Files to convert from `index.md` to `index-es.md`
// Or `README.md` to `README-ZH.md` for example
//
//
// markdown: ... (note we expose `Mandarin.DEFAULT_PATTERNS` for you)
});
//
// Translate Phrases
//
// with async/await
(async () => {
try {
await mandarin.translate();
} catch (err) {
console.log(err);
}
})();
// with promises and then/catch
mandarin
.translate()
.then(() => {
console.log('done');
})
.catch(console.error);
// with callbacks
mandarin.translate(err => {
if (err) throw err;
console.log('done');
});
//
// Translate Markdown Files
//
// with async/await
(async () => {
try {
await mandarin.markdown();
} catch (err) {
console.log(err);
}
})();
// with promises and then/catch
mandarin
.markdown()
.then(() => {
console.log('done');
})
.catch(console.error);
// with callbacks
mandarin.markdown(err => {
if (err) throw err;
console.log('done');
});
```
2. This assumes that you have locale files already and a default locale file (e.g. `./locales/en.json` with phrases that need translated to other languages you support). Based off the defaults from [i18n][], you would automatically get your `en.json` file translated to the locales `es` (Spanish) and `zh` (Chinese).
3. Follow the "Before you begin" steps here (basically you download a JSON file after creating a Google Cloud Project with Cloud Translation API enabled).
4. Specify the path to the JSON file and run your script that uses `mandarin`:
```sh
GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/[FILE_NAME].json" node app.js
```
## Contributors
| Name | Website |
| -------------- | -------------------------- |
| **Nick Baugh** | |
## License
[MIT](LICENSE) © [Nick Baugh](http://niftylettuce.com/)
##
[npm]: https://www.npmjs.com/
[i18n]: https://github.com/ladjs/i18n
[redis]: https://redis.io/