From 5cfffcdddb3618d11cfcb5cf42876acf1f9deba2 Mon Sep 17 00:00:00 2001 From: Connor Shea Date: Wed, 29 Oct 2025 16:19:19 -0600 Subject: [PATCH] docs(linter): Add configuration option docs for jsdoc/no-defaults rule. --- crates/oxc_linter/src/rules/jsdoc/no_defaults.rs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/crates/oxc_linter/src/rules/jsdoc/no_defaults.rs b/crates/oxc_linter/src/rules/jsdoc/no_defaults.rs index e6a9188ec4e0b..8d083b8427fa4 100644 --- a/crates/oxc_linter/src/rules/jsdoc/no_defaults.rs +++ b/crates/oxc_linter/src/rules/jsdoc/no_defaults.rs @@ -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::{ @@ -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, }