@chanyuxi/eslint-waltz 1.1.0 → 1.1.1

package/README.md

@@ -19,7 +19,7 @@ The following configuration modules are available:
 - JSONC and imports are enabled by default and can be disabled with `json: false` and `imports: false`.
 - TypeScript, React, Tailwind CSS, and gitignore support are opt-in.
 
-The `stylistic` configuration is always enabled. Perfectionist is enabled by default with JSX prop sorting.
+The `stylistic` configuration is always enabled. Perfectionist is enabled by default with the `recommended-alphabetical` preset.
 
 # Usage
 
@@ -33,7 +33,7 @@ pnpm add -D @chanyuxi/eslint-waltz eslint @eslint/js @stylistic/eslint-plugin es
 
 Install the peer packages for any optional modules you enable, such as `typescript-eslint`, `eslint-plugin-tailwindcss`, `tailwindcss`, or the React ESLint plugins.
 
-Perfectionist's `sort-jsx-props` rule is enabled by default for JSX props. Use `perfectionist: { preset: 'recommended-alphabetical' }` to enable its full recommended preset. ESLint 10 and the current integrations require Node.js `>=20.19.0`.
+Perfectionist uses the `recommended-alphabetical` preset by default. Use `perfectionist: { preset: 'recommended-custom' }`, `recommended-line-length`, or `recommended-natural` to select another recommended preset. ESLint 10 and the current integrations require Node.js `>=20.19.0`.
 
 Tailwind CSS support targets `eslint-plugin-tailwindcss` 4.x and Tailwind CSS 4.x. Node.js `>=20.19.0` is required when the Tailwind CSS module is enabled.
 

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import globals from 'globals';
 import { Linter } from 'eslint';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { PluginSettings } from 'eslint-plugin-tailwindcss';
+import globals from 'globals';
 
 /* eslint-disable */
 /* prettier-ignore */
@@ -9886,8 +9886,8 @@ interface PerfectionistOptions extends SharedOptions {
     /**
      * Select one of Perfectionist's full recommended presets.
      *
-     * Without a preset, only `perfectionist/sort-jsx-props` is enabled by
-     * default. A preset enables all of the plugin's sorting rules.
+     * Without a preset, the `recommended-alphabetical` preset is enabled by
+     * default. A preset selects one of the plugin's recommended presets.
      */
     preset?: PerfectionistPreset;
     /**
@@ -9942,7 +9942,8 @@ interface WaltzOptions {
      */
     gitignore?: boolean | FlatGitignoreOptions;
     /**
-     * Enable rules for validating and ordering imports and exports.
+     * Enable rules for validating imports and exports. Import ordering is
+     * provided by Perfectionist when enabled, and by `imports/order` otherwise.
      *
      * This configuration is enabled by default. JavaScript files are included
      * by default, and the scope also includes TypeScript files when `ts` is
@@ -9968,8 +9969,9 @@ interface WaltzOptions {
      * 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.
+     * TypeScript configuration files. Passing `files` changes the scope of the
+     * general JSON rules; the specialized file sorting remains targeted to
+     * those file names.
      *
      * @default true
      * @see https://github.com/ota-meshi/eslint-plugin-jsonc
@@ -9978,9 +9980,9 @@ interface WaltzOptions {
     /**
      * Configure Perfectionist sorting rules.
      *
-     * This configuration is enabled by default with
-     * `perfectionist/sort-jsx-props`. Set it to `false` to disable it, or pass
-     * a `preset` to enable one of the full recommended configurations.
+     * This configuration is enabled by default with the
+     * `recommended-alphabetical` preset. Set it to `false` to disable it, or
+     * pass a `preset` to select one of the recommended configurations.
      *
      * @default true
      * @see https://perfectionist.dev/configs

package/dist/index.js

@@ -72,10 +72,56 @@ const TS_FILES = '**/*.?([cm])ts?(x)';
 const JSON_FILES = '**/*.{json,json5,jsonc}';
 const ALL_SCRIPTS_FILES = [JS_FILES, TS_FILES];
 
-async function importsConfig(isEnableTypeScript = false, options = {}) {
+async function importsConfig(isEnableTypeScript = false, options = {}, relative = {}) {
     const importsPlugin = await importImportXPlugin();
     const scriptFiles = isEnableTypeScript ? ALL_SCRIPTS_FILES : [JS_FILES];
     const files = options.files ?? scriptFiles;
+    const { 'imports/order': orderOverride, ...overrides } = options.overrides ?? {};
+    const orderRules = {
+        'imports/order': orderOverride ?? [
+            'error',
+            {
+                'alphabetize': {
+                    caseInsensitive: true,
+                    order: 'asc',
+                    orderImportKind: 'asc',
+                },
+                'distinctGroup': false,
+                'groups': [
+                    'builtin',
+                    'external',
+                    'parent',
+                    'sibling',
+                    'index',
+                    'type',
+                    ['object', 'unknown'],
+                ],
+                'named': true,
+                'newlines-between': 'always',
+                'pathGroups': [
+                    {
+                        group: 'internal',
+                        pattern: '@/**',
+                        position: 'before',
+                    },
+                    {
+                        group: 'unknown',
+                        pattern: '*.{css,scss,less}',
+                        patternOptions: { matchBase: true },
+                        position: 'after',
+                    },
+                    {
+                        group: 'unknown',
+                        pattern: '*.{svg,png,jpg,gif,webp}',
+                        patternOptions: { matchBase: true },
+                        position: 'after',
+                    },
+                ],
+                'pathGroupsExcludedImportTypes': ['builtin'],
+                'warnOnUnassignedImports': true,
+            },
+        ],
+    };
     return [
         {
             files,
@@ -95,52 +141,17 @@ async function importsConfig(isEnableTypeScript = false, options = {}) {
                 'imports/no-duplicates': 'warn',
                 'imports/no-named-as-default': 'warn',
                 'imports/no-named-as-default-member': 'warn',
-                'imports/order': [
-                    'error',
-                    {
-                        'groups': [
-                            'builtin',
-                            'external',
-                            'parent',
-                            'sibling',
-                            'index',
-                            'type',
-                            ['object', 'unknown'],
-                        ],
-                        'pathGroups': [
-                            {
-                                pattern: '@/**',
-                                group: 'internal',
-                                position: 'before',
-                            },
-                            {
-                                pattern: '*.{css,scss,less}',
-                                group: 'unknown',
-                                patternOptions: { matchBase: true },
-                                position: 'after',
-                            },
-                            {
-                                pattern: '*.{svg,png,jpg,gif,webp}',
-                                group: 'unknown',
-                                patternOptions: { matchBase: true },
-                                position: 'after',
-                            },
-                        ],
-                        'pathGroupsExcludedImportTypes': ['builtin'],
-                        'newlines-between': 'always',
-                        'alphabetize': {
-                            order: 'asc',
-                            caseInsensitive: true,
-                            orderImportKind: 'asc',
-                        },
-                        'named': true,
-                        'warnOnUnassignedImports': true,
-                        'distinctGroup': false,
-                    },
-                ],
-                ...options.overrides,
+                ...overrides,
             },
         },
+        {
+            files,
+            ...(relative.perfectionistFiles
+                ? { ignores: relative.perfectionistFiles }
+                : {}),
+            name: 'waltz/imports/order',
+            rules: orderRules,
+        },
     ];
 }
 
@@ -175,14 +186,17 @@ async function jsoncConfig(options = {}) {
         importJsoncParser(),
     ]);
     const files = options.files ?? [JSON_FILES];
-    const packageJsonFiles = options.files ?? ['**/package.json'];
-    const tsconfigFiles = options.files ?? [
+    const packageJsonFiles = ['**/package.json'];
+    const tsconfigFiles = [
         '**/[jt]sconfig.json',
         '**/[jt]sconfig.*.json',
     ];
+    const setupFiles = options.files
+        ? [...options.files, ...packageJsonFiles, ...tsconfigFiles]
+        : files;
     return [
         {
-            files,
+            files: setupFiles,
             languageOptions: {
                 parser: jsoncParser,
             },
@@ -460,21 +474,19 @@ async function perfectionistConfig(options = {}, relative) {
     const scriptFiles = relative.isEnableTypeScript
         ? ALL_SCRIPTS_FILES
         : [JS_FILES];
-    const recommendedRules = options.preset
-        ? perfectionist.configs[options.preset].rules ?? {}
-        : {
-            'perfectionist/sort-jsx-props': 'error',
-        };
+    const ruleFiles = options.files ?? scriptFiles;
+    const preset = options.preset ?? 'recommended-alphabetical';
+    const recommendedRules = perfectionist.configs[preset].rules ?? {};
     return [
         {
-            files: scriptFiles,
+            files: ruleFiles,
             name: 'waltz/perfectionist/setup',
             plugins: {
                 perfectionist,
             },
         },
         {
-            files: options.files ?? scriptFiles,
+            files: ruleFiles,
             name: 'waltz/perfectionist/rules',
             ...(options.settings ? { settings: options.settings } : {}),
             rules: {
@@ -499,10 +511,15 @@ async function reactConfig(options = {}, relative) {
         ? ALL_SCRIPTS_FILES
         : [JS_FILES];
     const ruleFiles = resolvedConfig.files ?? scriptFiles;
+    const setupFiles = relative.isEnableTypeScript && resolvedConfig.files
+        ? [...resolvedConfig.files, TS_FILES]
+        : relative.isEnableTypeScript
+            ? scriptFiles
+            : ruleFiles;
     const typeScriptRules = relative.isEnableTypeScript
         ? [
             {
-                files: resolvedConfig.files ?? [TS_FILES],
+                files: [TS_FILES],
                 name: 'waltz/react/typescript-rules',
                 rules: {
                     '@eslint-react/dom/no-unknown-property': 'off',
@@ -513,7 +530,7 @@ async function reactConfig(options = {}, relative) {
         : [];
     return [
         {
-            files: scriptFiles,
+            files: setupFiles,
             name: 'waltz/react/setup',
             plugins: {
                 '@eslint-react': reactPlugin,
@@ -606,6 +623,7 @@ async function stylisticConfig(options = {}, relative) {
     const scriptFiles = relative.isEnableTypeScript
         ? ALL_SCRIPTS_FILES
         : [JS_FILES];
+    const ruleFiles = options.files ?? scriptFiles;
     // Directly use the generated recommendation rules
     const configs = eslintStylistic.configs.customize();
     // This will enable the following rules.
@@ -676,14 +694,14 @@ async function stylisticConfig(options = {}, relative) {
     // '@stylistic/jsx-wrap-multilines'
     return [
         {
-            files: scriptFiles,
+            files: ruleFiles,
             name: 'waltz/stylistic/setup',
             plugins: {
                 '@stylistic': eslintStylistic,
             },
         },
         {
-            files: options.files ?? scriptFiles,
+            files: ruleFiles,
             name: 'waltz/stylistic/rules',
             rules: {
                 ...configs.rules,
@@ -731,9 +749,10 @@ async function tsConfig(options = {}) {
         importTypeScriptRecommendedRules(),
     ]);
     const resolvedConfig = typeof options === 'boolean' ? {} : options;
+    const ruleFiles = resolvedConfig.files ?? [TS_FILES];
     return [
         {
-            files: [TS_FILES],
+            files: ruleFiles,
             languageOptions: {
                 parser: typeScriptParser,
             },
@@ -743,7 +762,7 @@ async function tsConfig(options = {}) {
             },
         },
         {
-            files: resolvedConfig.files ?? [TS_FILES],
+            files: ruleFiles,
             name: 'waltz/ts/rules',
             rules: {
                 ...recommendedRules,
@@ -756,6 +775,17 @@ async function tsConfig(options = {}) {
 async function waltz(options = {}, ...orders) {
     const isEnableTypeScript = !!options.ts;
     const isEnableReact = !!options.react;
+    const isEnablePerfectionist = options.perfectionist !== false;
+    const scriptFiles = isEnableTypeScript ? ALL_SCRIPTS_FILES : [JS_FILES];
+    const configuredPerfectionistFiles = typeof options.perfectionist === 'object'
+        ? options.perfectionist.files
+        : undefined;
+    const hasSimplePerfectionistFiles = configuredPerfectionistFiles?.every(file => typeof file === 'string');
+    const perfectionistFiles = isEnablePerfectionist
+        ? hasSimplePerfectionistFiles
+            ? configuredPerfectionistFiles
+            : scriptFiles
+        : undefined;
     const configs = [];
     if (options.gitignore) {
         configs.push(gitignore(options.gitignore));
@@ -775,7 +805,9 @@ async function waltz(options = {}, ...orders) {
     if (options.imports !== false) {
         configs.push(importsConfig(isEnableTypeScript, options.imports === true || options.imports === undefined
             ? {}
-            : options.imports));
+            : options.imports, {
+            perfectionistFiles,
+        }));
     }
     if (isEnableReact) {
         configs.push(reactConfig(options.react, {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@chanyuxi/eslint-waltz",
   "type": "module",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "packageManager": "pnpm@10.4.1",
   "description": "A composable ESLint flat config for JavaScript, TypeScript, JSONC, imports, React, Tailwind CSS, and Perfectionist.",
   "author": "chanyuxi <2438149743@qq.com> (https://github.com/chanyuxi)",
@@ -48,7 +48,7 @@
     "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",
+    "version": "changeset version && pnpm install --lockfile-only",
     "release": "pnpm build && changeset publish",
     "prepack": "pnpm build",
     "prepare": "husky"