Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Use JSON5 for en.json #1949

Merged
merged 20 commits into from
Nov 15, 2022
Merged

Use JSON5 for en.json #1949

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
8672abe
Add trailing commas and rename to `en.json5`
dhruvkb Oct 30, 2022
8293d72
Create a file to parse JSON5 into entries with comments
dhruvkb Oct 30, 2022
b853104
Use `/.../` over `new RegExp`
dhruvkb Oct 30, 2022
b3f43b3
Refactor and improve POT file generation scripts
dhruvkb Oct 30, 2022
0b0b302
Expose function for tests
dhruvkb Oct 30, 2022
ff79ae9
Add `$` to handle i18n strings with quotes
dhruvkb Oct 30, 2022
0a79946
Update documentation to reflect added features
dhruvkb Oct 30, 2022
15a2f91
Refactor to reduce code nesting
dhruvkb Oct 30, 2022
7463617
Add references to the new `en.json` process
dhruvkb Oct 30, 2022
e0ace1e
Add a comment as an example
dhruvkb Oct 30, 2022
8cbb2f8
Update `setup-node-env` action to create `en.json`
dhruvkb Oct 30, 2022
01899e0
Handle `wp-locales.json` being missing
dhruvkb Oct 30, 2022
a61fcb3
Throw if line could not be parsed
dhruvkb Oct 31, 2022
4cf614e
Set up EN translations in `predev` script
dhruvkb Nov 10, 2022
e7e585e
Add a note about `en.json5` being the primary file for translations
dhruvkb Nov 10, 2022
0506f01
Write EN translations file in `i18n:copy-test-locales` script
dhruvkb Nov 10, 2022
72057d4
Enable watch mode for English translations
dhruvkb Nov 11, 2022
214bd54
Document the use of watch mode
dhruvkb Nov 11, 2022
a90f275
Setup `en.json` during prepare step
dhruvkb Nov 13, 2022
ef1a4fd
Use Babel to parse JSON5 instead of hack parser
dhruvkb Nov 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/actions/setup-node-env/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ runs:
shell: bash
run: "pnpm install"

- name: Generate English locale file
shell: bash
run: "pnpm i18n:get-translations --en-only"

- name: Copy locale files
shell: bash
run: "cp -r test/locales/* src/locales"
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ vercel.json
.eslintcache
.nuxt
src/locales/*.json
!src/locales/en.json
.nuxt-storybook
storybook-static
.vercel
Expand Down
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,13 @@ Run the following commands in order to have the code up and running on your mach
# Builds and serves assets with hot-reload
# Automatically invokes pnpm install and pnpm i18n
pnpm dev
```

If you intend to change any text in the app, you will need to edit `src/locales/scripts/en.json5`. To ensure your changes are reflected immediately, run the following command.

```bash
# Watches the en.json5 file and updates the en.json file for every change.
pnpm i18n:watch-en
```

### Using HTTPS Locally
Expand Down
6 changes: 4 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,9 @@
"pc:install": "python3 pre-commit.pyz install -t pre-push -t pre-commit",
"pc:lint": "python3 pre-commit.pyz run --all-files",
"i18n": "pnpm i18n:create-locales-list && pnpm i18n:get-translations && pnpm i18n:update-locales",
"i18n:copy-test-locales": "cp -r test/locales/* src/locales/",
"i18n:no-get": "pnpm i18n:create-locales-list && pnpm i18n:update-locales",
"i18n:watch-en": "pnpm i18n:get-translations --en-only --watch",
dhruvkb marked this conversation as resolved.
Show resolved Hide resolved
"i18n:copy-test-locales": "cp -r test/locales/* src/locales/ && pnpm i18n:get-translations --en-only",
"i18n:no-get": "pnpm i18n:create-locales-list && pnpm i18n:update-locales && pnpm i18n:get-translations --en-only",
"i18n:create-locales-list": "node src/locales/scripts/create-wp-locale-list",
"i18n:get-translations": "node src/locales/scripts/get-translations",
"i18n:update-locales": "node src/locales/scripts/get-validated-locales",
Expand Down Expand Up @@ -137,6 +138,7 @@
"autoprefixer": "^10.4.0",
"babel-jest": "^26.6.3",
"babel-loader": "8.2.5",
"chokidar": "^3.5.3",
"css-loader": "^5.2.7",
"eslint": "^8.13.0",
"eslint-config-prettier": "^8.5.0",
Expand Down
Loading