@chanyuxi/eslint-waltz 0.1.0 → 1.0.0

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2026-present Chanyuxi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 # Introduction
 
-👋 A composable ESLint flat config for JavaScript, TypeScript, JSONC, imports, and React.
+👋 A composable ESLint flat config for JavaScript, TypeScript, JSONC, imports, React, Tailwind CSS, and Perfectionist.
 
 Inspired by [@antfu/eslint-config](https://github.com/antfu/eslint-config).
 
@@ -9,13 +9,17 @@ Inspired by [@antfu/eslint-config](https://github.com/antfu/eslint-config).
 The following configuration modules are available:
 
 - ✅ Javascript
-- ✅ Typescript
-- ✅ Stylistic
+- ✅ Typescript
+- ✅ Stylistic
+- ✅ Perfectionist
 - ✅ Json
 - ✅ Import
 - ✅ React
-- JSONC is enabled by default and can be disabled with `json: false`.
-- TypeScript, imports, React, and gitignore support are opt-in.
+- ✅ Tailwind CSS
+- 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.
 
 # Usage
 
@@ -24,10 +28,14 @@ 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-x eslint-plugin-perfectionist 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`, `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`.
+
+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.
 
 #### Configuration
 
@@ -37,11 +45,15 @@ 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,
+  tailwindcss: {
+    settings: {
+      tailwindcss: { cssConfigPath: './src/styles.css' },
+    },
+  },
   js: { globals: ['browser'] },
 })
 ```
@@ -57,14 +69,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() {