@heyq02/rslint-config 0.0.1 → 0.0.3-beta.1

package/README.md

@@ -1,8 +1,12 @@
 # @heyq02/rslint-config
 
-[![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![Unit Test][unit-test-src]][unit-test-href]
+<!-- automd:badges license -->
+
+[![npm version](https://img.shields.io/npm/v/@heyq02/rslint-config)](https://npmjs.com/package/@heyq02/rslint-config)
+[![npm downloads](https://img.shields.io/npm/dm/@heyq02/rslint-config)](https://npm.chart.dev/@heyq02/rslint-config)
+[![license](https://img.shields.io/github/license/heyq02/rslint-config)](https://github.com/heyq02/rslint-config/blob/main/LICENSE)
+
+<!-- /automd -->
 
 Opinionated [Rslint](https://rslint.rs/) flat-config preset, structured like [`@sxzz/eslint-config`](https://github.com/sxzz/eslint-config) and built on `@rslint/core` native presets.
 
@@ -11,6 +15,8 @@ Opinionated [Rslint](https://rslint.rs/) flat-config preset, structured like [`@
 - One-line config via `heyq02()`
 - JavaScript + TypeScript presets (`recommended` / `strict` / type-checked / stylistic)
 - Built-in Unicorn, import, Node, and Promise rules
+- Import sorting via `import/order` with an [Oxfmt `sortImports`](https://oxc.rs/docs/guide/usage/formatter/sorting.html)-shaped API
+- Community plugins (Rslint-compatible): unused-imports, regexp, de-morgan, eslint-comments
 - Optional React, React Hooks, JSX a11y, Jest, and Rstest (auto-detected)
 - Ignores common build artifacts (`dist`, `coverage`, lockfiles, …)
 - Special-case overrides for CLIs, tests, config files, and components
@@ -27,7 +33,7 @@ pnpm add -D @heyq02/rslint-config @rslint/core
 
 ```ts
 // rslint.config.ts
-import { heyq02 } from "@heyq02/rslint-config";
+import { heyq02 } from '@heyq02/rslint-config';
 
 export default heyq02({
   // Features auto-detect installed packages when omitted
@@ -44,7 +50,7 @@ export default heyq02(
   { typescript: true },
   {
     rules: {
-      "no-console": "off",
+      'no-console': 'off',
     },
   },
 );
@@ -52,24 +58,72 @@ export default heyq02(
 
 ### Options
 
-| Option       | Default             | Description                                                             |
-| ------------ | ------------------- | ----------------------------------------------------------------------- |
-| `typescript` | auto (`typescript`) | `true` / `false` / `{ typeChecked, strict, stylistic, projectService }` |
-| `javascript` | `true`              | JavaScript recommended + opinionated rules                              |
-| `unicorn`    | `true`              | Unicorn recommended + overrides                                         |
-| `imports`    | `true`              | Import recommended + no-default-export, etc.                            |
-| `node`       | `true` (`module`)   | `true` / `'module'` / `'script'` / `'mixed'`                            |
-| `promise`    | `true`              | Promise recommended (relaxed for async/await)                           |
-| `react`      | auto (`react`)      | React + React Hooks (+ jsx-a11y)                                        |
-| `jsxA11y`    | with react          | JSX accessibility rules                                                 |
-| `jest`       | auto (`jest`)       | Jest recommended + style                                                |
-| `rstest`     | auto (`rstest`)     | Rstest recommended                                                      |
-| `ignores`    | `[]`                | Extra global ignore patterns                                            |
+| Option           | Default             | Description                                                                                   |
+| ---------------- | ------------------- | --------------------------------------------------------------------------------------------- |
+| `typescript`     | auto (`typescript`) | `true` / `false` / `{ typeChecked, strict, stylistic, projectService }`                       |
+| `javascript`     | `true`              | JavaScript recommended + opinionated rules                                                    |
+| `unicorn`        | `true`              | Unicorn recommended + overrides                                                               |
+| `imports`        | `true`              | Import recommended + no-default-export, etc.                                                  |
+| `sortImports`    | `true`              | `true` / `false` / Oxfmt-like `{ groups, newlinesBetween, customGroups, … }` → `import/order` |
+| `node`           | `true` (`module`)   | `true` / `'module'` / `'script'` / `'mixed'`                                                  |
+| `promise`        | `true`              | Promise recommended (relaxed for async/await)                                                 |
+| `react`          | auto (`react`)      | React + React Hooks (+ jsx-a11y)                                                              |
+| `jsxA11y`        | with react          | JSX accessibility rules                                                                       |
+| `jest`           | auto (`jest`)       | Jest recommended + style                                                                      |
+| `rstest`         | auto (`rstest`)     | Rstest recommended                                                                            |
+| `unusedImports`  | `true`              | `eslint-plugin-unused-imports` (autofix unused imports)                                       |
+| `regexp`         | `true`              | `eslint-plugin-regexp`                                                                        |
+| `deMorgan`       | `true`              | `eslint-plugin-de-morgan`                                                                     |
+| `eslintComments` | `true`              | `@eslint-community/eslint-plugin-eslint-comments`                                             |
+| `ignores`        | `[]`                | Extra global ignore patterns                                                                  |
+
+### Sort imports
+
+Enabled by default (when `imports` is on). Options mirror Oxfmt [`sortImports`](https://oxc.rs/docs/guide/usage/formatter/sorting.html) where Rslint can enforce them via [`import/order`](https://rslint.rs/rules/import/order):
+
+```ts
+export default heyq02({
+  sortImports: {
+    groups: [
+      'type',
+      ['builtin', 'external'],
+      'internal',
+      ['parent', 'sibling', 'index'],
+      'unknown',
+    ],
+    newlinesBetween: true,
+    internalPattern: ['~/', '@/', '#'],
+    customGroups: [
+      {
+        groupName: 'react-libs',
+        elementNamePattern: ['react', 'react-**'],
+        group: 'external',
+        position: 'before',
+      },
+    ],
+    order: 'asc',
+    ignoreCase: true,
+    named: true,
+  },
+});
+```
+
+| Oxfmt option                                | This package      | Notes                                                                                               |
+| ------------------------------------------- | ----------------- | --------------------------------------------------------------------------------------------------- |
+| `groups`                                    | `groups`          | Uses `import/order` names (`builtin`, `type`, …), not perfectionist selectors (`value-builtin`)     |
+| `newlinesBetween`                           | `newlinesBetween` | `boolean` → `always` / `never`; per-group `{ newlinesBetween }` markers unsupported                 |
+| `customGroups`                              | `customGroups`    | Mapped to `pathGroups` (`group` + `position` required conceptually; defaults `external` / `before`) |
+| `internalPattern`                           | `internalPattern` | Glob-like prefixes → `import/internal-regex`                                                        |
+| `order` / `ignoreCase`                      | same              | → `alphabetize`                                                                                     |
+| `sortSideEffects`                           | `sortSideEffects` | → `warnOnUnassignedImports`                                                                         |
+| `partitionByComment` / `partitionByNewline` | —                 | Not supported by `import/order`                                                                     |
+
+If Oxfmt already sorts imports, set `sortImports: false` to avoid fighting the formatter.
 
 ### Presets
 
 ```ts
-import { presetJavaScript, presetBasic, presetAll } from "@heyq02/rslint-config";
+import { presetJavaScript, presetBasic, presetAll } from '@heyq02/rslint-config';
 
 export default presetBasic();
 ```
@@ -77,21 +131,32 @@ export default presetBasic();
 ## Development
 
 ```bash
-vp install
-vp pack
-vp check
-pnpm release   # bumpp → tag v* → GitHub Release + npm publish
+pnpm install
+pnpm run build
+pnpm run lint
+pnpm run typecheck
+pnpm run format   # automd + vp fmt (Oxfmt via Vite+)
+pnpm run check    # format:check + rslint + tsc
+pnpm release      # bumpp → tag v* → GitHub Release + npm publish
 ```
 
 ## License
 
-[MIT](./LICENSE) © Ari
+<!-- automd:contributors license=MIT author="heyq02" -->
+
+Published under the [MIT](https://github.com/heyq02/rslint-config/blob/main/LICENSE) license.
+Made by [@heyq02](https://github.com/heyq02) and [community](https://github.com/heyq02/rslint-config/graphs/contributors) 💛
+<br><br>
+<a href="https://github.com/heyq02/rslint-config/graphs/contributors">
+<img src="https://contrib.rocks/image?repo=heyq02/rslint-config" />
+</a>
+
+<!-- /automd -->
+
+<!-- automd:with-automd -->
+
+---
 
-<!-- Badges -->
+_🤖 auto updated with [automd](https://automd.unjs.io)_
 
-[npm-version-src]: https://img.shields.io/npm/v/@heyq02/rslint-config.svg
-[npm-version-href]: https://npmjs.com/package/@heyq02/rslint-config
-[npm-downloads-src]: https://img.shields.io/npm/dm/@heyq02/rslint-config
-[npm-downloads-href]: https://www.npmcharts.com/compare/@heyq02/rslint-config?interval=30
-[unit-test-src]: https://github.com/heyq02/rslint-config/actions/workflows/unit-test.yml/badge.svg
-[unit-test-href]: https://github.com/heyq02/rslint-config/actions/workflows/unit-test.yml
+<!-- /automd -->

package/dist/configs/de-morgan.d.ts

@@ -0,0 +1,5 @@
+import type { TypedFlatConfig } from '../types.js';
+/**
+ * De Morgan rewrites via `eslint-plugin-de-morgan` (Rslint community plugin).
+ */
+export declare const deMorgan: () => TypedFlatConfig[];

package/dist/configs/eslint-comments.d.ts

@@ -0,0 +1,5 @@
+import type { TypedFlatConfig } from '../types.js';
+/**
+ * `eslint-disable` hygiene via `@eslint-community/eslint-plugin-eslint-comments`.
+ */
+export declare const eslintComments: () => TypedFlatConfig[];

package/dist/configs/ignores.d.ts

@@ -0,0 +1,2 @@
+import type { TypedFlatConfig } from '../types.js';
+export declare const ignores: (extra?: string[]) => TypedFlatConfig[];

package/dist/configs/imports.d.ts

@@ -0,0 +1,10 @@
+import type { SortImportsOptions, TypedFlatConfig } from '../types.js';
+export interface ImportsOptions {
+    typescript?: boolean;
+    /**
+     * Enable Oxfmt-shaped import sorting via `import/order`.
+     * @default true
+     */
+    sortImports?: boolean | SortImportsOptions;
+}
+export declare const imports: (options?: ImportsOptions) => TypedFlatConfig[];

package/dist/configs/index.d.ts

@@ -0,0 +1,16 @@
+export * from './de-morgan.js';
+export * from './eslint-comments.js';
+export * from './ignores.js';
+export * from './imports.js';
+export * from './javascript.js';
+export * from './jest.js';
+export * from './node.js';
+export * from './promise.js';
+export * from './react.js';
+export * from './regexp.js';
+export * from './rstest.js';
+export * from './sort-imports.js';
+export * from './special-cases.js';
+export * from './typescript.js';
+export * from './unicorn.js';
+export * from './unused-imports.js';

package/dist/configs/javascript.d.ts

@@ -0,0 +1,3 @@
+import type { TypedFlatConfig } from '../types.js';
+export declare const restrictedSyntaxJs: string[];
+export declare const javascript: () => TypedFlatConfig[];

package/dist/configs/jest.d.ts

@@ -0,0 +1,2 @@
+import type { TypedFlatConfig } from '../types.js';
+export declare const jest: () => TypedFlatConfig[];

package/dist/configs/node.d.ts

@@ -0,0 +1,2 @@
+import type { NodePreset, TypedFlatConfig } from '../types.js';
+export declare const node: (preset?: Exclude<NodePreset, false>) => TypedFlatConfig[];

package/dist/configs/promise.d.ts

@@ -0,0 +1,2 @@
+import type { TypedFlatConfig } from '../types.js';
+export declare const promise: () => TypedFlatConfig[];

package/dist/configs/react.d.ts

@@ -0,0 +1,5 @@
+import type { TypedFlatConfig } from '../types.js';
+export declare const jsxA11y: () => TypedFlatConfig[];
+export declare const react: (options?: {
+    jsxA11y?: boolean;
+}) => TypedFlatConfig[];

package/dist/configs/regexp.d.ts

@@ -0,0 +1,5 @@
+import type { TypedFlatConfig } from '../types.js';
+/**
+ * RegExp quality rules via `eslint-plugin-regexp` (Rslint community plugin).
+ */
+export declare const regexp: () => TypedFlatConfig[];

package/dist/configs/rstest.d.ts

@@ -0,0 +1,2 @@
+import type { TypedFlatConfig } from '../types.js';
+export declare const rstest: () => TypedFlatConfig[];

package/dist/configs/sort-imports.d.ts

@@ -0,0 +1,42 @@
+import type { ImportOrderOptions } from '@rslint/core';
+import type { SortImportsCustomGroup, SortImportsOptions } from '../types.js';
+/** eslint-plugin-import / Rslint `import/order` group names. */
+export type ImportOrderGroup = 'builtin' | 'external' | 'internal' | 'unknown' | 'parent' | 'sibling' | 'index' | 'object' | 'type';
+type ImportOrderConfig = NonNullable<ImportOrderOptions[0]>;
+/**
+ * Default group order inspired by Oxfmt / perfectionist `sort-imports`
+ * (type-first, then builtin+external, internal, relative, unknown).
+ *
+ * Mapped onto `import/order` groups — modifier-selectors like
+ * `value-builtin` / `type-internal` are not expressible 1:1, so types are
+ * collected via the dedicated `type` group.
+ *
+ * @see https://oxc.rs/docs/guide/usage/formatter/sorting.html
+ */
+export declare const DEFAULT_SORT_IMPORT_GROUPS: (ImportOrderGroup | ImportOrderGroup[])[];
+/** Oxfmt default prefixes for internal modules. */
+export declare const DEFAULT_INTERNAL_PATTERN: string[];
+/**
+ * Convert Oxfmt-style glob prefixes (`~/`, `@/`, `#`) into a single
+ * `import/internal-regex` source string.
+ */
+export declare function internalPatternToRegex(patterns: string[]): string;
+/**
+ * Map Oxfmt-like `customGroups` onto `import/order` `pathGroups`.
+ *
+ * Custom group names are not first-class in `import/order`; each entry must
+ * attach to a real group via `group` / `position` (defaults: `external` /
+ * `before`), matching the common “react before other externals” pattern.
+ */
+export declare function customGroupsToPathGroups(customGroups: SortImportsCustomGroup[]): Exclude<ImportOrderConfig['pathGroups'], undefined>;
+/**
+ * Translate Oxfmt-shaped `sortImports` options into `import/order` options +
+ * settings. Options that cannot be honored (per-group `newlinesBetween`
+ * markers, `partitionByComment`, perfectionist modifier-selectors, etc.) are
+ * intentionally omitted — see README.
+ */
+export declare function resolveSortImports(options?: true | SortImportsOptions): {
+    rule: ImportOrderConfig;
+    settings: Record<string, unknown>;
+};
+export {};

package/dist/configs/special-cases.d.ts

@@ -0,0 +1,2 @@
+import type { TypedFlatConfig } from '../types.js';
+export declare const specialCases: () => TypedFlatConfig[];

package/dist/configs/typescript.d.ts

@@ -0,0 +1,2 @@
+import type { TypeScriptOptions, TypedFlatConfig } from '../types.js';
+export declare const typescript: (options?: true | TypeScriptOptions) => TypedFlatConfig[];

package/dist/configs/unicorn.d.ts

@@ -0,0 +1,2 @@
+import type { TypedFlatConfig } from '../types.js';
+export declare const unicorn: () => TypedFlatConfig[];

package/dist/configs/unused-imports.d.ts

@@ -0,0 +1,5 @@
+import type { TypedFlatConfig } from '../types.js';
+/**
+ * Autofix unused imports via `eslint-plugin-unused-imports` (Rslint community plugin).
+ */
+export declare const unusedImports: () => TypedFlatConfig[];

package/dist/env.d.ts

@@ -0,0 +1,6 @@
+export declare const hasTypeScript: () => boolean;
+export declare const hasReact: () => boolean;
+export declare const hasJest: () => boolean;
+export declare const hasRstest: () => boolean;
+export declare function isInEditorEnv(): boolean;
+export declare function isInGitHooksOrLintStaged(): boolean;

package/dist/globs.d.ts

@@ -0,0 +1,11 @@
+export declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+export declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+export declare const GLOB_JS = "**/*.?([cm])js";
+export declare const GLOB_JSX = "**/*.jsx";
+export declare const GLOB_TS = "**/*.?([cm])ts";
+export declare const GLOB_TSX = "**/*.tsx";
+export declare const GLOB_TESTS: readonly ["**/__tests__/**/*.?([cm])[jt]s?(x)", "**/*.spec.?([cm])[jt]s?(x)", "**/*.test.?([cm])[jt]s?(x)", "**/*.bench.?([cm])[jt]s?(x)", "**/*.benchmark.?([cm])[jt]s?(x)"];
+export declare const GLOB_NODE_MODULES: '**/node_modules';
+export declare const GLOB_DIST: '**/dist';
+export declare const GLOB_LOCKFILE: string[];
+export declare const GLOB_EXCLUDE: string[];

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './configs/index.js';
+export * from './env.js';
+export * from './globs.js';
+export * from './presets.js';
+export * from './types.js';
+export * from './utils.js';