@homer0/oxlint-config 0.2.0

package/src/rules/tests.ts

@@ -0,0 +1,20 @@
+export const tests = {
+  /**
+   * Enforce a maximum number of classes per file.
+   *
+   * @see https://eslint.org/docs/latest/rules/max-classes-per-file
+   */
+  'max-classes-per-file': 'off',
+  /**
+   * Disallow magic numbers.
+   *
+   * @see https://eslint.org/docs/latest/rules/no-magic-numbers
+   */
+  'no-magic-numbers': 'off',
+  /**
+   * Ensure all imports appear before other statements.
+   *
+   * @see https://github.com/un-ts/eslint-plugin-import-x/blob/v4.17.1/docs/rules/first.md
+   */
+  'import/first': 'off',
+} as const;

package/src/rules/typeAware.ts

@@ -0,0 +1,20 @@
+export const typeAware = {
+  /**
+   * Disallow use of APIs marked as deprecated by TypeScript declarations.
+   *
+   * @see https://typescript-eslint.io/rules/no-deprecated
+   */
+  'typescript/no-deprecated': 'error',
+  /**
+   * Require promises to be awaited, returned, or explicitly ignored.
+   *
+   * @see https://typescript-eslint.io/rules/no-floating-promises
+   */
+  'typescript/no-floating-promises': 'error',
+  /**
+   * Disallow promises in places that expect synchronous values or callbacks.
+   *
+   * @see https://typescript-eslint.io/rules/no-misused-promises
+   */
+  'typescript/no-misused-promises': 'error',
+} as const;

package/src/rules/typescript.ts

@@ -0,0 +1,178 @@
+export const typescript = {
+  /**
+   * Disallow `@ts-<directive>` comments or require descriptions after directives.
+   *
+   * @see https://typescript-eslint.io/rules/ban-ts-comment
+   */
+  'typescript/ban-ts-comment': [
+    'error',
+    {
+      'ts-expect-error': 'allow-with-description',
+      'ts-ignore': 'allow-with-description',
+      'ts-nocheck': 'allow-with-description',
+      'ts-check': 'allow-with-description',
+    },
+  ],
+  /**
+   * Disallow `Array` constructors in favor of array literals.
+   *
+   * @see https://typescript-eslint.io/rules/no-array-constructor
+   */
+  'typescript/no-array-constructor': 'error',
+  /**
+   * Disallow duplicate values in TypeScript enums.
+   *
+   * @see https://typescript-eslint.io/rules/no-duplicate-enum-values
+   */
+  'typescript/no-duplicate-enum-values': 'error',
+  /**
+   * Disallow the empty object type.
+   *
+   * @see https://typescript-eslint.io/rules/no-empty-object-type
+   */
+  'typescript/no-empty-object-type': 'error',
+  /**
+   * Disallow the `any` type.
+   *
+   * @see https://typescript-eslint.io/rules/no-explicit-any
+   */
+  'typescript/no-explicit-any': 'error',
+  /**
+   * Disallow unnecessary non-null assertions.
+   *
+   * @see https://typescript-eslint.io/rules/no-extra-non-null-assertion
+   */
+  'typescript/no-extra-non-null-assertion': 'error',
+  /**
+   * Disallow classes that are used as namespaces.
+   *
+   * @see https://typescript-eslint.io/rules/no-misused-new
+   */
+  'typescript/no-misused-new': 'error',
+  /**
+   * Disallow TypeScript namespaces.
+   *
+   * @see https://typescript-eslint.io/rules/no-namespace
+   */
+  'typescript/no-namespace': 'error',
+  /**
+   * Disallow non-null assertions after optional chains.
+   *
+   * @see https://typescript-eslint.io/rules/no-non-null-asserted-optional-chain
+   */
+  'typescript/no-non-null-asserted-optional-chain': 'error',
+  /**
+   * Disallow CommonJS `require()` imports.
+   *
+   * @see https://typescript-eslint.io/rules/no-require-imports
+   */
+  'typescript/no-require-imports': 'error',
+  /**
+   * Disallow assigning `this` to another variable.
+   *
+   * @see https://typescript-eslint.io/rules/no-this-alias
+   */
+  'typescript/no-this-alias': 'error',
+  /**
+   * Disallow unnecessary type constraints.
+   *
+   * @see https://typescript-eslint.io/rules/no-unnecessary-type-constraint
+   */
+  'typescript/no-unnecessary-type-constraint': 'error',
+  /**
+   * Disallow unsafe declaration merging.
+   *
+   * @see https://typescript-eslint.io/rules/no-unsafe-declaration-merging
+   */
+  'typescript/no-unsafe-declaration-merging': 'error',
+  /**
+   * Disallow unsafe built-in function types.
+   *
+   * @see https://typescript-eslint.io/rules/no-unsafe-function-type
+   */
+  'typescript/no-unsafe-function-type': 'error',
+  /**
+   * Disallow unused expressions.
+   *
+   * @see https://typescript-eslint.io/rules/no-unused-expressions
+   */
+  'typescript/no-unused-expressions': 'error',
+  /**
+   * Disallow unused variables.
+   *
+   * @see https://typescript-eslint.io/rules/no-unused-vars
+   */
+  'typescript/no-unused-vars': 'error',
+  /**
+   * Disallow object-wrapper types.
+   *
+   * @see https://typescript-eslint.io/rules/no-wrapper-object-types
+   */
+  'typescript/no-wrapper-object-types': 'error',
+  /**
+   * Require `as const` assertions for literal types.
+   *
+   * @see https://typescript-eslint.io/rules/prefer-as-const
+   */
+  'typescript/prefer-as-const': 'error',
+  /**
+   * Require `namespace` instead of `module` declarations.
+   *
+   * @see https://typescript-eslint.io/rules/prefer-namespace-keyword
+   */
+  'typescript/prefer-namespace-keyword': 'error',
+  /**
+   * Disallow triple-slash reference directives.
+   *
+   * @see https://typescript-eslint.io/rules/triple-slash-reference
+   */
+  'typescript/triple-slash-reference': 'error',
+  /**
+   * Enforce dot notation whenever possible.
+   *
+   * @see https://typescript-eslint.io/rules/dot-notation
+   */
+  'typescript/dot-notation': 'error',
+  /**
+   * Let the TypeScript-specific rule enforce array constructor usage.
+   *
+   * @see https://eslint.org/docs/latest/rules/no-array-constructor
+   */
+  'no-array-constructor': 'off',
+  /**
+   * Allow empty functions for interface implementations and placeholders.
+   *
+   * @see https://eslint.org/docs/latest/rules/no-empty-function
+   */
+  'no-empty-function': 'off',
+  /**
+   * Let the TypeScript-specific rule enforce dot notation.
+   *
+   * @see https://eslint.org/docs/latest/rules/dot-notation
+   */
+  'dot-notation': 'off',
+  /**
+   * Let the TypeScript-specific rule detect unused expressions.
+   *
+   * @see https://eslint.org/docs/latest/rules/no-unused-expressions
+   */
+  'no-unused-expressions': 'off',
+  /**
+   * Let the TypeScript-specific rule detect unused variables.
+   *
+   * @see https://eslint.org/docs/latest/rules/no-unused-vars
+   */
+  'no-unused-vars': 'off',
+  /**
+   * Allow constructors that TypeScript requires for parameter properties.
+   *
+   * @see https://eslint.org/docs/latest/rules/no-useless-constructor
+   */
+  'no-useless-constructor': 'off',
+  /**
+   * Ensure consistent use of file extension within the import path.
+   *
+   * @see https://github.com/un-ts/eslint-plugin-import-x/blob/v4.17.1/docs/rules/extensions.md
+   */
+  'import/extensions': 'off',
+} as const;

package/src/rules/vitest.ts

@@ -0,0 +1,44 @@
+export const vitest = {
+  /**
+   * Disallow focused tests committed with `.only`.
+   *
+   * @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-focused-tests.md
+   */
+  'vitest/no-focused-tests': 'error',
+  /**
+   * Disallow disabled tests committed with `.skip`.
+   *
+   * @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-disabled-tests.md
+   */
+  'vitest/no-disabled-tests': 'error',
+  /**
+   * Require unique test titles within a suite.
+   *
+   * @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-identical-title.md
+   */
+  'vitest/no-identical-title': 'error',
+  /**
+   * Disallow assertions that execute only in conditional branches.
+   *
+   * @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-expect.md
+   */
+  'vitest/no-conditional-expect': 'error',
+  /**
+   * Disallow assertions outside a test or hook callback.
+   *
+   * @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-standalone-expect.md
+   */
+  'vitest/no-standalone-expect': 'error',
+  /**
+   * Allow mock factories without explicit type parameters.
+   *
+   * @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/require-mock-type-parameters.md
+   */
+  'vitest/require-mock-type-parameters': 'off',
+  /**
+   * Validate assertion matchers and their arguments.
+   *
+   * @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/valid-expect.md
+   */
+  'vitest/valid-expect': 'error',
+} as const;

package/src/types.ts

@@ -0,0 +1,109 @@
+import type { ExtensionFragmentName, TestConvention } from './consts.js';
+
+export type { ExtensionFragmentName } from './consts.js';
+
+export type ConfigName = 'browser' | 'node';
+
+export type RuleSettings = Record<string, unknown>;
+
+/** Adds native Oxlint rules to a generated fragment without replacing its policy. */
+export type ConfigFragment = {
+  rules?: RuleSettings;
+};
+
+/** Overrides are keyed by the generated fragment they extend. */
+export type ExtensionFragments = Partial<Record<ExtensionFragmentName, ConfigFragment>>;
+
+/** Selects a test framework-specific native rule policy. */
+export type TestFramework = 'vitest';
+
+/** Narrows a test override and optionally selects its environment, framework, and TypeScript policy. */
+export type TestConfigOptions = {
+  configs?: ConfigName[];
+  framework?: TestFramework;
+  /** Uses a built-in convention or custom glob(s). */
+  files?: TestConvention | (string & {}) | string[];
+  ts?: boolean;
+};
+
+/** Selects both conventions, one built-in convention, or a custom test override. */
+export type TestsOption = boolean | TestConvention | TestConfigOptions;
+
+export type CreateConfigOptions = {
+  configs: ConfigName[];
+  extensions?: ExtensionFragments;
+  ignores?: string[];
+  /** Enables the native subset of JSDoc policy. */
+  jsdoc?: boolean;
+  tests?: TestsOption;
+  /** Defaults to `true`. */
+  ts?: boolean;
+  /** Enables Oxlint's root-only type-aware mode. Requires oxlint-tsgolint and TypeScript 7+. */
+  typeAware?: boolean;
+};
+
+export type CreateReactConfigOptions = CreateConfigOptions;
+
+export type CreateNextjsConfigOptions = Omit<CreateConfigOptions, 'configs' | 'ts'>;
+
+export type CreateConfigSettings = CreateConfigOptions & {
+  nextjs?: boolean;
+  react?: boolean;
+};
+
+export type ResolveTestConfigOptions = {
+  tests: TestsOption | undefined;
+  productionConfig: ConfigName;
+  productionTs: boolean;
+};
+
+export type ResolvedTestConfig = {
+  configs: ConfigName[];
+  files: string[];
+  framework?: TestFramework;
+  ts: boolean;
+};
+
+export type GeneratedConfigOverride = {
+  files: string[];
+  globals: Record<string, boolean | string>;
+  rules: RuleSettings;
+};
+
+/** Native Oxlint configuration generated by this package's factories. */
+export type GeneratedConfig = {
+  globals: Record<string, boolean | string>;
+  ignorePatterns?: string[];
+  options?: {
+    typeAware: true;
+  };
+  overrides?: GeneratedConfigOverride[];
+  plugins: string[];
+  rules: RuleSettings;
+};
+
+export type CreateTestOverrideOptions = {
+  testConfig: ResolvedTestConfig;
+  extensions?: ExtensionFragments;
+};
+
+export type ResolveConfigComponentsOptions = CreateConfigSettings & {
+  testConfig?: ResolvedTestConfig;
+  baseFragment?: ConfigFragment;
+  baseExtensionFragment?: ConfigFragment;
+};
+
+export type ResolveTestConfigComponentsOptions = {
+  config: ConfigName;
+  testConfig?: ResolvedTestConfig;
+  tests?: TestsOption;
+  ts?: boolean;
+};
+
+export type ResolveConfigComponentsResult = {
+  config: ConfigName;
+  testConfig?: ResolvedTestConfig;
+  fragments: ConfigFragment[];
+  plugins: string[];
+  configGlobals?: Record<string, boolean | string>;
+};