Download your translations from Google Spreadsheet. Very popular library to support a workflow when you store your translations in Google Spreadsheets. GTD downloads translations for you, considering your file structure.
In other words, having a spreadsheet like this:
You can get the result file like this:
Please, take a look at the example Google Spreadsheet file. GTD CI (Github Actions) use this file not only to ensure that the unit tests are passing but also to ensure that integration with Google Sheets API is in a shape.
- Install the package
npm i gdocs-table-downloader -g
- Set your Google Secrets to
options.js
(seecustomOptions.default.js
for example) - Prepare your Google Spreadsheet:
- Run it:
gdocs-table-downloader --token XXX --sheets one,two --customOptions ./options.js --moduleType ESM --target ./out/{sheet}.{locale}.js
The token can be taken from the URL. The example spreadsheet https://docs.google.com/spreadsheets/d/1oFig-VwfFKP3BLsW4ZgLiw5ftAfcD4jpcUwmXBdhCPU/edit#gid=0
has token 1oFig-VwfFKP3BLsW4ZgLiw5ftAfcD4jpcUwmXBdhCPU
If your Google Spreadsheet had sheets one
and two
, each having, for example,
en
and de
locales, you should get the next file structure:
folder-where-you-ran-this-script/
โโ out/
โโ one.de.js
โโ one.en.js
โโ two.de.js
โโ two.en.js
See options.js
, it's yargs
config. Also, if you run this script and
forgot to mention some required options, you would get a description of
what you've missed.
Currently, gdocs-table-downloader
supports two types of modules in generated files: AMD and ESM.
You can observe examples in test/expected
.
/* eslint quotes: 0 */
define({
"row1": "cellValue"
})
/* eslint quotes: 0 */
export default {
"row1": "cellValue"
}
Google Sheets API requires any kind of authentication since v4.
gdocs-table-downloader
is limited to the "service account" type.
You should create such account in Google Console and then you have two options:
- Put
private_key
andclient_email
directly to a file specified by--customOptions
param. SeecustomOptions.default.js
for example. - Put
private_key
andclient_email
to ENV and read them fromprocess.env
Frankly, you're not restricted to only these two methods. You can invent any
type of "secrets storing", just ensure that getGoogleAuthCredentials()
returns
an object with two properties: private_key
and client_email
.
P.S. Read an article on how to store multiline secrets in Circle CI
If you need to perform some custom mapping for cell values before they are downloaded,
you can specify getValueMapper(rawCellValue)
function in --customOptions
file.
Every cell value goes through this function and the returned value is stored in a result file.
If you don't specify getValueMapper
, the default function from customOptions.default.js
would be used: it changes "undefined" values to empty strings.