@zeesoft/zlitt-sync

zlitt-sync tool usage guide

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 <tarball.tgz> 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 <tarball.tgz> get the tarball link from zeesoft
• zlitt-sync --sync to pull latest translations from zLiTT and create a Translation project if untranslated count threshold is reached
• --debug and --log-file options can be supplied to get more verbose information

---

TODO

• [x] add support for custom export file name mapping in zLiTT