@tb-dev/eslint-config 1.4.11 → 1.5.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Andrew Ferreira
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 Andrew Ferreira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -9,6 +9,7 @@ var Glob;
     Glob["ALL"] = "**/*.?([cm])[jt]s?(x)";
     Glob["JAVASCRIPT"] = "**/*.?([cm])js?(x)";
     Glob["TYPESCRIPT"] = "**/*.?([cm])ts?(x)";
+    Glob["VITEST"] = "**/*.{test,spec}.[jt]s";
     Glob["VUE"] = "**/*.vue";
 })(Glob || (Glob = {}));
 var GlobIgnore;
@@ -132,7 +133,7 @@ function javascript(options) {
             'no-sequences': 'error',
             'no-shadow-restricted-names': 'error',
             'no-sparse-arrays': 'error',
-            'no-template-curly-in-string': 'off',
+            'no-template-curly-in-string': 'error',
             'no-undef-init': 'error',
             'no-undefined': 'error',
             'no-unexpected-multiline': 'error',
@@ -588,6 +589,64 @@ async function unicorn(options) {
     };
 }
 
+async function vitest(options) {
+    const { overrides, vitest: enabled } = options;
+    if (!enabled)
+        return {};
+    const plugin = await interopDefault(import('eslint-plugin-vitest'));
+    return {
+        plugins: {
+            vitest: plugin
+        },
+        files: [Glob.VITEST],
+        rules: {
+            'vitest/consistent-test-it': ['error', { fn: 'it', withinDescribe: 'it' }],
+            'vitest/expect-expect': [
+                'error',
+                {
+                    assertFunctionNames: ['expect']
+                }
+            ],
+            'vitest/max-expects': ['error', { max: 5 }],
+            'vitest/max-nested-describe': ['error', { max: 1 }],
+            'vitest/no-alias-methods': 'error',
+            'vitest/no-commented-out-tests': 'error',
+            'vitest/no-conditional-expect': 'error',
+            'vitest/no-conditional-in-test': 'error',
+            'vitest/no-conditional-tests': 'error',
+            'vitest/no-done-callback': 'error',
+            'vitest/no-duplicate-hooks': 'error',
+            'vitest/no-identical-title': 'error',
+            'vitest/no-import-node-test': 'error',
+            'vitest/no-standalone-expect': 'error',
+            'vitest/no-test-return-statement': 'error',
+            'vitest/prefer-called-exactly-once-with': 'error',
+            'vitest/prefer-comparison-matcher': 'error',
+            'vitest/prefer-each': 'error',
+            'vitest/prefer-equality-matcher': 'error',
+            'vitest/prefer-expect-resolves': 'error',
+            'vitest/prefer-hooks-in-order': 'error',
+            'vitest/prefer-hooks-on-top': 'error',
+            'vitest/prefer-lowercase-title': 'error',
+            'vitest/prefer-mock-promise-shorthand': 'error',
+            'vitest/prefer-spy-on': 'error',
+            'vitest/prefer-to-be-object': 'error',
+            'vitest/prefer-to-contain': 'error',
+            'vitest/prefer-to-have-length': 'error',
+            'vitest/prefer-todo': 'error',
+            'vitest/require-top-level-describe': [
+                'error',
+                {
+                    maxNumberOfTopLevelDescribes: 10
+                }
+            ],
+            'vitest/valid-describe-callback': 'error',
+            'vitest/valid-expect': 'error',
+            ...overrides?.vitest
+        }
+    };
+}
+
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
@@ -881,6 +940,7 @@ async function config(options) {
         ...(await vue(options)),
         perfectionist(options),
         unicorn(options),
+        vitest(options),
         prettier ? eslintConfigPrettier : {},
         {
             ignores: [...getIgnores(), ...(options.ignores ?? [])]

package/dist/index.d.ts

@@ -1,44 +1 @@
-declare function config(options: ConfigOptions): Promise<Partial<ConfigObject>[]>;
-export default config;
-
-/** @see https://eslint.org/docs/latest/use/configure/configuration-files-new#configuration-objects */
-declare interface ConfigObject {
-    files: string[];
-    ignores?: Ignores['ignores'];
-    languageOptions: {
-        ecmaVersion?: 'latest';
-        sourceType?: 'module';
-        parser?: unknown;
-        parserOptions?: Record<string, unknown>;
-        globals?: Record<string, boolean | 'readonly' | 'writeable'>;
-    };
-    plugins?: Record<string, unknown>;
-    processor?: unknown;
-    rules: Rules;
-}
-
-declare interface ConfigOptions {
-    prettier?: boolean;
-    vue?: boolean;
-    jsx?: boolean;
-    /** `tsconfig.json` files for Typescript. */
-    project: string[];
-    ignores?: Ignores['ignores'];
-    overrides?: {
-        javascript?: Rules;
-        typescript?: Rules;
-        vue?: Rules;
-    };
-}
-
-declare interface Ignores {
-    ignores: string[];
-}
-
-declare type RuleOption = [Severity, string | Record<string, unknown>] | [Severity, string, Record<string, unknown>];
-
-declare type Rules = Record<string, Severity | RuleOption>;
-
-declare type Severity = 'error' | 'warn' | 'off' | 0 | 1;
-
 export { }

package/dist/index.mjs

@@ -7,6 +7,7 @@ var Glob;
     Glob["ALL"] = "**/*.?([cm])[jt]s?(x)";
     Glob["JAVASCRIPT"] = "**/*.?([cm])js?(x)";
     Glob["TYPESCRIPT"] = "**/*.?([cm])ts?(x)";
+    Glob["VITEST"] = "**/*.{test,spec}.[jt]s";
     Glob["VUE"] = "**/*.vue";
 })(Glob || (Glob = {}));
 var GlobIgnore;
@@ -130,7 +131,7 @@ function javascript(options) {
             'no-sequences': 'error',
             'no-shadow-restricted-names': 'error',
             'no-sparse-arrays': 'error',
-            'no-template-curly-in-string': 'off',
+            'no-template-curly-in-string': 'error',
             'no-undef-init': 'error',
             'no-undefined': 'error',
             'no-unexpected-multiline': 'error',
@@ -586,6 +587,64 @@ async function unicorn(options) {
     };
 }
 
+async function vitest(options) {
+    const { overrides, vitest: enabled } = options;
+    if (!enabled)
+        return {};
+    const plugin = await interopDefault(import('eslint-plugin-vitest'));
+    return {
+        plugins: {
+            vitest: plugin
+        },
+        files: [Glob.VITEST],
+        rules: {
+            'vitest/consistent-test-it': ['error', { fn: 'it', withinDescribe: 'it' }],
+            'vitest/expect-expect': [
+                'error',
+                {
+                    assertFunctionNames: ['expect']
+                }
+            ],
+            'vitest/max-expects': ['error', { max: 5 }],
+            'vitest/max-nested-describe': ['error', { max: 1 }],
+            'vitest/no-alias-methods': 'error',
+            'vitest/no-commented-out-tests': 'error',
+            'vitest/no-conditional-expect': 'error',
+            'vitest/no-conditional-in-test': 'error',
+            'vitest/no-conditional-tests': 'error',
+            'vitest/no-done-callback': 'error',
+            'vitest/no-duplicate-hooks': 'error',
+            'vitest/no-identical-title': 'error',
+            'vitest/no-import-node-test': 'error',
+            'vitest/no-standalone-expect': 'error',
+            'vitest/no-test-return-statement': 'error',
+            'vitest/prefer-called-exactly-once-with': 'error',
+            'vitest/prefer-comparison-matcher': 'error',
+            'vitest/prefer-each': 'error',
+            'vitest/prefer-equality-matcher': 'error',
+            'vitest/prefer-expect-resolves': 'error',
+            'vitest/prefer-hooks-in-order': 'error',
+            'vitest/prefer-hooks-on-top': 'error',
+            'vitest/prefer-lowercase-title': 'error',
+            'vitest/prefer-mock-promise-shorthand': 'error',
+            'vitest/prefer-spy-on': 'error',
+            'vitest/prefer-to-be-object': 'error',
+            'vitest/prefer-to-contain': 'error',
+            'vitest/prefer-to-have-length': 'error',
+            'vitest/prefer-todo': 'error',
+            'vitest/require-top-level-describe': [
+                'error',
+                {
+                    maxNumberOfTopLevelDescribes: 10
+                }
+            ],
+            'vitest/valid-describe-callback': 'error',
+            'vitest/valid-expect': 'error',
+            ...overrides?.vitest
+        }
+    };
+}
+
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
@@ -879,6 +938,7 @@ async function config(options) {
         ...(await vue(options)),
         perfectionist(options),
         unicorn(options),
+        vitest(options),
         prettier ? eslintConfigPrettier : {},
         {
             ignores: [...getIgnores(), ...(options.ignores ?? [])]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tb-dev/eslint-config",
-  "version": "1.4.11",
+  "version": "1.5.0",
   "description": "ESLint config",
   "license": "MIT",
   "type": "module",
@@ -17,12 +17,23 @@
   "lint-staged": {
     "*.{?(c|m)@(j|t)s,css,vue,md,json}": "prettier --write"
   },
+  "scripts": {
+    "build": "rollup --config rollup.config.js",
+    "deps": "pnpm exec taze -w -f -l",
+    "format": "pnpm exec prettier . --write",
+    "format-check": "pnpm exec prettier . --check",
+    "lint": "eslint . --config eslint.config.js --cache",
+    "prepare": "husky install",
+    "release": "miho -l publish",
+    "typecheck": "tsc --noEmit"
+  },
   "dependencies": {
     "@typescript-eslint/eslint-plugin": "^6.15.0",
     "@typescript-eslint/parser": "^6.15.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-perfectionist": "^2.5.0",
     "eslint-plugin-unicorn": "^49.0.0",
+    "eslint-plugin-vitest": "^0.3.18",
     "eslint-plugin-vue": "^9.19.2",
     "globals": "^13.24.0",
     "vue-eslint-parser": "^9.3.2"
@@ -33,6 +44,7 @@
     "@types/eslint-config-prettier": "^6.11.3",
     "@types/node": "^20.10.5",
     "eslint": "^8.56.0",
+    "execa": "^8.0.1",
     "husky": "^8.0.3",
     "lint-staged": "^15.2.0",
     "miho": "^2.2.3",
@@ -61,14 +73,5 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
     }
-  },
-  "scripts": {
-    "build": "rollup --config rollup.config.js",
-    "deps": "pnpm exec taze -w -f -l",
-    "format": "pnpm exec prettier . --write",
-    "format-check": "pnpm exec prettier . --check",
-    "lint": "eslint . --config eslint.config.js --cache",
-    "release": "miho -l publish",
-    "typecheck": "tsc --noEmit"
   }
-}
+}