feat: add support for rotki/eslint-plugin

package.json

@@ -36,10 +36,14 @@
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
+    "@rotki/eslint-plugin": ">=0.0.3",
     "eslint": ">=8.56.0",
     "eslint-plugin-cypress": ">=2.15.0"
   },
   "peerDependenciesMeta": {
+    "@rotki/eslint-plugin": {
+      "optional": true
+    },
     "eslint-plugin-cypress": {
       "optional": true
     }

src/configs/index.ts

@@ -18,6 +18,8 @@ export * from './node';
 
 export * from './perfectionist';
 
+export * from './rotki-plugin';
+
 export * from './sort';
 
 export * from './stylistic';

src/configs/rotki-plugin.ts

@@ -0,0 +1,53 @@
+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 rotkiPlugin(options: OptionsOverrides & OptionsHasTypeScript & OptionsFiles = {}): Promise<FlatConfigItem[]> {
+  const {
+    files = [GLOB_SRC, GLOB_VUE],
+    overrides = {},
+  } = options;
+
+  await ensurePackages([
+    '@rotki/eslint-plugin',
+  ]);
+
+  const [rotkiPlugin, parserVue] = await Promise.all([
+    interopDefault(import('@rotki/eslint-plugin')),
+    interopDefault(import('vue-eslint-parser')),
+  ] as const);
+
+  return [
+    {
+      plugins: {
+        '@rotki': rotkiPlugin,
+      },
+    },
+    {
+      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: {
+        ...rotkiPlugin.configs.recommended.rules,
+        ...overrides,
+      },
+    },
+  ];
+}

src/factory.ts

@@ -12,6 +12,7 @@ import {
   markdown,
   node,
   perfectionist,
+  rotkiPlugin,
   sortPackageJson,
   sortTsconfig,
   stylistic,
@@ -55,6 +56,7 @@ 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,
     typescript: enableTypeScript = isPackageExists('typescript'),
     vue: enableVue = VuePackages.some(i => isPackageExists(i)),
   } = options;
@@ -138,6 +140,13 @@ export async function rotki(
     }));
   }
 
+  if (enableRotki) {
+    configs.push(rotkiPlugin({
+      overrides: getOverrides(options, 'rotki'),
+      typescript: !!enableTypeScript,
+    }));
+  }
+
   if (options.jsonc ?? true) {
     configs.push(
       jsonc({

src/types.ts

@@ -53,6 +53,8 @@ export type Rules = WrapRuleConfig<
       'cypress/no-force': RuleConfig<[]>;
       'cypress/no-async-tests': RuleConfig<[]>;
       'cypress/no-pause': RuleConfig<[]>;
+    } & {
+      '@rotki/no-deprecated-classes': RuleConfig<[]>;
     }
     >
 >;
@@ -292,6 +294,16 @@ export interface OptionsConfig extends OptionsComponentExts {
    */
   cypress?: boolean | OptionsCypress;
 
+  /**
+   * Enable rotki linting
+   * Requires installing:
+   * - `@rotki/eslint-plugin`
+   *
+   *
+   * @default false
+   */
+  rotki?: boolean;
+
   /**
      * Control to disable some rules in editors.
      * @default auto-detect based on the process.env