"@intlify/eslint-plugin-vue-i18n": minor

feat: support flat config

/lib/configs/**/*.ts

/tests/integrations

node-version: 18

node: [18, 20]

/scripts/update-**.ts

- :star: mark: the rule which is enabled by `plugin:@intlify/vue-i18n/recommended` or `*.configs["flat/recommended"]` preset.

- :star: The `"extends": "plugin:@intlify/vue-i18n/recommended"` or `*.configs["flat/recommended"]` property in a configuration file enables this rule.

- :star: The `"extends": "plugin:@intlify/vue-i18n/recommended"` or `*.configs["flat/recommended"]` property in a configuration file enables this rule.

- :star: The `"extends": "plugin:@intlify/vue-i18n/recommended"` or `*.configs["flat/recommended"]` property in a configuration file enables this rule.

- :star: The `"extends": "plugin:@intlify/vue-i18n/recommended"` or `*.configs["flat/recommended"]` property in a configuration file enables this rule.

Use `eslint.config.[c|m]js` file to configure rules. This is the default in ESLint v9, but can be used starting from ESLint v8.57.0. See also: https://eslint.org/docs/latest/use/configure/configuration-files-new.

Example eslint.config.js:

import vueI18n from '@intlify/eslint-plugin-vue-i18n'

export default [

// add more generic rulesets here, such as:

// js.configs.recommended, // '@eslint/js'

// ...vue.configs['flat/recommended'], // 'eslint-plugin-vue'

...vueI18n.configs['flat/recommended'],

{

rules: {

// Optional.

'@intlify/vue-i18n/no-dynamic-keys': 'error',

'@intlify/vue-i18n/no-unused-keys': [

'error',

{

extensions: ['.js', '.vue']

}

]

},

settings: {

'vue-i18n': {

localeDir: './path/to/locales/*.{json,json5,yaml,yml}', // extension is glob formatting!

// or

// localeDir: {

// pattern: './path/to/locales/*.{json,json5,yaml,yml}', // extension is glob formatting!

// localeKey: 'file' // or 'path' or 'key'

// }

// or

// localeDir: [

// {

// // 'file' case

// pattern: './path/to/locales1/*.{json,json5,yaml,yml}',

// localeKey: 'file'

// },

// {

// // 'path' case

// pattern: './path/to/locales2/*.{json,json5,yaml,yml}',

// localePattern: /^.*\/(?<locale>[A-Za-z0-9-_]+)\/.*\.(json5?|ya?ml)$/,

// localeKey: 'path'

// },

// {

// // 'key' case

// pattern: './path/to/locales3/*.{json,json5,yaml,yml}',

// localeKey: 'key'

// },

// ]

// Specify the version of `vue-i18n` you are using.

// If not specified, the message will be parsed twice.

messageSyntaxVersion: '^9.0.0'

}

}

}

]

See the [rule list](./rules/index.md) to get the `configs` & `rules` that this plugin provides.

This plugin provides some predefined configs. You can use the following configs by adding them to `eslint.config.[c|m]js`. (All flat configs in this plugin are provided as arrays, so spread syntax is required when combining them with other configs.)

- `*.configs["flat/base"]`: Settings and rules to enable correct ESLint parsing.

- `*.configs["flat/recommended"]`: Above, plus rules to enforce subjective community defaults to ensure consistency.

Use `.eslintrc.*` file to configure rules in ESLint < v9. See also: https://eslint.org/docs/latest/use/configure/.

Example `.eslintrc.js`:

See the [rule list](./rules/index.md) to get the `configs` & `rules` that this plugin provides.

This plugin provides some predefined configs. You can use the following configs by adding them to `.eslintrc.*`. (All flat configs in this plugin are provided as arrays, so spread syntax is required when combining them with other configs.)

- `"plugin:@intlify/vue-i18n/base"`: Settings and rules to enable correct ESLint parsing.

- `"plugin:@intlify/vue-i18n/recommended"`: Above, plus rules to enforce subjective community defaults to ensure consistency.

export = [

{

name: '@intlify/vue-i18n:base:setup',

plugins: {

get '@intlify/vue-i18n'() {

return require('../../index')

}

}

},

{

name: '@intlify/vue-i18n:base:setup:json',

files: ['*.json', '**/*.json', '*.json5', '**/*.json5'],

languageOptions: {

parser: require('vue-eslint-parser'),

parserOptions: {

parser: require('jsonc-eslint-parser')

}

}

},

{

name: '@intlify/vue-i18n:base:setup:yaml',

files: ['*.yaml', '**/*.yaml', '*.yml', '**/*.yml'],

languageOptions: {

parser: require('vue-eslint-parser'),

parserOptions: {

parser: require('yaml-eslint-parser')

}

},

rules: {

'no-irregular-whitespace': 'off',

'spaced-comment': 'off'

}

}

const globals = require('globals')

const config = require('./base')

export = [

...config,

{

name: '@intlify/vue-i18n:recommended:setup',

languageOptions: {

ecmaVersion: 2018,

sourceType: 'module',

globals: globals.browser,

parserOptions: {

ecmaFeatures: {

jsx: true

}

}

}

},

{

name: '@intlify/vue-i18n:recommended:rules',

rules: {

'@intlify/vue-i18n/no-html-messages': 'warn',

'@intlify/vue-i18n/no-missing-keys': 'warn',

'@intlify/vue-i18n/no-raw-text': 'warn',

'@intlify/vue-i18n/no-v-html': 'warn'

}

}

import flatBase from './configs/flat/base'

import flatRecommended from './configs/flat/recommended'

import keyFormatStyle from './rules/key-format-style'

import noDeprecatedI18nComponent from './rules/no-deprecated-i18n-component'

import noDeprecatedI18nPlaceAttr from './rules/no-deprecated-i18n-place-attr'

import noDeprecatedI18nPlacesProp from './rules/no-deprecated-i18n-places-prop'

import noDuplicateKeysInLocale from './rules/no-duplicate-keys-in-locale'

import noDynamicKeys from './rules/no-dynamic-keys'

import noHtmlMessages from './rules/no-html-messages'

import noI18nTPathProp from './rules/no-i18n-t-path-prop'

import noMissingKeysInOtherLocales from './rules/no-missing-keys-in-other-locales'

import noMissingKeys from './rules/no-missing-keys'

import noRawText from './rules/no-raw-text'

import noUnknownLocale from './rules/no-unknown-locale'

import noUnusedKeys from './rules/no-unused-keys'

import noVHtml from './rules/no-v-html'

import preferLinkedKeyWithParen from './rules/prefer-linked-key-with-paren'

import preferSfcLangAttr from './rules/prefer-sfc-lang-attr'

import sfcLocaleAttr from './rules/sfc-locale-attr'

import validMessageSyntax from './rules/valid-message-syntax'

configs: {

// eslintrc configs

base,

recommended,

// flat configs

'flat/base': flatBase,

'flat/recommended': flatRecommended

},

rules: {

'key-format-style': keyFormatStyle,

'no-deprecated-i18n-component': noDeprecatedI18nComponent,

'no-deprecated-i18n-place-attr': noDeprecatedI18nPlaceAttr,

'no-deprecated-i18n-places-prop': noDeprecatedI18nPlacesProp,

'no-duplicate-keys-in-locale': noDuplicateKeysInLocale,

'no-dynamic-keys': noDynamicKeys,

'no-html-messages': noHtmlMessages,

'no-i18n-t-path-prop': noI18nTPathProp,

'no-missing-keys-in-other-locales': noMissingKeysInOtherLocales,

'no-missing-keys': noMissingKeys,

'no-raw-text': noRawText,

'no-unknown-locale': noUnknownLocale,

'no-unused-keys': noUnusedKeys,

'no-v-html': noVHtml,

'prefer-linked-key-with-paren': preferLinkedKeyWithParen,

'prefer-sfc-lang-attr': preferSfcLangAttr,

'sfc-locale-attr': sfcLocaleAttr,

'valid-message-syntax': validMessageSyntax

}