@mlaursen/eslint-config 5.0.0 → 5.1.1

package/README.md

@@ -14,19 +14,24 @@ Then create an `eslint.config.mjs` with the following:
 
 ```js
 // @ts-check
-import { config, configs } from "@mlaursen/eslint-config";
+import { config, configs, gitignore } from "@mlaursen/eslint-config";
 
-// choose the config you want to use
-export default config(...configs.frontend);
-export default config(...configs.frontendTypeChecking(import.meta.dirname));
+// choose the config you want to use:
+// somewhat strict type checking
+export default config(gitignore(import.meta.url), ...configs.frontend);
+
+// strict type checking
+export default config(gitignore(import.meta.url), ...configs.frontendTypeChecking(import.meta.dirname));
 ```
 
-The `config` export is the `typescript-eslint.config()` function to provide
-type definitions.
+The `config` export is the `typescript-eslint.config()` function to provide type
+definitions and `gitignore` automatically ignores files from linting based on
+your `.gitignore` rules.
 
 ## Configs
 
-I normally just use the `frontend` or `frontendTypeChecking` configs, but the others can be used individually if needed.
+I normally just use the `frontend` or `frontendTypeChecking` configs, but the
+others can be used individually if needed.
 
 <!--toc:start-->
 
@@ -37,6 +42,9 @@ I normally just use the `frontend` or `frontendTypeChecking` configs, but the ot
 - [jestDom](#jestdom)
 - [testingLibraryReact](#testinglibraryreact)
 - [testingLibraryDom](#testinglibrarydom)
+- [react](#react)
+- [jsxA11y](#jsxa11y)
+- [next](#next)
 - [frontend](#frontend)
 - [frontendTypeChecking](#frontendtypechecking)
 
@@ -128,9 +136,43 @@ import { config, configs } from "@mlaursen/eslint-config";
 export default config(...configs.testingLibraryDom);
 ```
 
+### react
+
+This enables the `eslint-plugin-react` and `eslint-plugin-react-hooks`:
+
+```js
+// @ts-check
+import { config, configs } from "@mlaursen/eslint-config";
+
+export default config(...configs.react);
+```
+
+### jsxA11y
+
+This enables `eslint-plugin-jsx-a11y`:
+
+```js
+// @ts-check
+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 `jest`, `jest-dom`, `typescript`, `react`, `testing-library/react`.
+This is my normal frontend repo setup with `react`, `jsxA11y`, `jest`,
+`jest-dom`, `typescript`, `testing-library/react`.
 
 ```js
 // @ts-check

package/dist/constants.d.ts

@@ -1,2 +1,3 @@
 export declare const DEV_WARNING_PROD_ERROR: string;
 export declare const TEST_FILES: string[];
+export declare const JSX_FILES: string[];

package/dist/constants.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEST_FILES = exports.DEV_WARNING_PROD_ERROR = void 0;
+exports.JSX_FILES = exports.TEST_FILES = exports.DEV_WARNING_PROD_ERROR = void 0;
 exports.DEV_WARNING_PROD_ERROR = process.env.NODE_ENV !== "production" ? "warn" : "error";
 exports.TEST_FILES = [
     "**/__tests__/**",
     "**/*.{spec,test}.{ts,tsx,js,jsx}",
 ];
+exports.JSX_FILES = ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"];

package/dist/frontend.js

@@ -27,8 +27,10 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.frontendTypeChecking = exports.frontend = void 0;
 var jest_1 = require("./jest");
+var jsxA11y_1 = require("./jsxA11y");
+var react_1 = require("./react");
 var testing_library_1 = require("./testing-library");
 var typescript_1 = require("./typescript");
-exports.frontend = __spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(typescript_1.typescript), false), __read(jest_1.jest), false), __read(jest_1.jestDom), false), __read(testing_library_1.testingLibraryReact), false);
-var frontendTypeChecking = function (tsconfigRootDir) { return __spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read((0, typescript_1.typescriptTypeChecking)(tsconfigRootDir)), false), __read(jest_1.jest), false), __read(jest_1.jestDom), false), __read(testing_library_1.testingLibraryReact), false); };
+exports.frontend = __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(typescript_1.typescript), false), __read(react_1.react), false), __read(jsxA11y_1.jsxA11y), false), __read(jest_1.jest), false), __read(jest_1.jestDom), false), __read(testing_library_1.testingLibraryReact), false);
+var frontendTypeChecking = function (tsconfigRootDir) { return __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read((0, typescript_1.typescriptTypeChecking)(tsconfigRootDir)), false), __read(react_1.react), false), __read(jsxA11y_1.jsxA11y), false), __read(jest_1.jest), false), __read(jest_1.jestDom), false), __read(testing_library_1.testingLibraryReact), false); };
 exports.frontendTypeChecking = frontendTypeChecking;

package/dist/gitignore.d.ts

@@ -0,0 +1,2 @@
+import { type TSESLint } from "@typescript-eslint/utils";
+export declare function gitignore(importMetaUrl: string): TSESLint.FlatConfig.Config;

package/dist/gitignore.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gitignore = gitignore;
+var compat_1 = require("@eslint/compat");
+var node_path_1 = __importDefault(require("node:path"));
+var node_url_1 = require("node:url");
+function gitignore(importMetaUrl) {
+    var __filename = (0, node_url_1.fileURLToPath)(importMetaUrl);
+    var __dirname = node_path_1.default.dirname(__filename);
+    var gitignorePath = node_path_1.default.resolve(__dirname, ".gitignore");
+    return (0, compat_1.includeIgnoreFile)(gitignorePath);
+}

package/dist/index.d.ts

@@ -1,12 +1,16 @@
 export { config } from "typescript-eslint";
+export { gitignore } from "./gitignore";
 export declare const configs: {
     readonly base: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
     readonly jest: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
     readonly jestDom: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    readonly react: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
     readonly typescript: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
     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 jsxA11y: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+    readonly next: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
 };

package/dist/index.js

@@ -1,21 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configs = exports.config = void 0;
+exports.configs = exports.gitignore = exports.config = void 0;
 var base_1 = require("./base");
 var frontend_1 = require("./frontend");
 var jest_1 = require("./jest");
+var jsxA11y_1 = require("./jsxA11y");
+var next_1 = require("./next");
+var react_1 = require("./react");
 var testing_library_1 = require("./testing-library");
 var typescript_1 = require("./typescript");
 var typescript_eslint_1 = require("typescript-eslint");
 Object.defineProperty(exports, "config", { enumerable: true, get: function () { return typescript_eslint_1.config; } });
+var gitignore_1 = require("./gitignore");
+Object.defineProperty(exports, "gitignore", { enumerable: true, get: function () { return gitignore_1.gitignore; } });
 exports.configs = {
     base: base_1.base,
     jest: jest_1.jest,
     jestDom: jest_1.jestDom,
+    react: react_1.react,
     typescript: typescript_1.typescript,
     typescriptTypeChecking: typescript_1.typescriptTypeChecking,
     testingLibraryDom: testing_library_1.testingLibraryDom,
     testingLibraryReact: testing_library_1.testingLibraryReact,
     frontend: frontend_1.frontend,
     frontendTypeChecking: frontend_1.frontendTypeChecking,
+    jsxA11y: jsxA11y_1.jsxA11y,
+    next: next_1.next,
 };

package/dist/jsxA11y.d.ts

@@ -0,0 +1,2 @@
+import { type TSESLint } from "@typescript-eslint/utils";
+export declare const jsxA11y: TSESLint.FlatConfig.ConfigArray;

package/dist/jsxA11y.js

@@ -0,0 +1,25 @@
+"use strict";
+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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsxA11y = void 0;
+var eslint_plugin_jsx_a11y_1 = __importDefault(require("eslint-plugin-jsx-a11y"));
+var globals_1 = __importDefault(require("globals"));
+var constants_1 = require("./constants");
+exports.jsxA11y = [
+    __assign(__assign({ files: constants_1.JSX_FILES }, eslint_plugin_jsx_a11y_1.default.flatConfigs.recommended), { languageOptions: {
+            globals: __assign({}, globals_1.default.browser),
+        } }),
+];

package/dist/next.d.ts

@@ -0,0 +1,2 @@
+import { type TSESLint } from "@typescript-eslint/utils";
+export declare const next: TSESLint.FlatConfig.ConfigArray;

package/dist/{react-hooks.js → next.js}

@@ -14,14 +14,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reactHooks = void 0;
-var eslint_plugin_react_hooks_1 = __importDefault(require("eslint-plugin-react-hooks"));
-exports.reactHooks = [
+exports.next = void 0;
+var compat_1 = require("@eslint/compat");
+var eslint_plugin_next_1 = __importDefault(require("@next/eslint-plugin-next"));
+exports.next = [
     {
-        files: ["**/*.{ts,tsx,js,jsx}"],
         plugins: {
-            "react-hooks": eslint_plugin_react_hooks_1.default,
+            // @ts-expect-error There is a bad typing atm
+            "@next/next": (0, compat_1.fixupPluginRules)(eslint_plugin_next_1.default),
         },
-        rules: __assign({}, eslint_plugin_react_hooks_1.default.configs.recommended.rules),
+        rules: __assign({}, eslint_plugin_next_1.default.configs.recommended.rules),
     },
 ];

package/dist/react.d.ts

@@ -0,0 +1,10 @@
+import { type TSESLint } from "@typescript-eslint/utils";
+/**
+ * Enables:
+ * - `eslint-plugin-react` with:
+ *   - flat.recommended
+ *   - flat['jsx-runtime']
+ * - `eslint-plugin-react-hooks` with:
+ *   - recommended rules
+ */
+export declare const react: TSESLint.FlatConfig.ConfigArray;

package/dist/react.js

@@ -0,0 +1,46 @@
+"use strict";
+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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.react = void 0;
+var eslint_plugin_react_1 = __importDefault(require("eslint-plugin-react"));
+var eslint_plugin_react_hooks_1 = __importDefault(require("eslint-plugin-react-hooks"));
+var globals_1 = __importDefault(require("globals"));
+var constants_1 = require("./constants");
+var flat = eslint_plugin_react_1.default.configs.flat;
+var reactPlugins = flat.recommended.plugins;
+var recommendedRules = flat.recommended.rules;
+var jsxRuntimeRules = flat["jsx-runtime"].rules;
+/**
+ * Enables:
+ * - `eslint-plugin-react` with:
+ *   - flat.recommended
+ *   - flat['jsx-runtime']
+ * - `eslint-plugin-react-hooks` with:
+ *   - recommended rules
+ */
+exports.react = [
+    {
+        files: constants_1.JSX_FILES,
+        settings: {
+            react: {
+                version: "detect",
+            },
+        },
+        plugins: __assign(__assign({}, reactPlugins), { "react-hooks": eslint_plugin_react_hooks_1.default }),
+        rules: __assign(__assign(__assign({}, recommendedRules), jsxRuntimeRules), eslint_plugin_react_hooks_1.default.configs.recommended.rules),
+        languageOptions: __assign(__assign({}, flat.recommended.languageOptions), { globals: __assign({}, globals_1.default.browser) }),
+    },
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mlaursen/eslint-config",
-  "version": "5.0.0",
+  "version": "5.1.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>",
@@ -22,10 +22,13 @@
   "dependencies": {
     "@eslint/compat": "^1.2.0",
     "@eslint/js": "^9.12.0",
+    "@next/eslint-plugin-next": "^14.2.15",
     "@types/eslint__js": "^8.42.3",
     "@typescript-eslint/utils": "^8.8.1",
     "eslint-plugin-jest": "^28.8.3",
     "eslint-plugin-jest-dom": "^5.4.0",
+    "eslint-plugin-jsx-a11y": "^6.10.0",
+    "eslint-plugin-react": "^7.37.1",
     "eslint-plugin-react-hooks": "^5.0.0",
     "eslint-plugin-testing-library": "^6.3.0",
     "typescript-eslint": "^8.8.1"

package/dist/react-hooks.d.ts

@@ -1,2 +0,0 @@
-import { type TSESLint } from "@typescript-eslint/utils";
-export declare const reactHooks: TSESLint.FlatConfig.ConfigArray;