Add support for vitest (#191)

Co-authored-by: Shinigami92 <[email protected]>

Author: azat-io

package.json

@@ -78,6 +78,7 @@
     "eslint-plugin-sonarjs": "~0.19.0",
     "eslint-plugin-spellcheck": "~0.0.20",
     "eslint-plugin-unicorn": "~46.0.0",
+    "eslint-plugin-vitest": "~0.1.4",
     "eslint-plugin-vue": "~9.11.0",
     "eslint-plugin-vue-pug": "~0.6.0",
     "expect-type": "~0.15.0",

pnpm-lock.yaml

@@ -0,0 +1,19 @@
+diff --git a/src/rules/vitest/valid-title.d.ts b/src/rules/vitest/valid-title.d.ts
+index 8bdfe9a..83c707b 100644
+--- a/src/rules/vitest/valid-title.d.ts
++++ b/src/rules/vitest/valid-title.d.ts
+@@ -8,13 +8,7 @@ export interface ValidTitleOption {
+   disallowedWords?: string[];
+   /**
+    */
+-  [k: string]:
+-    | string
+-    | [string]
+-    | [string, string]
+-    | {
+-        [k: string]: string | [string] | [string, string];
+-      };
++  [k: string]: any;
+ }
+ 
+ /**

scripts/generate-rule-files/diffs/rules/vitest/valid-title.d.ts.diff

@@ -68,6 +68,10 @@ export const PLUGIN_REGISTRY: Readonly<Record<string, Plugin>> = {
     name: 'Unicorn',
     module: 'eslint-plugin-unicorn',
   },
+  vitest: {
+    name: 'Vitest',
+    module: 'eslint-plugin-vitest',
+  },
   vue: {
     name: 'Vue',
     module: 'eslint-plugin-vue',

scripts/generate-rule-files/src/plugins-map.ts

@@ -0,0 +1,8 @@
+/**
+ * Eslint Vitest extensions.
+ *
+ * @see [Eslint Vitest extensions](https://eslint.vuejs.org/user-guide/#usage)
+ */
+export type VitestExtensions =
+  | 'plugin:vitest/all'
+  | 'plugin:vitest/recommended';

src/config/extends/eslint-plugin-vitest.d.ts

@@ -12,6 +12,7 @@ import type { PrettierExtensions } from './eslint-plugin-prettier';
 import type { PromiseExtensions } from './eslint-plugin-promise';
 import type { SonarjsExtensions } from './eslint-plugin-sonarjs';
 import type { UnicornExtensions } from './eslint-plugin-unicorn';
+import type { VitestExtensions } from './eslint-plugin-vitest';
 import type { VueExtensions } from './eslint-plugin-vue';
 import type { VuePugExtensions } from './eslint-plugin-vue-pug';
 import type { IntlifyVueI18nExtensions } from './intlify-vue-i18n';
@@ -36,6 +37,7 @@ export type KnownExtensions = LiteralUnion<
   | SonarjsExtensions
   | TypescriptEslintExtensions
   | UnicornExtensions
+  | VitestExtensions
   | VueExtensions
   | VuePugExtensions
 >;

src/config/extends/index.d.ts

@@ -14,5 +14,6 @@ export type Plugin = LiteralUnion<
   | 'sonarjs'
   | 'spellcheck'
   | 'unicorn'
+  | 'vitest'
   | 'vue'
 >;

src/config/plugin.d.ts

@@ -13,6 +13,7 @@ import type { SonarJSRules } from './sonarjs';
 import type { SpellcheckRules } from './spellcheck';
 import type { TypeScriptRules } from './typescript-eslint';
 import type { UnicornRules } from './unicorn';
+import type { VitestRules } from './vitest';
 import type { VueRules } from './vue';
 import type { VueI18nRules } from './vue-i18n';
 import type { VuePugRules } from './vue-pug';
@@ -37,6 +38,7 @@ export type Rules = Partial<
     SpellcheckRules &
     TypeScriptRules &
     UnicornRules &
+    VitestRules &
     VueRules &
     VueI18nRules &
     VuePugRules &

src/rules/index.d.ts

@@ -0,0 +1,36 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Option.
+ */
+export interface ConsistentTestFilenameOption {
+  pattern?: string;
+  allTestPattern?: string;
+}
+
+/**
+ * Options.
+ */
+export type ConsistentTestFilenameOptions = [ConsistentTestFilenameOption?];
+
+/**
+ * Forbidden .spec test file pattern.
+ *
+ * @see [consistent-test-filename](https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-filename.md)
+ */
+export type ConsistentTestFilenameRuleConfig =
+  RuleConfig<ConsistentTestFilenameOptions>;
+
+/**
+ * Forbidden .spec test file pattern.
+ *
+ * @see [consistent-test-filename](https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-filename.md)
+ */
+export interface ConsistentTestFilenameRule {
+  /**
+   * Forbidden .spec test file pattern.
+   *
+   * @see [consistent-test-filename](https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-filename.md)
+   */
+  'vitest/consistent-test-filename': ConsistentTestFilenameRuleConfig;
+}

src/rules/vitest/consistent-test-filename.d.ts

@@ -0,0 +1,35 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Option.
+ */
+export interface ConsistentTestItOption {
+  fn?: 'test' | 'it';
+  withinDescribe?: 'test' | 'it';
+}
+
+/**
+ * Options.
+ */
+export type ConsistentTestItOptions = [ConsistentTestItOption?];
+
+/**
+ * Prefer test or it but not both.
+ *
+ * @see [consistent-test-it](https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-it.md)
+ */
+export type ConsistentTestItRuleConfig = RuleConfig<ConsistentTestItOptions>;
+
+/**
+ * Prefer test or it but not both.
+ *
+ * @see [consistent-test-it](https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-it.md)
+ */
+export interface ConsistentTestItRule {
+  /**
+   * Prefer test or it but not both.
+   *
+   * @see [consistent-test-it](https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-it.md)
+   */
+  'vitest/consistent-test-it': ConsistentTestItRuleConfig;
+}