@zhangyu1818/oxlint-config 1.0.0

package/README.md

@@ -0,0 +1,125 @@
+# @zhangyu1818/oxlint-config
+
+Native `oxlint` + `oxfmt` presets for JavaScript and TypeScript projects.
+
+Core presets in this package use functionality implemented natively in Oxc. The `reactAgentRules` preset is backed by an Oxlint JS plugin that ships with this package and auto-enables when `react` is installed.
+
+## Installation
+
+```bash
+pnpm add -D @zhangyu1818/oxlint-config oxlint oxlint-tsgolint oxfmt
+```
+
+## Oxlint
+
+Create `oxlint.config.ts`:
+
+```ts
+import { defineConfig } from '@zhangyu1818/oxlint-config'
+
+export default defineConfig({
+  presets: {
+    node: true,
+    react: true,
+    test: true,
+    typescript: true,
+  },
+})
+```
+
+Available presets:
+
+- `ignores`
+- `imports`
+- `javascript`
+- `node`
+- `react`
+- `reactAgentRules`
+- `next`
+- `test`
+- `typescript`
+- `unicorn`
+
+Default line limits:
+
+- source files: `300`
+- component files (`*.jsx`, `*.tsx`, `*.mtsx`, `*.ctsx`): `200`
+- test files: `500`
+
+`react` preset options:
+
+```ts
+react: {
+  options: {
+    a11y: true,
+    framework: {
+      next: true,
+      vite: false,
+    },
+  },
+}
+```
+
+`reactAgentRules` adds the bundled `react-agent-rules` JS plugin preset and applies:
+
+- `react-agent-rules/no-manual-memoization`
+- `react-agent-rules/no-forward-ref`
+- `react-agent-rules/effect-empty-deps-only`
+
+```ts
+export default defineConfig({
+  presets: {
+    react: true,
+  },
+})
+```
+
+## Oxfmt
+
+Create `oxfmt.config.ts`:
+
+```ts
+import { defineOxfmtConfig } from '@zhangyu1818/oxlint-config'
+
+export default defineOxfmtConfig({
+  presets: {
+    imports: true,
+    packageJson: true,
+    tailwindcss: false,
+  },
+})
+```
+
+Default formatter options:
+
+- `semi: false`
+- `singleQuote: true`
+- `tabWidth: 2`
+- `useTabs: false`
+- `printWidth: 80`
+- `endOfLine: 'lf'`
+
+## Scripts
+
+```json
+{
+  "scripts": {
+    "lint": "oxlint",
+    "lint:fix": "oxlint --fix",
+    "format": "oxfmt -c oxfmt.config.ts .",
+    "format:check": "oxfmt --check -c oxfmt.config.ts ."
+  }
+}
+```
+
+## Migration Notes
+
+This migration keeps `264` native rules and drops `139` rules from the previous ESLint-based package.
+
+## Exports
+
+- `defineConfig`
+- `defineOxlintConfig`
+- `defineOxfmtConfig`
+- `defaultIgnorePatterns`
+- `defaultSortImports`

package/dist/index.d.ts

@@ -0,0 +1,169 @@
+declare const defaultIgnorePatterns: string[];
+
+type Severity = 'off' | 'warn' | 'error';
+type JsonPrimitive = boolean | null | number | string;
+type JsonValue = JsonObject | JsonPrimitive | JsonValue[];
+interface JsonObject {
+    [key: string]: JsonValue;
+}
+type RuleConfig = Severity | [Severity, ...JsonValue[]];
+type Rules = Record<string, RuleConfig>;
+interface OxlintJsPluginAlias {
+    name: string;
+    specifier: string;
+}
+type OxlintJsPlugin = OxlintJsPluginAlias | string;
+type OxlintPlugin = 'eslint' | 'import' | 'jest' | 'jsdoc' | 'jsx-a11y' | 'nextjs' | 'node' | 'oxc' | 'promise' | 'react' | 'react-perf' | 'typescript' | 'unicorn' | 'vitest' | 'vue';
+interface OxlintOverride {
+    env?: Record<string, boolean>;
+    files: string[];
+    jsPlugins?: OxlintJsPlugin[];
+    plugins?: OxlintPlugin[];
+    rules?: Rules;
+}
+interface OxlintConfig {
+    $schema?: string;
+    categories?: Record<string, Severity>;
+    env?: Record<string, boolean>;
+    ignorePatterns?: string[];
+    jsPlugins?: OxlintJsPlugin[];
+    options?: {
+        typeAware?: boolean;
+        typeCheck?: boolean;
+    };
+    overrides?: OxlintOverride[];
+    plugins?: OxlintPlugin[];
+    rules?: Rules;
+    settings?: Record<string, JsonValue>;
+}
+interface OxlintPresetConfig<TOptions = undefined> {
+    enabled?: boolean;
+    options?: TOptions;
+    rules?: Rules;
+}
+interface IgnorePresetConfig {
+    enabled?: boolean;
+    patterns?: string[];
+}
+interface ReactOptions {
+    next?: boolean;
+    vite?: boolean;
+}
+interface ReactPresetOptions {
+    a11y?: boolean;
+    framework?: ReactOptions;
+}
+interface TypeScriptOptions {
+    typeAware?: boolean;
+}
+interface OxlintPresets {
+    ignores?: boolean | IgnorePresetConfig;
+    imports?: boolean | OxlintPresetConfig;
+    javascript?: boolean | OxlintPresetConfig;
+    next?: boolean | OxlintPresetConfig;
+    node?: boolean | OxlintPresetConfig;
+    react?: boolean | OxlintPresetConfig<ReactPresetOptions>;
+    reactAgentRules?: boolean | OxlintPresetConfig;
+    test?: boolean | OxlintPresetConfig;
+    typescript?: boolean | OxlintPresetConfig<TypeScriptOptions>;
+    unicorn?: boolean | OxlintPresetConfig;
+}
+interface DefineOxlintConfigOptions {
+    categories?: Record<string, Severity>;
+    env?: Record<string, boolean>;
+    ignorePatterns?: string[];
+    jsPlugins?: OxlintJsPlugin[];
+    overrides?: OxlintOverride[];
+    presets?: OxlintPresets;
+    rules?: Rules;
+    settings?: Record<string, JsonValue>;
+}
+interface SortImportCustomGroup {
+    elementNamePattern?: string[];
+    groupName: string;
+    modifiers?: string[];
+    selector?: string;
+}
+type SortImportGroup = {
+    newlinesBetween: boolean;
+} | string | string[];
+interface SortImportsOptions {
+    customGroups?: SortImportCustomGroup[];
+    groups?: SortImportGroup[];
+    ignoreCase?: boolean;
+    internalPattern?: string[];
+    newlinesBetween?: boolean;
+    order?: 'asc' | 'desc';
+    partitionByComment?: boolean;
+    partitionByNewline?: boolean;
+    sortSideEffects?: boolean;
+}
+interface SortPackageJsonOptions {
+    sortScripts?: boolean;
+}
+interface TailwindSortOptions {
+    attributes?: string[];
+    config?: string;
+    functions?: string[];
+    preserveDuplicates?: boolean;
+    preserveWhitespace?: boolean;
+    stylesheet?: string;
+}
+interface OxfmtOverrideOptions {
+    endOfLine?: 'cr' | 'crlf' | 'lf';
+    printWidth?: number;
+    semi?: boolean;
+    singleQuote?: boolean;
+    sortImports?: boolean | SortImportsOptions;
+    sortPackageJson?: boolean | SortPackageJsonOptions;
+    sortTailwindcss?: boolean | TailwindSortOptions;
+    tabWidth?: number;
+    trailingComma?: 'all' | 'es5' | 'none';
+    useTabs?: boolean;
+}
+interface OxfmtOverride {
+    excludeFiles?: string[];
+    files: string[];
+    options: OxfmtOverrideOptions;
+}
+interface OxfmtConfig extends OxfmtOverrideOptions {
+    $schema?: string;
+    ignorePatterns?: string[];
+    overrides?: OxfmtOverride[];
+}
+interface OxfmtPresetConfig<TOptions = undefined> {
+    enabled?: boolean;
+    options?: TOptions;
+}
+interface OxfmtPresets {
+    imports?: boolean | OxfmtPresetConfig<SortImportsOptions>;
+    packageJson?: boolean | OxfmtPresetConfig<SortPackageJsonOptions>;
+    tailwindcss?: boolean | OxfmtPresetConfig<TailwindSortOptions>;
+}
+interface DefineOxfmtConfigOptions extends OxfmtOverrideOptions {
+    ignorePatterns?: string[];
+    overrides?: OxfmtOverride[];
+    presets?: OxfmtPresets;
+}
+
+declare const defaultOxlintPresets: {
+    ignores: true;
+    imports: true;
+    javascript: true;
+    next: boolean;
+    node: false;
+    react: boolean;
+    reactAgentRules: boolean;
+    test: boolean;
+    typescript: boolean;
+    unicorn: true;
+};
+declare function defineOxlintConfig(options?: DefineOxlintConfigOptions): OxlintConfig;
+declare const defineConfig: typeof defineOxlintConfig;
+
+declare const defaultSortImports: SortImportsOptions;
+
+declare const defaultOxfmtPresets: Required<OxfmtPresets>;
+declare function defineOxfmtConfig(options?: DefineOxfmtConfigOptions): OxfmtConfig;
+
+export { type DefineOxfmtConfigOptions, type DefineOxlintConfigOptions, type OxfmtConfig, type OxfmtOverride, type OxfmtPresetConfig, type OxfmtPresets, type OxlintConfig, type OxlintJsPlugin, type OxlintJsPluginAlias, type OxlintOverride, type OxlintPlugin, type OxlintPresetConfig, type OxlintPresets, type ReactOptions, type ReactPresetOptions, type RuleConfig, type Rules, type Severity, type SortImportsOptions, type SortPackageJsonOptions, type TailwindSortOptions, type TypeScriptOptions, defaultIgnorePatterns, defaultOxfmtPresets, defaultOxlintPresets, defaultSortImports, defineConfig, defineOxfmtConfig, defineOxlintConfig };