@vp-tw/eslint-config 1.0.2 → 1.0.5

package/README.md

@@ -85,16 +85,43 @@ export default vdustr({
 
 Automatically sorts keys in `pnpm-workspace.yaml` alphabetically using `yaml/sort-keys` rule.
 
-## Release
+## Contributing
+
+### Development
+
+```bash
+pnpm install            # Install dependencies
+pnpm build              # Build @vp-tw/eslint-config (in packages/eslint-config)
+pnpm test               # Run tests for @vp-tw/eslint-config
+pnpm run checkTypes     # Type check entire workspace
+pnpm lint               # Lint entire workspace
+```
+
+### Release
+
+Managed by [changesets](https://github.com/changesets/changesets). CI auto-publishes when merged to main.
 
 ```bash
-pnpm -w v:patch # or
-pnpm -w v:minor # or
-pnpm -w v:major
+pnpm changeset          # Create changeset interactively
+```
+
+### Adding Dynamic Import Wrappers
+
+When adding support for optional ESLint plugins, create a wrapper in `src/lib/`:
 
-pnpm -r publish
+```typescript
+// src/lib/my-plugin.ts
+import type MyPlugin from "eslint-plugin-my";
+import { interopDefault } from "@antfu/eslint-config";
+
+// Explicit return type required to avoid TS2742 build errors
+const myPlugin = (): Promise<typeof MyPlugin> => interopDefault(import("eslint-plugin-my"));
+
+export { myPlugin };
 ```
 
+See [CLAUDE.md](./CLAUDE.md) for detailed architecture and patterns.
+
 ## License
 
 MIT © ViPro <vdustr@gmail.com> (<http://vdustr.dev>)

package/dist/configs/packageJson.js

@@ -20,6 +20,7 @@ const packageJson = async options => {
     ...(0, _esToolkit.omit)(recommended, ["name", "plugins"]),
     rules: (0, _renameRules.renameRules)({
       ...recommended.rules,
+      // sorted by oxfmt
       "package-json/order-properties": "off"
     }),
     name: "vdustr/package-json/rules"

package/dist/esm/configs/packageJson.mjs

@@ -14,6 +14,7 @@ const packageJson = async (options) => {
     ...omit(recommended, ["name", "plugins"]),
     rules: renameRules({
       ...recommended.rules,
+      // sorted by oxfmt
       "package-json/order-properties": "off"
     }),
     name: "vdustr/package-json/rules"

package/dist/esm/extends/react.mjs

@@ -1,8 +1,8 @@
 import { GLOB_MARKDOWN_CODE } from "@antfu/eslint-config";
-import eslintReact from "@eslint-react/eslint-plugin";
 import { omit, pick } from "es-toolkit";
 import { reactCompiler } from "../configs/reactCompiler.mjs";
 import { GLOB_MDX_CODE } from "../globs.mjs";
+import { eslintReact as importEslintReact } from "../lib/eslint-react.mjs";
 import { extendsConfig } from "../utils/extendsConfig.mjs";
 import { mergeConfig } from "../utils/mergeConfig.mjs";
 import { ignoreKeys } from "./_utils.mjs";
@@ -32,6 +32,7 @@ function renameReactRules(rules) {
 const react = (composer, options) => {
   const typescriptEnabled = options?.typescript ?? true;
   extendsConfig(composer, "antfu/react/rules", async (config) => {
+    const eslintReact = await importEslintReact();
     const modifiedConfig = mergeConfig(pick(options?.react ?? {}, ["files", "ignores"]), config);
     const omittedConfig = omit(modifiedConfig, ignoreKeys);
     const baseConfig = typescriptEnabled ? eslintReact.configs["strict-typescript"] : eslintReact.configs.strict;

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

@@ -0,0 +1,3 @@
+import type EslintReact from "@eslint-react/eslint-plugin";
+declare const eslintReact: () => Promise<typeof EslintReact>;
+export { eslintReact };

package/dist/esm/lib/eslint-react.mjs

@@ -0,0 +1,3 @@
+import { interopDefault } from "@antfu/eslint-config";
+const eslintReact = () => interopDefault(import("@eslint-react/eslint-plugin"));
+export { eslintReact };

package/dist/esm/vdustr.mjs

@@ -40,6 +40,7 @@ const vdustr = (options, ...userConfigs) => {
   const mdxEnabled = Boolean(vpOptions?.mdx ?? false);
   const storybookEnabled = Boolean(vpOptions?.storybook ?? false);
   const prettierEnabled = Boolean(vpOptions?.prettier ?? true);
+  const reactEnabled = Boolean(antfuOptions?.react ?? false);
   let config = antfu({
     ...antfuOptions,
     ...!prettierEnabled ? null : {
@@ -56,7 +57,9 @@ const vdustr = (options, ...userConfigs) => {
   sortJsonKeys(config, vpOptions?.extends?.sort?.jsoncSortKeys);
   sortJsonArrayValues(config, vpOptions?.extends?.sort?.jsoncSortArrayValues);
   yaml(config, vpOptions?.extends?.yaml);
-  react(config, vpOptions?.extends?.react);
+  if (reactEnabled) {
+    react(config, vpOptions?.extends?.react);
+  }
   pnpm(config, vpOptions?.extends?.pnpm);
   if (packageJsonEnabled) {
     const packageJsonOptions = typeof vpOptions?.packageJson !== "object" ? void 0 : vpOptions.packageJson;

package/dist/extends/react.js

@@ -5,14 +5,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.react = void 0;
 var _eslintConfig = require("@antfu/eslint-config");
-var _eslintPlugin = _interopRequireDefault(require("@eslint-react/eslint-plugin"));
 var _esToolkit = require("es-toolkit");
 var _reactCompiler = require("../configs/reactCompiler");
 var _globs = require("../globs");
+var _eslintReact = require("../lib/eslint-react");
 var _extendsConfig = require("../utils/extendsConfig");
 var _mergeConfig = require("../utils/mergeConfig");
 var _utils = require("./_utils");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const reactRulesRenameMap = {
   "@eslint-react": "react",
   "@eslint-react/dom": "react-dom",
@@ -37,9 +36,10 @@ function renameReactRules(rules) {
 const react = (composer, options) => {
   const typescriptEnabled = options?.typescript ?? true;
   (0, _extendsConfig.extendsConfig)(composer, "antfu/react/rules", async config => {
+    const eslintReact = await (0, _eslintReact.eslintReact)();
     const modifiedConfig = (0, _mergeConfig.mergeConfig)((0, _esToolkit.pick)(options?.react ?? {}, ["files", "ignores"]), config);
     const omittedConfig = (0, _esToolkit.omit)(modifiedConfig, _utils.ignoreKeys);
-    const baseConfig = typescriptEnabled ? _eslintPlugin.default.configs["strict-typescript"] : _eslintPlugin.default.configs.strict;
+    const baseConfig = typescriptEnabled ? eslintReact.configs["strict-typescript"] : eslintReact.configs.strict;
     const rulesConfig = (0, _mergeConfig.mergeConfig)((0, _esToolkit.omit)(options?.react ?? {}, ["files", "ignores"]), {
       // plugins already setup by antfu
       ...(0, _esToolkit.omit)(baseConfig, ["plugins"]),

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

@@ -0,0 +1,3 @@
+import type EslintReact from "@eslint-react/eslint-plugin";
+declare const eslintReact: () => Promise<typeof EslintReact>;
+export { eslintReact };

package/dist/lib/eslint-react.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.eslintReact = void 0;
+var _eslintConfig = require("@antfu/eslint-config");
+const eslintReact = () => (0, _eslintConfig.interopDefault)(Promise.resolve().then(() => require("@eslint-react/eslint-plugin")));
+exports.eslintReact = eslintReact;

package/dist/vdustr.js

@@ -31,6 +31,7 @@ const vdustr = (options, ...userConfigs) => {
   const mdxEnabled = Boolean(vpOptions?.mdx ?? false);
   const storybookEnabled = Boolean(vpOptions?.storybook ?? false);
   const prettierEnabled = Boolean(vpOptions?.prettier ?? true);
+  const reactEnabled = Boolean(antfuOptions?.react ?? false);
   let config = (0, _eslintConfig.default)({
     ...antfuOptions,
     ...(!prettierEnabled ? null : {
@@ -47,7 +48,9 @@ const vdustr = (options, ...userConfigs) => {
   (0, _sort.sortJsonKeys)(config, vpOptions?.extends?.sort?.jsoncSortKeys);
   (0, _sort.sortJsonArrayValues)(config, vpOptions?.extends?.sort?.jsoncSortArrayValues);
   (0, _yaml.yaml)(config, vpOptions?.extends?.yaml);
-  (0, _react.react)(config, vpOptions?.extends?.react);
+  if (reactEnabled) {
+    (0, _react.react)(config, vpOptions?.extends?.react);
+  }
   (0, _pnpm.pnpm)(config, vpOptions?.extends?.pnpm);
   if (packageJsonEnabled) {
     const packageJsonOptions = typeof vpOptions?.packageJson !== "object" ? void 0 : vpOptions.packageJson;

package/package.json

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