@vp-tw/eslint-config 0.0.5 → 0.0.7

package/README.md

@@ -7,9 +7,43 @@ ViPro's ESLint configuration.
   - [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier)
   - [eslint-mdx](https://github.com/mdx-js/eslint-mdx).
   - [eslint-plugin-storybook](https://github.com/storybookjs/eslint-plugin-storybook)
+  - [eslint-plugin-react-compiler](https://www.npmjs.com/package/eslint-plugin-react-compiler)
 - Fine-tuned to provide an opinionated, optimal DX. Please copy the VSCode settings from [eslint-config.code-workspace](https://github.com/VdustR/eslint-config/blob/main/eslint-config.code-workspace).
 
-Click [here](https://vdustr.dev/eslint-config) to preview the ESLint inspection.
+Check [here](https://vdustr.dev/eslint-config) to preview the ESLint inspection.
+
+## Installation
+
+```bash
+pnpm i -D @vp-tw/eslint-config
+```
+
+## Usage
+
+Simlar to [antfu/eslint-config](https://github.com/antfu/eslint-config) but with additional options:
+
+```ts
+// eslint.config.ts
+import { fileURLToPath } from "node:url";
+
+import { includeIgnoreFile } from "@eslint/compat";
+import { vdustr } from "@vp-tw/eslint-config";
+import path from "pathe";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const prettierignorePath = path.resolve(__dirname, ".prettierignore");
+
+export default vdustr(
+  {
+    // `stylistic` has been removed in favor of `prettier`.
+    // stylistic: true,
+    storybook: true,
+    mdx: true,
+  },
+  includeIgnoreFile(prettierignorePath),
+);
+```
 
 ## License
 

package/dist/esm/vdustr.d.ts

@@ -1,7 +1,7 @@
 import type { Config } from "./types";
 import antfu from "@antfu/eslint-config";
 import { mdx } from "./configs/mdx";
-type Options = NonNullable<Parameters<typeof antfu>[0]> & {
+type Options = Omit<NonNullable<Parameters<typeof antfu>[0]>, "stylistic"> & {
     mdx?: boolean | mdx.Options;
     storybook?: boolean;
 };

package/dist/esm/vdustr.mjs

@@ -10,22 +10,22 @@ const vdustr = (options, ...userConfigs) => {
   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
-  ];
+  const mdxEnabled = Boolean(options?.mdx ?? false);
+  const mdxOptions = {
+    ...typeof options?.mdx !== "object" ? null : options.mdx
+  };
+  const mdxFlatCodeBlocksEnabled = Boolean(
+    mdxOptions?.flatCodeBlocks ?? true
+  );
+  const mdxFlatCodeBlocksOptions = {
+    ...typeof mdxOptions?.flatCodeBlocks !== "object" ? null : mdxOptions.flatCodeBlocks
+  };
   let config = antfu(
     {
       // We use `prettier`.
       stylistic: false,
       ...options
     },
-    ...defaultConfigs,
     ...userConfigs
   );
   config = config.override("antfu/javascript/rules", (config2) => ({
@@ -72,6 +72,7 @@ const vdustr = (options, ...userConfigs) => {
       "import/no-default-export": "off"
     },
     files: [
+      // Configuration files
       "**/*.config.*",
       // Single file components
       "**/*.vue",
@@ -115,7 +116,7 @@ const vdustr = (options, ...userConfigs) => {
          */
         "**/package.json"
       ]
-    })).remove("antfu/sort/package-json").remove("antfu/sort/tsconfig-json");
+    })).insertAfter("antfu/jsonc/rules", packageJson).remove("antfu/sort/package-json").remove("antfu/sort/tsconfig-json");
   }
   if (reactEnabled) {
     config = config.override("antfu/react/rules", (config2) => ({
@@ -135,7 +136,7 @@ const vdustr = (options, ...userConfigs) => {
     }));
   }
   if (storybookEnabled) {
-    config = config.override("storybook:csf:stories-rules", (config2) => ({
+    config = config.append(storybook).override("storybook:csf:stories-rules", (config2) => ({
       ...config2,
       rules: {
         ...config2.rules,
@@ -143,6 +144,21 @@ const vdustr = (options, ...userConfigs) => {
       }
     }));
   }
+  if (mdxEnabled) {
+    config = config.append(
+      mdx({
+        ...mdxOptions,
+        flatCodeBlocks: !mdxFlatCodeBlocksEnabled ? false : {
+          ...mdxFlatCodeBlocksOptions,
+          rules: {
+            "import/no-default-export": "off",
+            ...mdxFlatCodeBlocksOptions?.rules
+          }
+        }
+      })
+    );
+  }
+  config = config.append(prettier);
   return config;
 };
 export { vdustr };

package/dist/vdustr.d.ts

@@ -1,7 +1,7 @@
 import type { Config } from "./types";
 import antfu from "@antfu/eslint-config";
 import { mdx } from "./configs/mdx";
-type Options = NonNullable<Parameters<typeof antfu>[0]> & {
+type Options = Omit<NonNullable<Parameters<typeof antfu>[0]>, "stylistic"> & {
     mdx?: boolean | mdx.Options;
     storybook?: boolean;
 };

package/dist/vdustr.js

@@ -17,15 +17,19 @@ const vdustr = (options, ...userConfigs) => {
   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)
-  })), ...(!storybookEnabled ? [] : _storybook.storybook), _prettier.prettier];
+  const mdxEnabled = Boolean(options?.mdx ?? false);
+  const mdxOptions = {
+    ...(typeof options?.mdx !== "object" ? null : options.mdx)
+  };
+  const mdxFlatCodeBlocksEnabled = Boolean(mdxOptions?.flatCodeBlocks ?? true);
+  const mdxFlatCodeBlocksOptions = {
+    ...(typeof mdxOptions?.flatCodeBlocks !== "object" ? null : mdxOptions.flatCodeBlocks)
+  };
   let config = (0, _eslintConfig.default)({
     // We use `prettier`.
     stylistic: false,
     ...options
-  }, ...defaultConfigs, ...userConfigs);
+  }, ...userConfigs);
   config = config.override("antfu/javascript/rules", config2 => ({
     ...config2,
     rules: {
@@ -69,7 +73,9 @@ const vdustr = (options, ...userConfigs) => {
     rules: {
       "import/no-default-export": "off"
     },
-    files: ["**/*.config.*",
+    files: [
+    // Configuration files
+    "**/*.config.*",
     // Single file components
     "**/*.vue", "**/*.svelte"]
   });
@@ -110,7 +116,7 @@ const vdustr = (options, ...userConfigs) => {
        * Lint `package.json` files with `eslint-plugin-package-json` instead.
        */
       "**/package.json"]
-    })).remove("antfu/sort/package-json").remove("antfu/sort/tsconfig-json");
+    })).insertAfter("antfu/jsonc/rules", _recommended.default).remove("antfu/sort/package-json").remove("antfu/sort/tsconfig-json");
   }
   if (reactEnabled) {
     config = config.override("antfu/react/rules", config2 => ({
@@ -130,7 +136,7 @@ const vdustr = (options, ...userConfigs) => {
     }));
   }
   if (storybookEnabled) {
-    config = config.override("storybook:csf:stories-rules", config2 => ({
+    config = config.append(_storybook.storybook).override("storybook:csf:stories-rules", config2 => ({
       ...config2,
       rules: {
         ...config2.rules,
@@ -138,6 +144,19 @@ const vdustr = (options, ...userConfigs) => {
       }
     }));
   }
+  if (mdxEnabled) {
+    config = config.append((0, _mdx.mdx)({
+      ...mdxOptions,
+      flatCodeBlocks: !mdxFlatCodeBlocksEnabled ? false : {
+        ...mdxFlatCodeBlocksOptions,
+        rules: {
+          "import/no-default-export": "off",
+          ...mdxFlatCodeBlocksOptions?.rules
+        }
+      }
+    }));
+  }
+  config = config.append(_prettier.prettier);
   return config;
 };
 exports.vdustr = vdustr;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vp-tw/eslint-config",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "ViPro's ESLint configuration",
   "homepage": "https://github.com/vdustr/eslint-config",
   "author": {

package/src/vdustr.ts

@@ -11,7 +11,7 @@ import { prettier } from "./configs/prettier";
 import { storybook } from "./configs/storybook";
 import { reactCompiler } from "./lib/eslint-plugin-react-compiler";
 
-type Options = NonNullable<Parameters<typeof antfu>[0]> & {
+type Options = Omit<NonNullable<Parameters<typeof antfu>[0]>, "stylistic"> & {
   mdx?: boolean | mdx.Options;
   storybook?: boolean;
 };
@@ -36,33 +36,12 @@ const vdustr = (options?: Options, ...userConfigs: Array<Config>) => {
       ? null
       : mdxOptions.flatCodeBlocks),
   };
-  type Config = NonNullable<Parameters<typeof antfu>[1]>;
-  const defaultConfigs: Array<Config> = [
-    ...(!jsoncEnabled ? [] : [packageJson]),
-    ...(!mdxEnabled
-      ? []
-      : mdx({
-          ...mdxOptions,
-          flatCodeBlocks: !mdxFlatCodeBlocksEnabled
-            ? false
-            : {
-                ...mdxFlatCodeBlocksOptions,
-                rules: {
-                  "import/no-default-export": "off",
-                  ...mdxFlatCodeBlocksOptions?.rules,
-                },
-              },
-        })),
-    ...(!storybookEnabled ? [] : storybook),
-    prettier,
-  ];
   let config = antfu(
     {
       // We use `prettier`.
       stylistic: false,
       ...options,
     },
-    ...defaultConfigs,
     ...userConfigs,
   );
 
@@ -120,7 +99,9 @@ const vdustr = (options?: Options, ...userConfigs: Array<Config>) => {
         "import/no-default-export": "off",
       },
       files: [
+        // Configuration files
         "**/*.config.*",
+
         // Single file components
         "**/*.vue",
         "**/*.svelte",
@@ -169,6 +150,7 @@ const vdustr = (options?: Options, ...userConfigs: Array<Config>) => {
           "**/package.json",
         ],
       }))
+      .insertAfter("antfu/jsonc/rules", packageJson)
       .remove("antfu/sort/package-json")
       .remove("antfu/sort/tsconfig-json");
   }
@@ -193,15 +175,36 @@ const vdustr = (options?: Options, ...userConfigs: Array<Config>) => {
   }
 
   if (storybookEnabled) {
-    config = config.override("storybook:csf:stories-rules", (config) => ({
-      ...config,
-      rules: {
-        ...config.rules,
-        "import/no-default-export": "off",
-      },
-    }));
+    config = config
+      .append(storybook)
+      .override("storybook:csf:stories-rules", (config) => ({
+        ...config,
+        rules: {
+          ...config.rules,
+          "import/no-default-export": "off",
+        },
+      }));
   }
 
+  if (mdxEnabled) {
+    config = config.append(
+      mdx({
+        ...mdxOptions,
+        flatCodeBlocks: !mdxFlatCodeBlocksEnabled
+          ? false
+          : {
+              ...mdxFlatCodeBlocksOptions,
+              rules: {
+                "import/no-default-export": "off",
+                ...mdxFlatCodeBlocksOptions?.rules,
+              },
+            },
+      }),
+    );
+  }
+
+  config = config.append(prettier);
+
   return config;
 };