oxlint 1.75.0 → 1.77.0

package/dist/index.d.ts

@@ -88,8 +88,8 @@ type MaxDependenciesConfigJson = number | MaxDependenciesConfig;
 type Target = "single" | "any";
 type TestCaseName = "it" | "test";
 type JestFnType = "hook" | "describe" | "test" | "expect" | "jest" | "unknown";
-type DummyRule = AllowWarnDeny | [AllowWarnDeny, ...unknown[]];
 type SnapshotHintMode = "always" | "multi";
+type DummyRule = AllowWarnDeny | [AllowWarnDeny, ...unknown[]];
 type AltTextElements = "img" | "object" | "area" | 'input[type="image"]';
 type AnchorIsValidAspect = "noHref" | "invalidHref" | "preferButton";
 type Assert = "htmlFor" | "nesting" | "both" | "either";
@@ -116,6 +116,8 @@ type NoInnerDeclarationsConfig = "functions" | "both";
 type BlockScopedFunctions = "allow" | "disallow";
 type Namespaces = "allow" | "disallow";
 type NoMagicNumbersNumber = number | string;
+type NoRestrictedGlobalsConfigEnum = string | RestrictedGlobal | NoRestrictedGlobalsObjectConfig;
+type GlobalNameOrObject = string | RestrictedGlobal;
 type NoRestrictedImportsConfigEnum = string | RestrictedPath | NoRestrictedImportsConfig;
 type PossiblePaths = string | RestrictedPath;
 type PossiblePatterns = string | RestrictedPattern;
@@ -138,6 +140,7 @@ type Location = "start" | "anywhere";
  * The rule takes a single option - an array of possible callback names - which may include object methods. The default callback names are `callback`, `cb`, `next`.
  */
 type CallbackReturn = string[];
+type ExportsStyleMode = "module.exports" | "exports";
 /**
  * The rule takes a single string option: the name of the error parameter.
  *
@@ -476,9 +479,23 @@ interface Oxlintrc$1 {
    */
   env?: OxlintEnv;
   /**
-   * Paths of configuration files that this configuration file extends (inherits from). The files
-   * are resolved relative to the location of the configuration file that contains the `extends`
-   * property. The configuration files are merged from the first to the last, with the last file
+   * Configurations that this configuration file extends (inherits from).
+   *
+   * In `.oxlintrc.json`, `extends` has type `string[]`. Each string is a path to a configuration
+   * file, resolved relative to the location of the configuration file that contains the
+   * `extends` property.
+   *
+   * In `oxlint.config.ts`, `extends` has type `OxlintConfig[]`. Import each configuration and
+   * pass the configuration object directly:
+   *
+   * ```ts
+   * import { defineConfig } from "oxlint";
+   * import baseConfig from "./base-config.ts";
+   *
+   * export default defineConfig({ extends: [baseConfig] });
+   * ```
+   *
+   * Configurations are merged from the first to the last, with the last configuration
    * overriding the previous ones.
    */
   extends?: string[];
@@ -829,6 +846,7 @@ interface DummyRuleMap {
   "getter-return"?: RuleNoConfig | [AllowWarnDeny, GetterReturn];
   "grouped-accessor-pairs"?: RuleNoConfig | [AllowWarnDeny, PairOrder] | [AllowWarnDeny, PairOrder, GroupedAccessorPairsConfig];
   "guard-for-in"?: RuleNoConfig;
+  "id-denylist"?: RuleNoConfig | [AllowWarnDeny, string, ...string[]];
   "id-length"?: RuleNoConfig | [AllowWarnDeny, IdLengthConfig];
   "id-match"?: RuleNoConfig | [AllowWarnDeny, string] | [AllowWarnDeny, string, IdMatchOptions];
   "import/consistent-type-specifier-style"?: RuleNoConfig | [AllowWarnDeny, Mode];
@@ -906,7 +924,7 @@ interface DummyRuleMap {
   "jest/prefer-hooks-on-top"?: RuleNoConfig;
   "jest/prefer-importing-jest-globals"?: RuleNoConfig | [AllowWarnDeny, PreferImportingJestGlobalsConfig];
   "jest/prefer-jest-mocked"?: RuleNoConfig;
-  "jest/prefer-lowercase-title"?: DummyRule;
+  "jest/prefer-lowercase-title"?: RuleNoConfig | [AllowWarnDeny, PreferLowercaseTitleConfig];
   "jest/prefer-mock-promise-shorthand"?: RuleNoConfig;
   "jest/prefer-mock-return-shorthand"?: RuleNoConfig;
   "jest/prefer-snapshot-hint"?: RuleNoConfig | [AllowWarnDeny, SnapshotHintMode];
@@ -1090,7 +1108,7 @@ interface DummyRuleMap {
   "no-redeclare"?: RuleNoConfig | [AllowWarnDeny, NoRedeclare];
   "no-regex-spaces"?: RuleNoConfig;
   "no-restricted-exports"?: RuleNoConfig | [AllowWarnDeny, NoRestrictedExportsConfig];
-  "no-restricted-globals"?: DummyRule;
+  "no-restricted-globals"?: RuleNoConfig | [AllowWarnDeny, NoRestrictedGlobalsConfigEnum, ...NoRestrictedGlobalsConfigEnum[]];
   "no-restricted-imports"?: RuleNoConfig | [AllowWarnDeny, NoRestrictedImportsConfigEnum, ...NoRestrictedImportsConfigEnum[]];
   "no-restricted-properties"?: RuleNoConfig | [AllowWarnDeny, PropertyDetails, ...PropertyDetails[]];
   "no-return-assign"?: RuleNoConfig | [AllowWarnDeny, NoReturnAssignMode];
@@ -1135,9 +1153,10 @@ interface DummyRuleMap {
   "no-useless-return"?: RuleNoConfig;
   "no-var"?: RuleNoConfig;
   "no-void"?: RuleNoConfig | [AllowWarnDeny, NoVoid];
-  "no-warning-comments"?: RuleNoConfig | [AllowWarnDeny, NoWarningCommentsConfigJson];
+  "no-warning-comments"?: RuleNoConfig | [AllowWarnDeny, NoWarningCommentsConfig];
   "no-with"?: RuleNoConfig;
   "node/callback-return"?: RuleNoConfig | [AllowWarnDeny, CallbackReturn];
+  "node/exports-style"?: RuleNoConfig | [AllowWarnDeny, ExportsStyleMode] | [AllowWarnDeny, ExportsStyleMode, ExportsStyleOptions];
   "node/global-require"?: RuleNoConfig;
   "node/handle-callback-err"?: RuleNoConfig | [AllowWarnDeny, HandleCallbackErrConfig];
   "node/no-exports-assign"?: RuleNoConfig;
@@ -1154,6 +1173,7 @@ interface DummyRuleMap {
   "oxc/bad-bitwise-operator"?: RuleNoConfig;
   "oxc/bad-char-at-comparison"?: RuleNoConfig;
   "oxc/bad-comparison-sequence"?: RuleNoConfig;
+  "oxc/bad-match-all-arg"?: RuleNoConfig;
   "oxc/bad-min-max-func"?: RuleNoConfig;
   "oxc/bad-object-literal-comparison"?: RuleNoConfig;
   "oxc/bad-replace-all-arg"?: RuleNoConfig;
@@ -1579,7 +1599,7 @@ interface DummyRuleMap {
   "vitest/prefer-hooks-on-top"?: RuleNoConfig;
   "vitest/prefer-import-in-mock"?: RuleNoConfig | [AllowWarnDeny, PreferImportInMockConfig];
   "vitest/prefer-importing-vitest-globals"?: RuleNoConfig;
-  "vitest/prefer-lowercase-title"?: DummyRule;
+  "vitest/prefer-lowercase-title"?: RuleNoConfig | [AllowWarnDeny, PreferLowercaseTitleConfig];
   "vitest/prefer-mock-promise-shorthand"?: RuleNoConfig;
   "vitest/prefer-mock-return-shorthand"?: RuleNoConfig;
   "vitest/prefer-snapshot-hint"?: RuleNoConfig | [AllowWarnDeny, SnapshotHintMode];
@@ -2299,6 +2319,96 @@ interface PreferImportingJestGlobalsConfig {
    */
   types?: JestFnType[];
 }
+interface PreferLowercaseTitleConfig {
+  /**
+   * This array option allows specifying prefixes, which contain capitals that titles
+   * can start with. This can be useful when writing tests for API endpoints, where
+   * you'd like to prefix with the HTTP method.
+   * By default, nothing is allowed (the equivalent of `{ "allowedPrefixes": [] }`).
+   *
+   * Example of **correct** code for the `{ "allowedPrefixes": ["GET"] }` option:
+   * ```js
+   * /* jest/prefer-lowercase-title: ["error", { "allowedPrefixes": ["GET"] }] * /
+   * describe('GET /live');
+   * ```
+   */
+  allowedPrefixes?: string[];
+  /**
+   * This array option controls which Jest or Vitest functions are checked by this rule. There
+   * are four possible values:
+   * - `"describe"`
+   * - `"test"`
+   * - `"it"`
+   * - `"bench"`
+   *
+   * By default, none of these options are enabled (the equivalent of
+   * `{ "ignore": [] }`).
+   *
+   * Example of **correct** code for the `{ "ignore": ["describe"] }` option:
+   * ```js
+   * /* jest/prefer-lowercase-title: ["error", { "ignore": ["describe"] }] * /
+   * describe('Uppercase description');
+   * ```
+   *
+   * Example of **correct** code for the `{ "ignore": ["test"] }` option:
+   * ```js
+   * /* jest/prefer-lowercase-title: ["error", { "ignore": ["test"] }] * /
+   * test('Uppercase description');
+   * ```
+   *
+   * Example of **correct** code for the `{ "ignore": ["it"] }` option:
+   * ```js
+   * /* jest/prefer-lowercase-title: ["error", { "ignore": ["it"] }] * /
+   * it('Uppercase description');
+   * ```
+   */
+  ignore?: string[];
+  /**
+   * This option can be set to allow only the top-level `describe` blocks to have a
+   * title starting with an upper-case letter.
+   *
+   * Example of **correct** code for the `{ "ignoreTopLevelDescribe": true }` option:
+   * ```js
+   * /* jest/prefer-lowercase-title: ["error", { "ignoreTopLevelDescribe": true }] * /
+   * describe('MyClass', () => {
+   * describe('#myMethod', () => {
+   * it('does things', () => {
+   * //
+   * });
+   * });
+   * });
+   * ```
+   */
+  ignoreTopLevelDescribe?: boolean;
+  /**
+   * This option can be set to only validate that the first character of a test name is lowercased.
+   *
+   * Example of **correct** code for the `{ "lowercaseFirstCharacterOnly": true }` option:
+   * ```js
+   * /* vitest/prefer-lowercase-title: ["error", { "lowercaseFirstCharacterOnly": true }] * /
+   * describe('myClass', () => {
+   * describe('myMethod', () => {
+   * it('does things', () => {
+   * //
+   * });
+   * });
+   * });
+   * ```
+   *
+   * Example of **incorrect** code for the `{ "lowercaseFirstCharacterOnly": true }` option:
+   * ```js
+   * /* vitest/prefer-lowercase-title: ["error", { "lowercaseFirstCharacterOnly": true }] * /
+   * describe('MyClass', () => {
+   * describe('MyMethod', () => {
+   * it('does things', () => {
+   * //
+   * });
+   * });
+   * });
+   * ```
+   */
+  lowercaseFirstCharacterOnly?: boolean;
+}
 interface RequireHookConfig {
   /**
    * An array of function names that are allowed to be called outside of hooks.
@@ -3382,6 +3492,38 @@ interface RestrictDefaultExports {
    */
   namespaceFrom?: boolean;
 }
+/**
+ * A restricted global with an optional custom message.
+ */
+interface RestrictedGlobal {
+  /**
+   * A custom message shown when the restricted global is used.
+   */
+  message?: string;
+  /**
+   * The name of the restricted global.
+   */
+  name: string;
+}
+/**
+ * Object form of the configuration, which additionally allows detecting
+ * restricted globals accessed via global objects.
+ */
+interface NoRestrictedGlobalsObjectConfig {
+  /**
+   * Whether to also detect restricted globals accessed via global objects. Default is `false`.
+   */
+  checkGlobalObject?: boolean;
+  /**
+   * Additional global object names to check when `checkGlobalObject` is enabled.
+   * By default, the rule checks these global objects: `globalThis`, `self`, and `window`.
+   */
+  globalObjects?: string[];
+  /**
+   * The restricted globals, as names or `{ "name", "message" }` objects.
+   */
+  globals: GlobalNameOrObject[];
+}
 interface RestrictedPath {
   allowImportNames?: string[];
   allowTypeImports?: boolean;
@@ -3920,11 +4062,28 @@ interface NoVoid {
    */
   allowAsStatement?: boolean;
 }
-interface NoWarningCommentsConfigJson {
+interface NoWarningCommentsConfig {
+  /**
+   * An array of characters to ignore at the start of comments when `location` is `"start"`.
+   *
+   * Useful for ignoring common comment decorations like `*` in JSDoc-style comments.
+   */
   decoration?: string[];
+  /**
+   * Where to check for the terms.
+   */
   location?: Location;
+  /**
+   * An array of terms to match. The matching is case-insensitive.
+   */
   terms?: string[];
 }
+interface ExportsStyleOptions {
+  /**
+   * If this option is set to `true`, `module.exports = exports = obj` are allowed.
+   */
+  allowBatchAssign?: boolean;
+}
 interface NoMixedRequiresOptions {
   allowCall?: boolean;
   grouping?: boolean;
@@ -5507,12 +5666,30 @@ interface NoUnnecessaryBooleanLiteralCompareConfig {
 }
 interface NoUnnecessaryConditionConfig {
   /**
-   * Whether to allow constant loop conditions.
-   * `true` is treated as `"always"`, `false` as `"never"`.
+   * Controls which constant conditions are allowed in `while`, `do...while`, and `for` loops.
+   *
+   * - `"never"` (or `false`) reports all constant loop conditions.
+   * - `"always"` (or `true`) allows conditions whose type is the literal type `true`, such as
+   * `while (true)` or `while (variable)` when `variable` has type `true`.
+   * - `"only-allowed-literals"` allows only the literal expressions `true`, `false`, `0`, and
+   * `1`. Variables whose types are those literal types are still reported.
    */
   allowConstantLoopConditions?: AllowConstantLoopConditions;
   /**
-   * Whether to check type predicate functions.
+   * Whether to check arguments passed to type predicate and assertion functions.
+   *
+   * When enabled, the rule reports a call if the argument already satisfies the predicate or
+   * if an assertion function receives an argument that is always truthy or always falsy.
+   *
+   * For example, `narrow(value)` is unnecessary because `value` already has type `true`:
+   *
+   * ```ts
+   * declare const narrow: (value: unknown) => value is true;
+   * const value = true;
+   * if (narrow(value)) {
+   * // ...
+   * }
+   * ```
    */
   checkTypePredicates?: boolean;
 }
@@ -6741,6 +6918,11 @@ interface VitestPluginSettings {
 type Oxlintrc = Omit<Oxlintrc$1, "$schema" | "extends">;
 type ExternalPluginsConfig = Exclude<Oxlintrc["jsPlugins"], undefined | null>;
 interface OxlintConfig extends Oxlintrc {
+  /**
+   * Configuration objects to extend.
+   *
+   * Import configurations and pass them directly instead of using file paths.
+   */
   extends?: OxlintConfig[];
 }
 /**
@@ -6749,6 +6931,6 @@ interface OxlintConfig extends Oxlintrc {
  * @param config - Oxlint configuration
  * @returns Config unchanged
  */
-declare function defineConfig<T extends OxlintConfig>(config: T): T;
+declare function defineConfig<T extends OxlintConfig>(config: T & OxlintConfig): T;
 //#endregion
 export { type AllowWarnDeny, type DummyRule, type DummyRuleMap, type ExternalPluginEntry, type ExternalPluginsConfig, type OxlintConfig, type OxlintEnv, type OxlintGlobals, type OxlintOverride, type RuleCategories, defineConfig };