@chanyuxi/eslint-waltz 0.1.0 → 0.1.1

package/README.md

@@ -14,8 +14,8 @@ The following configuration modules are available:
 - ✅ Json
 - ✅ Import
 - ✅ React
-- JSONC is enabled by default and can be disabled with `json: false`.
-- TypeScript, imports, React, and gitignore support are opt-in.
+- JSONC and imports are enabled by default and can be disabled with `json: false` and `imports: false`.
+- TypeScript, React, and gitignore support are opt-in.
 
 # Usage
 
@@ -24,10 +24,10 @@ The following configuration modules are available:
 Install the core package and its core ESLint peers:
 
 ```bash
-pnpm add -D @chanyuxi/eslint-waltz eslint @eslint/js @stylistic/eslint-plugin eslint-plugin-jsonc jsonc-eslint-parser globals
+pnpm add -D @chanyuxi/eslint-waltz eslint @eslint/js @stylistic/eslint-plugin eslint-plugin-jsonc eslint-plugin-import jsonc-eslint-parser globals
 ```
 
-Install the peer packages for any optional modules you enable, such as `typescript-eslint`, `eslint-plugin-import`, or the React ESLint plugins.
+Install the peer packages for any optional modules you enable, such as `typescript-eslint` or the React ESLint plugins.
 
 #### Configuration
 
@@ -37,10 +37,9 @@ Create a `eslint.config.ts` file in the project root directory and configure it
 import waltz from '@chanyuxi/eslint-waltz'
 
 export default waltz({
-  // JSONC is enabled by default
+  // JSONC and imports are enabled by default
   json: true,
   ts: true,
-  imports: true,
   react: true,
   js: { globals: ['browser'] },
 })
@@ -57,14 +56,14 @@ export default waltz({}, {
 })
 ```
 
-Run `pnpm run check` before committing. `pnpm pack` and `npm publish` build the package automatically through the `prepack` lifecycle.
-
-#### VS Code synchronization
-
-After installing the package, run this command from your project root:
-
-```bash
-npx eslint-waltz sync-vscode
-```
-
-It creates or updates `.vscode/settings.json` with ESLint fix-on-save settings while preserving other settings and JSONC comments.
+Run `pnpm run check` before committing. `pnpm pack` and `npm publish` build the package automatically through the `prepack` lifecycle.
+
+#### VS Code synchronization
+
+After installing the package, run this command from your project root:
+
+```bash
+npx eslint-waltz sync-vscode
+```
+
+It creates or updates `.vscode/settings.json` with ESLint fix-on-save settings while preserving other settings and JSONC comments.

package/dist/cli.js

@@ -1509,10 +1509,10 @@ async function syncVSCodeSettings(cwd = process.cwd()) {
 }
 
 function printHelp() {
-    console.log(`Usage: eslint-waltz <command>
-
-Commands:
-  sync-vscode  Create or update .vscode/settings.json for ESLint fix-on-save
+    console.log(`Usage: eslint-waltz <command>
+
+Commands:
+  sync-vscode  Create or update .vscode/settings.json for ESLint fix-on-save
 `);
 }
 async function main() {

package/dist/index.d.ts

@@ -5031,15 +5031,27 @@ type Arraiable<T> = T | Array<T>;
 type UnresolvedLinterConfig = Arraiable<LinterConfig> | Promise<Arraiable<LinterConfig>>;
 interface SharedOptions {
     /**
-     * Each configuration automatically lints all corresponding files, this option is used to override
+     * Restrict this module's configuration to the specified files.
+     *
+     * Each module has its own default file pattern. Providing this option
+     * replaces that pattern; it does not add another pattern to the default.
      */
     files?: Linter.Config['files'];
     /**
-     * Rewrite rules
+     * Override rules within this module's file scope.
+     *
+     * Rule names are not restricted to the plugin used by this module, so core
+     * ESLint rules and rules from other configured plugins can also be set here.
      */
     overrides?: LinterConfig['rules'];
 }
 interface JsOptions extends SharedOptions {
+    /**
+     * Add predefined global variables to JavaScript files.
+     *
+     * Values must be names exported by the `globals` package, such as `browser`
+     * or `node`.
+     */
     globals?: (keyof typeof globals)[];
 }
 type TsOptions = SharedOptions;
@@ -5049,46 +5061,86 @@ type ImportsOptions = SharedOptions;
 type ReactOptions = SharedOptions;
 interface WaltzOptions {
     /**
-     * Treat the .gitignore file as a global ignore
+     * Treat patterns from `.gitignore` as global ESLint ignores.
+     *
+     * Pass an options object to customize `eslint-config-flat-gitignore`, or
+     * use `true` to enable its strict mode with the default options.
      *
      * @default false
      * @see https://github.com/antfu/eslint-config-flat-gitignore
      */
     gitignore?: boolean | FlatGitignoreOptions;
     /**
-     * Set lint configs and default to the recommended configuration of `@eslint/js`
+     * Configure the core ESLint rules for JavaScript files.
+     *
+     * The JavaScript configuration is always included. It targets JavaScript
+     * files, including JSX files, by default. Use `files`, `globals`, and
+     * `overrides` to adjust its scope and rules.
      *
      * @default {}
      * @see https://github.com/eslint/eslint.git
      */
     js?: JsOptions;
     /**
-     * Enable TypeScript support and default to the recommended configuration of `typescript-eslint`
+     * Enable TypeScript support for TypeScript files.
+     *
+     * `true` enables the TypeScript parser and the recommended
+     * `typescript-eslint` rules. By default, this applies to `.ts`, `.tsx`,
+     * `.mts`, and `.cts` files, including their JSX variants. Passing an
+     * options object additionally allows the TypeScript file scope and rules to
+     * be customized with `files` and `overrides`.
+     *
+     * When enabled, the default stylistic, import, and React configurations also
+     * include TypeScript files when those configurations are enabled.
      *
      * @default false
      * @see https://typescript-eslint.io/linting/configs/#recommended-config
      */
     ts?: boolean | TsOptions;
     /**
-     * Set lint configs
+     * Configure stylistic rules for script files.
+     *
+     * This configuration is always enabled and uses `@stylistic/eslint-plugin`.
+     * It targets JavaScript files by default, and also targets TypeScript files
+     * when `ts` is enabled. The JSX prop-sorting rule is enabled in addition to
+     * the plugin's customized rules.
      *
      * @default {}
+     * @see https://eslint.style/
      */
     stylistic?: StylisticOptions;
     /**
-     * Enable JSON/JSONC rules
+     * Enable linting for JSON, JSON5, and JSONC files.
+     *
+     * The default configuration also sorts keys in `package.json` and
+     * TypeScript configuration files. Pass an options object to change the file
+     * scope or override rules.
      *
      * @default true
+     * @see https://github.com/ota-meshi/eslint-plugin-jsonc
      */
     json?: boolean | JsoncOptions;
     /**
-     * Enable import rules
+     * Enable rules for validating and ordering imports and exports.
      *
-     * @default false
+     * This configuration is enabled by default. JavaScript files are included
+     * by default, and the scope also includes TypeScript files when `ts` is
+     * enabled. Set this option to `false` to disable it, or pass an options
+     * object to change the file scope or override rules.
+     *
+     * @default true
+     * @see https://github.com/import-js/eslint-plugin-import
      */
     imports?: boolean | ImportsOptions;
     /**
+     * Enable React-specific lint rules.
+     *
+     * JavaScript and JSX files are included by default. When `ts` is enabled,
+     * TypeScript and TSX files are included as well. Pass an options object to
+     * change the file scope or override rules.
+     *
      * @default false
+     * @see https://github.com/Rel1cx/eslint-react
      */
     react?: boolean | ReactOptions;
 }

package/dist/index.js

@@ -456,6 +456,73 @@ async function stylisticConfig(options = {}, relative) {
         : [JS_FILES];
     // Directly use the generated recommendation rules
     const configs = eslintStylistic.configs.customize();
+    // This will enable the following rules.
+    // '@stylistic/array-bracket-spacing'
+    // '@stylistic/arrow-parens'
+    // '@stylistic/arrow-spacing'
+    // '@stylistic/block-spacing'
+    // '@stylistic/brace-style'
+    // '@stylistic/comma-dangle'
+    // '@stylistic/comma-spacing'
+    // '@stylistic/comma-style'
+    // '@stylistic/computed-property-spacing'
+    // '@stylistic/dot-location'
+    // '@stylistic/eol-last'
+    // '@stylistic/generator-star-spacing'
+    // '@stylistic/indent'
+    // '@stylistic/indent-binary-ops'
+    // '@stylistic/key-spacing'
+    // '@stylistic/keyword-spacing'
+    // '@stylistic/lines-between-class-members'
+    // '@stylistic/max-statements-per-line'
+    // '@stylistic/member-delimiter-style'
+    // '@stylistic/multiline-ternary'
+    // '@stylistic/new-parens'
+    // '@stylistic/no-extra-parens'
+    // '@stylistic/no-floating-decimal'
+    // '@stylistic/no-mixed-operators'
+    // '@stylistic/no-mixed-spaces-and-tabs'
+    // '@stylistic/no-multi-spaces'
+    // '@stylistic/no-multiple-empty-lines'
+    // '@stylistic/no-tabs'
+    // '@stylistic/no-trailing-spaces'
+    // '@stylistic/no-whitespace-before-property'
+    // '@stylistic/object-curly-spacing'
+    // '@stylistic/operator-linebreak'
+    // '@stylistic/padded-blocks'
+    // '@stylistic/quote-props'
+    // '@stylistic/quotes'
+    // '@stylistic/rest-spread-spacing'
+    // '@stylistic/semi'
+    // '@stylistic/semi-spacing'
+    // '@stylistic/space-before-blocks'
+    // '@stylistic/space-before-function-paren'
+    // '@stylistic/space-in-parens'
+    // '@stylistic/space-infix-ops'
+    // '@stylistic/space-unary-ops'
+    // '@stylistic/spaced-comment'
+    // '@stylistic/template-curly-spacing'
+    // '@stylistic/template-tag-spacing'
+    // '@stylistic/type-annotation-spacing'
+    // '@stylistic/type-generic-spacing'
+    // '@stylistic/type-named-tuple-spacing'
+    // '@stylistic/wrap-iife'
+    // '@stylistic/yield-star-spacing'
+    // '@stylistic/jsx-closing-bracket-location'
+    // '@stylistic/jsx-closing-tag-location'
+    // '@stylistic/jsx-curly-brace-presence'
+    // '@stylistic/jsx-curly-newline'
+    // '@stylistic/jsx-curly-spacing'
+    // '@stylistic/jsx-equals-spacing'
+    // '@stylistic/jsx-first-prop-new-line'
+    // '@stylistic/jsx-function-call-newline'
+    // '@stylistic/jsx-indent-props'
+    // '@stylistic/jsx-max-props-per-line'
+    // '@stylistic/jsx-one-expression-per-line'
+    // '@stylistic/jsx-quotes'
+    // '@stylistic/jsx-sort-props'
+    // '@stylistic/jsx-tag-spacing'
+    // '@stylistic/jsx-wrap-multilines'
     return [
         {
             name: 'waltz/stylistic/setup',
@@ -469,6 +536,7 @@ async function stylisticConfig(options = {}, relative) {
             files: options.files ?? scriptFiles,
             rules: {
                 ...configs.rules,
+                '@stylistic/jsx-sort-props': 'error',
                 ...options.overrides,
             },
         },
@@ -655,8 +723,10 @@ async function waltz(options = {}, ...orders) {
     if (isEnableTypeScript) {
         configs.push(tsConfig(options.ts));
     }
-    if (options.imports) {
-        configs.push(importsConfig(isEnableTypeScript, options.imports === true ? {} : options.imports));
+    if (options.imports !== false) {
+        configs.push(importsConfig(isEnableTypeScript, options.imports === true || options.imports === undefined
+            ? {}
+            : options.imports));
     }
     if (isEnableReact) {
         configs.push(reactConfig(options.react, {

package/package.json

@@ -1,139 +1,136 @@
-{
-  "name": "@chanyuxi/eslint-waltz",
-  "type": "module",
-  "version": "0.1.0",
-  "packageManager": "pnpm@10.4.1",
-  "description": "A composable ESLint flat config for JavaScript, TypeScript, JSONC, imports, and React.",
-  "author": "chanyuxi <2438149743@qq.com> (https://github.com/chanyuxi)",
-  "license": "ISC",
-  "homepage": "https://github.com/chanyuxi/eslint-waltz",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/chanyuxi/eslint-waltz.git"
-  },
-  "bugs": {
-    "url": "https://github.com/chanyuxi/eslint-waltz/issues"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "keywords": [
-    "chanyuxi",
-    "eslint",
-    "config",
-    "integration"
-  ],
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "default": "./dist/index.js"
-    }
-  },
-  "bin": {
-    "eslint-waltz": "./dist/cli.js"
-  },
-  "files": [
-    "dist"
-  ],
-  "engines": {
-    "node": ">=18.18.0"
-  },
-  "scripts": {
-    "build": "rimraf ./dist && pnpm gen && rollup -c rollup.config.ts --configPlugin @rollup/plugin-typescript",
-    "gen": "tsx scripts/typegen.ts",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "typeCheck": "pnpm gen && tsc --noEmit",
-    "test": "node --import tsx test/index.ts",
-    "check": "pnpm run typeCheck && pnpm run lint && pnpm run test",
-    "changeset": "changeset",
-    "version": "changeset version && pnpm install --lockfile-only",
-    "release": "pnpm build && changeset publish",
-    "prepack": "pnpm build",
-    "prepare": "husky"
-  },
-  "peerDependencies": {
-    "@eslint/js": "^9.32.0",
-    "@stylistic/eslint-plugin": "^5.2.2",
-    "eslint": "^9.32.0",
-    "eslint-config-flat-gitignore": "^2.1.0",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jsonc": "^2.20.1",
-    "eslint-plugin-react-debug": "^1.52.3",
-    "eslint-plugin-react-dom": "^1.52.3",
-    "eslint-plugin-react-hooks-extra": "^1.52.3",
-    "eslint-plugin-react-naming-convention": "^1.52.3",
-    "eslint-plugin-react-web-api": "^1.52.3",
-    "eslint-plugin-react-x": "^1.52.3",
-    "globals": "^16.3.0",
-    "jsonc-eslint-parser": "^2.4.0",
-    "typescript-eslint": "^8.38.0"
-  },
-  "peerDependenciesMeta": {
-    "eslint-config-flat-gitignore": {
-      "optional": true
-    },
-    "eslint-plugin-import": {
-      "optional": true
-    },
-    "eslint-plugin-react-debug": {
-      "optional": true
-    },
-    "eslint-plugin-react-dom": {
-      "optional": true
-    },
-    "eslint-plugin-react-hooks-extra": {
-      "optional": true
-    },
-    "eslint-plugin-react-naming-convention": {
-      "optional": true
-    },
-    "eslint-plugin-react-web-api": {
-      "optional": true
-    },
-    "eslint-plugin-react-x": {
-      "optional": true
-    },
-    "typescript-eslint": {
-      "optional": true
-    }
-  },
-  "dependencies": {
-    "jsonc-parser": "^3.3.1"
-  },
-  "devDependencies": {
-    "@changesets/cli": "^3.0.2",
-    "@commitlint/cli": "^19.8.1",
-    "@commitlint/config-conventional": "^19.8.1",
-    "@commitlint/types": "^19.8.1",
-    "@eslint/js": "^9.32.0",
-    "@rollup/plugin-commonjs": "^28.0.6",
-    "@rollup/plugin-node-resolve": "^16.0.1",
-    "@rollup/plugin-typescript": "^12.1.4",
-    "@stylistic/eslint-plugin": "^5.2.2",
-    "@types/node": "^24.1.0",
-    "eslint": "^9.32.0",
-    "eslint-config-flat-gitignore": "^2.1.0",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jsonc": "^2.20.1",
-    "eslint-plugin-react-debug": "^1.52.3",
-    "eslint-plugin-react-dom": "^1.52.3",
-    "eslint-plugin-react-hooks-extra": "^1.52.3",
-    "eslint-plugin-react-naming-convention": "^1.52.3",
-    "eslint-plugin-react-web-api": "^1.52.3",
-    "eslint-plugin-react-x": "^1.52.3",
-    "eslint-typegen": "^2.3.0",
-    "globals": "^16.3.0",
-    "husky": "^9.1.7",
-    "jiti": "^2.5.1",
-    "jsonc-eslint-parser": "^2.4.0",
-    "rimraf": "^6.0.1",
-    "rollup": "^4.46.2",
-    "rollup-plugin-dts": "^6.2.1",
-    "tslib": "^2.8.1",
-    "tsx": "^4.20.3",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.38.0"
-  }
-}
+{
+  "name": "@chanyuxi/eslint-waltz",
+  "type": "module",
+  "version": "0.1.1",
+  "packageManager": "pnpm@10.4.1",
+  "description": "A composable ESLint flat config for JavaScript, TypeScript, JSONC, imports, and React.",
+  "author": "chanyuxi <2438149743@qq.com> (https://github.com/chanyuxi)",
+  "license": "ISC",
+  "homepage": "https://github.com/chanyuxi/eslint-waltz",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/chanyuxi/eslint-waltz.git"
+  },
+  "bugs": {
+    "url": "https://github.com/chanyuxi/eslint-waltz/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "chanyuxi",
+    "eslint",
+    "config",
+    "integration"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "eslint-waltz": "./dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18.18.0"
+  },
+  "scripts": {
+    "build": "rimraf ./dist && pnpm gen && rollup -c rollup.config.ts --configPlugin @rollup/plugin-typescript",
+    "gen": "tsx scripts/typegen.ts",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "typeCheck": "pnpm gen && tsc --noEmit",
+    "test": "node --import tsx test/index.ts",
+    "check": "pnpm run typeCheck && pnpm run lint && pnpm run test",
+    "changeset": "changeset",
+    "version": "changeset version && pnpm install --lockfile-only",
+    "release": "pnpm build && changeset publish",
+    "prepack": "pnpm build",
+    "prepare": "husky"
+  },
+  "peerDependencies": {
+    "@eslint/js": "^9.32.0",
+    "@stylistic/eslint-plugin": "^5.2.2",
+    "eslint": "^9.32.0",
+    "eslint-config-flat-gitignore": "^2.1.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsonc": "^2.20.1",
+    "eslint-plugin-react-debug": "^1.52.3",
+    "eslint-plugin-react-dom": "^1.52.3",
+    "eslint-plugin-react-hooks-extra": "^1.52.3",
+    "eslint-plugin-react-naming-convention": "^1.52.3",
+    "eslint-plugin-react-web-api": "^1.52.3",
+    "eslint-plugin-react-x": "^1.52.3",
+    "globals": "^16.3.0",
+    "jsonc-eslint-parser": "^2.4.0",
+    "typescript-eslint": "^8.38.0"
+  },
+  "peerDependenciesMeta": {
+    "eslint-config-flat-gitignore": {
+      "optional": true
+    },
+    "eslint-plugin-react-debug": {
+      "optional": true
+    },
+    "eslint-plugin-react-dom": {
+      "optional": true
+    },
+    "eslint-plugin-react-hooks-extra": {
+      "optional": true
+    },
+    "eslint-plugin-react-naming-convention": {
+      "optional": true
+    },
+    "eslint-plugin-react-web-api": {
+      "optional": true
+    },
+    "eslint-plugin-react-x": {
+      "optional": true
+    },
+    "typescript-eslint": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "jsonc-parser": "^3.3.1"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^3.0.2",
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@commitlint/types": "^19.8.1",
+    "@eslint/js": "^9.32.0",
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "@stylistic/eslint-plugin": "^5.2.2",
+    "@types/node": "^24.1.0",
+    "eslint": "^9.32.0",
+    "eslint-config-flat-gitignore": "^2.1.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsonc": "^2.20.1",
+    "eslint-plugin-react-debug": "^1.52.3",
+    "eslint-plugin-react-dom": "^1.52.3",
+    "eslint-plugin-react-hooks-extra": "^1.52.3",
+    "eslint-plugin-react-naming-convention": "^1.52.3",
+    "eslint-plugin-react-web-api": "^1.52.3",
+    "eslint-plugin-react-x": "^1.52.3",
+    "eslint-typegen": "^2.3.0",
+    "globals": "^16.3.0",
+    "husky": "^9.1.7",
+    "jiti": "^2.5.1",
+    "jsonc-eslint-parser": "^2.4.0",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.46.2",
+    "rollup-plugin-dts": "^6.2.1",
+    "tslib": "^2.8.1",
+    "tsx": "^4.20.3",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.38.0"
+  }
+}