@chanyuxi/eslint-waltz 0.0.0-alpha.2 → 0.0.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,24 @@ 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.

package/dist/index.d.ts

@@ -5027,6 +5027,8 @@ type Rules = Record<string, Linter.RuleEntry | undefined> & RuleOptions;
 interface LinterConfig extends Omit<Linter.Config, 'rules'> {
     rules?: Rules;
 }
+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
@@ -5034,7 +5036,7 @@ interface SharedOptions {
     files?: Linter.Config['files'];
     /**
      * Rewrite rules
-    */
+     */
     overrides?: LinterConfig['rules'];
 }
 interface JsOptions extends SharedOptions {
@@ -5043,6 +5045,7 @@ interface JsOptions extends SharedOptions {
 type TsOptions = SharedOptions;
 type StylisticOptions = SharedOptions;
 type JsoncOptions = SharedOptions;
+type ImportsOptions = SharedOptions;
 type ReactOptions = SharedOptions;
 interface WaltzOptions {
     /**
@@ -5073,19 +5076,24 @@ interface WaltzOptions {
      */
     stylistic?: StylisticOptions;
     /**
+     * Enable JSON/JSONC rules
      *
+     * @default true
      */
     json?: boolean | JsoncOptions;
     /**
+     * Enable import rules
      *
+     * @default false
      */
-    imports?: boolean;
+    imports?: boolean | ImportsOptions;
     /**
      * @default false
      */
     react?: boolean | ReactOptions;
 }
 
-declare function waltz(options?: WaltzOptions, ...orders: LinterConfig[]): Promise<FlatArray<LinterConfig | LinterConfig[], 0 | 1 | -1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20>[]>;
+declare function waltz(options?: WaltzOptions, ...orders: LinterConfig[]): Promise<LinterConfig[]>;
 
 export { waltz as default };
+export type { ImportsOptions, JsOptions, JsoncOptions, LinterConfig, ReactOptions, SharedOptions, StylisticOptions, TsOptions, UnresolvedLinterConfig, WaltzOptions };