Skip to content

docs(linter): Add documentation on ignoreRestSiblings option for no-unused-vars rule #14807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
camc314 merged 3 commits into from
Oct 22, 2025
Merged

docs(linter): Add documentation on ignoreRestSiblings option for no-unused-vars rule #14807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ddffa49
docs(linter): Add documentation on ignoreRestSiblings option for no-u…
howenyap Oct 20, 2025
bc085b2
Apply suggestions from code review
howenyap Oct 20, 2025
06e76f2
remove manually written config docs, use generated config docs
howenyap Oct 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion crates/oxc_linter/src/rules/eslint/no_unused_vars/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,8 @@ declare_oxc_lint!(
NoUnusedVars,
eslint,
correctness,
dangerous_suggestion
dangerous_suggestion,
config = NoUnusedVarsOptions
);

impl Deref for NoUnusedVars {
Expand Down
17 changes: 13 additions & 4 deletions crates/oxc_linter/src/rules/eslint/no_unused_vars/options.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ use std::{borrow::Cow, ops::Deref};

use lazy_regex::{Regex, RegexBuilder};
use oxc_diagnostics::OxcDiagnostic;
use schemars::JsonSchema;
use serde_json::Value;

/// See [ESLint - no-unused-vars config schema](https://github.com/eslint/eslint/blob/53b1ff047948e36682fade502c949f4e371e53cd/lib/rules/no-unused-vars.js#L61)
#[derive(Debug, Clone)]
#[derive(Debug, Clone, JsonSchema)]
#[serde(rename_all = "camelCase")]
#[must_use]
#[non_exhaustive]
pub struct NoUnusedVarsOptions {
Expand Down Expand Up @@ -34,6 +36,7 @@ pub struct NoUnusedVarsOptions {
/// var b = 10;
/// console.log(b);
/// ```
#[schemars(skip)]
pub vars_ignore_pattern: IgnorePattern<Regex>,

/// Controls how unused arguments are checked.
Expand Down Expand Up @@ -65,6 +68,7 @@ pub struct NoUnusedVarsOptions {
/// }
/// foo(1, 2);
/// ```
#[schemars(skip)]
pub args_ignore_pattern: IgnorePattern<Regex>,

/// Using a Rest property it is possible to "omit" properties from an
Expand Down Expand Up @@ -108,6 +112,7 @@ pub struct NoUnusedVarsOptions {
/// console.error("Error caught in catch block");
/// }
/// ```
#[schemars(skip)]
pub caught_errors_ignore_pattern: IgnorePattern<Regex>,

/// This option specifies exceptions within destructuring patterns that will
Expand All @@ -132,6 +137,7 @@ pub struct NoUnusedVarsOptions {
/// console.log(n);
/// });
/// ```
#[schemars(skip)]
pub destructured_array_ignore_pattern: IgnorePattern<Regex>,

/// The `ignoreClassWithStaticInitBlock` option is a boolean (default:
Expand Down Expand Up @@ -368,7 +374,8 @@ impl Default for NoUnusedVarsOptions {
}
}

#[derive(Debug, Default, Clone, PartialEq, Eq)]
#[derive(Debug, Default, Clone, PartialEq, Eq, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub enum VarsOption {
/// All variables are checked for usage, including those in the global scope.
#[default]
Expand All @@ -383,7 +390,8 @@ impl VarsOption {
}
}

#[derive(Debug, Default, Clone, PartialEq, Eq)]
#[derive(Debug, Default, Clone, PartialEq, Eq, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub enum ArgsOption {
/// Unused positional arguments that occur before the last used argument
/// will not be checked, but all named arguments and all positional
Expand Down Expand Up @@ -412,7 +420,8 @@ impl ArgsOption {
}
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, JsonSchema)]
#[serde(rename_all = "camelCase")]
#[repr(transparent)]
pub struct CaughtErrors(bool);

Expand Down
Loading