compile translation files to AST for efficiency
Description
Environment
None
Potential Workaround
None
clones
relates to
Checklist
hideTestRail: Results
Activity
Show:
Done
Details
Details
Assignee
Zak Burke
Zak BurkeReporter
Zak Burke
Zak BurkePriority
Story Points
1
Sprint
None
Development Team
Stripes Force
Fix versions
Release
Poppy (R2 2023)
TestRail: Cases
Open TestRail: Cases
TestRail: Runs
Open TestRail: Runs
Created May 12, 2023 at 1:52 PM
Updated October 12, 2023 at 12:41 AM
Resolved May 16, 2023 at 3:44 AM
TestRail: Cases
TestRail: Runs
Overview:
Steps to Implement (See ui-plugin-find-user PR for example):
Add
@formatjs/cli
as a dev-depyarn add -D @formatjs/cli
Add the following command to package.json with (replacing <ui-module-name> with your module name):
"formatjs-compile": "formatjs compile-folder --ast --format simple ./translations/<ui-module-name> ./translations/<ui-module-name>/compiled"
Run the command
yarn formatjs-compile
If there are any errors, contact @Peter Murray to let him know of the error and he will work with Lokalise to get the files corrected. After Lokalise corrects files, update your branch from master.
Modify
.github/workflows/build-npm-*.yml
to runformatjs-compile
. In theenv
section near the top add:COMPILE_TRANSLATION_FILES: 'true'
and after the "Run yarn test" step add a compile-translations step:
- name: Run yarn formatjs-compile if: ${{ env.COMPILE_TRANSLATION_FILES == 'true' }} run: yarn formatjs-compile
See https://github.com/folio-org/stripes/blob/master/doc/dev-guide.md#pre-compiling-translations-into-ast-format for reference.