@vp-tw/eslint-config 0.0.1 → 0.0.3

package/src/eslint-typegen.d.ts

@@ -17,10 +17,90 @@ export interface RuleOptions {
    * Surfaces diagnostics from React Forget
    */
   'react-compiler/react-compiler'?: Linter.RuleEntry<ReactCompilerReactCompiler>
+  /**
+   * Interactions should be awaited
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/await-interactions.md
+   */
+  'storybook/await-interactions'?: Linter.RuleEntry<[]>
+  /**
+   * Pass a context when invoking play function of another story
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/context-in-play-function.md
+   */
+  'storybook/context-in-play-function'?: Linter.RuleEntry<[]>
+  /**
+   * The component property should be set
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/csf-component.md
+   */
+  'storybook/csf-component'?: Linter.RuleEntry<[]>
+  /**
+   * Story files should have a default export
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/default-exports.md
+   */
+  'storybook/default-exports'?: Linter.RuleEntry<[]>
+  /**
+   * Deprecated hierarchy separator in title property
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/hierarchy-separator.md
+   */
+  'storybook/hierarchy-separator'?: Linter.RuleEntry<[]>
+  /**
+   * Meta should only have inline properties
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/meta-inline-properties.md
+   */
+  'storybook/meta-inline-properties'?: Linter.RuleEntry<StorybookMetaInlineProperties>
+  /**
+   * A story should not have a redundant name property
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/no-redundant-story-name.md
+   */
+  'storybook/no-redundant-story-name'?: Linter.RuleEntry<[]>
+  /**
+   * storiesOf is deprecated and should not be used
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/no-stories-of.md
+   */
+  'storybook/no-stories-of'?: Linter.RuleEntry<[]>
+  /**
+   * Do not define a title in meta
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/no-title-property-in-meta.md
+   */
+  'storybook/no-title-property-in-meta'?: Linter.RuleEntry<[]>
+  /**
+   * This rule identifies storybook addons that are invalid because they are either not installed or contain a typo in their name.
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/no-uninstalled-addons.md
+   */
+  'storybook/no-uninstalled-addons'?: Linter.RuleEntry<StorybookNoUninstalledAddons>
+  /**
+   * Stories should use PascalCase
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/prefer-pascal-case.md
+   */
+  'storybook/prefer-pascal-case'?: Linter.RuleEntry<[]>
+  /**
+   * A story file must contain at least one story export
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/story-exports.md
+   */
+  'storybook/story-exports'?: Linter.RuleEntry<[]>
+  /**
+   * Use expect from `@storybook/test` or `@storybook/jest`
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/use-storybook-expect.md
+   */
+  'storybook/use-storybook-expect'?: Linter.RuleEntry<[]>
+  /**
+   * Do not use testing-library directly on stories
+   * @see https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/use-storybook-testing-library.md
+   */
+  'storybook/use-storybook-testing-library'?: Linter.RuleEntry<[]>
 }
 
 /* ======= Declarations ======= */
 // ----- react-compiler/react-compiler -----
 type ReactCompilerReactCompiler = []|[{
   [k: string]: unknown | undefined
+}]
+// ----- storybook/meta-inline-properties -----
+type StorybookMetaInlineProperties = []|[{
+  csfVersion?: number
+}]
+// ----- storybook/no-uninstalled-addons -----
+type StorybookNoUninstalledAddons = []|[{
+  packageJsonLocation?: string
+  ignore?: string[]
+  [k: string]: unknown | undefined
 }]

package/src/tsconfig.json

@@ -1,4 +1,3 @@
 {
-  "extends": ["@vp-tw/tsconfig/base/bundler/tsconfig"],
-  "include": [".", "../lib"]
+  "extends": ["@vp-tw/tsconfig/base/bundler/tsconfig"]
 }

package/src/utils/renameRules.ts

@@ -0,0 +1,7 @@
+import { defaultPluginRenaming, renameRules } from "@antfu/eslint-config";
+
+function renameRulesInternal(rules: Parameters<typeof renameRules>[0]) {
+  return renameRules(rules, defaultPluginRenaming);
+}
+
+export { renameRulesInternal as renameRules };

package/src/vdustr.ts

@@ -1,19 +1,27 @@
+// eslint-disable-next-line import/no-empty-named-blocks -- Type only import.
+import type {} from "./eslint-typegen";
 import type { Config } from "./types";
 import antfu from "@antfu/eslint-config";
-import packageJson from "eslint-plugin-package-json/configs/recommended";
 
+import packageJson from "eslint-plugin-package-json/configs/recommended";
+// eslint-disable-next-line import/no-namespace -- This is a cjs module.
 import * as reactCompilerPlugin from "eslint-plugin-react-compiler";
+import { isPackageExists } from "local-pkg";
 import { mdx } from "./configs/mdx";
 import { prettier } from "./configs/prettier";
-import "./eslint-typegen.d";
+import { storybook } from "./configs/storybook";
 
 type Options = NonNullable<Parameters<typeof antfu>[0]> & {
   mdx?: boolean | mdx.Options;
+  storybook?: boolean;
 };
 
 const vdustr = (options?: Options, ...userConfigs: Array<Config>) => {
-  const mdxOptions = options?.mdx ?? true;
+  const typescriptEnabled = isPackageExists("typescript");
   const jsoncEnabled: boolean = Boolean(options?.jsonc ?? true);
+  const reactEnabled: boolean = Boolean(options?.react ?? false);
+  const storybookEnabled: boolean = Boolean(options?.storybook ?? false);
+  const mdxOptions = options?.mdx ?? true;
   type Config = NonNullable<Parameters<typeof antfu>[1]>;
   const defaultConfigs: Array<Config> = [
     ...(!jsoncEnabled ? [] : [packageJson]),
@@ -22,9 +30,10 @@ const vdustr = (options?: Options, ...userConfigs: Array<Config>) => {
       : mdx({
           ...(typeof mdxOptions !== "object" ? null : mdxOptions),
         })),
+    ...(!storybookEnabled ? [] : storybook),
     prettier,
   ];
-  return antfu(
+  let config = antfu(
     {
       // We use `prettier`.
       stylistic: false,
@@ -32,7 +41,9 @@ const vdustr = (options?: Options, ...userConfigs: Array<Config>) => {
     },
     ...defaultConfigs,
     ...userConfigs,
-  )
+  );
+
+  config = config
     .override("antfu/javascript/rules", (config) => ({
       ...config,
       rules: {
@@ -61,9 +72,40 @@ const vdustr = (options?: Options, ...userConfigs: Array<Config>) => {
          * Forbid `import {} from "module"`.
          */
         "import/no-empty-named-blocks": "error",
+
+        /**
+         * Wildcard imports can prevent tree shaking and cause name conflicts.
+         * Consider using named imports instead.
+         */
+        "import/no-namespace": "error",
+
+        /**
+         * 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.
+         */
+        "import/no-default-export": "error",
       },
     }))
-    .override("antfu/typescript/rules", (config) => ({
+
+    /**
+     * Allow default exports in certain files.
+     */
+    .insertAfter("antfu/imports/rules", {
+      name: "vdustr/allow-default-export",
+      rules: {
+        "import/no-default-export": "off",
+      },
+      files: [
+        "**/*.config.*",
+        // Single file components
+        "**/*.vue",
+        "**/*.svelte",
+      ],
+    });
+
+  if (typescriptEnabled) {
+    config = config.override("antfu/typescript/rules", (config) => ({
       ...config,
       rules: {
         ...config.rules,
@@ -84,25 +126,32 @@ const vdustr = (options?: Options, ...userConfigs: Array<Config>) => {
          */
         "ts/no-unused-vars": "off",
       },
-    }))
-    .override("antfu/jsonc/rules", (config) => ({
-      ...config,
-      rules: {
-        ...config.rules,
-        "jsonc/sort-keys": "error",
-      },
-      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) => ({
+    }));
+  }
+
+  if (jsoncEnabled) {
+    config = config
+      .override("antfu/jsonc/rules", (config) => ({
+        ...config,
+        rules: {
+          ...config.rules,
+          "jsonc/sort-keys": "error",
+        },
+        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");
+  }
+
+  if (reactEnabled) {
+    config = config.override("antfu/react/rules", (config) => ({
       ...config,
       plugins: {
         ...config.plugins,
@@ -118,6 +167,19 @@ const vdustr = (options?: Options, ...userConfigs: Array<Config>) => {
         "react/prefer-destructuring-assignment": "off",
       },
     }));
+  }
+
+  if (storybookEnabled) {
+    config = config.override("storybook:csf:stories-rules", (config) => ({
+      ...config,
+      rules: {
+        ...config.rules,
+        "import/no-default-export": "off",
+      },
+    }));
+  }
+
+  return config;
 };
 
 export { vdustr };

package/tsconfig.json

@@ -1,4 +1,4 @@
 {
-  "exclude": ["dist", "src", "node_modules"],
+  "exclude": ["scripts", "./*.ts", "src/lib"],
   "extends": ["@vp-tw/tsconfig/base/bundler/tsconfig"]
 }