feat: add eslint-plugin-vuetify support

package.json

@@ -38,14 +38,18 @@
   "peerDependencies": {
     "@rotki/eslint-plugin": ">=0.0.3",
     "eslint": ">=8.56.0",
-    "eslint-plugin-cypress": ">=2.15.0"
+    "eslint-plugin-cypress": ">=2.15.0",
+    "eslint-plugin-vuetify": "^1 || ^2"
   },
   "peerDependenciesMeta": {
     "@rotki/eslint-plugin": {
       "optional": true
     },
     "eslint-plugin-cypress": {
       "optional": true
+    },
+    "eslint-plugin-vuetify": {
+      "optional": true
     }
   },
   "dependencies": {

src/configs/index.ts

@@ -32,4 +32,6 @@ export * from './unicorn';
 
 export * from './vue';
 
+export * from './vuetify';
+
 export * from './yaml';

src/configs/rotki-plugin.ts

@@ -13,15 +13,15 @@ export async function rotkiPlugin(options: OptionsOverrides & OptionsHasTypeScri
     '@rotki/eslint-plugin',
   ]);
 
-  const [rotkiPlugin, parserVue] = await Promise.all([
+  const [pluginRotki, parserVue] = await Promise.all([
     interopDefault(import('@rotki/eslint-plugin')),
     interopDefault(import('vue-eslint-parser')),
   ] as const);
 
   return [
     {
       plugins: {
-        '@rotki': rotkiPlugin,
+        '@rotki': pluginRotki,
       },
     },
     {
@@ -45,7 +45,7 @@ export async function rotkiPlugin(options: OptionsOverrides & OptionsHasTypeScri
         },
       },
       rules: {
-        ...rotkiPlugin.configs.recommended.rules,
+        ...pluginRotki.configs.recommended.rules,
         ...overrides,
       },
     },

src/configs/vuetify.ts

@@ -0,0 +1,52 @@
+import globals from 'globals';
+import { ensurePackages, interopDefault } from '../utils';
+import { GLOB_SRC, GLOB_VUE } from '../globs';
+import type { FlatConfigItem, OptionsFiles, OptionsHasTypeScript, OptionsOverrides } from '../types';
+
+export async function vuetify(options: OptionsOverrides & OptionsHasTypeScript & OptionsFiles = {}): Promise<FlatConfigItem[]> {
+  const {
+    files = [GLOB_SRC, GLOB_VUE],
+    overrides = { },
+  } = options;
+
+  await ensurePackages(['eslint-plugin-vuetify']);
+
+  const [pluginVuetify, parserVue] = await Promise.all([
+    interopDefault(import('eslint-plugin-vuetify')),
+    interopDefault(import('vue-eslint-parser')),
+  ] as const);
+
+  return [
+    {
+      plugins: {
+        vuetify: pluginVuetify,
+      },
+    },
+    {
+      files,
+      languageOptions: {
+        globals: {
+          ...globals.browser,
+          ...globals.es2015,
+        },
+        parser: parserVue,
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true,
+          },
+          ecmaVersion: 2022,
+          extraFileExtensions: ['.vue'],
+          parser: options.typescript
+            ? await interopDefault(import('@typescript-eslint/parser')) as any
+            : null,
+          sourceType: 'module',
+        },
+      },
+      rules: {
+        ...pluginVuetify.configs.base.rules,
+        ...pluginVuetify.configs.recommended.rules,
+        ...overrides,
+      },
+    },
+  ];
+}

src/factory.ts

@@ -20,6 +20,7 @@ import {
   typescript,
   unicorn,
   vue,
+  vuetify,
   yaml,
 } from './configs';
 import { combine, interopDefault } from './utils';
@@ -56,9 +57,10 @@ export async function rotki(
     cypress: enableCypress,
     gitignore: enableGitignore = true,
     isInEditor = !!((process.env.VSCODE_PID || process.env.JETBRAINS_IDE || process.env.VIM) && !process.env.CI),
-    rotki: enableRotki = false,
+    rotki: enableRotki,
     typescript: enableTypeScript = isPackageExists('typescript'),
     vue: enableVue = VuePackages.some(i => isPackageExists(i)),
+    vuetify: enableVuetify,
   } = options;
 
   const stylisticOptions = options.stylistic === false
@@ -147,6 +149,14 @@ export async function rotki(
     }));
   }
 
+  if (enableVuetify) {
+    configs.push(vuetify({
+      ...resolveSubOptions(options, 'vuetify'),
+      overrides: getOverrides(options, 'vuetify'),
+      typescript: !!enableTypeScript,
+    }));
+  }
+
   if (options.jsonc ?? true) {
     configs.push(
       jsonc({

src/globs.ts

@@ -82,6 +82,8 @@ export const GLOB_EXCLUDE = [
   '**/output',
   '**/coverage',
   '**/temp',
+  '**/logs',
+  '**/build',
   '**/fixtures',
   '**/.vitepress/cache',
   '**/.nuxt',

src/types.ts

@@ -1,3 +1,4 @@
+import type { VuetifyRules } from './vendor/rules/vuetify';
 import type { VendoredPrettierOptions } from './vendor/prettier';
 import type { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import type { ParserOptions } from '@typescript-eslint/parser';
@@ -55,7 +56,7 @@ export type Rules = WrapRuleConfig<
       'cypress/no-pause': RuleConfig<[]>;
     } & {
       '@rotki/no-deprecated-classes': RuleConfig<[]>;
-    }
+    } & VuetifyRules
     >
 >;
 
@@ -248,13 +249,6 @@ export interface OptionsConfig extends OptionsComponentExts {
      */
   yaml?: boolean | OptionsOverrides;
 
-  /**
-     * Enable TOML support.
-     *
-     * @default true
-     */
-  toml?: boolean | OptionsOverrides;
-
   /**
      * Enable linting for **code snippets** in Markdown.
      *
@@ -304,6 +298,16 @@ export interface OptionsConfig extends OptionsComponentExts {
    */
   rotki?: boolean;
 
+  /**
+   * Enable vuetify linting support.
+   * Requires installing:
+   * - `eslint-plugin-vuetify`
+   *
+   *
+   * @default false
+   */
+  vuetify?: boolean | OptionsOverrides;
+
   /**
      * Control to disable some rules in editors.
      * @default auto-detect based on the process.env

src/vendor/rules/vuetify.ts

@@ -0,0 +1,18 @@
+import type { RuleConfig } from '@antfu/eslint-define-config';
+
+export type ValidVLostConfiguration = [{
+  allowModifiers?: boolean;
+}];
+
+export interface VuetifyRules {
+  'vue/valid-v-slot': RuleConfig<ValidVLostConfiguration>;
+
+  'vuetify/no-deprecated-classes': RuleConfig<[]>;
+  'vuetify/no-deprecated-colors': RuleConfig<[]>;
+  'vuetify/no-deprecated-components': RuleConfig<[]>;
+  'vuetify/no-deprecated-events': RuleConfig<[]>;
+  'vuetify/no-deprecated-props': RuleConfig<[]>;
+  'vuetify/no-deprecated-slots': RuleConfig<[]>;
+
+  'vuetify/grid-unknown-attributes': RuleConfig<[]>;
+}

src/vendor/vuetify.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Types are based on v2.x of vuetify plugin.
+ * Not paying to much attention to it since we are going to use the
+ * recommended anyway.
+ */
+declare module 'eslint-plugin-vuetify' {
+  import type { ValidVLostConfiguration, VuetifyRules } from './rules/vuetify';
+  import type { RuleConfig } from '@antfu/eslint-define-config';
+
+  const baseRules = {
+    'vue/valid-v-slot': ['error' as const, {
+      allowModifiers: true,
+    }] satisfies RuleConfig<ValidVLostConfiguration>,
+
+    'vuetify/no-deprecated-classes': 'error' as const,
+    'vuetify/no-deprecated-colors': 'error' as const, // v2.x
+    'vuetify/no-deprecated-components': 'error' as const,
+    'vuetify/no-deprecated-events': 'error' as const, // v2.x
+    'vuetify/no-deprecated-props': 'error' as const,
+    'vuetify/no-deprecated-slots': 'error' as const, // v2.x
+  };
+
+  const baseConfig = {
+    plugins: ['vuetify'],
+    rules: baseRules,
+  };
+
+  export const vuetify: {
+    rules: VuetifyRules;
+    configs: {
+      base: typeof baseConfig;
+      recommended: typeof baseConfig & {
+        rules: {
+          'vuetify/grid-unknown-attributes': 'error';
+        };
+      };
+    };
+  };
+
+  // eslint-disable-next-line import/no-default-export
+  export default vuetify;
+}