@mlaursen/eslint-config 12.0.6 → 12.0.8

package/dist/index.d.ts

@@ -1,14 +1,295 @@
-import { base } from "./base.js";
-import { jsxA11y } from "./jsxA11y.js";
-import { react } from "./react.js";
-import { recommended } from "./recommended.js";
-import { recommendedFrontend } from "./recommendedFrontend.js";
-import { scripts } from "./scripts.js";
-import { testingLibraryDom, testingLibraryReact } from "./testing-library.js";
-import { jest, jestDom, testing, vitest } from "./testing.js";
-import { typescript } from "./typescript.js";
-import { unicorn } from "./unicorn.js";
-export * from "./constants.js";
+import { Linter } from 'eslint';
+import reactRefreshPlugin from 'eslint-plugin-react-refresh';
+
+/**
+ * @example
+ * ```js
+ * import { configs } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig(configs.base);
+ * ```
+ */
+declare const base: Linter.Config[];
+
+/**
+ * @example
+ * ```ts
+ * import { configs } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig(configs.jsxA11y);
+ * ```
+ */
+declare const jsxA11y: Linter.Config[];
+
+type ReactRefreshConfig = keyof typeof reactRefreshPlugin.configs;
+interface ReactOptions {
+    /**
+     * Set to one of the `eslint-plugin-react-refresh` config names to enable.
+     *
+     * @example Vite
+     * ```js
+     * configs.react({
+     *   reactRefresh: "vite",
+     * })
+     * ```
+     *
+     * @example Next.js
+     * ```js
+     * configs.react({
+     *   reactRefresh: "next",
+     * })
+     * ```
+     *
+     * @example Recommended
+     * ```js
+     * configs.react({
+     *   reactRefresh: "recommended",
+     * })
+     * ```
+     */
+    reactRefresh?: ReactRefreshConfig;
+    /**
+     * Set to `true` to enable the react compiler eslint rules.
+     *
+     * @defaultValue `false`
+     */
+    reactCompiler?: boolean;
+}
+/**
+ * @example
+ * ```ts
+ * import { configs } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig(configs.react());
+ *
+ * // or with react compiler rules enabled
+ * export default defineConfig(configs.react(true));
+ * ```
+ *
+ * Enables:
+ * - `eslint-plugin-react` with:
+ *   - flat.recommended
+ *   - flat['jsx-runtime']
+ * - `eslint-plugin-react-hooks` with:
+ *   - recommended rules
+ *   - compiler rules (if `true` is provided)
+ */
+declare const react: (options?: ReactOptions) => Linter.Config[];
+
+type TestFramework = "jest" | "vitest";
+interface TestOptions {
+    /**
+     * @defaultValue `"vitest"`
+     */
+    testFramework?: TestFramework;
+}
+/**
+ * @example
+ * ```ts
+ * import { configs } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig(configs.vitest);
+ * ```
+ */
+declare const vitest: Linter.Config[];
+/**
+ * @example
+ * ```ts
+ * import { configs } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig(configs.jest);
+ * ```
+ */
+declare const jest: Linter.Config[];
+/**
+ * @example
+ * ```ts
+ * import { configs } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig([
+ *   ...configs.jest,
+ *   ...configs.jestDom,
+ * ]);
+ * ```
+ */
+declare const jestDom: Linter.Config[];
+/**
+ * @example
+ * ```ts
+ * import { configs } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig(configs.testing({ testFramework: "jest" }));
+ *
+ * // or
+ * export default defineConfig(configs.testing({ testFramework: "vitest" }));
+ * ```
+ */
+declare const testing: (options?: TestOptions) => Linter.Config[];
+
+interface TypescriptOptions {
+    /**
+     * This is required when working in monorepos or when the
+     * {@link strictTypeChecked} rules are enabled.
+     *
+     * @example
+     * ```js
+     * configs.recommended({
+     *   tsconfigRootDir: import.meta.dirname,
+     * })
+     * ```
+     */
+    tsconfigRootDir?: string;
+    /**
+     * The {@link tsconfigRootDir} must be set if this is `true`.
+     *
+     * @example
+     * ```js
+     * configs.recommended({
+     *   tsconfigRootDir: import.meta.dirname,
+     *   strictTypeChecked: process.env.STRICT_TYPING === "true",
+     * })
+     *
+     * @defaultValue `false`
+     */
+    strictTypeChecked?: boolean;
+}
+/**
+ * @example
+ * ```ts
+ * import { configs, gitignore } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig([
+ *   gitignore(import.meta.url),
+ *   ...configs.typescript(),
+ * ]);
+ * ```
+ */
+declare const typescript: (options?: TypescriptOptions) => Linter.Config[];
+
+interface RecommendedOptions extends TypescriptOptions, TestOptions {
+}
+/**
+ * @example
+ * ```ts
+ * import { configs, gitignore } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig([
+ *   gitignore(import.meta.url),
+ *   ...configs.recommended(),
+ * ]);
+ * ```
+ */
+declare const recommended: (options?: RecommendedOptions) => readonly Linter.Config[];
+
+interface RecommendedFrontendOptions extends RecommendedOptions, ReactOptions {
+}
+/**
+ * @example
+ * ```ts
+ * import { configs, gitignore } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig([
+ *   gitignore(import.meta.url),
+ *   ...configs.recommendedFrontend(),
+ * ]);
+ * ```
+ */
+declare const recommendedFrontend: (options?: RecommendedFrontendOptions) => readonly Linter.Config[];
+
+/**
+ * @example
+ * ```ts
+ * import { configs } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig(configs.scripts);
+ * ```
+ */
+declare const scripts: Linter.Config[];
+
+/**
+ * @example
+ * ```ts
+ * import { configs } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig([
+ *   ...configs.react,
+ *   ...configs.jest,
+ *   ...configs.jestDom,
+ *   ...configs.testingLibraryReact
+ * ]);
+ * ```
+ *
+ * NOTE: Only choose this or the {@link testingLibraryDom}. Do not use
+ * both.
+ */
+declare const testingLibraryReact: Linter.Config[];
+/**
+ * @example
+ * ```ts
+ * import { configs, defineConfig } from "@mlaursen/eslint-config";
+ *
+ * export default defineConfig([
+ *   ...configs.jest,
+ *   ...configs.jestDom,
+ *   ...configs.testingLibraryDom
+ * ]);
+ * ```
+ *
+ * NOTE: Only choose this or the {@link testingLibraryReact}. Do not use
+ * both.
+ */
+declare const testingLibraryDom: Linter.Config[];
+
+declare const unicorn: Linter.Config[];
+
+declare const DEV_WARNING_PROD_ERROR: string;
+/**
+ * This is a "temporary" workaround until autofixable rules can be disabled with
+ * a config option because of the "autofix + format(+ save)?" behavior. It
+ * should be something closer to `DEV_WARN_PROD_ERROR_AND_FIX`
+ */
+declare const DEV_OFF_PROD_ERROR: string;
+declare const BASE_NAME = "@mlaursen/eslint-config";
+declare const TS_FILES: string[];
+declare const TEST_FILES: string[];
+declare const JSX_FILES: string[];
+declare const VITE_MAIN_FILES: string[];
+
+/**
+ * @example
+ * ```ts
+ * import { configs, gitignore } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ *
+ * export default defineConfig([gitignore(import.meta.url), ...configs.typescript]);
+ * ```
+ *
+ * @example .gitignore in a different folder
+ * ```ts
+ * import { configs, gitignore } from "@mlaursen/eslint-config";
+ * import { defineConfig } from "eslint/config";
+ * import { join } from "node:path";
+ *
+ * export default defineConfig([
+ *   gitignore(join(import.meta.url, "..", "..")),
+ *   ...configs.typescript,
+ * ]);
+ * ```
+ */
+declare function gitignore(importMetaUrl: string): Linter.Config;
+
 interface EslintConfigs {
     recommended: typeof recommended;
     recommendedFrontend: typeof recommendedFrontend;
@@ -25,5 +306,7 @@ interface EslintConfigs {
     unicorn: typeof unicorn;
     vitest: typeof vitest;
 }
-export declare const configs: Readonly<EslintConfigs>;
-export { gitignore } from "./gitignore.js";
+declare const configs: Readonly<EslintConfigs>;
+
+export { BASE_NAME, DEV_OFF_PROD_ERROR, DEV_WARNING_PROD_ERROR, JSX_FILES, TEST_FILES, TS_FILES, VITE_MAIN_FILES, configs, gitignore };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":["../types/base.d.ts","../types/jsxA11y.d.ts","../types/react.d.ts","../types/testing.d.ts","../types/typescript.d.ts","../types/recommended.d.ts","../types/recommendedFrontend.d.ts","../types/scripts.d.ts","../types/testing-library.d.ts","../types/unicorn.d.ts","../types/constants.d.ts","../types/gitignore.d.ts","../types/index.d.ts"],"mappings":";;;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,IAAI,EAAE,MAAM,CAAC,MAAM;;ACTjC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,OAAO,EAAE,MAAM,CAAC,MAAM;;ACRpC,KAAK,kBAAkB,gBAAgB,kBAAkB,CAAC,OAAO;AACjE,UAAU,YAAY;AACtB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,mBAAmB,kBAAkB;AACrC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,KAAK,aAAa,YAAY,KAAK,MAAM,CAAC,MAAM;;ACvD9D,KAAK,aAAa;AAClB,UAAU,WAAW;AACrB;AACA;AACA;AACA,oBAAoB,aAAa;AACjC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,MAAM,EAAE,MAAM,CAAC,MAAM;AACnC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,IAAI,EAAE,MAAM,CAAC,MAAM;AACjC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,OAAO,EAAE,MAAM,CAAC,MAAM;AACpC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,OAAO,aAAa,WAAW,KAAK,MAAM,CAAC,MAAM;;ACpD/D,UAAU,iBAAiB;AAC3B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,UAAU,aAAa,iBAAiB,KAAK,MAAM,CAAC,MAAM;;ACrCxE,UAAU,kBAAkB,SAAS,iBAAiB,EAAE,WAAW;AACnE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,WAAW,aAAa,kBAAkB,cAAc,MAAM,CAAC,MAAM;;ACdnF,UAAU,0BAA0B,SAAS,kBAAkB,EAAE,YAAY;AAC7E;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,mBAAmB,aAAa,0BAA0B,cAAc,MAAM,CAAC,MAAM;;AChBnG;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,OAAO,EAAE,MAAM,CAAC,MAAM;;ACTpC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,mBAAmB,EAAE,MAAM,CAAC,MAAM;AAChD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,iBAAiB,EAAE,MAAM,CAAC,MAAM;;ACjC9C,cAAc,OAAO,EAAE,MAAM,CAAC,MAAM;;ACDpC,cAAc,sBAAsB;AACpC;AACA;AACA;AACA;AACA;AACA,cAAc,kBAAkB;AAChC,cAAc,SAAS;AACvB,cAAc,QAAQ;AACtB,cAAc,UAAU;AACxB,cAAc,SAAS;AACvB,cAAc,eAAe;;ACV7B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,iBAAiB,SAAS,yBAAyB,MAAM,CAAC,MAAM;;ACXhE,UAAU,aAAa;AACvB,wBAAwB,WAAW;AACnC,gCAAgC,mBAAmB;AACnD,iBAAiB,IAAI;AACrB,iBAAiB,IAAI;AACrB,oBAAoB,OAAO;AAC3B,oBAAoB,OAAO;AAC3B,kBAAkB,KAAK;AACvB,oBAAoB,OAAO;AAC3B,oBAAoB,OAAO;AAC3B,8BAA8B,iBAAiB;AAC/C,gCAAgC,mBAAmB;AACnD,uBAAuB,UAAU;AACjC,oBAAoB,OAAO;AAC3B,mBAAmB,MAAM;AACzB;AACA,cAAc,OAAO,EAAE,QAAQ,CAAC,aAAa;;;;","names":[]}