3.0.1 • Published 2 years ago
@captaincool/locale-key-generator v3.0.1
Locale Key Generator
Installation
Install the package via npm
npm install -g @captaincool/locale-key-generatorConfiguration
By default, keys will be exported based on the contents of config.json. To use a custom configuration, supply its path using the --config argument during execution
locale-keys export -i ./content -o ./output --config=customConfig.jsonUsage
# generate locale files for all contexts inside the 'content' directory and output them to 'output'
locale-keys export -i ./content -o ./output
# generate locale files for a specific context
locale-keys export -i ./content -o ./output --contexts=shared,web:feature
# lint the contents of the 'content' directory
locale-keys lint -i ./contentOptions
| Option | Default | Description |
|---|---|---|
| baseLanguage | en_US | Files with this code in the suffix of the filename will be treated as the base language. Any files which don't contain a base file will be discarded. |
| outputFormat | json | The desired export format. Possible values are json or xliff |
| contextDelimiterKeys | : | How to specify contexts messages belong to |
| contextDelimiterFiles | __ | How to specify contexts in the final output files |
| localeRegionExp | /[a-z]{2}_[A-Z]{2}/ | The pattern to determine locale |
| keyMatchExp | /[\\w]+/ | The style pattern contexts and message keys should enforce |
| ignoreFiles | '.DS_STORE' | A list of files to be ignored by the parser |
| filenameSuffix | A fixed string to apply at the end of the exported file | |
| reservedContext | messages | Files with this name will be rolled into the same context as their parent. For example, messages contained inside "some/feature/messages.en_US.json" will be namespaced as "some:feature" |
| indent | 2 | Enforce an indentation style either via number of spaces or "tab". Accepts a number or the value "tab" |