CLI library to connect with zLiTT to localize and sync project resources
1. Development usage
- yarn install
- yarn sync
- after making any changes make sure to run build and obtain tarball
yarn build
yarn pack
- for publishing
yarn | npm login to the npm
yarn publish --access public
---
2. .zsyncrc configuration file (json structure)
- add .zsyncrcfile to your project directory and add the following configurations
- productInfo obtain from zLiTT of your product name and description
- setupInfo obtain from zLiTT for setup setps with details
- accessToken obtain from zLiTT
- env should be one of _prod, dev, local_ where accessToken is obtained
- locales array of locales for which translations to be managed by zlitt-sync
- inputFiles array of source resource file paths _[glob pattern is also supported]_
- customExportName use custom file names for localization resource files as configured in zLiTT
- untranslatedThreshold auto create a localization during sync process if untranslated words count is greater than threshold
- machineT9n machine translation will translate source string in target language on initial process itself to avoid showing English string to customer
---
3. Library usage
- install zlitt-sync as your project dev dependency
- npm i -g zlitt-sync or get the tarball link from zeesoft
- zlitt-sync module exposes sync api for programmatical usage
---
4. CLI usage
- install as global package
- npm i -g zlitt-sync or get the tarball link from zeesoft.
- zlitt-sync --vendor-process or zlitt-sync -v L10n files will get processed with latest translations from zLiterati and additionally creates a Vendor project in zLiterati when untranslated threshold exceeds the configured value.
- zlitt-sync --localization-process or zlitt-sync -l L10n files will get processed with latest translations from zLiterati and applies MT in the absence of t9n. It will create a Localization project in zLiterati when untranslated threshold exceeds the configured value.
- --debug and --log-file options can be supplied to get more verbose information.
---