simplelocalize-cli/simplelocalize-sample.yml at master · simplelocalize/simplelocalize-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# Common
apiKey: API_KEY

# Business plan option
customerId: ikea


#################################
# 'simplelocalize upload' command
#################################

# 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.
# For example, if you have translations in 2 languages and 2 namespaces, you can use the following path: ./src/translations/{lang}/{ns}.json
uploadPath: ./src/translations.json

# Upload format is a format of the file(s) with translations.
# Supported formats: https://simplelocalize.io/docs/general/file-formats/
uploadFormat: multi-language-json

# Upload options are options that are passed to the upload command.
# Supported options: https://simplelocalize.io/docs/general/options/
uploadOptions:
  - 'UPDATE_TRANSLATIONS'


###################################
# 'simplelocalize download' command
###################################

# 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.
# For example, if you have translations in 2 languages and 2 namespaces, you can use the following path: ./src/translations/{lang}/{ns}.json
downloadPath: ./src/translations.json

# Download format is a format of the file(s) with translations.
# Supported formats: https://simplelocalize.io/docs/general/file-formats/
downloadFormat: multi-language-json

# Download options are options that are passed to the download command.
# Supported options: https://simplelocalize.io/docs/general/options/
downloadOptions:
  - 'WRITE_NESTED' # write nested JSON


###################################
# Language mapping (YAML only)
###################################

# mappings.lang maps SimpleLocalize language keys ('languageKey') to the language name used in the file system / {lang} placeholder ('placeholder').
# On download the SimpleLocalize language key is translated to the file system language name ({lang}),
# on upload the file system language name ({lang}) is translated back to the SimpleLocalize language key.
# This can be used to customize where files are downloaded, e.g. to download 'en' to '/values/' instead of '/values-en/'.
# This option can be configured only via this YAML configuration file.
mappings:
   lang:
     - languageKey: "en"
       placeholder: ""      # SimpleLocalize 'en' is downloaded to '{lang}' = '' (e.g. ./res/values{lang} -> ./res/values)
     - languageKey: "de"
       placeholder: "-de"   # SimpleLocalize 'de' is downloaded to '{lang}' = '-de' (e.g. ./res/values{lang} -> ./res/values-de)


#########################################
# 'simplelocalize auto-translate' command
#########################################

# autoTranslation.languageKeys is a list of languages that should be auto-translated.
# Leave empty to auto-translate all project languages.
autoTranslation:
  languageKeys:
    - 'en'
    - 'de'

##################################
# 'simplelocalize extract' command
##################################

# Extract path is a path to a directory with application source code.
searchDir: ./src

# Project type is a type of the project. It is used to extract i18n keys from the source code.
# Supported project types: https://simplelocalize.io/docs/cli/i18n-keys-extraction/
projectType: yahoo/react-intl

# Ignore keys are a list of keys that should be ignored during i18n keys extraction.
ignoreKeys:
  - 'WELCOME'
  - 'ABOUT-US'