Configuration file

Configuration file

Use configuration file to simplify your bash command. Arguments used in command always override properties set in the configuration file. By default, SimpleLocalize will load configuration from file named simplelocalize.yml. You can load configuration from different location by using a -c parameters.

# Load default simplelocalize.yml file
simplelocalize upload

# Use configuration file at custom location
simplelocalize -c my-configuration.yml upload

Sample configuration file

Filename: simplelocalize.yml

# Get started with CLI: https://simplelocalize.io/docs/cli/get-started/
# Available formats: https://simplelocalize.io/docs/general/file-formats/
# Available import/export options: https://simplelocalize.io/docs/general/options/
# Support: contact@simplelocalize.io

# Project API Key
apiKey: API_KEY

# Properties used by 'upload' command
uploadPath: ./source-translations/messages_en.json
uploadLanguageKey: en-GB
uploadFormat: single-language-json
uploadTags:
  - 'development'
  - 'staging'
uploadOptions:
  # by default, the 'upload' command adds new keys and fills empty translations, 
  # add this option to update existing translations with values from the uploaded file
  - UPDATE_TRANSLATIONS 

# Properties used by 'download' command
downloadPath: ./output-translations/messages_{lang}.json
downloadLanguageKeys: ['de-DE', 'fr-FR', 'pl-PL']
downloadFormat: single-language-json
downloadTags:
  - 'development'
  - 'staging'
downloadOptions:
  - WRITE_NESTED

## Language mapping
# Mapping between SimpleLocalize language key and {lang} placeholder.
# On download the SimpleLocalize language key is mapped to the {lang} placeholder,
# On upload the {lang} placeholder is mapped 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/'.
mappings:
  lang:
    - languageKey: "en"
      placeholder: ""      # download 'en' to ./res/values/strings.xml
    - languageKey: "de"
      placeholder: "-de"   # download 'de' to ./res/values-de/strings.xml

# Properties used by 'extract' command
searchDir: ./src
projectType: yahoo/react-intl
ignoreKeys:
  - 'WELCOME'
  - 'ABOUT-US'

# Properties used by 'pull' and 'publish' command    
pullPath: ./src/hosting/
environment: '_production' # or '_latest', or 'my_custom'