Skip to content

docs(linter): Add configuration option docs for oxc/no-optional-chaining rule. #15071

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 oxc/no-optional-chaining rule. #15071

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
27 changes: 7 additions & 20 deletions crates/oxc_linter/src/rules/oxc/no_optional_chaining.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 crate::{AstNode, context::LintContext, rule::Rule};

Expand All @@ -18,8 +19,12 @@ fn no_optional_chaining_diagnostic(span: Span, help: &str) -> OxcDiagnostic {
#[derive(Debug, Default, Clone)]
pub struct NoOptionalChaining(Box<NoOptionalChainingConfig>);

#[derive(Debug, Default, Clone)]
#[derive(Debug, Default, Clone, JsonSchema)]
#[serde(rename_all = "camelCase", default)]
pub struct NoOptionalChainingConfig {
/// A custom help message to display when optional chaining is found.
/// For example, "Our output target is ES2016, and optional chaining results in verbose
/// helpers and should be avoided."
message: String,
}

Expand Down Expand Up @@ -52,28 +57,10 @@ declare_oxc_lint!(
/// const foo = obj?.foo;
/// obj.fn?.();
/// ```
///
/// ### Options
///
/// ```json
/// {
/// "rules": {
/// "no-optional-chaining": [
/// "error",
/// {
/// "message": "Our output target is ES2016, and optional chaining results in verbose
/// helpers and should be avoided.",
/// }
/// ]
/// }
/// }
/// ```
///
/// - `message`: A custom help message to display when optional chaining is found.
///
NoOptionalChaining,
oxc,
restriction,
config = NoOptionalChainingConfig,
);

impl Rule for NoOptionalChaining {
Expand Down
Loading