@vp-tw/eslint-config 0.0.1

package/dist/esm/configs/mdx.mjs

@@ -0,0 +1,27 @@
+import * as mdxPlugin from "eslint-plugin-mdx";
+const mdx = ({
+  flatCodeBlocks = true,
+  processorOptions,
+  ...options
+} = {}) => [
+  {
+    name: "vdustr/mdx",
+    ...mdxPlugin.flat,
+    ...options,
+    processor: mdxPlugin.createRemarkProcessor({
+      lintCodeBlocks: Boolean(flatCodeBlocks),
+      ...processorOptions,
+      languageMapper: {
+        ...processorOptions?.languageMapper
+      }
+    })
+  },
+  ...!flatCodeBlocks ? [] : [
+    {
+      name: "vdustr/mdx/flat-code-blocks",
+      ...mdxPlugin.flatCodeBlocks,
+      ...typeof flatCodeBlocks !== "object" ? null : flatCodeBlocks
+    }
+  ]
+];
+export { mdx };

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

@@ -0,0 +1,3 @@
+import type { Config } from "../types";
+declare const prettier: Config;
+export { prettier };

package/dist/esm/configs/prettier.mjs

@@ -0,0 +1,8 @@
+import { defaultPluginRenaming, renameRules } from "@antfu/eslint-config";
+import eslintConfigPrettier from "eslint-config-prettier";
+const prettier = {
+  name: "vdustr/prettier",
+  ...eslintConfigPrettier,
+  rules: renameRules(eslintConfigPrettier.rules, defaultPluginRenaming)
+};
+export { prettier };

package/dist/esm/eslint-typegen.d.ts

@@ -0,0 +1,26 @@
+/* eslint-disable */
+/* prettier-ignore */
+import type { Linter } from 'eslint'
+
+declare module 'eslint' {
+  namespace Linter {
+    interface RulesRecord extends RuleOptions {}
+  }
+}
+
+export interface RuleOptions {
+  /**
+   * Linter integration with remark plugins
+   */
+  'mdx/remark'?: Linter.RuleEntry<[]>
+  /**
+   * Surfaces diagnostics from React Forget
+   */
+  'react-compiler/react-compiler'?: Linter.RuleEntry<ReactCompilerReactCompiler>
+}
+
+/* ======= Declarations ======= */
+// ----- react-compiler/react-compiler -----
+type ReactCompilerReactCompiler = []|[{
+  [k: string]: unknown | undefined
+}]

package/dist/esm/index.d.ts

@@ -0,0 +1 @@
+export * from "./vdustr";

package/dist/esm/index.mjs

@@ -0,0 +1 @@
+export * from "./vdustr.mjs";

package/dist/esm/lib/eslint-plugin-react-compiler.d.ts

@@ -0,0 +1,13 @@
+declare module "eslint-plugin-react-compiler" {
+    type Plugin = import("eslint").ESLint.Plugin;
+    type LegacyConfig = import("eslint").Linter.LegacyConfig;
+    interface ReactCompiler extends Plugin {
+        rules: NonNullable<Plugin["rules"]>;
+        configs: {
+            recommended: LegacyConfig;
+        };
+    }
+    const rules: ReactCompiler["rules"];
+    const configs: ReactCompiler["configs"];
+    export { configs, rules };
+}

package/dist/esm/types.d.ts

@@ -0,0 +1,3 @@
+import type antfu from "@antfu/eslint-config";
+type Config = NonNullable<Parameters<typeof antfu>[1]>;
+export type { Config };

package/dist/esm/vdustr.d.ts

@@ -0,0 +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;
+};
+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/esm/vdustr.mjs

@@ -0,0 +1,101 @@
+import antfu from "@antfu/eslint-config";
+import packageJson from "eslint-plugin-package-json/configs/recommended";
+import * as reactCompilerPlugin from "eslint-plugin-react-compiler";
+import { mdx } from "./configs/mdx.mjs";
+import { prettier } from "./configs/prettier.mjs";
+import "./eslint-typegen.d";
+const vdustr = (options, ...userConfigs) => {
+  const mdxOptions = options?.mdx ?? true;
+  const jsoncEnabled = Boolean(options?.jsonc ?? true);
+  const defaultConfigs = [
+    ...!jsoncEnabled ? [] : [packageJson],
+    ...!mdxOptions ? [] : mdx({
+      ...typeof mdxOptions !== "object" ? null : mdxOptions
+    }),
+    prettier
+  ];
+  return antfu(
+    {
+      // We use `prettier`.
+      stylistic: false,
+      ...options
+    },
+    ...defaultConfigs,
+    ...userConfigs
+  ).override("antfu/javascript/rules", (config) => ({
+    ...config,
+    rules: {
+      ...config.rules,
+      /**
+       * Some callbacks are purposefully named to make the code self-documenting.
+       */
+      "prefer-arrow-callback": "off",
+      /**
+       * This rule does not integrate well with JSDoc `@link` tags. It's advised
+       * to verify its behavior with TypeScript instead.
+       */
+      "no-unused-vars": "off",
+      "unused-imports/no-unused-vars": "off",
+      "unused-imports/no-unused-imports-ts": "off",
+      "unused-imports/no-unused-vars-ts": "off",
+      "unused-imports/no-unused-imports": "off"
+    }
+  })).override("antfu/imports/rules", (config) => ({
+    ...config,
+    rules: {
+      ...config.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" }],
+      /**
+       * 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"
+    }
+  })).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) => ({
+    ...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"
+    }
+  }));
+};
+export { vdustr };

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./vdustr";

package/dist/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _vdustr = require("./vdustr");
+Object.keys(_vdustr).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _vdustr[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _vdustr[key];
+    }
+  });
+});

package/dist/lib/eslint-plugin-react-compiler.d.ts

@@ -0,0 +1,13 @@
+declare module "eslint-plugin-react-compiler" {
+    type Plugin = import("eslint").ESLint.Plugin;
+    type LegacyConfig = import("eslint").Linter.LegacyConfig;
+    interface ReactCompiler extends Plugin {
+        rules: NonNullable<Plugin["rules"]>;
+        configs: {
+            recommended: LegacyConfig;
+        };
+    }
+    const rules: ReactCompiler["rules"];
+    const configs: ReactCompiler["configs"];
+    export { configs, rules };
+}

package/dist/lib/eslint-plugin-react-compiler.js

@@ -0,0 +1 @@
+"use strict";

package/dist/types.d.ts

@@ -0,0 +1,3 @@
+import type antfu from "@antfu/eslint-config";
+type Config = NonNullable<Parameters<typeof antfu>[1]>;
+export type { Config };

package/dist/types.js

@@ -0,0 +1 @@
+"use strict";

package/dist/vdustr.d.ts

@@ -0,0 +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;
+};
+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

@@ -0,0 +1,102 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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 _mdx = require("./configs/mdx");
+var _prettier = require("./configs/prettier");
+require("./eslint-typegen.d");
+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 jsoncEnabled = Boolean(options?.jsonc ?? true);
+  const defaultConfigs = [...(!jsoncEnabled ? [] : [_recommended.default]), ...(!mdxOptions ? [] : (0, _mdx.mdx)({
+    ...(typeof mdxOptions !== "object" ? null : mdxOptions)
+  })), _prettier.prettier];
+  return (0, _eslintConfig.default)({
+    // We use `prettier`.
+    stylistic: false,
+    ...options
+  }, ...defaultConfigs, ...userConfigs).override("antfu/javascript/rules", config => ({
+    ...config,
+    rules: {
+      ...config.rules,
+      /**
+       * Some callbacks are purposefully named to make the code self-documenting.
+       */
+      "prefer-arrow-callback": "off",
+      /**
+       * This rule does not integrate well with JSDoc `@link` tags. It's advised
+       * to verify its behavior with TypeScript instead.
+       */
+      "no-unused-vars": "off",
+      "unused-imports/no-unused-vars": "off",
+      "unused-imports/no-unused-imports-ts": "off",
+      "unused-imports/no-unused-vars-ts": "off",
+      "unused-imports/no-unused-imports": "off"
+    }
+  })).override("antfu/imports/rules", config => ({
+    ...config,
+    rules: {
+      ...config.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"
+      }],
+      /**
+       * 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"
+    }
+  })).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 => ({
+    ...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"
+    }
+  }));
+};
+exports.vdustr = vdustr;

package/global.d.ts

@@ -0,0 +1 @@
+/// <reference types="@total-typescript/ts-reset" />

package/lib/eslint-plugin-react-compiler.ts

@@ -0,0 +1,13 @@
+declare module "eslint-plugin-react-compiler" {
+  type Plugin = import("eslint").ESLint.Plugin;
+  type LegacyConfig = import("eslint").Linter.LegacyConfig;
+  interface ReactCompiler extends Plugin {
+    rules: NonNullable<Plugin["rules"]>;
+    configs: {
+      recommended: LegacyConfig;
+    };
+  }
+  const rules: ReactCompiler["rules"];
+  const configs: ReactCompiler["configs"];
+  export { configs, rules };
+}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@vp-tw/eslint-config",
+  "version": "0.0.1",
+  "description": "ViPro's ESLint configuration",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "default": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./*": {
+      "import": {
+        "types": "./dist/esm/*.d.ts",
+        "default": "./dist/esm/*.mjs"
+      },
+      "default": {
+        "types": "./dist/*.d.ts",
+        "default": "./dist/*.js"
+      }
+    },
+    "./README.md": "./README.md",
+    "./package": "./package.json",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/esm/index.mjs",
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@antfu/eslint-config": "^4.1.0",
+    "@eslint-react/eslint-plugin": "^1.25.0",
+    "@eslint/compat": "^1.2.5",
+    "@mui/types": "^7.2.21",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/eslint__eslintrc": "^2.1.2",
+    "eslint-config-prettier": "^10.0.1",
+    "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"
+  },
+  "devDependencies": {
+    "eslint-typegen": "^1.0.0",
+    "unbuild": "^3.3.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "copy": "run-p copy:*",
+    "copy:license": "fse copy ../../LICENSE LICENSE",
+    "copy:readme": "fse copy ../../README.md README.md",
+    "typegen": "tsx scripts/typegen.ts"
+  }
+}

package/scripts/typegen.ts

@@ -0,0 +1,34 @@
+import type { ESLint } from "eslint";
+import { rules } from "eslint-plugin-mdx/lib/rules";
+import reactCompiler from "eslint-plugin-react-compiler";
+import { pluginsToRulesDTS } from "eslint-typegen/core";
+import fs from "fs-extra";
+import path from "pathe";
+import { packageDirectory } from "pkg-dir";
+
+(async () => {
+  const pkgDir = await packageDirectory();
+  if (!pkgDir) {
+    throw new Error("Could not find package directory");
+  }
+  const distDir = path.join(pkgDir, "src");
+  const targetPath = path.join(distDir, "eslint-typegen.d.ts");
+  await fs.ensureDir(path.dirname(targetPath));
+
+  type Plugins = Record<string, ESLint.Plugin>;
+
+  function definePlugins<T extends Plugins>(plugins: T): T {
+    return plugins;
+  }
+
+  const plugins: Plugins = {
+    ...definePlugins({ "react-compiler": reactCompiler }),
+    ...definePlugins({
+      mdx: {
+        rules,
+      },
+    }),
+  };
+
+  await fs.writeFile(targetPath, await pluginsToRulesDTS(plugins));
+})();

package/src/configs/mdx.ts

@@ -0,0 +1,44 @@
+import type { TypedFlatConfigItem } from "@antfu/eslint-config";
+import type { DistributiveOmit } from "@mui/types";
+import type { Config } from "../types";
+
+import * as mdxPlugin from "eslint-plugin-mdx";
+
+namespace mdx {
+  export interface Options
+    extends DistributiveOmit<TypedFlatConfigItem, "processor"> {
+    processorOptions?: mdxPlugin.ProcessorOptions;
+    flatCodeBlocks?: boolean | Config;
+  }
+}
+
+const mdx = ({
+  flatCodeBlocks = true,
+  processorOptions,
+  ...options
+}: mdx.Options = {}) =>
+  [
+    {
+      name: "vdustr/mdx",
+      ...mdxPlugin.flat,
+      ...options,
+      processor: mdxPlugin.createRemarkProcessor({
+        lintCodeBlocks: Boolean(flatCodeBlocks),
+        ...processorOptions,
+        languageMapper: {
+          ...processorOptions?.languageMapper,
+        },
+      }),
+    },
+    ...(!flatCodeBlocks
+      ? []
+      : [
+          {
+            name: "vdustr/mdx/flat-code-blocks",
+            ...mdxPlugin.flatCodeBlocks,
+            ...(typeof flatCodeBlocks !== "object" ? null : flatCodeBlocks),
+          } satisfies Config,
+        ]),
+  ] satisfies Array<Config>;
+
+export { mdx };

package/src/configs/prettier.ts

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

package/src/eslint-typegen.d.ts

@@ -0,0 +1,26 @@
+/* eslint-disable */
+/* prettier-ignore */
+import type { Linter } from 'eslint'
+
+declare module 'eslint' {
+  namespace Linter {
+    interface RulesRecord extends RuleOptions {}
+  }
+}
+
+export interface RuleOptions {
+  /**
+   * Linter integration with remark plugins
+   */
+  'mdx/remark'?: Linter.RuleEntry<[]>
+  /**
+   * Surfaces diagnostics from React Forget
+   */
+  'react-compiler/react-compiler'?: Linter.RuleEntry<ReactCompilerReactCompiler>
+}
+
+/* ======= Declarations ======= */
+// ----- react-compiler/react-compiler -----
+type ReactCompilerReactCompiler = []|[{
+  [k: string]: unknown | undefined
+}]

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./vdustr";

package/src/tsconfig.json

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

package/src/types.ts

@@ -0,0 +1,5 @@
+import type antfu from "@antfu/eslint-config";
+
+type Config = NonNullable<Parameters<typeof antfu>[1]>;
+
+export type { Config };