Skip to content

docs: update CONTRIBUTING i18n and lint docs #2336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MatteoGabriele merged 8 commits into from
Mar 31, 2026
Merged

docs: update CONTRIBUTING i18n and lint docs #2336

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8f4c01e
docs: update CONTRIBUTING.md by removing obsolete scripts
alfonsusac Mar 30, 2026
48213d8
[autofix.ci] apply automated fixes
autofix-ci[bot] Mar 30, 2026
d5be07e
fix: improve docs
alfonsusac Mar 30, 2026
c75933c
fix: re-add missing scripts
alfonsusac Mar 30, 2026
50615c9
fix: use correct lint command
alfonsusac Mar 31, 2026
14f74bd
fix: use correct vp command to run vp scripts
alfonsusac Mar 31, 2026
96d57c5
[autofix.ci] apply automated fixes
autofix-ci[bot] Mar 31, 2026
f7a7e0a
Merge branch 'main' into contributor-docs-update
MatteoGabriele Mar 31, 2026
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
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ pnpm npmx-connector # Start the real connector (requires npm login)
pnpm mock-connector # Start the mock connector (no npm login needed)

# Code Quality
pnpm lint # Run linter (oxlint + oxfmt)
pnpm vp run lint # Run linter (oxlint + oxfmt)
pnpm lint:fix # Auto-fix lint issues
pnpm test:types # TypeScript type checking

Expand Down Expand Up @@ -460,13 +460,13 @@ npmx.dev uses [@nuxtjs/i18n](https://i18n.nuxtjs.org/) for internationalization.

The following scripts help manage translation files. `en.json` is the reference locale.

| Command | Description |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pnpm i18n:check [locale]` | Compares `en.json` with other locale files. Shows missing and extra keys. Optionally filter output by locale (e.g. `pnpm i18n:check ja-JP`). |
| `pnpm i18n:check:fix [locale]` | Same as check, but adds missing keys to other locales with English placeholders. |
| `pnpm i18n:report` | Audits translation keys against code usage in `.vue` and `.ts` files. Reports missing keys (used in code but not in locale), unused keys (in locale but not in code), and dynamic keys. |
| `pnpm i18n:report:fix` | Removes unused keys from `en.json` and all other locale files. |
| `pnpm i18n:schema` | Generates a JSON Schema from `en.json` at `i18n/schema.json`. Locale files reference this schema for IDE validation and autocompletion. |
| Command | Description |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pnpm i18n:check:fix [locale]` | Compares `en.json` with other locale files and adds missing keys with English placeholders. Optionally filter output by locale (e.g. `pnpm i18n:check:fix ja-JP`). |
| `pnpm i18n:report:fix` | Removes unused keys from `en.json` and all other locale files. |
| `pnpm vp run i18n:check [locale]` | Same as check:fix, but only show missing and extra keys. |
| `pnpm vp run i18n:report` | Audits translation keys against code usage in `.vue` and `.ts` files. Reports missing keys (used in code but not in locale), unused keys (in locale but not in code), and dynamic keys. |
| `pnpm vp run i18n:schema` | Generates a JSON Schema from `en.json` at `i18n/schema.json`. Locale files reference this schema for IDE validation and autocompletion. |

### Adding a new locale

Expand Down Expand Up @@ -502,7 +502,7 @@ Check [Pluralization rule callback](https://vue-i18n.intlify.dev/guide/essential
We track the current progress of translations with [Lunaria](https://lunaria.dev/) on this site: https://i18n.npmx.dev/
If you see any outdated translations in your language, feel free to update the keys to match the English version.

Use `pnpm i18n:check` and `pnpm i18n:check:fix` to verify and fix your locale (see [i18n commands](#i18n-commands) above for details).
Use `pnpm i18n:check:fix` to fix your locale (see [i18n commands](#i18n-commands) above for details).

#### Country variants (advanced)

Expand Down Expand Up @@ -590,7 +590,7 @@ See how `es`, `es-ES`, and `es-419` are configured in [config/i18n.ts](./config/
- Use `common.*` for shared strings (loading, retry, close, etc.)
- Use component-specific prefixes: `package.card.*`, `settings.*`, `nav.*`
- Do not use dashes (`-`) in translation keys; always use underscore (`_`): e.g., `privacy_policy` instead of `privacy-policy`
- **Always use static string literals as translation keys.** Our i18n scripts (`pnpm i18n:report`) rely on static analysis to detect unused and missing keys. Dynamic keys cannot be analyzed and will be flagged as errors.
- **Always use static string literals as translation keys.** Our i18n scripts (`pnpm i18n:report:fix`) rely on static analysis to detect unused and missing keys. Dynamic keys cannot be analyzed and will be flagged as errors.

**Bad:**

Expand Down
Loading