https://github.com/codewell/translate
Minimalistic translating function for JavaScript
https://github.com/codewell/translate
Last synced: 10 days ago
JSON representation
Minimalistic translating function for JavaScript
- Host: GitHub
- URL: https://github.com/codewell/translate
- Owner: codewell
- License: mit
- Created: 2020-03-24T11:17:30.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T16:59:03.000Z (over 3 years ago)
- Last Synced: 2025-02-22T07:31:50.006Z (over 1 year ago)
- Language: JavaScript
- Size: 934 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @codewell/translate
Minimalistic translating function for JavaScript
## Installation
```
npm install @codewell/translate
```
## Basic Usage
```JavaScript
import translate from '@codewell/translate';
const dictionary = {
words: [
{
translations: [
{language: "foo", word: "foo"},
{language: "bar", word: "bar"},
],
},
],
};
// Set dictionary
const translatedWithDictionary = translate(dictionary);
// Set language
const toFooLanguage = translatedWithDictionary("foo");
// Translate word in dictionary to language
const toFooLanguage("bar"); // => "foo"
// Or
translate(dictionary)("foo")("bar"); // => "foo"
```
## Testing
**Functions**
Write tests in the `tests/` folder
**Package**
1. Make a dry reslease with `npm run dry-release`. This will generate a file `packagename-x.x.x.tgz`.
2. Install the package in your other application/package by running `npm install path/to/packagename-x.x.x.tgz`.
3. Import and use as usual in you application/package.
## Releasing
1. Run `npm run release`
2. Push the code to github
3. Update package version
- `npm version patch` updates `x.x.1` -> `x.x.2`
- `npm version minor` updates `x.1.x` -> `x.2.x`
- `npm version major` updates `1.x.x` -> `2.x.x`
4. Run `npm publish --access public`
## Issues
Please help by posting issues here on github