@chanyuxi/eslint-waltz 1.1.1 → 1.3.0

package/README.md

@@ -1,82 +1,106 @@
-# Introduction
+# @chanyuxi/eslint-waltz
 
-👋 A composable ESLint flat config for JavaScript, TypeScript, JSONC, imports, React, Tailwind CSS, and Perfectionist.
+Composable ESLint flat config for JavaScript, TypeScript, JSONC, React, Tailwind CSS, Perfectionist, and Vitest.
 
-Inspired by [@antfu/eslint-config](https://github.com/antfu/eslint-config).
+Requires Node.js `>=20.19.0`.
 
-# Features
+## Install
 
-The following configuration modules are available:
+Install the package, ESLint, and the peer dependencies used by the default configuration:
 
-- ✅ Javascript
-- ✅ Typescript
-- ✅ Stylistic
-- ✅ Perfectionist
-- ✅ Json
-- ✅ Import
-- ✅ React
-- ✅ 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 the `recommended-alphabetical` preset.
-
-# Usage
+```bash
+pnpm add -D @chanyuxi/eslint-waltz eslint eslint-plugin-jsonc eslint-plugin-import-x eslint-plugin-perfectionist jsonc-eslint-parser
+```
 
-#### Install
+`@eslint/js`, `@stylistic/eslint-plugin`, `globals`, and `jsonc-parser` are included automatically.
 
-Install the core package and its core ESLint peers:
+Install peers only for the optional modules you enable:
 
 ```bash
-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
-```
+# TypeScript
+pnpm add -D typescript-eslint
 
-Install the peer packages for any optional modules you enable, such as `typescript-eslint`, `eslint-plugin-tailwindcss`, `tailwindcss`, or the React ESLint plugins.
-
-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`.
+# React
+pnpm add -D eslint-plugin-react-x eslint-plugin-react-debug eslint-plugin-react-dom eslint-plugin-react-hooks-extra eslint-plugin-react-naming-convention eslint-plugin-react-web-api
 
-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.
+# Tailwind CSS
+pnpm add -D eslint-plugin-tailwindcss tailwindcss
 
-#### Configuration
+# .gitignore support
+pnpm add -D eslint-config-flat-gitignore
+
+# Vitest
+pnpm add -D @vitest/eslint-plugin vitest
+```
 
-Create a `eslint.config.ts` file in the project root directory and configure it as follows:
+## Usage
 
 ```ts
+// eslint.config.ts
 import waltz from '@chanyuxi/eslint-waltz'
 
 export default waltz({
-  // JSONC and imports are enabled by default
-  json: true,
   ts: true,
   react: true,
-  tailwindcss: {
-    settings: {
-      tailwindcss: { cssConfigPath: './src/styles.css' },
-    },
-  },
-  js: { globals: ['browser'] },
 })
 ```
 
-Every module accepts `files` and `overrides` where applicable. Custom flat configs can be appended after the options:
+Enabled by default:
 
-```ts
-export default waltz({}, {
-  files: ['src/**/*.js'],
-  rules: {
-    'no-console': 'off',
-  },
-})
-```
+- JavaScript and stylistic rules
+- JSONC rules
+- import validation
+- Perfectionist with `recommended-alphabetical`
 
-Run `pnpm run check` before committing. `pnpm pack` and `npm publish` build the package automatically through the `prepack` lifecycle.
+Optional: `ts`, `react`, `tailwindcss`, `gitignore`, and `vitest`.
 
-#### 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.
+More options are documented in the exported TypeScript types.
+
+The potentially expensive module-resolution rules are disabled by default. Enable
+them explicitly when your project needs them:
+
+```ts
+export default waltz({
+  imports: {
+    overrides: {
+      'imports/named': 'error',
+      'imports/namespace': 'error',
+    },
+  },
+})
+```
+
+## TypeScript file scope
+
+When `ts.files` is provided, it is the maximum TypeScript scope used by the
+other modules that automatically include TypeScript files. JavaScript files
+keep their normal scope, and a module's own `files` option can override this
+limit. Vitest additionally intersects its test-file patterns with this scope.
+
+```ts
+export default waltz({
+  ts: { files: ['src/**/*.ts'] },
+  react: true,
+})
+```
+
+## VS Code synchronization
+
+Run this command from your project root to enable ESLint fix-on-save settings
+while preserving existing `.vscode/settings.json` values and comments:
+
+```bash
+npx eslint-waltz sync-vscode
+```
+
+React plugin settings can be customized when needed:
+
+```ts
+export default waltz({
+  react: {
+    settings: {
+      'react-x': { importSource: 'preact' },
+    },
+  },
+})
+```