|
1 | | -# Common |
2 | | -apiKey: API_KEY |
| 1 | +# Need help with the configuration? Contact us: [email protected] |
3 | 2 |
|
4 | | -# Business plan option |
5 | | -# customerId: ikea |
| 3 | +# Common, required configuration |
| 4 | +apiKey: YOUR_PROJECT_API_KEY |
6 | 5 |
|
| 6 | +############################################################################################## |
| 7 | +# 'simplelocalize upload' ## Learn more: https://simplelocalize.io/docs/general/file-formats/ |
| 8 | +############################################################################################## |
7 | 9 |
|
8 | | -################################# |
9 | | -# 'simplelocalize upload' command |
10 | | -################################# |
| 10 | +# Input path for source translations. |
| 11 | +# Placeholders: |
| 12 | +# - {lang} - language key (optional) |
| 13 | +# - {ns} - namespace (optional) |
| 14 | +# Examples: |
| 15 | +# - ./translations_{lang}.json |
| 16 | +# - ./translations_en/{ns}.json |
| 17 | +# Use '--dryRun' parameter to see which files will be uploaded without actually uploading them. |
| 18 | +uploadPath: ./translations_en.json |
11 | 19 |
|
12 | | -# Upload path is a path to a file(s) with translations. Use {lang} placeholder to specify language or locale and {ns} placeholder to specify namespace. |
13 | | -# For example, if you have translations in 2 languages and 2 namespaces, you can use the following path: ./src/translations/{lang}/{ns}.json. |
14 | | -# Add '--dryRun' parameter to check what translation files will be uploaded without actually uploading them. |
15 | | -uploadPath: ./src/translations.json |
| 20 | +# Specify language key for uploaded translations. Language key must match the language key used in SimpleLocalize. |
| 21 | +uploadLanguageKey: en |
16 | 22 |
|
17 | | -# Upload format is a format of the file(s) with translations. |
18 | | -# Supported formats: https://simplelocalize.io/docs/general/file-formats/ |
19 | | -uploadFormat: multi-language-json |
| 23 | +# Input format for translations: https://simplelocalize.io/docs/general/file-formats/ |
| 24 | +uploadFormat: single-language-json |
20 | 25 |
|
21 | | -# Upload options are options that are passed to the upload command. |
22 | | -# Supported options: https://simplelocalize.io/docs/general/options/ |
23 | | -uploadOptions: |
24 | | -# - 'REPLACE_TRANSLATION_IF_FOUND' # overwrite translation for given a key and namespace if found |
25 | 26 |
|
26 | 27 |
|
27 | | -################################### |
28 | | -# 'simplelocalize download' command |
29 | | -################################### |
| 28 | +##################################################################################################### |
| 29 | +# 'simplelocalize download' ## Learn more: https://simplelocalize.io/docs/cli/download-translations/ |
| 30 | +##################################################################################################### |
30 | 31 |
|
31 | | -# Download path is a path to a file(s) with translations. Use {lang} placeholder to specify language or locale and {ns} placeholder to specify namespace. |
32 | | -# For example, if you have translations in 2 languages and 2 namespaces, you can use the following path: ./src/translations/{lang}/{ns}.json |
33 | | -downloadPath: ./src/translations.json |
| 32 | +# Output path for downloaded translations. |
| 33 | +# Placeholders: |
| 34 | +# - {lang} - language key (optional) |
| 35 | +# - {ns} - namespace (optional) |
| 36 | +# Examples: |
| 37 | +# - ./translations_{lang}.json |
| 38 | +# - ./translations_{lang}/{ns}.json |
| 39 | +downloadPath: ./translations_{lang}.json |
34 | 40 |
|
35 | | -# Download format is a format of the file(s) with translations. |
36 | | -# Supported formats: https://simplelocalize.io/docs/general/file-formats/ |
37 | | -downloadFormat: multi-language-json |
| 41 | +# Specify language keys which you want to download, by default all languages are downloaded. |
| 42 | +# downloadLanguageKey: ['pl', 'es'] |
| 43 | + |
| 44 | +# Output format for translations: https://simplelocalize.io/docs/general/file-formats/ |
| 45 | +downloadFormat: single-language-json |
38 | 46 |
|
39 | | -# Download options are options that are passed to the download command. |
40 | | -# Supported options: https://simplelocalize.io/docs/general/options/ |
41 | | -downloadOptions: |
42 | | -# - 'WRITE_NESTED' # write nested JSON |
43 | 47 |
|
44 | 48 |
|
45 | 49 | ######################################### |
46 | | -# 'simplelocalize auto-translate' command |
| 50 | +# 'simplelocalize auto-translate' ## Learn more: https://simplelocalize.io/docs/cli/other-commands/#auto-translate-project |
47 | 51 | ######################################### |
48 | 52 |
|
49 | | -# autoTranslation.languageKeys is a list of languages that should be auto-translated. |
50 | | -# Leave empty to auto-translate all project languages. |
51 | | -autoTranslation: |
52 | | - languageKeys: |
53 | | - - 'en' |
54 | | - - 'de' |
55 | | - |
56 | | -################################## |
57 | | -# 'simplelocalize extract' command |
58 | | -################################## |
59 | | - |
60 | | -# Extract path is a path to a directory with application source code. |
61 | | -searchDir: ./src |
62 | | - |
63 | | -# Project type is a type of the project. It is used to extract i18n keys from the source code. |
64 | | -# Supported project types: https://simplelocalize.io/docs/cli/i18n-keys-extraction/ |
65 | | -projectType: yahoo/react-intl |
66 | | - |
67 | | -# Ignore keys are a list of keys that should be ignored during i18n keys extraction. |
68 | | -ignoreKeys: |
69 | | - - 'WELCOME' |
70 | | - - 'ABOUT-US' |
| 53 | +# Specify language keys which you want to auto-translate, leave empty to auto-translate all languages. |
| 54 | +# autoTranslateLanguageKeys: ['en', 'de'] |
0 commit comments