Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tiagodanin/nodejs-i18n
Minimalistic internationalization using gettext style for NodeJS
https://github.com/tiagodanin/nodejs-i18n
gettext i18n i18n-js i18n-node internationalization javascript nodejs
Last synced: 15 days ago
JSON representation
Minimalistic internationalization using gettext style for NodeJS
- Host: GitHub
- URL: https://github.com/tiagodanin/nodejs-i18n
- Owner: TiagoDanin
- License: mit
- Created: 2018-10-05T19:36:57.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-03T18:38:12.000Z (about 1 month ago)
- Last Synced: 2024-10-25T13:00:56.521Z (22 days ago)
- Topics: gettext, i18n, i18n-js, i18n-node, internationalization, javascript, nodejs
- Language: JavaScript
- Homepage: https://tiagodanin.github.io/NodeJS-i18n/
- Size: 173 KB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NodeJS i18n
[](https://travis-ci.org/TiagoDanin/NodeJS-i18n) [](https://npmjs.org/package/nodejs-i18n) [](https://npmjs.org/package/nodejs-i18n) [](https://npmjs.org/package/nodejs-i18n)
Minimalistic internationalization using gettext style for NodeJS
## Features
- Gettext Style
- Easy Imprementation
- Create .po via CLI
- Select Lang per User
## Installation
Module available through the [npm registry](https://www.npmjs.com/). It can be installed using the [`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally) or [`yarn`](https://yarnpkg.com/en/) command line tool.
```sh
# Yarn (Recomend)
yarn global add nodejs-i18n
# NPM
npm install nodejs-i18n --global
```
## Usage
```sh
# Create file
find . | grep .js | sort | nodejs-i18n > en.po
# Create file (all strings) [beta]
find . | grep .js | sort | nodejs-i18n --all > en.po
# Create file (get identifier value) [beta]
find . | grep .js | sort | nodejs-i18n --value > en.po
```
## Example
```js
const { Resources, Translation } = require('nodejs-i18n')
const resources = new Resources()
resources.load('pt', 'pt.po')
const user = new Translation('pt')
//i18n: My Hello World with NodeJs i18n
const world = user._`world` // Mundo
user._`Hello ${world}` // Olá mundo
```
## Documentation
### Options
#### Options :: Resources({})
- **lang** - String
> Lang id.
> Default value: `en`
#### Options :: Resources({}).load(lang, file)
Load translation
- **lang** - String
> Lang id.
- **file** - String
> File path
#### Options :: Resources({}).remove()
Remove translation.
- **lang** - String
> Lang id.
#### Options :: Translation(lang)
Select translation.
- **lang** - String
> Lang id.
#### Options :: Translation(lang).\_(string)
String translation.
- **String** - String
### CLI
Create en.po files with `nodejs-i18n`. Add in your package.json
```json
"scripts": {
"i18n": "find . | grep .js | sort | nodejs-i18n > en.po"
}
```
and run `$ npm run i18n` or `$ yarn i18n`
## Tests
To run the test suite, first install the dependencies, then run `test`:
```sh
# Using Yarn
yarn test
```
## Dependencies
argv: CLI Argument Parser
Author: Corey Hart
License:
Version: 0.0.2
esprima: ECMAScript parsing infrastructure for multipurpose analysis
Author: Ariya Hidayat
License: BSD-2-Clause
Version: ^4.0.1
gettext-parser: Parse and compile gettext po and mo files to/from json, nothing more, nothing less
Author: Andris Reinman
License: MIT
Version: ^4.0.3
minimist: parse argument options
Author: James Halliday
License: MIT
Version: ^1.2.5
tempy: Get a random temporary file or directory path
Author: Sindre Sorhus
License: MIT
Version: 0.5.0
## Dev Dependency
mocha: simple, flexible, fun test framework
Author: TJ Holowaychuk
License: MIT
Version: 7.2.0
## Related
gettext-parser: Parse and compile gettext po and mo files to/from json, nothing more, nothing less
Author: Andris Reinman
License: MIT
## Contributors
Pull requests and stars are always welcome. For bugs and feature requests, please [create an issue](https://github.com/TiagoDanin/NodeJS-i18n/issues). [List of all contributors](https://github.com/TiagoDanin/NodeJS-i18n/graphs/contributors).
## License
[MIT](LICENSE) © [TiagoDanin](https://TiagoDanin.github.io)