@vp-tw/eslint-config 0.0.4 → 0.0.6

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,11 +10,27 @@ 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 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
+  };
   const defaultConfigs = [
     ...!jsoncEnabled ? [] : [packageJson],
-    ...!mdxOptions ? [] : mdx({
-      ...typeof mdxOptions !== "object" ? null : mdxOptions
+    ...!mdxEnabled ? [] : mdx({
+      ...mdxOptions,
+      flatCodeBlocks: !mdxFlatCodeBlocksEnabled ? false : {
+        ...mdxFlatCodeBlocksOptions,
+        rules: {
+          "import/no-default-export": "off",
+          ...mdxFlatCodeBlocksOptions?.rules
+        }
+      }
     }),
     ...!storybookEnabled ? [] : storybook,
     prettier

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,9 +17,23 @@ 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)
+  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)
+  };
+  const defaultConfigs = [...(!jsoncEnabled ? [] : [_recommended.default]), ...(!mdxEnabled ? [] : (0, _mdx.mdx)({
+    ...mdxOptions,
+    flatCodeBlocks: !mdxFlatCodeBlocksEnabled ? false : {
+      ...mdxFlatCodeBlocksOptions,
+      rules: {
+        "import/no-default-export": "off",
+        ...mdxFlatCodeBlocksOptions?.rules
+      }
+    }
   })), ...(!storybookEnabled ? [] : _storybook.storybook), _prettier.prettier];
   let config = (0, _eslintConfig.default)({
     // We use `prettier`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vp-tw/eslint-config",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "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;
 };
@@ -21,14 +21,37 @@ const vdustr = (options?: Options, ...userConfigs: Array<Config>) => {
   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;
+  const mdxEnabled: boolean = Boolean(options?.mdx ?? false);
+  const mdxOptions: Extract<Options["mdx"], Record<PropertyKey, any>> = {
+    ...(typeof options?.mdx !== "object" ? null : options.mdx),
+  };
+  const mdxFlatCodeBlocksEnabled: boolean = Boolean(
+    mdxOptions?.flatCodeBlocks ?? true,
+  );
+  const mdxFlatCodeBlocksOptions: Extract<
+    (typeof mdxOptions)["flatCodeBlocks"],
+    Record<PropertyKey, any>
+  > = {
+    ...(typeof mdxOptions?.flatCodeBlocks !== "object"
+      ? null
+      : mdxOptions.flatCodeBlocks),
+  };
   type Config = NonNullable<Parameters<typeof antfu>[1]>;
   const defaultConfigs: Array<Config> = [
     ...(!jsoncEnabled ? [] : [packageJson]),
-    ...(!mdxOptions
+    ...(!mdxEnabled
       ? []
       : mdx({
-          ...(typeof mdxOptions !== "object" ? null : mdxOptions),
+          ...mdxOptions,
+          flatCodeBlocks: !mdxFlatCodeBlocksEnabled
+            ? false
+            : {
+                ...mdxFlatCodeBlocksOptions,
+                rules: {
+                  "import/no-default-export": "off",
+                  ...mdxFlatCodeBlocksOptions?.rules,
+                },
+              },
         })),
     ...(!storybookEnabled ? [] : storybook),
     prettier,