Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uniplaces/ember-cli-uni-translations
https://github.com/uniplaces/ember-cli-uni-translations
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/uniplaces/ember-cli-uni-translations
- Owner: uniplaces
- License: mit
- Created: 2016-11-08T12:38:27.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-08T14:03:56.000Z (almost 6 years ago)
- Last Synced: 2024-12-01T07:39:58.944Z (27 days ago)
- Language: JavaScript
- Size: 186 KB
- Stars: 1
- Watchers: 29
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-cli-uni-translations
[](https://badge.fury.io/js/ember-cli-uni-translations)
[](https://travis-ci.org/uniplaces/ember-cli-uni-translations)
[](https://david-dm.org/uniplaces/eember-cli-uni-translations)
[](https://david-dm.org/uniplaces/ember-cli-uni-translations?type=dev)
This add-on provides a client (cli) to make it easier to manage translations which are stored using Google Spreadsheets. It provides two commands: one to get all translations and one to set a translation.
It stores the translations under a default folder: `app/locales`.
This add-on generates a different file for each locale, consisting of JSONs with the translations key and value.
## Installation
To install ember-cli-uni-translations you just need npm.
```bash
$ ember install ember-cli-uni-translations
```
## Setup
In order to setup ember-cli-uni-translations for your project, you will need to configure your Ember `environment.js`.
```js
ENV.uniTranslations = {
spreadsheetId: 'fake-spreadsheet-id',
spreadsheetCredentialsFile: 'config/dummy.json',
keyColumn: 'forbiddenaccesslabeldonottouch',
defaultLocale: 'pt-pt', // This is optional and defaults to "en-gb"
locales: ['en-gb', 'es-es', 'it-it', 'pt-pt', 'de-de']
}
```
The `spreadsheetCredentialsFile` represents the relative path to your credentials file, given your project's root directory.
## Available commands
#### Get all translations
To get all translations, simply run the following command on your terminal.
```bash
$ ember translate:get
```
This addon ignores empty strings by default, but you can disable this behaviour by passing the ```-ies``` to the command above.
```bash
$ ember translate:get -ies=false
```
#### Get translations by spreadsheet tab
To get the translations of only a spreadsheet tab, run the following command on your terminal.
Note that the other tabs' translations will not be included on the result.
```bash
$ ember translate:get -t
```
* `spreadsheetTabName`: the tab name from the Google spreadsheet where the translations are to be kept. Example: `self_service`.
#### Set a translation
To set a translation, run the following command on your terminal:
```bash
$ ember translate:set -t -k -s -d [originalLocale]
```
* `spreadsheetTabName`: the tab name from the Google spreadsheet where the translations are to be kept. Example: `self_service`.
* `key`: the desired translation key. Example: `footer.titles.come_again`.
* `value`: the translation itself. Currently you might face some issues with unescaped characters. Example: `Come again!`.
* `originalLocale`: the locale in which `value` is written. Default: `en-gb`.
## Current TODOs:
* Verify if a translation key already existed and overwrite or discard
* Escape strings when setting translation
* Use same locale notation as i18n
## LICENSE
The MIT License (MIT)
Copyright (c) 2017
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.