Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lykmapipo/i18n
i18n helpers
https://github.com/lykmapipo/i18n
i18n l language locale lykmapipo m mf t template
Last synced: 17 days ago
JSON representation
i18n helpers
- Host: GitHub
- URL: https://github.com/lykmapipo/i18n
- Owner: lykmapipo
- License: mit
- Created: 2018-10-15T13:45:46.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-11T22:03:32.000Z (almost 2 years ago)
- Last Synced: 2024-08-09T09:32:48.144Z (3 months ago)
- Topics: i18n, l, language, locale, lykmapipo, m, mf, t, template
- Language: JavaScript
- Size: 2.56 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# i18n
[](https://app.travis-ci.com/lykmapipo/i18n)
[](https://david-dm.org/lykmapipo/i18n)
[](https://coveralls.io/github/lykmapipo/i18n?branch=master)
[](https://github.com/lykmapipo/i18n/blob/develop/LICENSE)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/prettier/prettier)
[](https://github.com/airbnb/javascript)
[](https://www.npmjs.com/package/@lykmapipo/i18n)
[i18n](https://github.com/mashpie/i18n-node) helpers.
*Note: Make sure you have `locales` inside your base directory. [Check](https://github.com/lykmapipo/i18n/tree/master/test/fixtures/locales)*
## Requirements
- [NodeJS v14.1+](https://nodejs.org)
- [Npm v6.14+](https://www.npmjs.com/)
## Installation
```sh
npm install @lykmapipo/i18n --save
```
## Usage
```js
import { t } from '@lykmapipo/i18n';
// default locale
t('hello'); // => Hello
t('hello', { name: 'John' }); // => Hello John
// passing specific locale
t('hello', 'sw'); // => Mambo
t('hello', 'sw', { name: 'John' }); // => Mambo John
...
```
## Environment
```js
I18N_DEFAULT_LOCALE=en
I18N_LOCALES=en,sw
I18N_QUERY_PARAMETER=lang
I18N_DIRECTORY=./locales
I18N_OBJECT_NOTATION=true
```
## Helpers
- `t(phrase:String, [locale:String], [options:Object])`: Translates a single
phrase and adds it to locales if unknown. It returns translated parsed and
substituted string.
Example:
```js
t('hello');
t('hello', { name: 'John' });
t('hello', 'sw');
t('hello', 'sw', { name: 'John' });
```
- `n(phrase:String, [locale:String|count:Number], count:Number)`: Plurals translation of a single phrase. Singular and plural forms will get added to locales if unknown. Returns translated parsed and substituted string based on last count parameter.
Example:
```js
n('You have %s message', 1);
n('You have %s message', 10);
n('You have %s message', 'sw', 1);
n('You have %s message', 'sw', 10);
```
## Testing
- Clone this repository
- Install all development dependencies
```sh
npm install
```
- Run example
```sh
npm run dev
```
- Then run test
```sh
npm test
```
## Contribute
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
## License
The MIT License (MIT)
Copyright (c) lykmapipo & Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.