Skip to content

docs: add note about JavaScript-based locale files limited support #650

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
merged 2 commits into from
Jul 30, 2025
Merged

docs: add note about JavaScript-based locale files limited support #650

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1252ded
docs: update started.md to clarify unsupported JavaScript-based local…
junwen-k Jul 5, 2025
adfa71f
docs: update javascript-based locale warning
junwen-k Jul 30, 2025
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
2 changes: 2 additions & 0 deletions docs/started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,8 @@ This plugin provides some predefined configs. You can use the following configs

The `localePattern` options does not support SFC i18n custom blocks (`src` attribute), only for resources of files to import when specified in VueI18n's `messages` options (VueI18n v9 and later, `messages` specified in `createI18n`) for resources of files to import.

JavaScript-based locale files have limited support. JavaScript (`.js`) files can be loaded and used with rules that check for missing keys (like `no-missing-keys`), but TypeScript (`.ts`) locale files are not supported. Rules that analyze locale file contents (like `no-duplicate-keys-in-locale` and `no-html-messages`) are not supported for either format. For more information, please see [#32](https://github.com/intlify/eslint-plugin-vue-i18n/issues/32).

:::

### Running ESLint from command line
Expand Down