oxlint 1.76.0 → 1.78.0

package/dist/index.d.ts

@@ -156,6 +156,18 @@ type ExportsStyleMode = "module.exports" | "exports";
 type HandleCallbackErrConfig = string;
 type NoMixedRequiresConfig = boolean | NoMixedRequiresOptions;
 type ShorthandType = "always" | "methods" | "properties" | "consistent" | "consistent-as-needed" | "never";
+/**
+ * Enforces consistent grouping of variable declarations.
+ */
+type OneVar = OneVarConfig;
+/**
+ * Configuration accepted by the `one-var` rule.
+ */
+type OneVarConfig = OneVarMode | OneVarOptions;
+/**
+ * Controls how variable declarators are grouped into declarations.
+ */
+type OneVarMode = "always" | "never" | "consecutive";
 type Destructuring = "any" | "all";
 type PreferDestructuringOption = PreferDestructuringTargetOption | PreferDestructuringAssignmentConfig;
 type TerminationMethod = string | string[];
@@ -203,9 +215,7 @@ type ImportKind = "none" | "all" | "multiple" | "single";
 type SortOrder = "desc" | "asc";
 type ArrayOption = "array" | "array-simple" | "generic";
 type ReadonlyArrayOption = "array" | "array-simple" | "generic";
-type DirectiveConfigSchema = boolean | RequireDescription | {
-  descriptionFormat?: string;
-};
+type DirectiveConfigSchema = boolean | RequireDescription | DescriptionFormatConfig;
 type RequireDescription = "allow-with-description";
 type ClassLiteralPropertyStyleOption = "fields" | "getters";
 type PreferGenericType = "constructor" | "type-annotation";
@@ -948,6 +958,7 @@ interface DummyRuleMap {
   "jsdoc/check-tag-names"?: RuleNoConfig | [AllowWarnDeny, CheckTagNamesConfig];
   "jsdoc/empty-tags"?: RuleNoConfig | [AllowWarnDeny, EmptyTagsConfig];
   "jsdoc/implements-on-classes"?: RuleNoConfig;
+  "jsdoc/no-blank-blocks"?: RuleNoConfig | [AllowWarnDeny, NoBlankBlocks];
   "jsdoc/no-defaults"?: RuleNoConfig | [AllowWarnDeny, NoDefaultsConfig];
   "jsdoc/require-param"?: RuleNoConfig | [AllowWarnDeny, RequireParamConfig];
   "jsdoc/require-param-description"?: RuleNoConfig | [AllowWarnDeny, RequireParamDescriptionConfig];
@@ -967,7 +978,7 @@ interface DummyRuleMap {
   "jsdoc/require-yields-type"?: RuleNoConfig;
   "jsx-a11y/alt-text"?: RuleNoConfig | [AllowWarnDeny, AltTextConfigSchema];
   "jsx-a11y/anchor-ambiguous-text"?: RuleNoConfig | [AllowWarnDeny, AnchorAmbiguousTextConfig];
-  "jsx-a11y/anchor-has-content"?: RuleNoConfig;
+  "jsx-a11y/anchor-has-content"?: RuleNoConfig | [AllowWarnDeny, AnchorHasContentConfig];
   "jsx-a11y/anchor-is-valid"?: RuleNoConfig | [AllowWarnDeny, AnchorIsValidConfig];
   "jsx-a11y/aria-activedescendant-has-tabindex"?: RuleNoConfig;
   "jsx-a11y/aria-props"?: RuleNoConfig;
@@ -1153,7 +1164,7 @@ 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];
@@ -1167,6 +1178,7 @@ interface DummyRuleMap {
   "node/no-sync"?: RuleNoConfig | [AllowWarnDeny, NoSyncConfig];
   "node/no-top-level-await"?: RuleNoConfig | [AllowWarnDeny, NoTopLevelAwaitConfig];
   "object-shorthand"?: RuleNoConfig | [AllowWarnDeny, ShorthandType] | [AllowWarnDeny, ShorthandType, ObjectShorthandOptions];
+  "one-var"?: RuleNoConfig | [AllowWarnDeny, OneVar];
   "operator-assignment"?: RuleNoConfig | [AllowWarnDeny, AlwaysNever];
   "oxc/approx-constant"?: RuleNoConfig;
   "oxc/bad-array-method-on-arguments"?: RuleNoConfig;
@@ -2463,6 +2475,12 @@ interface EmptyTagsConfig {
    */
   tags?: string[];
 }
+interface NoBlankBlocks {
+  /**
+   * Whether to automatically remove blank JSDoc blocks.
+   */
+  enableFixer?: boolean;
+}
 interface NoDefaultsConfig {
   /**
    * If true, report the presence of optional param names (square brackets) on `@param` tags.
@@ -2605,6 +2623,12 @@ interface AnchorAmbiguousTextConfig {
    */
   words?: string[];
 }
+interface AnchorHasContentConfig {
+  /**
+   * Additional custom component names to treat as anchor elements.
+   */
+  components?: string[];
+}
 interface AnchorIsValidConfig {
   /**
    * Sub-rule aspects to run.
@@ -4062,9 +4086,20 @@ 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 {
@@ -4107,6 +4142,46 @@ interface ObjectShorthandOptions {
   ignoreConstructors?: boolean;
   methodsIgnorePattern?: string;
 }
+/**
+ * Options for configuring declaration grouping by kind or initialization state.
+ *
+ * `initialized` and `uninitialized` take precedence over the per-kind option for the
+ * corresponding declarators.
+ */
+interface OneVarOptions {
+  /**
+   * Controls grouping for `await using` declarations.
+   */
+  awaitUsing?: OneVarMode;
+  /**
+   * Controls grouping for `const` declarations.
+   */
+  const?: OneVarMode;
+  /**
+   * Controls grouping for initialized declarators, overriding per-kind options.
+   */
+  initialized?: OneVarMode;
+  /**
+   * Controls grouping for `let` declarations.
+   */
+  let?: OneVarMode;
+  /**
+   * Keeps direct `require(...)` initializers separate from other initialized declarations.
+   */
+  separateRequires?: boolean;
+  /**
+   * Controls grouping for uninitialized declarators, overriding per-kind options.
+   */
+  uninitialized?: OneVarMode;
+  /**
+   * Controls grouping for `using` declarations.
+   */
+  using?: OneVarMode;
+  /**
+   * Controls grouping for `var` declarations.
+   */
+  var?: OneVarMode;
+}
 interface NoAsyncEndpointHandlersConfig {
   /**
    * An array of names that are allowed to be async.
@@ -5103,6 +5178,9 @@ interface BanTsCommentConfig {
    */
   "ts-nocheck"?: DirectiveConfigSchema;
 }
+interface DescriptionFormatConfig {
+  descriptionFormat?: string;
+}
 interface ConsistentReturnConfig {
   /**
    * Treat explicit `return undefined` as equivalent to an unspecified return.
@@ -5655,12 +5733,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;
 }