feat(vue-a11y): include the plugin into vue option instead

Author: oliver139

README.md

@@ -538,7 +538,26 @@ export default antfu({
 })
 ```
 
-As it's in maintenance mode, we only accept bug fixes for Vue 2. It might also be removed in the future when `eslint-plugin-vue` drops support for Vue 2. We recommend upgrading to Vue 3 if possible.
+#### Vue Accessibility
+
+To enable Vue accessibility support, you need to explicitly turn it on:
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu({
+  vue: {
+    a11y: true
+  },
+})
+```
+
+Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
+
+```bash
+npm i -D eslint-plugin-vuejs-accessibility
+```
 
 ### Optional Configs
 

eslint.config.ts

@@ -4,8 +4,9 @@ import { antfu } from './src'
 
 export default antfu(
   {
-    vue: true,
-    vueA11y: true,
+    vue: {
+      a11y: true,
+    },
     react: true,
     solid: true,
     svelte: true,

src/configs/index.ts

@@ -25,5 +25,4 @@ export * from './typescript'
 export * from './unicorn'
 export * from './unocss'
 export * from './vue'
-export * from './vueA11y'
 export * from './yaml'

src/configs/vue.ts

@@ -15,6 +15,7 @@ export async function vue(
   options: OptionsVue & OptionsHasTypeScript & OptionsOverrides & OptionsStylistic & OptionsFiles = {},
 ): Promise<TypedFlatConfigItem[]> {
   const {
+    a11y = false,
     files = [GLOB_VUE],
     overrides = {},
     stylistic = true,
@@ -33,10 +34,12 @@ export async function vue(
     pluginVue,
     parserVue,
     processorVueBlocks,
+    pluginVueA11y,
   ] = await Promise.all([
     interopDefault(import('eslint-plugin-vue')),
     interopDefault(import('vue-eslint-parser')),
     interopDefault(import('eslint-processor-vue-blocks')),
+    ...a11y ? [interopDefault(import('eslint-plugin-vuejs-accessibility'))] : [],
   ] as const)
 
   return [
@@ -64,6 +67,7 @@ export async function vue(
       name: 'antfu/vue/setup',
       plugins: {
         vue: pluginVue,
+        ...a11y ? { 'vue-a11y': pluginVueA11y } : {},
       },
     },
     {
@@ -192,6 +196,33 @@ export async function vue(
             }
           : {},
 
+        ...a11y
+          ? {
+              'vue-a11y/alt-text': 'error',
+              'vue-a11y/anchor-has-content': 'error',
+              'vue-a11y/aria-props': 'error',
+              'vue-a11y/aria-role': 'error',
+              'vue-a11y/aria-unsupported-elements': 'error',
+              'vue-a11y/click-events-have-key-events': 'error',
+              'vue-a11y/form-control-has-label': 'error',
+              'vue-a11y/heading-has-content': 'error',
+              'vue-a11y/iframe-has-title': 'error',
+              'vue-a11y/interactive-supports-focus': 'error',
+              'vue-a11y/label-has-for': 'error',
+              'vue-a11y/media-has-caption': 'warn',
+              'vue-a11y/mouse-events-have-key-events': 'error',
+              'vue-a11y/no-access-key': 'error',
+              'vue-a11y/no-aria-hidden-on-focusable': 'error',
+              'vue-a11y/no-autofocus': 'warn',
+              'vue-a11y/no-distracting-elements': 'error',
+              'vue-a11y/no-redundant-roles': 'error',
+              'vue-a11y/no-role-presentation-on-focusable': 'error',
+              'vue-a11y/no-static-element-interactions': 'error',
+              'vue-a11y/role-has-required-aria-props': 'error',
+              'vue-a11y/tabindex-no-positive': 'warn',
+            }
+          : {},
+
         ...overrides,
       },
     },

src/configs/vueA11y.ts

@@ -31,7 +31,6 @@ import {
   unicorn,
   unocss,
   vue,
-  vueA11y,
   yaml,
 } from './configs'
 import { formatters } from './configs/formatters'
@@ -98,7 +97,6 @@ export function antfu(
     unicorn: enableUnicorn = true,
     unocss: enableUnoCSS = false,
     vue: enableVue = VuePackages.some(i => isPackageExists(i)),
-    vueA11y: enableVueA11y = false,
   } = options
 
   let isInEditor = options.isInEditor
@@ -208,12 +206,6 @@ export function antfu(
     }))
   }
 
-  if (enableVueA11y) {
-    configs.push(vueA11y({
-      overrides: getOverrides(options, 'vueA11y'),
-    }))
-  }
-
   if (enableReact) {
     configs.push(react({
       ...typescriptOptions,

src/factory.ts

@@ -44,6 +44,14 @@ export interface OptionsVue extends OptionsOverrides {
    * @default 3
    */
   vueVersion?: 2 | 3
+
+  /**
+   * Vue accessibility plugin. Help check a11y issue in `.vue` files upon enabled
+   *
+   * @see https://vue-a11y.github.io/eslint-plugin-vuejs-accessibility/
+   * @default false
+   */
+  a11y?: boolean
 }
 
 export type OptionsTypescript =
@@ -290,14 +298,6 @@ export interface OptionsConfig extends OptionsComponentExts, OptionsProjectType
    */
   vue?: boolean | OptionsVue
 
-  /**
-   * Enable Vue A11y support.
-   *
-   * @see https://vue-a11y.github.io/eslint-plugin-vuejs-accessibility/
-   * @default auto-detect based on the dependencies
-   */
-  vueA11y?: boolean | OptionsOverrides
-
   /**
    * Enable JSONC support.
    *