Skip to content

Commit a9d312a

Browse files
authored
docs: add note about JavaScript-based locale files not being supported (#650)
* docs: update started.md to clarify unsupported JavaScript-based locale files * docs: update javascript-based locale warning
1 parent 93e5806 commit a9d312a

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,8 @@ This plugin provides some predefined configs. You can use the following configs
177177

178178
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.
179179

180+
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).
181+
180182
:::
181183

182184
### Running ESLint from command line

0 commit comments

Comments
 (0)