https://github.com/sc5/google-sheets-translate
Maintain and collaborate your translations in Google Sheets
https://github.com/sc5/google-sheets-translate
Last synced: about 1 year ago
JSON representation
Maintain and collaborate your translations in Google Sheets
- Host: GitHub
- URL: https://github.com/sc5/google-sheets-translate
- Owner: SC5
- Created: 2015-09-25T06:53:40.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T18:53:12.000Z (about 3 years ago)
- Last Synced: 2025-04-14T04:39:21.253Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 119 KB
- Stars: 2
- Watchers: 17
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# google-sheets-translate
Maintain your translations in Google Sheets and fetch them into JSON files - ready to be used other translation libraries like [Globalize](https://github.com/jquery/globalize)
## Getting started
Steps to get started with Google documents. See more verbose version in related project: https://github.com/SC5/google-sheets-api
- Register app in [Google Developers Console](https://console.developers.google.com/project)
- Enable Google Drive API
- Create Service account under Credentials (get P12 key)
- Convert P12 key into PEM format
- Collect the service email account
- Create Google Sheets -document
- Share the document to service email address
**NOTE:** Authentication is required - link based sharing is not currently supported.
Example document:
Example code:
```javascript
var fs = require('fs');
var GoogleSheetsTranslate = require('google-sheets-translate');
var gtranslator = new GoogleSheetsTranslate({
documentId: 'your-document-id',
serviceEmail: 'your-generated-service-email@developer.gserviceaccount.com',
serviceKey: fs.readFileSync('./your-service.pem').toString()
});
var output;
gtranslator.getTranslations()
.then(function(translations) {
translations.forEach(function(translation, locale) {
// In this example we're writing files in Globalize compatible format
output = {};
output[locale] = translation;
fs.writeFileSync(
'messages/' + locale + '.json',
JSON.stringify(output, null, 2)
);
});
})
.catch(function(err) {
console.warn('Failed to generate translations:', err);
});
```
Example output:
```json
{
"en": {
"translation": "Translation",
"dog-house": "Doghouse",
"sister": "Sister"
}
}
```
```json
{
"fi": {
"translation": "Käännös",
"dog-house": "Koirankoppi",
"sister": "Sisko"
}
}
```
## API
#### new GoogleSheetsTranslate(opts)
Create an instance from the client. All the options are **required**.
* @param {Object} opts All the options
* @param {String} id Sheets document id
* @param {String} opts.serviceEmail Service email address
* @param {String} opts.serviceKey Service .PEM key contents
#### gstranslate.getTranslations(opts)
Retrieve the translations from the sheet. All the options are **optional**.
* @param {Object} opts All the options
* @param {String} opts.sheetOrdinal Sheet ordinal to process. Defaults to 0 (first sheet)
* @param {String} opts.sheetName Sheet name to process. If not provided, uses sheetOrdinal
* @param {String} opts.range Range where the translations are. Defaults to whole document (first row contains the header)
## License
Module is MIT -licensed
## Credit
Module is backed by [Nordcloud](https://nordcloud.com)