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

package/dist/plugin-utils.d.ts

@@ -0,0 +1,3 @@
+import type { ESLintPlugin } from '@rslint/core';
+/** Cast community ESLint plugin objects into Rslint's `ESLintPlugin` shape. */
+export declare function asESLintPlugin(plugin: unknown): ESLintPlugin;

package/dist/presets.d.ts

@@ -0,0 +1,30 @@
+import type { Options, ResolvableConfig, TypeScriptOptions, TypedFlatConfig } from './types.js';
+/** Ignore common files and include JavaScript support. */
+export declare const presetJavaScript: () => TypedFlatConfig[];
+/** Includes `presetJavaScript` and TypeScript support. */
+export declare const presetBasic: (typescriptOptions?: true | TypeScriptOptions) => TypedFlatConfig[];
+/**
+ * Full opinionated preset:
+ * - JS + TS
+ * - Unicorn / import / node / promise
+ * - React / Jest / Rstest when detected
+ * - Special-case overrides
+ */
+export declare const presetAll: () => TypedFlatConfig[];
+/**
+ * `@heyq02`'s opinionated Rslint config preset.
+ *
+ * @example
+ * ```ts
+ * // rslint.config.ts
+ * import { heyq02 } from '@heyq02/rslint-config'
+ *
+ * export default heyq02({
+ *   typescript: { typeChecked: true, strict: true },
+ *   react: true,
+ * })
+ * ```
+ */
+export declare function heyq02(options?: Options, ...userConfigs: ResolvableConfig[]): TypedFlatConfig[];
+/** Alias of {@link heyq02}. */
+export declare const rslintConfig: typeof heyq02;

package/dist/types.d.ts

@@ -0,0 +1,197 @@
+import type { RslintConfig, RslintConfigEntry } from '@rslint/core';
+export type { RslintConfig, RslintConfigEntry };
+export type TypedFlatConfig = RslintConfigEntry;
+export type ResolvableConfig = TypedFlatConfig | TypedFlatConfig[] | RslintConfig | false | null | undefined;
+export type TypeScriptPreset = 'recommended' | 'recommendedTypeChecked' | 'strict' | 'strictTypeChecked';
+export interface TypeScriptOptions {
+    /**
+     * Enable type-aware TypeScript rules.
+     * When true, uses `*TypeChecked` presets and enables `projectService` by default.
+     * @default false
+     */
+    typeChecked?: boolean;
+    /**
+     * Use TypeScript strict presets instead of recommended.
+     * @default false
+     */
+    strict?: boolean;
+    /**
+     * Layer TypeScript stylistic rules after the baseline.
+     * @default true
+     */
+    stylistic?: boolean;
+    /**
+     * Enable automatic TypeScript project discovery for type-aware rules.
+     * Defaults to `true` when `typeChecked` is enabled.
+     */
+    projectService?: boolean;
+}
+export type NodePreset = boolean | 'module' | 'script' | 'mixed';
+/**
+ * `import/order` group names (Rslint / eslint-plugin-import).
+ * Closest enforceable equivalent of Oxfmt perfectionist selectors.
+ */
+export type SortImportsGroup = 'builtin' | 'external' | 'internal' | 'unknown' | 'parent' | 'sibling' | 'index' | 'object' | 'type';
+/**
+ * Oxfmt-like custom group → mapped to `import/order` `pathGroups`.
+ *
+ * @see https://oxc.rs/docs/guide/usage/formatter/sorting.html
+ */
+export interface SortImportsCustomGroup {
+    /**
+     * Display / documentation name (Oxfmt `groupName`).
+     * Not a first-class `import/order` group — attach via {@link group}.
+     */
+    groupName?: string;
+    /**
+     * Glob patterns matched against the import source (Oxfmt `elementNamePattern`).
+     */
+    elementNamePattern: string | string[];
+    /**
+     * Target `import/order` group to attach to.
+     * @default 'external'
+     */
+    group?: SortImportsGroup;
+    /**
+     * Position relative to {@link group}.
+     * @default 'before'
+     */
+    position?: 'before' | 'after';
+}
+/**
+ * Import sorting options, shaped like Oxfmt `sortImports` and implemented via
+ * Rslint `import/order`.
+ *
+ * Unsupported Oxfmt knobs (no-op / not exposed): per-group `{ newlinesBetween }`,
+ * `partitionByComment`, `partitionByNewline`, perfectionist modifier-selectors
+ * (`value-builtin`, `type-import`, …).
+ *
+ * @see https://oxc.rs/docs/guide/usage/formatter/sorting.html
+ */
+export interface SortImportsOptions {
+    /**
+     * Relative order of import groups.
+     * @default `['type', ['builtin', 'external'], 'internal', ['parent', 'sibling', 'index'], 'unknown']`
+     */
+    groups?: (SortImportsGroup | SortImportsGroup[])[];
+    /**
+     * Insert a blank line between groups.
+     * Maps to `newlines-between: 'always' | 'never'`.
+     * @default true
+     */
+    newlinesBetween?: boolean;
+    /**
+     * Custom path-based groups (Oxfmt `customGroups` → `pathGroups`).
+     */
+    customGroups?: SortImportsCustomGroup[];
+    /**
+     * Prefixes treated as internal imports (Oxfmt `internalPattern`).
+     * Converted to `settings['import/internal-regex']`.
+     * @default `['~/', '@/', '#']`
+     */
+    internalPattern?: string[];
+    /**
+     * Alphabetical order within each group.
+     * @default 'asc'
+     */
+    order?: 'asc' | 'desc';
+    /**
+     * Case-insensitive alphabetical sort.
+     * @default true
+     */
+    ignoreCase?: boolean;
+    /**
+     * Sort named import / export members.
+     * @default true
+     */
+    named?: boolean;
+    /**
+     * Whether side-effect imports participate in ordering
+     * (`warnOnUnassignedImports`).
+     * @default false
+     */
+    sortSideEffects?: boolean;
+}
+export interface Options {
+    /**
+     * Global ignore patterns. Merged with the built-in excludes.
+     */
+    ignores?: string[];
+    /**
+     * JavaScript support. @default true
+     */
+    javascript?: boolean;
+    /**
+     * TypeScript support. Auto-enabled when `typescript` is installed.
+     * Pass an object for type-checked / strict / stylistic controls.
+     * @default auto
+     */
+    typescript?: boolean | TypeScriptOptions;
+    /**
+     * Unicorn rules. @default true
+     */
+    unicorn?: boolean;
+    /**
+     * Import rules. @default true
+     */
+    imports?: boolean;
+    /**
+     * Sort imports via `import/order`, with an Oxfmt-like options surface.
+     * Enabled by default when {@link imports} is on.
+     * Set `false` if Oxfmt `sortImports` already owns ordering.
+     * @default true
+     */
+    sortImports?: boolean | SortImportsOptions;
+    /**
+     * Node.js rules.
+     * - `true` / `'module'` — ESM-oriented Node rules (default)
+     * - `'script'` — CommonJS-oriented
+     * - `'mixed'` — upstream mixed recommended preset
+     * @default true
+     */
+    node?: NodePreset;
+    /**
+     * Promise rules. @default true
+     */
+    promise?: boolean;
+    /**
+     * React + React Hooks. Auto-enabled when React is detected.
+     * @default auto
+     */
+    react?: boolean;
+    /**
+     * JSX accessibility rules. Auto-enabled with React when unset.
+     * @default auto with react
+     */
+    jsxA11y?: boolean;
+    /**
+     * Jest rules. Auto-enabled when `jest` is detected.
+     * @default auto
+     */
+    jest?: boolean;
+    /**
+     * Rstest rules. Auto-enabled when `rstest` / `@rstest/core` is detected.
+     * @default auto
+     */
+    rstest?: boolean;
+    /**
+     * Autofix unused imports (`eslint-plugin-unused-imports`).
+     * @default true
+     */
+    unusedImports?: boolean;
+    /**
+     * RegExp rules (`eslint-plugin-regexp`).
+     * @default true
+     */
+    regexp?: boolean;
+    /**
+     * De Morgan rewrites (`eslint-plugin-de-morgan`).
+     * @default true
+     */
+    deMorgan?: boolean;
+    /**
+     * `eslint-disable` hygiene (`@eslint-community/eslint-plugin-eslint-comments`).
+     * @default true
+     */
+    eslintComments?: boolean;
+}

package/dist/utils.d.ts

@@ -0,0 +1,4 @@
+import type { ResolvableConfig, TypedFlatConfig } from './types.js';
+/** Flatten nested config values into a single entry list. */
+export declare function flattenConfigs(...configs: ResolvableConfig[]): TypedFlatConfig[];
+export declare function toArray<T>(value: T | T[]): T[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heyq02/rslint-config",
-  "version": "0.0.1",
+  "version": "0.0.3-beta.1",
   "description": "Opinionated Rslint flat-config preset.",
   "keywords": [
     "flat-config",
@@ -23,19 +23,36 @@
     "dist"
   ],
   "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./dist/index.mjs",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
     "./package.json": "./package.json"
   },
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.8.1",
+    "eslint-plugin-de-morgan": "^2.2.0",
+    "eslint-plugin-regexp": "^3.3.1",
+    "eslint-plugin-unused-imports": "^4.4.1",
+    "local-pkg": "^1.2.1"
+  },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@heyq02/rslib-config": "^1.0.1",
+    "@rslib/core": "^1.0.3",
     "@rslint/core": "^0.9.4",
     "@types/node": "^26.1.1",
+    "automd": "^0.4.3",
     "bumpp": "^11.1.0",
+    "publint": "^0.3.25",
     "typescript": "^7.0.2",
-    "vite-plus": "1.0.0"
+    "vite-plus": "^1.1.0"
   },
   "peerDependencies": {
     "@rslint/core": "^0.9.0"
@@ -47,15 +64,23 @@
       "onFail": "download"
     }
   },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
   "scripts": {
-    "build": "vp pack",
-    "dev": "vp pack --watch",
-    "test": "echo Skip",
-    "check": "vp check",
+    "build": "rslib",
+    "dev": "rslib --watch",
+    "test": "vp test",
     "lint": "rslint .",
     "lint:fix": "rslint --fix .",
-    "format": "vp fmt",
-    "typecheck": "vp check --no-fmt --no-lint",
+    "automd": "automd",
+    "format": "pnpm automd && vp fmt",
+    "format:check": "vp fmt --check",
+    "typecheck": "tsc --noEmit",
+    "check": "pnpm run format:check && pnpm run lint && pnpm run typecheck",
+    "publint": "publint",
+    "attw": "pnpm pack && attw heyq02-rslint-config-*.tgz --profile esm-only && rm -f heyq02-rslint-config-*.tgz",
+    "check:package": "pnpm run build && pnpm run publint && pnpm run attw",
     "release": "bumpp"
   }
 }

package/dist/index.d.mts

@@ -1,183 +0,0 @@
-import { RslintConfig, RslintConfigEntry } from "@rslint/core";
-//#region src/types.d.ts
-export type TypedFlatConfig = RslintConfigEntry;
-export type ResolvableConfig = TypedFlatConfig | TypedFlatConfig[] | RslintConfig | false | null | undefined;
-export type TypeScriptPreset = "recommended" | "recommendedTypeChecked" | "strict" | "strictTypeChecked";
-export interface TypeScriptOptions {
-  /**
-   * Enable type-aware TypeScript rules.
-   * When true, uses `*TypeChecked` presets and enables `projectService` by default.
-   * @default false
-   */
-  typeChecked?: boolean;
-  /**
-   * Use TypeScript strict presets instead of recommended.
-   * @default false
-   */
-  strict?: boolean;
-  /**
-   * Layer TypeScript stylistic rules after the baseline.
-   * @default true
-   */
-  stylistic?: boolean;
-  /**
-   * Enable automatic TypeScript project discovery for type-aware rules.
-   * Defaults to `true` when `typeChecked` is enabled.
-   */
-  projectService?: boolean;
-}
-export type NodePreset = boolean | "module" | "script" | "mixed";
-export interface Options {
-  /**
-   * Global ignore patterns. Merged with the built-in excludes.
-   */
-  ignores?: string[];
-  /**
-   * JavaScript support. @default true
-   */
-  javascript?: boolean;
-  /**
-   * TypeScript support. Auto-enabled when `typescript` is installed.
-   * Pass an object for type-checked / strict / stylistic controls.
-   * @default auto
-   */
-  typescript?: boolean | TypeScriptOptions;
-  /**
-   * Unicorn rules. @default true
-   */
-  unicorn?: boolean;
-  /**
-   * Import rules. @default true
-   */
-  imports?: boolean;
-  /**
-   * Node.js rules.
-   * - `true` / `'module'` — ESM-oriented Node rules (default)
-   * - `'script'` — CommonJS-oriented
-   * - `'mixed'` — upstream mixed recommended preset
-   * @default true
-   */
-  node?: NodePreset;
-  /**
-   * Promise rules. @default true
-   */
-  promise?: boolean;
-  /**
-   * React + React Hooks. Auto-enabled when React is detected.
-   * @default auto
-   */
-  react?: boolean;
-  /**
-   * JSX accessibility rules. Auto-enabled with React when unset.
-   * @default auto with react
-   */
-  jsxA11y?: boolean;
-  /**
-   * Jest rules. Auto-enabled when `jest` is detected.
-   * @default auto
-   */
-  jest?: boolean;
-  /**
-   * Rstest rules. Auto-enabled when `rstest` / `@rstest/core` is detected.
-   * @default auto
-   */
-  rstest?: boolean;
-}
-//#endregion
-//#region src/configs/ignores.d.ts
-export declare const ignores: (extra?: string[]) => TypedFlatConfig[];
-//#endregion
-//#region src/configs/imports.d.ts
-export declare const imports: (options?: {
-  typescript?: boolean;
-}) => TypedFlatConfig[];
-//#endregion
-//#region src/configs/javascript.d.ts
-export declare const restrictedSyntaxJs: string[];
-export declare const javascript: () => TypedFlatConfig[];
-//#endregion
-//#region src/configs/jest.d.ts
-export declare const jest: () => TypedFlatConfig[];
-//#endregion
-//#region src/configs/node.d.ts
-export declare const node: (preset?: Exclude<NodePreset, false>) => TypedFlatConfig[];
-//#endregion
-//#region src/configs/promise.d.ts
-export declare const promise: () => TypedFlatConfig[];
-//#endregion
-//#region src/configs/react.d.ts
-export declare const jsxA11y: () => TypedFlatConfig[];
-export declare const react: (options?: {
-  jsxA11y?: boolean;
-}) => TypedFlatConfig[];
-//#endregion
-//#region src/configs/rstest.d.ts
-export declare const rstest: () => TypedFlatConfig[];
-//#endregion
-//#region src/configs/special-cases.d.ts
-export declare const specialCases: () => TypedFlatConfig[];
-//#endregion
-//#region src/configs/typescript.d.ts
-export declare const typescript: (options?: true | TypeScriptOptions) => TypedFlatConfig[];
-//#endregion
-//#region src/configs/unicorn.d.ts
-export declare const unicorn: () => TypedFlatConfig[];
-//#endregion
-//#region src/env.d.ts
-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;
-//#endregion
-//#region src/globs.d.ts
-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[];
-//#endregion
-//#region src/presets.d.ts
-/** Ignore common files and include JavaScript support. */
-export declare const presetJavaScript: () => TypedFlatConfig[];
-/** Includes `presetJavaScript` and TypeScript support. */
-export declare const presetBasic: (typescriptOptions?: true | TypeScriptOptions) => TypedFlatConfig[];
-/**
- * Full opinionated preset:
- * - JS + TS
- * - Unicorn / import / node / promise
- * - React / Jest / Rstest when detected
- * - Special-case overrides
- */
-export declare const presetAll: () => TypedFlatConfig[];
-/**
- * `@heyq02`'s opinionated Rslint config preset.
- *
- * @example
- * ```ts
- * // rslint.config.ts
- * import { heyq02 } from '@heyq02/rslint-config'
- *
- * export default heyq02({
- *   typescript: { typeChecked: true, strict: true },
- *   react: true,
- * })
- * ```
- */
-export declare function heyq02(options?: Options, ...userConfigs: ResolvableConfig[]): TypedFlatConfig[];
-/** Alias of {@link heyq02}. */
-export declare const rslintConfig: typeof heyq02;
-//#endregion
-//#region src/utils.d.ts
-/** Flatten nested config values into a single entry list. */
-export declare function flattenConfigs(...configs: ResolvableConfig[]): TypedFlatConfig[];
-export declare function toArray<T>(value: T | T[]): T[];
-//#endregion
-export type { RslintConfig, RslintConfigEntry };