@vp-tw/eslint-config 0.0.1 → 0.0.3

package/dist/esm/vdustr.mjs

@@ -1,20 +1,25 @@
 import antfu from "@antfu/eslint-config";
 import packageJson from "eslint-plugin-package-json/configs/recommended";
 import * as reactCompilerPlugin from "eslint-plugin-react-compiler";
+import { isPackageExists } from "local-pkg";
 import { mdx } from "./configs/mdx.mjs";
 import { prettier } from "./configs/prettier.mjs";
-import "./eslint-typegen.d";
+import { storybook } from "./configs/storybook.mjs";
 const vdustr = (options, ...userConfigs) => {
-  const mdxOptions = options?.mdx ?? true;
+  const typescriptEnabled = isPackageExists("typescript");
   const jsoncEnabled = Boolean(options?.jsonc ?? true);
+  const reactEnabled = Boolean(options?.react ?? false);
+  const storybookEnabled = Boolean(options?.storybook ?? false);
+  const mdxOptions = options?.mdx ?? true;
   const defaultConfigs = [
     ...!jsoncEnabled ? [] : [packageJson],
     ...!mdxOptions ? [] : mdx({
       ...typeof mdxOptions !== "object" ? null : mdxOptions
     }),
+    ...!storybookEnabled ? [] : storybook,
     prettier
   ];
-  return antfu(
+  let config = antfu(
     {
       // We use `prettier`.
       stylistic: false,
@@ -22,10 +27,11 @@ const vdustr = (options, ...userConfigs) => {
     },
     ...defaultConfigs,
     ...userConfigs
-  ).override("antfu/javascript/rules", (config) => ({
-    ...config,
+  );
+  config = config.override("antfu/javascript/rules", (config2) => ({
+    ...config2,
     rules: {
-      ...config.rules,
+      ...config2.rules,
       /**
        * Some callbacks are purposefully named to make the code self-documenting.
        */
@@ -40,62 +46,103 @@ const vdustr = (options, ...userConfigs) => {
       "unused-imports/no-unused-vars-ts": "off",
       "unused-imports/no-unused-imports": "off"
     }
-  })).override("antfu/imports/rules", (config) => ({
-    ...config,
+  })).override("antfu/imports/rules", (config2) => ({
+    ...config2,
     rules: {
-      ...config.rules,
+      ...config2.rules,
       /**
        * Forbid `import {} from "module"`.
        */
-      "import/no-empty-named-blocks": "error"
-    }
-  })).override("antfu/typescript/rules", (config) => ({
-    ...config,
-    rules: {
-      ...config.rules,
-      "ts/array-type": ["error", { default: "generic" }],
+      "import/no-empty-named-blocks": "error",
       /**
-       * Namespaces are useful for centralizing the management of types. Just avoid
-       * overusing them with runtime code.
-       *
-       * - References:
-       *   - <https://x.com/mattpocockuk/status/1805606072167940167>
+       * Wildcard imports can prevent tree shaking and cause name conflicts.
+       * Consider using named imports instead.
        */
-      "ts/no-namespace": "off",
-      "ts/no-redeclare": "off",
+      "import/no-namespace": "error",
       /**
-       * Check for unused variables in TypeScript.
+       * Enforcing named exports improves consistency, enhances auto-completion and refactoring, and avoids issues
+       * with default export renaming. Additionally, default exports might lead to different behavior when transformed
+       * to CJS.
        */
-      "ts/no-unused-vars": "off"
+      "import/no-default-export": "error"
     }
-  })).override("antfu/jsonc/rules", (config) => ({
-    ...config,
+  })).insertAfter("antfu/imports/rules", {
+    name: "vdustr/allow-default-export",
     rules: {
-      ...config.rules,
-      "jsonc/sort-keys": "error"
+      "import/no-default-export": "off"
     },
-    files: [...config.files ?? [], "**/*.code-workspace"],
-    ignores: [
-      ...config.ignores ?? [],
-      /**
-       * Lint `package.json` files with `eslint-plugin-package-json` instead.
-       */
-      "**/package.json"
+    files: [
+      "**/*.config.*",
+      // Single file components
+      "**/*.vue",
+      "**/*.svelte"
     ]
-  })).remove("antfu/sort/package-json").remove("antfu/sort/tsconfig-json").override("antfu/react/rules", (config) => ({
-    ...config,
-    plugins: {
-      ...config.plugins,
-      "react-compiler": reactCompilerPlugin
-    },
-    rules: {
-      ...config.rules,
-      "react-compiler/react-compiler": "error",
-      /**
-       * Not all destructuring assignments are more readable than their alternatives.
-       */
-      "react/prefer-destructuring-assignment": "off"
-    }
-  }));
+  });
+  if (typescriptEnabled) {
+    config = config.override("antfu/typescript/rules", (config2) => ({
+      ...config2,
+      rules: {
+        ...config2.rules,
+        "ts/array-type": ["error", { default: "generic" }],
+        /**
+         * Namespaces are useful for centralizing the management of types. Just avoid
+         * overusing them with runtime code.
+         *
+         * - References:
+         *   - <https://x.com/mattpocockuk/status/1805606072167940167>
+         */
+        "ts/no-namespace": "off",
+        "ts/no-redeclare": "off",
+        /**
+         * Check for unused variables in TypeScript.
+         */
+        "ts/no-unused-vars": "off"
+      }
+    }));
+  }
+  if (jsoncEnabled) {
+    config = config.override("antfu/jsonc/rules", (config2) => ({
+      ...config2,
+      rules: {
+        ...config2.rules,
+        "jsonc/sort-keys": "error"
+      },
+      files: [...config2.files ?? [], "**/*.code-workspace"],
+      ignores: [
+        ...config2.ignores ?? [],
+        /**
+         * Lint `package.json` files with `eslint-plugin-package-json` instead.
+         */
+        "**/package.json"
+      ]
+    })).remove("antfu/sort/package-json").remove("antfu/sort/tsconfig-json");
+  }
+  if (reactEnabled) {
+    config = config.override("antfu/react/rules", (config2) => ({
+      ...config2,
+      plugins: {
+        ...config2.plugins,
+        "react-compiler": reactCompilerPlugin
+      },
+      rules: {
+        ...config2.rules,
+        "react-compiler/react-compiler": "error",
+        /**
+         * Not all destructuring assignments are more readable than their alternatives.
+         */
+        "react/prefer-destructuring-assignment": "off"
+      }
+    }));
+  }
+  if (storybookEnabled) {
+    config = config.override("storybook:csf:stories-rules", (config2) => ({
+      ...config2,
+      rules: {
+        ...config2.rules,
+        "import/no-default-export": "off"
+      }
+    }));
+  }
+  return config;
 };
 export { vdustr };

package/dist/utils/renameRules.d.ts

@@ -0,0 +1,3 @@
+import { renameRules } from "@antfu/eslint-config";
+declare function renameRulesInternal(rules: Parameters<typeof renameRules>[0]): Record<string, any>;
+export { renameRulesInternal as renameRules };

package/dist/utils/renameRules.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.renameRules = renameRulesInternal;
+var _eslintConfig = require("@antfu/eslint-config");
+function renameRulesInternal(rules) {
+  return (0, _eslintConfig.renameRules)(rules, _eslintConfig.defaultPluginRenaming);
+}

package/dist/vdustr.d.ts

@@ -1,9 +1,9 @@
 import type { Config } from "./types";
 import antfu from "@antfu/eslint-config";
 import { mdx } from "./configs/mdx";
-import "./eslint-typegen.d";
 type Options = NonNullable<Parameters<typeof antfu>[0]> & {
     mdx?: boolean | mdx.Options;
+    storybook?: boolean;
 };
 declare const vdustr: (options?: Options, ...userConfigs: Array<Config>) => import("eslint-flat-config-utils/index").FlatConfigComposer<import("@antfu/eslint-config").TypedFlatConfigItem, import("@antfu/eslint-config").ConfigNames>;
 export { vdustr };

package/dist/vdustr.js

@@ -7,26 +7,31 @@ exports.vdustr = void 0;
 var _eslintConfig = _interopRequireDefault(require("@antfu/eslint-config"));
 var _recommended = _interopRequireDefault(require("eslint-plugin-package-json/configs/recommended"));
 var reactCompilerPlugin = _interopRequireWildcard(require("eslint-plugin-react-compiler"));
+var _localPkg = require("local-pkg");
 var _mdx = require("./configs/mdx");
 var _prettier = require("./configs/prettier");
-require("./eslint-typegen.d");
+var _storybook = require("./configs/storybook");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const vdustr = (options, ...userConfigs) => {
-  const mdxOptions = options?.mdx ?? true;
+  const typescriptEnabled = (0, _localPkg.isPackageExists)("typescript");
   const jsoncEnabled = Boolean(options?.jsonc ?? true);
+  const reactEnabled = Boolean(options?.react ?? false);
+  const storybookEnabled = Boolean(options?.storybook ?? false);
+  const mdxOptions = options?.mdx ?? true;
   const defaultConfigs = [...(!jsoncEnabled ? [] : [_recommended.default]), ...(!mdxOptions ? [] : (0, _mdx.mdx)({
     ...(typeof mdxOptions !== "object" ? null : mdxOptions)
-  })), _prettier.prettier];
-  return (0, _eslintConfig.default)({
+  })), ...(!storybookEnabled ? [] : _storybook.storybook), _prettier.prettier];
+  let config = (0, _eslintConfig.default)({
     // We use `prettier`.
     stylistic: false,
     ...options
-  }, ...defaultConfigs, ...userConfigs).override("antfu/javascript/rules", config => ({
-    ...config,
+  }, ...defaultConfigs, ...userConfigs);
+  config = config.override("antfu/javascript/rules", config2 => ({
+    ...config2,
     rules: {
-      ...config.rules,
+      ...config2.rules,
       /**
        * Some callbacks are purposefully named to make the code self-documenting.
        */
@@ -41,62 +46,100 @@ const vdustr = (options, ...userConfigs) => {
       "unused-imports/no-unused-vars-ts": "off",
       "unused-imports/no-unused-imports": "off"
     }
-  })).override("antfu/imports/rules", config => ({
-    ...config,
+  })).override("antfu/imports/rules", config2 => ({
+    ...config2,
     rules: {
-      ...config.rules,
+      ...config2.rules,
       /**
        * Forbid `import {} from "module"`.
        */
-      "import/no-empty-named-blocks": "error"
-    }
-  })).override("antfu/typescript/rules", config => ({
-    ...config,
-    rules: {
-      ...config.rules,
-      "ts/array-type": ["error", {
-        default: "generic"
-      }],
+      "import/no-empty-named-blocks": "error",
       /**
-       * Namespaces are useful for centralizing the management of types. Just avoid
-       * overusing them with runtime code.
-       *
-       * - References:
-       *   - <https://x.com/mattpocockuk/status/1805606072167940167>
+       * Wildcard imports can prevent tree shaking and cause name conflicts.
+       * Consider using named imports instead.
        */
-      "ts/no-namespace": "off",
-      "ts/no-redeclare": "off",
+      "import/no-namespace": "error",
       /**
-       * Check for unused variables in TypeScript.
+       * Enforcing named exports improves consistency, enhances auto-completion and refactoring, and avoids issues
+       * with default export renaming. Additionally, default exports might lead to different behavior when transformed
+       * to CJS.
        */
-      "ts/no-unused-vars": "off"
+      "import/no-default-export": "error"
     }
-  })).override("antfu/jsonc/rules", config => ({
-    ...config,
+  })).insertAfter("antfu/imports/rules", {
+    name: "vdustr/allow-default-export",
     rules: {
-      ...config.rules,
-      "jsonc/sort-keys": "error"
+      "import/no-default-export": "off"
     },
-    files: [...(config.files ?? []), "**/*.code-workspace"],
-    ignores: [...(config.ignores ?? []),
-    /**
-     * Lint `package.json` files with `eslint-plugin-package-json` instead.
-     */
-    "**/package.json"]
-  })).remove("antfu/sort/package-json").remove("antfu/sort/tsconfig-json").override("antfu/react/rules", config => ({
-    ...config,
-    plugins: {
-      ...config.plugins,
-      "react-compiler": reactCompilerPlugin
-    },
-    rules: {
-      ...config.rules,
-      "react-compiler/react-compiler": "error",
+    files: ["**/*.config.*",
+    // Single file components
+    "**/*.vue", "**/*.svelte"]
+  });
+  if (typescriptEnabled) {
+    config = config.override("antfu/typescript/rules", config2 => ({
+      ...config2,
+      rules: {
+        ...config2.rules,
+        "ts/array-type": ["error", {
+          default: "generic"
+        }],
+        /**
+         * Namespaces are useful for centralizing the management of types. Just avoid
+         * overusing them with runtime code.
+         *
+         * - References:
+         *   - <https://x.com/mattpocockuk/status/1805606072167940167>
+         */
+        "ts/no-namespace": "off",
+        "ts/no-redeclare": "off",
+        /**
+         * Check for unused variables in TypeScript.
+         */
+        "ts/no-unused-vars": "off"
+      }
+    }));
+  }
+  if (jsoncEnabled) {
+    config = config.override("antfu/jsonc/rules", config2 => ({
+      ...config2,
+      rules: {
+        ...config2.rules,
+        "jsonc/sort-keys": "error"
+      },
+      files: [...(config2.files ?? []), "**/*.code-workspace"],
+      ignores: [...(config2.ignores ?? []),
       /**
-       * Not all destructuring assignments are more readable than their alternatives.
+       * Lint `package.json` files with `eslint-plugin-package-json` instead.
        */
-      "react/prefer-destructuring-assignment": "off"
-    }
-  }));
+      "**/package.json"]
+    })).remove("antfu/sort/package-json").remove("antfu/sort/tsconfig-json");
+  }
+  if (reactEnabled) {
+    config = config.override("antfu/react/rules", config2 => ({
+      ...config2,
+      plugins: {
+        ...config2.plugins,
+        "react-compiler": reactCompilerPlugin
+      },
+      rules: {
+        ...config2.rules,
+        "react-compiler/react-compiler": "error",
+        /**
+         * Not all destructuring assignments are more readable than their alternatives.
+         */
+        "react/prefer-destructuring-assignment": "off"
+      }
+    }));
+  }
+  if (storybookEnabled) {
+    config = config.override("storybook:csf:stories-rules", config2 => ({
+      ...config2,
+      rules: {
+        ...config2.rules,
+        "import/no-default-export": "off"
+      }
+    }));
+  }
+  return config;
 };
 exports.vdustr = vdustr;

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@vp-tw/eslint-config",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "ViPro's ESLint configuration",
+  "homepage": "https://github.com/vdustr/eslint-config",
+  "author": {
+    "name": "ViPro",
+    "url": "https://vdustr.dev"
+  },
   "exports": {
     ".": {
       "import": {
@@ -41,8 +46,9 @@
     "eslint-flat-config-utils": "^2.0.0",
     "eslint-plugin-mdx": "^3.1.5",
     "eslint-plugin-package-json": "^0.21.1",
-    "eslint-plugin-react": "^7.37.4",
-    "eslint-plugin-react-compiler": "^19.0.0-beta-27714ef-20250124"
+    "eslint-plugin-react-compiler": "^19.0.0-beta-27714ef-20250124",
+    "eslint-plugin-storybook": "^0.11.2",
+    "local-pkg": "^1.0.0"
   },
   "devDependencies": {
     "eslint-typegen": "^1.0.0",
@@ -53,9 +59,7 @@
   },
   "scripts": {
     "build": "unbuild",
-    "copy": "run-p copy:*",
-    "copy:license": "fse copy ../../LICENSE LICENSE",
-    "copy:readme": "fse copy ../../README.md README.md",
+    "copy": "tsx scripts/copy",
     "typegen": "tsx scripts/typegen.ts"
   }
 }

package/scripts/copy.ts

@@ -0,0 +1,23 @@
+import fs from "fs-extra";
+import path from "pathe";
+import { packageDirectory } from "pkg-dir";
+
+const filesToCopy = ["README.md", "LICENSE"] satisfies Array<string>;
+
+(async () => {
+  const pkgDir = await packageDirectory();
+  if (!pkgDir) {
+    throw new Error("Could not find package directory");
+  }
+  const rootPkgDir = await packageDirectory({
+    cwd: path.resolve(pkgDir, ".."),
+  });
+
+  if (!rootPkgDir) {
+    throw new Error("Could not find root package directory");
+  }
+
+  for (const file of filesToCopy) {
+    await fs.copyFile(path.join(rootPkgDir, file), path.join(pkgDir, file));
+  }
+})();

package/scripts/typegen.ts

@@ -1,6 +1,8 @@
 import type { ESLint } from "eslint";
-import { rules } from "eslint-plugin-mdx/lib/rules";
-import reactCompiler from "eslint-plugin-react-compiler";
+import { rules as mdxRules } from "eslint-plugin-mdx/lib/rules";
+// eslint-disable-next-line import/no-namespace -- This is a cjs module.
+import * as reactCompiler from "eslint-plugin-react-compiler";
+import storybook from "eslint-plugin-storybook";
 import { pluginsToRulesDTS } from "eslint-typegen/core";
 import fs from "fs-extra";
 import path from "pathe";
@@ -25,9 +27,18 @@ import { packageDirectory } from "pkg-dir";
     ...definePlugins({ "react-compiler": reactCompiler }),
     ...definePlugins({
       mdx: {
-        rules,
+        rules: mdxRules,
       },
     }),
+    ...definePlugins({
+      ...Object.fromEntries(
+        storybook.configs["flat/csf-strict"].flatMap((config) =>
+          !("plugins" in config) || !config.plugins
+            ? []
+            : Object.entries(config.plugins),
+        ),
+      ),
+    }),
   };
 
   await fs.writeFile(targetPath, await pluginsToRulesDTS(plugins));

package/src/configs/mdx.ts

@@ -1,14 +1,15 @@
 import type { TypedFlatConfigItem } from "@antfu/eslint-config";
 import type { DistributiveOmit } from "@mui/types";
-import type { Config } from "../types";
 
+// eslint-disable-next-line import/no-namespace -- `mdx` exports the plugin as a namespace.
 import * as mdxPlugin from "eslint-plugin-mdx";
+import { renameRules } from "../utils/renameRules";
 
 namespace mdx {
   export interface Options
     extends DistributiveOmit<TypedFlatConfigItem, "processor"> {
     processorOptions?: mdxPlugin.ProcessorOptions;
-    flatCodeBlocks?: boolean | Config;
+    flatCodeBlocks?: boolean | TypedFlatConfigItem;
   }
 }
 
@@ -16,12 +17,20 @@ const mdx = ({
   flatCodeBlocks = true,
   processorOptions,
   ...options
-}: mdx.Options = {}) =>
-  [
+}: mdx.Options = {}) => {
+  const flatCodeBlocksOptions: TypedFlatConfigItem =
+    typeof flatCodeBlocks !== "object" ? {} : flatCodeBlocks;
+  const configs: Array<TypedFlatConfigItem> = [
     {
       name: "vdustr/mdx",
       ...mdxPlugin.flat,
       ...options,
+      rules: {
+        ...renameRules({
+          ...mdxPlugin.flat.rules,
+        }),
+        ...options.rules,
+      },
       processor: mdxPlugin.createRemarkProcessor({
         lintCodeBlocks: Boolean(flatCodeBlocks),
         ...processorOptions,
@@ -36,9 +45,17 @@ const mdx = ({
           {
             name: "vdustr/mdx/flat-code-blocks",
             ...mdxPlugin.flatCodeBlocks,
-            ...(typeof flatCodeBlocks !== "object" ? null : flatCodeBlocks),
-          } satisfies Config,
+            ...flatCodeBlocksOptions,
+            rules: {
+              ...renameRules({
+                ...mdxPlugin.flatCodeBlocks.rules,
+              }),
+              ...flatCodeBlocksOptions.rules,
+            },
+          } satisfies TypedFlatConfigItem,
         ]),
-  ] satisfies Array<Config>;
+  ];
+  return configs;
+};
 
 export { mdx };

package/src/configs/prettier.ts

@@ -1,12 +1,12 @@
-import type { Config } from "../types";
-import { defaultPluginRenaming, renameRules } from "@antfu/eslint-config";
+import type { TypedFlatConfigItem } from "@antfu/eslint-config";
 
 import eslintConfigPrettier from "eslint-config-prettier";
+import { renameRules } from "../utils/renameRules";
 
-const prettier: Config = {
+const prettier = {
   name: "vdustr/prettier",
   ...eslintConfigPrettier,
-  rules: renameRules(eslintConfigPrettier.rules, defaultPluginRenaming),
-};
+  rules: renameRules(eslintConfigPrettier.rules),
+} satisfies TypedFlatConfigItem;
 
 export { prettier };

package/src/configs/storybook.ts

@@ -0,0 +1,20 @@
+import type { TypedFlatConfigItem } from "@antfu/eslint-config";
+import storybookPlugin from "eslint-plugin-storybook";
+import { renameRules } from "../utils/renameRules";
+
+const storybook = storybookPlugin.configs["flat/csf-strict"].map((config) => {
+  const allConfig = config as TypedFlatConfigItem;
+  const { rules, files, plugins, ...rest } = allConfig;
+  return {
+    ...rest,
+    ...(!rules
+      ? null
+      : {
+          rules: renameRules(rules),
+        }),
+    ...(!files ? null : { files }),
+    ...(!plugins ? null : { plugins }),
+  } satisfies TypedFlatConfigItem;
+});
+
+export { storybook };