@mlaursen/eslint-config 5.1.2 → 5.1.3

package/dist/index.js

@@ -1,18 +1,23 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configs = exports.gitignore = exports.config = void 0;
+exports.globals = exports.gitignore = exports.config = exports.configs = void 0;
+var globals_1 = __importDefault(require("globals"));
+exports.globals = globals_1.default;
+var typescript_eslint_1 = require("typescript-eslint");
+Object.defineProperty(exports, "config", { enumerable: true, get: function () { return typescript_eslint_1.config; } });
 var base_1 = require("./base");
 var frontend_1 = require("./frontend");
+var gitignore_1 = require("./gitignore");
+Object.defineProperty(exports, "gitignore", { enumerable: true, get: function () { return gitignore_1.gitignore; } });
 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,
@@ -27,3 +32,9 @@ exports.configs = {
     jsxA11y: jsxA11y_1.jsxA11y,
     next: next_1.next,
 };
+exports.default = {
+    config: typescript_eslint_1.config,
+    configs: exports.configs,
+    globals: globals_1.default,
+    gitignore: gitignore_1.gitignore,
+};

package/dist/jest.d.ts

@@ -1,3 +1,19 @@
 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

@@ -18,9 +18,25 @@ exports.jestDom = exports.jest = void 0;
 var eslint_plugin_jest_1 = __importDefault(require("eslint-plugin-jest"));
 var eslint_plugin_jest_dom_1 = __importDefault(require("eslint-plugin-jest-dom"));
 var constants_1 = require("./constants");
+/**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.jest);
+ * ```
+ */
 exports.jest = [
-    __assign({ files: constants_1.TEST_FILES }, eslint_plugin_jest_1.default.configs["flat/recommended"]),
+    __assign({ name: "".concat(constants_1.BASE_NAME, "/jest"), files: constants_1.TEST_FILES }, eslint_plugin_jest_1.default.configs["flat/recommended"]),
 ];
+/**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.jest, ...configs.jestDom);
+ * ```
+ */
 exports.jestDom = [
-    __assign({ files: constants_1.TEST_FILES }, eslint_plugin_jest_dom_1.default.configs["flat/recommended"]),
+    __assign({ name: "".concat(constants_1.BASE_NAME, "/jest-dom"), files: constants_1.TEST_FILES }, eslint_plugin_jest_dom_1.default.configs["flat/recommended"]),
 ];

package/dist/jsxA11y.d.ts

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

package/dist/jsxA11y.js

@@ -18,8 +18,16 @@ 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");
+/**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.jsxA11y);
+ * ```
+ */
 exports.jsxA11y = [
-    __assign(__assign({ files: constants_1.JSX_FILES }, eslint_plugin_jsx_a11y_1.default.flatConfigs.recommended), { languageOptions: {
+    __assign(__assign({ name: "".concat(constants_1.BASE_NAME, "/jsx-a11y"), files: constants_1.JSX_FILES }, eslint_plugin_jsx_a11y_1.default.flatConfigs.recommended), { languageOptions: {
             globals: __assign({}, globals_1.default.browser),
         }, rules: {
             // I **only** use autoFocus within dialogs which provide the correct
@@ -28,6 +36,7 @@ exports.jsxA11y = [
         } }),
     {
         files: constants_1.TEST_FILES,
+        name: "".concat(constants_1.BASE_NAME, "/jsx-a11y/testing"),
         rules: {
             "jsx-a11y/anchor-has-content": "off",
             "jsx-a11y/click-events-have-key-events": "off",

package/dist/next.d.ts

@@ -1,2 +1,10 @@
 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

@@ -17,8 +17,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.next = void 0;
 var compat_1 = require("@eslint/compat");
 var eslint_plugin_next_1 = __importDefault(require("@next/eslint-plugin-next"));
+var constants_1 = require("./constants");
+/**
+ * @example
+ * ```ts
+ * import { config, configs, gitignore } from "@mlaursen/eslint-config";
+ *
+ * export default config(gitignore(import.meta.url), ...configs.typescript, ...configs.next);
+ * ```
+ */
 exports.next = [
     {
+        name: "".concat(constants_1.BASE_NAME, "/next"),
         plugins: {
             // @ts-expect-error There is a bad typing atm
             "@next/next": (0, compat_1.fixupPluginRules)(eslint_plugin_next_1.default),

package/dist/react.d.ts

@@ -1,5 +1,12 @@
 import { type TSESLint } from "@typescript-eslint/utils";
 /**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.react);
+ * ```
+ *
  * Enables:
  * - `eslint-plugin-react` with:
  *   - flat.recommended

package/dist/react.js

@@ -24,6 +24,13 @@ var reactPlugins = flat.recommended.plugins;
 var recommendedRules = flat.recommended.rules;
 var jsxRuntimeRules = flat["jsx-runtime"].rules;
 /**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(...configs.react);
+ * ```
+ *
  * Enables:
  * - `eslint-plugin-react` with:
  *   - flat.recommended
@@ -33,6 +40,7 @@ var jsxRuntimeRules = flat["jsx-runtime"].rules;
  */
 exports.react = [
     {
+        name: "".concat(constants_1.BASE_NAME, "/react"),
         files: constants_1.JSX_FILES,
         settings: {
             react: {

package/dist/testing-library.d.ts

@@ -1,10 +1,33 @@
 import { type TSESLint } from "@typescript-eslint/utils";
 /**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(
+ *   ...configs.react,
+ *   ...configs.jest,
+ *   ...configs.jestDom,
+ *   ...configs.testingLibraryReact
+ * );
+ * ```
+ *
  * NOTE: Only choose this or the {@link testingLibraryDom}. Do not use
  * both.
  */
 export declare const testingLibraryReact: TSESLint.FlatConfig.ConfigArray;
 /**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(
+ *   ...configs.jest,
+ *   ...configs.jestDom,
+ *   ...configs.testingLibraryDom
+ * );
+ * ```
+ *
  * NOTE: Only choose this or the {@link testingLibraryReact}. Do not use
  * both.
  */

package/dist/testing-library.js

@@ -26,16 +26,39 @@ var testingLibrary = {
     },
 };
 /**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(
+ *   ...configs.react,
+ *   ...configs.jest,
+ *   ...configs.jestDom,
+ *   ...configs.testingLibraryReact
+ * );
+ * ```
+ *
  * NOTE: Only choose this or the {@link testingLibraryDom}. Do not use
  * both.
  */
 exports.testingLibraryReact = [
-    __assign(__assign({}, testingLibrary), { rules: __assign({}, eslint_plugin_testing_library_1.default.configs["flat/react"].rules) }),
+    __assign(__assign({}, testingLibrary), { name: "".concat(constants_1.BASE_NAME, "/testing-library/react"), rules: __assign({}, eslint_plugin_testing_library_1.default.configs["flat/react"].rules) }),
 ];
 /**
+ * @example
+ * ```ts
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default config(
+ *   ...configs.jest,
+ *   ...configs.jestDom,
+ *   ...configs.testingLibraryDom
+ * );
+ * ```
+ *
  * NOTE: Only choose this or the {@link testingLibraryReact}. Do not use
  * both.
  */
 exports.testingLibraryDom = [
-    __assign(__assign({}, testingLibrary), { rules: __assign({}, eslint_plugin_testing_library_1.default.configs["flat/dom"].rules) }),
+    __assign(__assign({}, testingLibrary), { name: "".concat(constants_1.BASE_NAME, "/testing-library/dom"), rules: __assign({}, eslint_plugin_testing_library_1.default.configs["flat/dom"].rules) }),
 ];

package/dist/typescript.d.ts

@@ -1,12 +1,20 @@
 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);
+ * ```
+ */
 export declare const typescript: TSESLint.FlatConfig.ConfigArray;
 /**
  * @example
  * ```ts
  * // @ts-check
- * import { config, configs } from "@mlaursen/eslint-config";
+ * import { config, configs, gitignore } from "@mlaursen/eslint-config";
  *
- * export default config(...configs.typescriptTypeChecking(import.meta.dirname));
+ * export default config(gitignore(import.meta.url), ...configs.typescriptTypeChecking(import.meta.dirname));
  * ```
  */
 export declare const typescriptTypeChecking: (tsconfigRootDir: string) => TSESLint.FlatConfig.ConfigArray;

package/dist/typescript.js

@@ -32,9 +32,18 @@ exports.typescriptTypeChecking = exports.typescript = void 0;
 var typescript_eslint_1 = __importDefault(require("typescript-eslint"));
 var base_1 = require("./base");
 var constants_1 = require("./constants");
+/**
+ * @example
+ * ```ts
+ * import { config, configs, gitignore } from "@mlaursen/eslint-config";
+ *
+ * export default config(gitignore(import.meta.url), ...configs.typescript);
+ * ```
+ */
 exports.typescript = __spreadArray(__spreadArray(__spreadArray([], __read(base_1.base), false), __read(typescript_eslint_1.default.configs.strict), false), [
     {
-        files: ["**/*.{ts,tsx}"],
+        name: "".concat(constants_1.BASE_NAME, "/typescript"),
+        files: constants_1.TS_FILES,
         rules: {
             // I prefer specifying when something is used only as a type
             "@typescript-eslint/consistent-type-imports": [
@@ -71,6 +80,7 @@ exports.typescript = __spreadArray(__spreadArray(__spreadArray([], __read(base_1
         },
     },
     {
+        name: "".concat(constants_1.BASE_NAME, "/typescript/tests"),
         files: constants_1.TEST_FILES,
         rules: {
             // allow tests to be less strict
@@ -87,13 +97,21 @@ exports.typescript = __spreadArray(__spreadArray(__spreadArray([], __read(base_1
  * @example
  * ```ts
  * // @ts-check
- * import { config, configs } from "@mlaursen/eslint-config";
+ * import { config, configs, gitignore } from "@mlaursen/eslint-config";
  *
- * export default config(...configs.typescriptTypeChecking(import.meta.dirname));
+ * export default config(gitignore(import.meta.url), ...configs.typescriptTypeChecking(import.meta.dirname));
  * ```
  */
 var typescriptTypeChecking = function (tsconfigRootDir) { return __spreadArray(__spreadArray(__spreadArray([], __read(exports.typescript), false), __read(typescript_eslint_1.default.configs.strictTypeCheckedOnly), false), [
     {
+        name: "".concat(constants_1.BASE_NAME, "/typescript-type-checking"),
+        files: constants_1.TS_FILES,
+        languageOptions: {
+            parserOptions: {
+                projectService: true,
+                tsconfigRootDir: tsconfigRootDir,
+            },
+        },
         rules: {
             // I do not enable the `noUncheckedIndexedAccess` tsconfig option, so I
             // still need to verify that stuff exists. There are other cases where I
@@ -117,6 +135,7 @@ var typescriptTypeChecking = function (tsconfigRootDir) { return __spreadArray(_
         },
     },
     {
+        name: "".concat(constants_1.BASE_NAME, "/typescript-type-checking/tests"),
         files: constants_1.TEST_FILES,
         rules: {
             // like base typescript, can be less strict in tests
@@ -125,13 +144,5 @@ var typescriptTypeChecking = function (tsconfigRootDir) { return __spreadArray(_
             "@typescript-eslint/restrict-template-expressions": "off",
         },
     },
-    {
-        languageOptions: {
-            parserOptions: {
-                projectService: true,
-                tsconfigRootDir: tsconfigRootDir,
-            },
-        },
-    },
 ], false); };
 exports.typescriptTypeChecking = typescriptTypeChecking;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mlaursen/eslint-config",
-  "version": "5.1.2",
+  "version": "5.1.3",
   "description": "An eslint config used by mlaursen for most projects.",
   "repository": "https://github.com/mlaursen/eslint-config.git",
   "author": "Mikkel Laursen <mlaursen03@gmail.com>",