@vp-tw/eslint-config 0.0.9 → 0.0.11

package/README.md

@@ -36,7 +36,7 @@ const prettierignorePath = path.resolve(__dirname, ".prettierignore");
 
 export default vdustr(
   {
-    // `stylistic` has been removed in favor of `prettier`.
+    // By default, we disable `stylistic` and use `prettier` instead.
     // stylistic: true,
     storybook: true,
     mdx: true,
@@ -45,6 +45,37 @@ export default vdustr(
 );
 ```
 
+## Known Issues
+
+## `RulesRecord` Type Definition Not Applied
+
+If the rule record type definitions are not applied correctly, the plugin rules
+supported by this ESLint config may not appear in properties that rely on these
+types, such as `overrides`.
+
+For example, you might not see the rule key `react-compiler/react-compiler` as
+expected.
+
+To fix this, you may need to prevent the outdated package `@types/eslint` from
+being installed. This can be done by creating a `.pnpmfile.cjs` file:
+
+```js
+// .pnpmfile.cjs
+module.exports = {
+  hooks: {
+    readPackage(pkg) {
+      if (pkg.dependencies) {
+        delete pkg.dependencies["@types/eslint"];
+      }
+      return pkg;
+    },
+  },
+};
+```
+
+- [ESLint v9.10.0 released - Types now included](https://eslint.org/blog/2024/09/eslint-v9.10.0-released/#types-now-included)
+- [feat: Add types #18854](https://github.com/eslint/eslint/pull/18854)
+
 ## License
 
 MIT © ViPro <vdustr@gmail.com> (<http://vdustr.dev>)

package/dist/configs/mdx.d.ts

@@ -1,10 +1,28 @@
 import type { TypedFlatConfigItem } from "@antfu/eslint-config";
-import type { DistributiveOmit } from "@mui/types";
+import type { ConfigOverrides, ResolveConfigNamesMap } from "../types";
+declare const configNamesMapSource: {
+    readonly setup: "vdustr/mdx/setup";
+    readonly processor: "vdustr/mdx/processor";
+    readonly rules: "vdustr/mdx/rules";
+    readonly codeBlocks: "vdustr/mdx/code-blocks";
+};
+declare module "../types" {
+    interface ConfigNamesMap extends ResolveConfigNamesMap<mdx.ConfigNamesMapSource> {
+    }
+}
 declare namespace mdx {
-    interface Options extends DistributiveOmit<TypedFlatConfigItem, "processor"> {
+    type ConfigNamesMapSource = typeof configNamesMapSource;
+    interface Options extends ConfigOverrides {
         processorOptions?: import("eslint-plugin-mdx").ProcessorOptions;
-        flatCodeBlocks?: boolean | TypedFlatConfigItem;
+        codeBlocks?: boolean | ConfigOverrides;
     }
 }
-declare const mdx: ({ flatCodeBlocks, processorOptions, ...options }?: mdx.Options) => Promise<Array<TypedFlatConfigItem>>;
+declare const mdx: (({ codeBlocks, processorOptions, ...options }?: mdx.Options) => Promise<Array<TypedFlatConfigItem>>) & {
+    configNamesMapSource: {
+        readonly setup: "vdustr/mdx/setup";
+        readonly processor: "vdustr/mdx/processor";
+        readonly rules: "vdustr/mdx/rules";
+        readonly codeBlocks: "vdustr/mdx/code-blocks";
+    };
+};
 export { mdx };

package/dist/configs/mdx.js

@@ -5,43 +5,97 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.mdx = void 0;
 var _eslintConfig = require("@antfu/eslint-config");
+var _esToolkit = require("es-toolkit");
 var _renameRules = require("../utils/renameRules");
-const mdx = async ({
-  flatCodeBlocks = true,
+const configNamesMapSource = {
+  setup: "vdustr/mdx/setup",
+  processor: "vdustr/mdx/processor",
+  rules: "vdustr/mdx/rules",
+  codeBlocks: "vdustr/mdx/code-blocks"
+};
+const mdxInternal = async ({
+  codeBlocks = true,
   processorOptions,
   ...options
 } = {}) => {
   await (0, _eslintConfig.ensurePackages)(["eslint-plugin-mdx"]);
   const mdxPlugin = await (0, _eslintConfig.interopDefault)(await Promise.resolve().then(() => require("eslint-plugin-mdx")));
-  const flatCodeBlocksOptions = typeof flatCodeBlocks !== "object" ? {} : flatCodeBlocks;
+  const codeBlocksOptions = typeof codeBlocks !== "object" ? {} : codeBlocks;
   const configs = [{
-    name: "vdustr/mdx",
-    ...mdxPlugin.flat,
+    ...(0, _esToolkit.pick)(mdxPlugin.flat, ["plugins"]),
+    name: configNamesMapSource.setup
+  }, {
+    processor: mdxPlugin.createRemarkProcessor({
+      lintCodeBlocks: Boolean(codeBlocks),
+      ...processorOptions,
+      languageMapper: {
+        ...processorOptions?.languageMapper
+      }
+    }),
+    name: configNamesMapSource.processor
+  }, {
+    /**
+     * Inherited.
+     */
+    ...(0, _esToolkit.omit)(mdxPlugin.flat, ["plugins", "processor"]),
+    /**
+     * Default.
+     */
+    name: configNamesMapSource.rules,
+    ignores: [
+    /**
+     * Handled by `@eslint/markdown`.
+     */
+    _eslintConfig.GLOB_MARKDOWN],
+    /**
+     * Overridable.
+     */
     ...options,
     rules: {
+      /**
+       * Inherited.
+       */
       ...(0, _renameRules.renameRules)({
         ...mdxPlugin.flat.rules
       }),
+      /**
+       * Overridable.
+       */
       ...options.rules
-    },
-    processor: mdxPlugin.createRemarkProcessor({
-      lintCodeBlocks: Boolean(flatCodeBlocks),
-      ...processorOptions,
-      languageMapper: {
-        ...processorOptions?.languageMapper
-      }
-    })
-  }, ...(!flatCodeBlocks ? [] : [{
-    name: "vdustr/mdx/flat-code-blocks",
+    }
+  }, ...(!codeBlocks ? [] : [{
+    /**
+     * Inherited.
+     */
     ...mdxPlugin.flatCodeBlocks,
-    ...flatCodeBlocksOptions,
+    /**
+     * Default.
+     */
+    name: configNamesMapSource.codeBlocks,
+    ignores: [
+    /**
+     * Handled by `@eslint/markdown`.
+     */
+    _eslintConfig.GLOB_MARKDOWN_CODE],
+    /**
+     * Overridable.
+     */
+    ...codeBlocksOptions,
     rules: {
+      /**
+       * Inherited.
+       */
       ...(0, _renameRules.renameRules)({
         ...mdxPlugin.flatCodeBlocks.rules
       }),
-      ...flatCodeBlocksOptions.rules
+      /**
+       * Overridable.
+       */
+      ...codeBlocksOptions.rules
     }
   }])];
   return configs;
 };
-exports.mdx = mdx;
+const mdx = exports.mdx = Object.assign(mdxInternal, {
+  configNamesMapSource
+});

package/dist/configs/prettier.d.ts

@@ -1,3 +1,20 @@
 import type { TypedFlatConfigItem } from "@antfu/eslint-config";
-declare const prettier: () => Promise<TypedFlatConfigItem>;
+import type { ConfigOverrides, ResolveConfigNamesMap } from "../types";
+declare const configNamesMapSource: {
+    readonly rules: "vdustr/prettier/rules";
+};
+declare module "../types" {
+    interface ConfigNamesMap extends ResolveConfigNamesMap<prettier.ConfigNamesMapSource> {
+    }
+}
+declare namespace prettier {
+    type ConfigNamesMapSource = typeof configNamesMapSource;
+    interface Options extends ConfigOverrides {
+    }
+}
+declare const prettier: ((options?: prettier.Options) => Promise<TypedFlatConfigItem>) & {
+    configNamesMapSource: {
+        readonly rules: "vdustr/prettier/rules";
+    };
+};
 export { prettier };

package/dist/configs/prettier.js

@@ -8,12 +8,35 @@ var _eslintConfig = require("@antfu/eslint-config");
 var _eslintConfigPrettier = _interopRequireDefault(require("eslint-config-prettier"));
 var _renameRules = require("../utils/renameRules");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const prettier = async () => {
+const configNamesMapSource = {
+  rules: "vdustr/prettier/rules"
+};
+const prettierInternal = async options => {
   await (0, _eslintConfig.ensurePackages)(["eslint-config-prettier"]);
   return {
-    name: "vdustr/prettier",
+    /**
+     * Inherited.
+     */
     ..._eslintConfigPrettier.default,
-    rules: (0, _renameRules.renameRules)(_eslintConfigPrettier.default.rules)
+    /**
+     * Default.
+     */
+    name: configNamesMapSource.rules,
+    /**
+     * Overridable.
+     */
+    rules: {
+      /**
+       * Inherited.
+       */
+      ...(0, _renameRules.renameRules)(_eslintConfigPrettier.default.rules),
+      /**
+       * Overridable.
+       */
+      ...options?.rules
+    }
   };
 };
-exports.prettier = prettier;
+const prettier = exports.prettier = Object.assign(prettierInternal, {
+  configNamesMapSource
+});

package/dist/configs/storybook.d.ts

@@ -1,3 +1,26 @@
 import type { TypedFlatConfigItem } from "@antfu/eslint-config";
-declare const storybook: () => Promise<Array<TypedFlatConfigItem>>;
+import type { ConfigOverrides, ResolveConfigNamesMap } from "../types";
+declare const configNamesMapSource: {
+    readonly setup: "vdustr/stroybook/setup";
+    readonly storiesRules: "vdustr/storybook/stories-rules";
+    readonly mainRules: "vdustr/storybook/main-rules";
+};
+declare module "../types" {
+    interface ConfigNamesMap extends ResolveConfigNamesMap<storybook.ConfigNamesMapSource> {
+    }
+}
+declare namespace storybook {
+    type ConfigNamesMapSource = typeof configNamesMapSource;
+    interface Options {
+        storiesConfig?: ConfigOverrides;
+        mainConfig?: ConfigOverrides;
+    }
+}
+declare const storybook: ((options?: storybook.Options) => Promise<Array<TypedFlatConfigItem>>) & {
+    configNamesMapSource: {
+        readonly setup: "vdustr/stroybook/setup";
+        readonly storiesRules: "vdustr/storybook/stories-rules";
+        readonly mainRules: "vdustr/storybook/main-rules";
+    };
+};
 export { storybook };

package/dist/configs/storybook.js

@@ -5,30 +5,74 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.storybook = void 0;
 var _eslintConfig = require("@antfu/eslint-config");
-var _renameRules = require("../utils/renameRules");
-const storybook = async () => {
+var _esToolkit = require("es-toolkit");
+const configNamesMapSource = {
+  setup: "vdustr/stroybook/setup",
+  storiesRules: "vdustr/storybook/stories-rules",
+  mainRules: "vdustr/storybook/main-rules"
+};
+const storybookInternal = async options => {
   await (0, _eslintConfig.ensurePackages)(["eslint-plugin-storybook"]);
   const storybookPlugin = await (0, _eslintConfig.interopDefault)(Promise.resolve().then(() => require("eslint-plugin-storybook")));
-  return storybookPlugin.configs["flat/csf-strict"].map(config => {
-    const allConfig = config;
-    const {
-      rules,
-      files,
-      plugins,
-      ...rest
-    } = allConfig;
-    return {
-      ...rest,
-      ...(!rules ? null : {
-        rules: (0, _renameRules.renameRules)(rules)
-      }),
-      ...(!files ? null : {
-        files
-      }),
-      ...(!plugins ? null : {
-        plugins
-      })
-    };
-  });
+  const inheritingConfigs = storybookPlugin.configs["flat/csf-strict"];
+  const originalSetupConfig = inheritingConfigs[0];
+  const originalStoryRulesConfig = inheritingConfigs[1];
+  const originalMainRulesConfig = inheritingConfigs[2];
+  const originalCsfStrictConfig = inheritingConfigs[3];
+  if (!originalSetupConfig) throw new Error("Missing setup config");
+  if (!originalStoryRulesConfig) throw new Error("Missing story rules config");
+  if (!originalMainRulesConfig) throw new Error("Missing main rules config");
+  if (!originalCsfStrictConfig) throw new Error("Missing csf strict config");
+  const setupConfig = {
+    ...(0, _esToolkit.pick)(originalSetupConfig, ["plugins"]),
+    name: configNamesMapSource.setup
+  };
+  const storyRulesConfig = {
+    /**
+     * Inherited.
+     */
+    ...originalStoryRulesConfig,
+    ...originalCsfStrictConfig,
+    /**
+     * Default.
+     */
+    name: configNamesMapSource.storiesRules,
+    /**
+     * Overridable.
+     */
+    ...options?.storiesConfig,
+    rules: {
+      /**
+       * Inherited.
+       */
+      ...originalStoryRulesConfig.rules,
+      ...originalCsfStrictConfig.rules,
+      /**
+       * Default.
+       */
+      "import/no-default-export": "off",
+      /**
+       * Overridable.
+       */
+      ...options?.storiesConfig?.rules
+    }
+  };
+  const mainRulesConfig = {
+    /**
+     * Inherited.
+     */
+    ...originalMainRulesConfig,
+    /**
+     * Default.
+     */
+    name: configNamesMapSource.mainRules,
+    /**
+     * Overridable.
+     */
+    ...options?.mainConfig
+  };
+  return [setupConfig, storyRulesConfig, mainRulesConfig];
 };
-exports.storybook = storybook;
+const storybook = exports.storybook = Object.assign(storybookInternal, {
+  configNamesMapSource
+});

package/dist/eslint-typegen.js

@@ -1,2 +1,2 @@
-// This is a placeholder for `eslint-typegen.d.ts`.
+// Placeholder for `eslint-typegen.d.ts`.
 "use strict";

package/dist/esm/configs/mdx.d.ts

@@ -1,10 +1,28 @@
 import type { TypedFlatConfigItem } from "@antfu/eslint-config";
-import type { DistributiveOmit } from "@mui/types";
+import type { ConfigOverrides, ResolveConfigNamesMap } from "../types";
+declare const configNamesMapSource: {
+    readonly setup: "vdustr/mdx/setup";
+    readonly processor: "vdustr/mdx/processor";
+    readonly rules: "vdustr/mdx/rules";
+    readonly codeBlocks: "vdustr/mdx/code-blocks";
+};
+declare module "../types" {
+    interface ConfigNamesMap extends ResolveConfigNamesMap<mdx.ConfigNamesMapSource> {
+    }
+}
 declare namespace mdx {
-    interface Options extends DistributiveOmit<TypedFlatConfigItem, "processor"> {
+    type ConfigNamesMapSource = typeof configNamesMapSource;
+    interface Options extends ConfigOverrides {
         processorOptions?: import("eslint-plugin-mdx").ProcessorOptions;
-        flatCodeBlocks?: boolean | TypedFlatConfigItem;
+        codeBlocks?: boolean | ConfigOverrides;
     }
 }
-declare const mdx: ({ flatCodeBlocks, processorOptions, ...options }?: mdx.Options) => Promise<Array<TypedFlatConfigItem>>;
+declare const mdx: (({ codeBlocks, processorOptions, ...options }?: mdx.Options) => Promise<Array<TypedFlatConfigItem>>) & {
+    configNamesMapSource: {
+        readonly setup: "vdustr/mdx/setup";
+        readonly processor: "vdustr/mdx/processor";
+        readonly rules: "vdustr/mdx/rules";
+        readonly codeBlocks: "vdustr/mdx/code-blocks";
+    };
+};
 export { mdx };

package/dist/esm/configs/mdx.mjs

@@ -1,46 +1,110 @@
-import { ensurePackages, interopDefault } from "@antfu/eslint-config";
+import {
+  ensurePackages,
+  GLOB_MARKDOWN,
+  GLOB_MARKDOWN_CODE,
+  interopDefault
+} from "@antfu/eslint-config";
+import { omit, pick } from "es-toolkit";
 import { renameRules } from "../utils/renameRules.mjs";
-const mdx = async ({
-  flatCodeBlocks = true,
+const configNamesMapSource = {
+  setup: "vdustr/mdx/setup",
+  processor: "vdustr/mdx/processor",
+  rules: "vdustr/mdx/rules",
+  codeBlocks: "vdustr/mdx/code-blocks"
+};
+const mdxInternal = async ({
+  codeBlocks = true,
   processorOptions,
   ...options
 } = {}) => {
   await ensurePackages(["eslint-plugin-mdx"]);
   const mdxPlugin = await interopDefault(await import("eslint-plugin-mdx"));
-  const flatCodeBlocksOptions = typeof flatCodeBlocks !== "object" ? {} : flatCodeBlocks;
+  const codeBlocksOptions = typeof codeBlocks !== "object" ? {} : codeBlocks;
   const configs = [
     {
-      name: "vdustr/mdx",
-      ...mdxPlugin.flat,
+      ...pick(mdxPlugin.flat, ["plugins"]),
+      name: configNamesMapSource.setup
+    },
+    {
+      processor: mdxPlugin.createRemarkProcessor({
+        lintCodeBlocks: Boolean(codeBlocks),
+        ...processorOptions,
+        languageMapper: {
+          ...processorOptions?.languageMapper
+        }
+      }),
+      name: configNamesMapSource.processor
+    },
+    {
+      /**
+       * Inherited.
+       */
+      ...omit(mdxPlugin.flat, ["plugins", "processor"]),
+      /**
+       * Default.
+       */
+      name: configNamesMapSource.rules,
+      ignores: [
+        /**
+         * Handled by `@eslint/markdown`.
+         */
+        GLOB_MARKDOWN
+      ],
+      /**
+       * Overridable.
+       */
       ...options,
       rules: {
+        /**
+         * Inherited.
+         */
         ...renameRules({
           ...mdxPlugin.flat.rules
         }),
+        /**
+         * Overridable.
+         */
         ...options.rules
-      },
-      processor: mdxPlugin.createRemarkProcessor({
-        lintCodeBlocks: Boolean(flatCodeBlocks),
-        ...processorOptions,
-        languageMapper: {
-          ...processorOptions?.languageMapper
-        }
-      })
+      }
     },
-    ...!flatCodeBlocks ? [] : [
+    ...!codeBlocks ? [] : [
       {
-        name: "vdustr/mdx/flat-code-blocks",
+        /**
+         * Inherited.
+         */
         ...mdxPlugin.flatCodeBlocks,
-        ...flatCodeBlocksOptions,
+        /**
+         * Default.
+         */
+        name: configNamesMapSource.codeBlocks,
+        ignores: [
+          /**
+           * Handled by `@eslint/markdown`.
+           */
+          GLOB_MARKDOWN_CODE
+        ],
+        /**
+         * Overridable.
+         */
+        ...codeBlocksOptions,
         rules: {
+          /**
+           * Inherited.
+           */
           ...renameRules({
             ...mdxPlugin.flatCodeBlocks.rules
           }),
-          ...flatCodeBlocksOptions.rules
+          /**
+           * Overridable.
+           */
+          ...codeBlocksOptions.rules
         }
       }
     ]
   ];
   return configs;
 };
+const mdx = Object.assign(mdxInternal, {
+  configNamesMapSource
+});
 export { mdx };

package/dist/esm/configs/prettier.d.ts

@@ -1,3 +1,20 @@
 import type { TypedFlatConfigItem } from "@antfu/eslint-config";
-declare const prettier: () => Promise<TypedFlatConfigItem>;
+import type { ConfigOverrides, ResolveConfigNamesMap } from "../types";
+declare const configNamesMapSource: {
+    readonly rules: "vdustr/prettier/rules";
+};
+declare module "../types" {
+    interface ConfigNamesMap extends ResolveConfigNamesMap<prettier.ConfigNamesMapSource> {
+    }
+}
+declare namespace prettier {
+    type ConfigNamesMapSource = typeof configNamesMapSource;
+    interface Options extends ConfigOverrides {
+    }
+}
+declare const prettier: ((options?: prettier.Options) => Promise<TypedFlatConfigItem>) & {
+    configNamesMapSource: {
+        readonly rules: "vdustr/prettier/rules";
+    };
+};
 export { prettier };

package/dist/esm/configs/prettier.mjs

@@ -1,12 +1,36 @@
 import { ensurePackages } from "@antfu/eslint-config";
 import eslintConfigPrettier from "eslint-config-prettier";
 import { renameRules } from "../utils/renameRules.mjs";
-const prettier = async () => {
+const configNamesMapSource = {
+  rules: "vdustr/prettier/rules"
+};
+const prettierInternal = async (options) => {
   await ensurePackages(["eslint-config-prettier"]);
   return {
-    name: "vdustr/prettier",
+    /**
+     * Inherited.
+     */
     ...eslintConfigPrettier,
-    rules: renameRules(eslintConfigPrettier.rules)
+    /**
+     * Default.
+     */
+    name: configNamesMapSource.rules,
+    /**
+     * Overridable.
+     */
+    rules: {
+      /**
+       * Inherited.
+       */
+      ...renameRules(eslintConfigPrettier.rules),
+      /**
+       * Overridable.
+       */
+      ...options?.rules
+    }
   };
 };
+const prettier = Object.assign(prettierInternal, {
+  configNamesMapSource
+});
 export { prettier };

package/dist/esm/configs/storybook.d.ts

@@ -1,3 +1,26 @@
 import type { TypedFlatConfigItem } from "@antfu/eslint-config";
-declare const storybook: () => Promise<Array<TypedFlatConfigItem>>;
+import type { ConfigOverrides, ResolveConfigNamesMap } from "../types";
+declare const configNamesMapSource: {
+    readonly setup: "vdustr/stroybook/setup";
+    readonly storiesRules: "vdustr/storybook/stories-rules";
+    readonly mainRules: "vdustr/storybook/main-rules";
+};
+declare module "../types" {
+    interface ConfigNamesMap extends ResolveConfigNamesMap<storybook.ConfigNamesMapSource> {
+    }
+}
+declare namespace storybook {
+    type ConfigNamesMapSource = typeof configNamesMapSource;
+    interface Options {
+        storiesConfig?: ConfigOverrides;
+        mainConfig?: ConfigOverrides;
+    }
+}
+declare const storybook: ((options?: storybook.Options) => Promise<Array<TypedFlatConfigItem>>) & {
+    configNamesMapSource: {
+        readonly setup: "vdustr/stroybook/setup";
+        readonly storiesRules: "vdustr/storybook/stories-rules";
+        readonly mainRules: "vdustr/storybook/main-rules";
+    };
+};
 export { storybook };