Skip to content

docs(linter): Add configuration option docs for jsdoc/no-defaults rule. #15074

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
merged 1 commit into from
Oct 29, 2025
Merged

docs(linter): Add configuration option docs for jsdoc/no-defaults rule. #15074

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions crates/oxc_linter/src/rules/jsdoc/no_defaults.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use oxc_ast::AstKind;
use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_span::Span;
use schemars::JsonSchema;
use serde::Deserialize;

use crate::{
Expand Down Expand Up @@ -47,12 +48,14 @@ declare_oxc_lint!(
/// ```
NoDefaults,
jsdoc,
correctness
correctness,
config = NoDefaultsConfig,
);

#[derive(Debug, Default, Clone, Deserialize)]
#[derive(Debug, Default, Clone, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase", default)]
struct NoDefaultsConfig {
#[serde(default, rename = "noOptionalParamNames")]
/// If true, report the presence of optional param names (square brackets) on `@param` tags.
no_optional_param_names: bool,
}

Expand Down
Loading