@chanyuxi/eslint-waltz 0.0.0-alpha.2 → 0.1.0

package/README.md

@@ -1,12 +1,12 @@
 # Introduction
 
-👋 A <b>fast eslint config boot</b> for `chanyuxi`.
+👋 A composable ESLint flat config for JavaScript, TypeScript, JSONC, imports, and React.
 
-😘 Thanks for [@antfu/eslint-config](https://github.com/antfu/eslint-config)
+Inspired by [@antfu/eslint-config](https://github.com/antfu/eslint-config).
 
 # Features
 
-At present, the following modes are supported, and more features are under development
+The following configuration modules are available:
 
 - ✅ Javascript
 - ✅ Typescript
@@ -14,17 +14,20 @@ At present, the following modes are supported, and more features are under devel
 - ✅ Json
 - ✅ Import
 - ✅ React
-- 🕐 <i>Continuously updating...</i>
+- JSONC is enabled by default and can be disabled with `json: false`.
+- TypeScript, imports, React, and gitignore support are opt-in.
 
 # Usage
 
 #### Install
 
-Install from `npm` | `pnpm` | `yarn`
+Install the core package and its core ESLint peers:
 
 ```bash
-npm i -D @chanyuxi/eslint-waltz
-```        
+pnpm add -D @chanyuxi/eslint-waltz eslint @eslint/js @stylistic/eslint-plugin eslint-plugin-jsonc 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.
 
 #### Configuration
 
@@ -34,7 +37,34 @@ Create a `eslint.config.ts` file in the project root directory and configure it
 import waltz from '@chanyuxi/eslint-waltz'
 
 export default waltz({
-    // enable typescript lint
-    ts: true,
+  // JSONC is enabled by default
+  json: true,
+  ts: true,
+  imports: true,
+  react: true,
+  js: { globals: ['browser'] },
+})
+```
+
+Every module accepts `files` and `overrides` where applicable. Custom flat configs can be appended after the options:
+
+```ts
+export default waltz({}, {
+  files: ['src/**/*.js'],
+  rules: {
+    'no-console': 'off',
+  },
 })
 ```
+
+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.