@mlaursen/eslint-config 7.1.0 → 8.0.0-next.1

package/README.md

@@ -10,18 +10,42 @@ Starting at `5.0.0`, I only support `eslint@^9` or greater.
 npm install -D eslint @mlaursen/eslint-config
 ```
 
-Then create an `eslint.config.mjs` with the following:
+Then create an `eslint.config.mjs` with one of the following:
 
 ```js
 // @ts-check
 import { config, configs, gitignore } from "@mlaursen/eslint-config";
 
-// choose the config you want to use:
 // somewhat strict type checking
-export default config(gitignore(import.meta.url), ...configs.frontend);
+export default config(gitignore(import.meta.url), ...configs.frontend("jest"));
+
+// or with vitest
+// export default config(
+//   gitignore(import.meta.url),
+//   ...configs.frontend("vitest")
+// );
+```
+
+```js
+// @ts-check
+import { config, configs, gitignore } from "@mlaursen/eslint-config";
 
 // strict type checking
-export default config(gitignore(import.meta.url), ...configs.frontendTypeChecking(import.meta.dirname));
+export default config(
+  gitignore(import.meta.url),
+  ...configs.frontendTypeChecking(import.meta.dirname, "jest")
+);
+
+// or with vitest
+// export default config(
+//   gitignore(import.meta.url),
+//   ...configs.frontendTypeChecking(import.meta.dirname, "vitest")
+// );
+```
+
+```js
+// @ts-check
+import { config, configs, gitignore } from "@mlaursen/eslint-config";
 
 // NOTE: This is recommended for strict type checking. Callable as:
 // `cross-env STRICT_TYPING=true eslint "**/*.{ts,tsx,mts,mtsx,js,jsx,mjs,cjs}`
@@ -29,8 +53,15 @@ export default config(gitignore(import.meta.url), ...configs.frontendTypeCheckin
 // strict type checking with an environment variable. uncomment the following
 // line to enable it in your editor
 // const strict = true || process.env.STRICT_TYPING === 'true';
-const strict = process.env.STRICT_TYPING === 'true';
-const frontend = strict ? configs.frontendTypeChecking(import.meta.dirname) : configs.frontend
+const strict = process.env.STRICT_TYPING === "true";
+const frontend = strict
+  ? configs.frontendTypeChecking(import.meta.dirname, "jest")
+  : configs.frontend("jest");
+
+// or with vitest
+// const frontend = strict
+//   ? configs.frontendTypeChecking(import.meta.dirname, "vitest")
+//   : configs.frontend("vitest");
 export default config(gitignore(import.meta.url), ...frontend);
 ```
 
@@ -48,13 +79,14 @@ others can be used individually if needed.
 - [base](#base)
 - [typescript](#typescript)
 - [typescriptTypeChecking](#typescripttypechecking)
+- [testing](#testing)
 - [jest](#jest)
 - [jestDom](#jestdom)
+- [vitest](#vitest)
 - [testingLibraryReact](#testinglibraryreact)
 - [testingLibraryDom](#testinglibrarydom)
 - [react](#react)
 - [jsxA11y](#jsxa11y)
-- [next](#next)
 - [frontend](#frontend)
 - [frontendTypeChecking](#frontendtypechecking)
 
@@ -100,9 +132,23 @@ import { config, configs } from "@mlaursen/eslint-config";
 export default config(...configs.typescriptTypeChecking(import.meta.dirname));
 ```
 
+### testing
+
+This enables the [jest](#jest) or [vitest](#vitest) rules along with [jestDom](#jestdom).
+
+```js
+// @ts-check
+import { config, configs } from "@mlaursen/eslint-config";
+
+export default config(...configs.testing("jest"));
+
+// or vitest
+export default config(...configs.testing("vitest"));
+```
+
 ### jest
 
-This only enables the `eslint-plugin-jest.configs['flat/recommended]` rules on tests files.
+This only enables the `eslint-plugin-jest.configs['flat/recommended]` rules on tests files and should not be used if using [testing](#testing).
 
 ```js
 // @ts-check
@@ -113,7 +159,7 @@ export default config(...configs.jest);
 
 ### jestDom
 
-This only enables the `eslint-plugin-jest-dom.configs['flat/recommended]` rules on tests files.
+This only enables the `eslint-plugin-jest-dom.configs['flat/recommended]` rules on tests files and should not be used if using [testing](#testing).
 
 ```js
 // @ts-check
@@ -122,6 +168,10 @@ import { config, configs } from "@mlaursen/eslint-config";
 export default config(...configs.jestDom);
 ```
 
+### vitest
+
+This only enables the `@vitest/eslint-plugin` rules on test files and should not be used if using [testing](#testing).
+
 ### testingLibraryReact
 
 This enables the `eslint-plugin-testing-library/.configs["flat/react]` plugin and rules on test files.
@@ -130,6 +180,13 @@ This enables the `eslint-plugin-testing-library/.configs["flat/react]` plugin an
 // @ts-check
 import { config, configs } from "@mlaursen/eslint-config";
 
+export default config(...configs.vitest);
+```
+
+```js
+// @ts-check
+import { config, configs } from "@mlaursen/eslint-config";
+
 export default config(...configs.testingLibraryReact);
 ```
 
@@ -168,27 +225,19 @@ import { config, configs } from "@mlaursen/eslint-config";
 export default config(...configs.jsxA11y);
 ```
 
-### next
-
-This is a small wrapper around the `@next/eslint-plugin-next` that works with eslint v9.
-
-```js
-// @ts-check
-import { config, configs } from "@mlaursen/eslint-config";
-
-export default config(...configs.next);
-```
-
 ### frontend
 
-This is my normal frontend repo setup with `react`, `jsxA11y`, `jest`,
-`jest-dom`, `typescript`, `testing-library/react`.
+This is my normal frontend repo setup with `react`, `jsxA11y`, `jest` or
+`vitest`, `jest-dom`, `typescript`, `testing-library/react`.
 
 ```js
 // @ts-check
 import { config, configs } from "@mlaursen/eslint-config";
 
-export default config(...configs.frontend);
+export default config(...configs.frontend("jest"));
+
+// or with vitest
+export default config(...configs.frontend("vitest"));
 ```
 
 ### frontendTypeChecking
@@ -199,5 +248,8 @@ Same as the [frontend](#frontend), but enables the strict type checking.
 // @ts-check
 import { config, configs } from "@mlaursen/eslint-config";
 
-export default config(...configs.frontendTypeChecking(import.meta.dirname));
+export default config(...configs.frontendTypeChecking(import.meta.dirname, "jest"));
+
+// or with vitest
+export default config(...configs.frontendTypeChecking(import.meta.dirname, "vitest"));
 ```

package/dist/frontend.d.ts

@@ -1,4 +1,5 @@
 import { type TSESLint } from "@typescript-eslint/utils";
+import { type TestFramework } from "./testing.js";
 /**
  * @example
  * ```ts
@@ -6,11 +7,12 @@ import { type TSESLint } from "@typescript-eslint/utils";
  *
  * export default config(
  *   gitignore(import.meta.url),
- *   ...configs.frontend
+ *   ...configs.frontend("jest")
+ *   // ...configs.frontend("vitest")
  * );
  * ```
  */
-export declare const frontend: TSESLint.FlatConfig.ConfigArray;
+export declare const frontend: (testFramework: TestFramework) => TSESLint.FlatConfig.ConfigArray;
 /**
  * @example
  * ```ts
@@ -18,8 +20,9 @@ export declare const frontend: TSESLint.FlatConfig.ConfigArray;
  *
  * export default config(
  *   gitignore(import.meta.url),
- *   ...configs.frontendTypeChecking(import.meta.dirname)
+ *   ...configs.frontendTypeChecking(import.meta.dirname, "jest")
+ *   // ...configs.frontendTypeChecking(import.meta.dirname, "vitest"),
  * );
  * ```
  */
-export declare const frontendTypeChecking: (tsconfigRootDir: string) => TSESLint.FlatConfig.ConfigArray;
+export declare const frontendTypeChecking: (tsconfigRootDir: string, testFramework: TestFramework) => TSESLint.FlatConfig.ConfigArray;

package/dist/frontend.js

@@ -23,10 +23,10 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     }
     return to.concat(ar || Array.prototype.slice.call(from));
 };
-import { jest, jestDom } from "./jest.js";
 import { jsxA11y } from "./jsxA11y.js";
 import { react } from "./react.js";
 import { testingLibraryReact } from "./testing-library.js";
+import { testing } from "./testing.js";
 import { typescript, typescriptTypeChecking } from "./typescript.js";
 /**
  * @example
@@ -35,11 +35,12 @@ import { typescript, typescriptTypeChecking } from "./typescript.js";
  *
  * export default config(
  *   gitignore(import.meta.url),
- *   ...configs.frontend
+ *   ...configs.frontend("jest")
+ *   // ...configs.frontend("vitest")
  * );
  * ```
  */
-export var frontend = __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(typescript), false), __read(react), false), __read(jsxA11y), false), __read(jest), false), __read(jestDom), false), __read(testingLibraryReact), false);
+export var frontend = function (testFramework) { return __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(typescript), false), __read(react), false), __read(jsxA11y), false), __read(testing(testFramework)), false), __read(testingLibraryReact), false); };
 /**
  * @example
  * ```ts
@@ -47,8 +48,9 @@ export var frontend = __spreadArray(__spreadArray(__spreadArray(__spreadArray(__
  *
  * export default config(
  *   gitignore(import.meta.url),
- *   ...configs.frontendTypeChecking(import.meta.dirname)
+ *   ...configs.frontendTypeChecking(import.meta.dirname, "jest")
+ *   // ...configs.frontendTypeChecking(import.meta.dirname, "vitest"),
  * );
  * ```
  */
-export var frontendTypeChecking = function (tsconfigRootDir) { return __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(typescriptTypeChecking(tsconfigRootDir)), false), __read(react), false), __read(jsxA11y), false), __read(jest), false), __read(jestDom), false), __read(testingLibraryReact), false); };
+export var frontendTypeChecking = function (tsconfigRootDir, testFramework) { return __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(typescriptTypeChecking(tsconfigRootDir)), false), __read(react), false), __read(jsxA11y), false), __read(testing(testFramework)), false), __read(testingLibraryReact), false); };

package/dist/index.d.ts

@@ -11,10 +11,11 @@ export declare const configs: {
     readonly typescriptTypeChecking: (tsconfigRootDir: string) => import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
     readonly testingLibraryDom: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
     readonly testingLibraryReact: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
-    readonly frontend: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
-    readonly frontendTypeChecking: (tsconfigRootDir: string) => import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    readonly frontend: (testFramework: import("./testing.js").TestFramework) => import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    readonly frontendTypeChecking: (tsconfigRootDir: string, testFramework: import("./testing.js").TestFramework) => import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
     readonly jsxA11y: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
-    readonly next: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    readonly testing: (framework: import("./testing.js").TestFramework) => import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    readonly vitest: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
 };
 declare const _default: {
     config: typeof config;
@@ -27,10 +28,11 @@ declare const _default: {
         readonly typescriptTypeChecking: (tsconfigRootDir: string) => import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
         readonly testingLibraryDom: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
         readonly testingLibraryReact: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
-        readonly frontend: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
-        readonly frontendTypeChecking: (tsconfigRootDir: string) => import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+        readonly frontend: (testFramework: import("./testing.js").TestFramework) => import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+        readonly frontendTypeChecking: (tsconfigRootDir: string, testFramework: import("./testing.js").TestFramework) => import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
         readonly jsxA11y: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
-        readonly next: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+        readonly testing: (framework: import("./testing.js").TestFramework) => import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+        readonly vitest: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
     };
     gitignore: typeof gitignore;
 };

package/dist/index.js

@@ -2,11 +2,10 @@ import { config } from "typescript-eslint";
 import { base } from "./base.js";
 import { frontend, frontendTypeChecking } from "./frontend.js";
 import { gitignore } from "./gitignore.js";
-import { jest, jestDom } from "./jest.js";
 import { jsxA11y } from "./jsxA11y.js";
-import { next } from "./next.js";
 import { react } from "./react.js";
 import { testingLibraryDom, testingLibraryReact } from "./testing-library.js";
+import { jest, jestDom, testing, vitest } from "./testing.js";
 import { typescript, typescriptTypeChecking } from "./typescript.js";
 export * from "./constants.js";
 export { config, gitignore };
@@ -22,7 +21,8 @@ export var configs = {
     frontend: frontend,
     frontendTypeChecking: frontendTypeChecking,
     jsxA11y: jsxA11y,
-    next: next,
+    testing: testing,
+    vitest: vitest,
 };
 export default {
     config: config,

package/dist/testing.d.ts

@@ -0,0 +1,41 @@
+import { type TSESLint } from "@typescript-eslint/utils";
+export type TestFramework = "jest" | "vitest";
+/**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.vitest);
+ * ```
+ */
+export declare const vitest: TSESLint.FlatConfig.ConfigArray;
+/**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.jest);
+ * ```
+ */
+export declare const jest: TSESLint.FlatConfig.ConfigArray;
+/**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.jest, ...configs.jestDom);
+ * ```
+ */
+export declare const jestDom: TSESLint.FlatConfig.ConfigArray;
+/**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.testing("jest"));
+ *
+ * // or
+ * export default config(...configs.testing("vitest"));
+ * ```
+ */
+export declare const testing: (framework: TestFramework) => TSESLint.FlatConfig.ConfigArray;

package/dist/testing.js

@@ -0,0 +1,103 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+import vitestPlugin from "@vitest/eslint-plugin";
+import jestPlugin from "eslint-plugin-jest";
+import jestDomPlugin from "eslint-plugin-jest-dom";
+import { BASE_NAME, DEV_WARNING_PROD_ERROR, TEST_FILES } from "./constants.js";
+/**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.vitest);
+ * ```
+ */
+export var vitest = [
+    {
+        name: "".concat(BASE_NAME, "/vitest"),
+        files: TEST_FILES,
+        plugins: {
+            vitest: vitestPlugin,
+        },
+        rules: __assign(__assign({}, vitestPlugin.configs.recommended.rules), { "vitest/no-alias-methods": "error", "vitest/no-focused-tests": DEV_WARNING_PROD_ERROR, "vitest/no-disabled-tests": DEV_WARNING_PROD_ERROR, "vitest/no-duplicate-hooks": "error", "vitest/no-standalone-expect": "error", "vitest/prefer-expect-resolves": "error", "vitest/prefer-spy-on": "error", "vitest/prefer-vi-mocked": "error" }),
+    },
+];
+/**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.jest);
+ * ```
+ */
+export var jest = [
+    __assign({ name: "".concat(BASE_NAME, "/jest"), files: TEST_FILES }, jestPlugin.configs["flat/recommended"]),
+];
+/**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.jest, ...configs.jestDom);
+ * ```
+ */
+export var jestDom = [
+    __assign({ name: "".concat(BASE_NAME, "/jest-dom"), files: TEST_FILES }, jestDomPlugin.configs["flat/recommended"]),
+];
+/**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.testing("jest"));
+ *
+ * // or
+ * export default config(...configs.testing("vitest"));
+ * ```
+ */
+export var testing = function (framework) {
+    var config;
+    switch (framework) {
+        case "jest":
+            config = jest;
+            break;
+        case "vitest":
+            config = vitest;
+            break;
+    }
+    return __spreadArray(__spreadArray([], __read(config), false), __read(jestDom), false);
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mlaursen/eslint-config",
   "type": "module",
-  "version": "7.1.0",
+  "version": "8.0.0-next.1",
   "description": "An eslint config used by mlaursen for most projects.",
   "repository": "https://github.com/mlaursen/eslint-config.git",
   "author": "Mikkel Laursen <mlaursen03@gmail.com>",
@@ -23,9 +23,9 @@
   "dependencies": {
     "@eslint/compat": "^1.2.8",
     "@eslint/js": "^9.24.0",
-    "@next/eslint-plugin-next": "^15.3.0",
     "@types/eslint-plugin-jsx-a11y": "^6.10.0",
     "@typescript-eslint/utils": "^8.30.1",
+    "@vitest/eslint-plugin": "^1.1.43",
     "eslint-plugin-jest": "^28.11.0",
     "eslint-plugin-jest-dom": "^5.5.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",

package/dist/jest.d.ts

@@ -1,19 +0,0 @@
-import { type TSESLint } from "@typescript-eslint/utils";
-/**
- * @example
- * ```ts
- * import { config, configs } from "@mlaursen/eslint-config";
- *
- * export default config(...configs.jest);
- * ```
- */
-export declare const jest: TSESLint.FlatConfig.ConfigArray;
-/**
- * @example
- * ```ts
- * import { config, configs } from "@mlaursen/eslint-config";
- *
- * export default config(...configs.jest, ...configs.jestDom);
- * ```
- */
-export declare const jestDom: TSESLint.FlatConfig.ConfigArray;

package/dist/jest.js

@@ -1,36 +0,0 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-import jestPlugin from "eslint-plugin-jest";
-import jestDomPlugin from "eslint-plugin-jest-dom";
-import { BASE_NAME, TEST_FILES } from "./constants.js";
-/**
- * @example
- * ```ts
- * import { config, configs } from "@mlaursen/eslint-config";
- *
- * export default config(...configs.jest);
- * ```
- */
-export var jest = [
-    __assign({ name: "".concat(BASE_NAME, "/jest"), files: TEST_FILES }, jestPlugin.configs["flat/recommended"]),
-];
-/**
- * @example
- * ```ts
- * import { config, configs } from "@mlaursen/eslint-config";
- *
- * export default config(...configs.jest, ...configs.jestDom);
- * ```
- */
-export var jestDom = [
-    __assign({ name: "".concat(BASE_NAME, "/jest-dom"), files: TEST_FILES }, jestDomPlugin.configs["flat/recommended"]),
-];

package/dist/next.d.ts

@@ -1,10 +0,0 @@
-import { type TSESLint } from "@typescript-eslint/utils";
-/**
- * @example
- * ```ts
- * import { config, configs, gitignore } from "@mlaursen/eslint-config";
- *
- * export default config(gitignore(import.meta.url), ...configs.typescript, ...configs.next);
- * ```
- */
-export declare const next: TSESLint.FlatConfig.ConfigArray;

package/dist/next.js

@@ -1,32 +0,0 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-import { fixupPluginRules } from "@eslint/compat";
-import nextPlugin from "@next/eslint-plugin-next";
-import { BASE_NAME } from "./constants.js";
-/**
- * @example
- * ```ts
- * import { config, configs, gitignore } from "@mlaursen/eslint-config";
- *
- * export default config(gitignore(import.meta.url), ...configs.typescript, ...configs.next);
- * ```
- */
-export var next = [
-    {
-        name: "".concat(BASE_NAME, "/next"),
-        plugins: {
-            // @ts-expect-error There is a bad typing atm
-            "@next/next": fixupPluginRules(nextPlugin),
-        },
-        rules: __assign({}, nextPlugin.configs.recommended.rules),
-    },
-];