@mlaursen/eslint-config 5.1.2 → 5.1.3

package/dist/base.d.ts

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

package/dist/base.js

@@ -1,4 +1,15 @@
 "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 };
 };
@@ -6,23 +17,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.base = void 0;
 var js_1 = __importDefault(require("@eslint/js"));
 var constants_1 = require("./constants");
+/**
+ * @example
+ * ```js
+ * import { config, configs } from "@mlaursen/eslint-config";
+ *
+ * export default configs.base;
+ * ```
+ */
 exports.base = [
-    js_1.default.configs.recommended,
-    {
-        rules: {
+    __assign(__assign({}, js_1.default.configs.recommended), { name: "".concat(constants_1.BASE_NAME, "/base"), rules: __assign(__assign({}, js_1.default.configs.recommended.rules), { 
             // You normally do not want `console.{whatever}` in prod but is fine for
             // development in debugging
-            "no-console": constants_1.DEV_WARNING_PROD_ERROR,
-            "no-use-before-define": "warn",
+            "no-console": constants_1.DEV_WARNING_PROD_ERROR, "no-use-before-define": "warn", 
             // I want to enforce all statements to require curly braces even if it
             // could be omitted for consistency
-            curly: "error",
+            curly: "error", 
             // Since this is auto-fixable, I like `{ someproperty }` instead of
             // `{ someproperty: someproperty }`
-            "object-shorthand": ["error", "always"],
+            "object-shorthand": ["error", "always"], 
             // This is about the same as `object-shorthand`. Only rename if it has to
             // be renamed
-            "no-useless-rename": ["error"],
-        },
-    },
+            "no-useless-rename": ["error"] }) }),
 ];

package/dist/constants.d.ts

@@ -1,3 +1,5 @@
 export declare const DEV_WARNING_PROD_ERROR: string;
+export declare const BASE_NAME = "@mlaursen/eslint-config";
+export declare const TS_FILES: string[];
 export declare const TEST_FILES: string[];
 export declare const JSX_FILES: string[];

package/dist/constants.js

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

package/dist/frontend.d.ts

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

package/dist/frontend.js

@@ -31,6 +31,28 @@ var jsxA11y_1 = require("./jsxA11y");
 var react_1 = require("./react");
 var testing_library_1 = require("./testing-library");
 var typescript_1 = require("./typescript");
+/**
+ * @example
+ * ```ts
+ * import { config, configs, gitignore } from "@mlaursen/eslint-config";
+ *
+ * export default config(
+ *   gitignore(import.meta.url),
+ *   ...configs.typescript
+ * );
+ * ```
+ */
 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);
+/**
+ * @example
+ * ```ts
+ * import { config, configs, gitignore } from "@mlaursen/eslint-config";
+ *
+ * export default config(
+ *   gitignore(import.meta.url),
+ *   ...configs.typescriptTypeChecking(import.meta.dirname)
+ * );
+ * ```
+ */
 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

@@ -1,2 +1,18 @@
 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);
+ * ```
+ *
+ * @example .gitignore in a different folder
+ * ```ts
+ * import { config, configs, gitignore } from "@mlaursen/eslint-config";
+ * import { join } from "node:path";
+ *
+ * export default config(gitignore(join(import.meta.url, "..", "..")), ...configs.typescript);
+ * ```
+ */
 export declare function gitignore(importMetaUrl: string): TSESLint.FlatConfig.Config;

package/dist/gitignore.js

@@ -7,6 +7,22 @@ exports.gitignore = gitignore;
 var compat_1 = require("@eslint/compat");
 var node_path_1 = __importDefault(require("node:path"));
 var node_url_1 = require("node:url");
+/**
+ * @example
+ * ```ts
+ * import { config, configs, gitignore } from "@mlaursen/eslint-config";
+ *
+ * export default config(gitignore(import.meta.url), ...configs.typescript);
+ * ```
+ *
+ * @example .gitignore in a different folder
+ * ```ts
+ * import { config, configs, gitignore } from "@mlaursen/eslint-config";
+ * import { join } from "node:path";
+ *
+ * export default config(gitignore(join(import.meta.url, "..", "..")), ...configs.typescript);
+ * ```
+ */
 function gitignore(importMetaUrl) {
     var __filename = (0, node_url_1.fileURLToPath)(importMetaUrl);
     var __dirname = node_path_1.default.dirname(__filename);