Skip to content

docs(linter): Update no-plusplus rule to expose documentation for config options #14837

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 21, 2025
+4 −17
Merged

docs(linter): Update no-plusplus rule to expose documentation for config options #14837

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
21 changes: 4 additions & 17 deletions crates/oxc_linter/src/rules/eslint/no_plusplus.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, ast::UpdateOperator};
use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_span::{GetSpan, Span};
use schemars::JsonSchema;

use crate::{AstNode, context::LintContext, rule::Rule};

Expand All @@ -22,7 +23,8 @@ fn no_plusplus_diagnostic(span: Span, operator: UpdateOperator) -> OxcDiagnostic
}
}

#[derive(Debug, Default, Clone)]
#[derive(Debug, Default, Clone, JsonSchema)]
#[serde(rename_all = "camelCase", default)]
pub struct NoPlusplus {
/// Whether to allow `++` and `--` in for loop afterthoughts.
allow_for_loop_afterthoughts: bool,
Expand Down Expand Up @@ -76,29 +78,14 @@ declare_oxc_lint!(
/// doSomething(i);
/// }
/// ```
///
/// ### Options
///
/// #### allowForLoopAfterthoughts
///
/// `{ type: boolean, default: false }`
///
/// Pass `"allowForLoopAfterthoughts": true` to allow `++` and `--` in for loop afterthoughts.
///
/// Example:
/// ```json
/// "no-plusplus": [
/// "error",
/// { "allowForLoopAfterthoughts": true }
/// ]
/// ```
NoPlusplus,
eslint,
restriction,
// This is not guaranteed to rewrite the code in a way that is equivalent.
// For example, `++i` and `i++` will be rewritten as `i += 1` even though they are not the same.
// If the code depends on the order of evaluation, then this might break it.
conditional_suggestion,
config = NoPlusplus,
);

impl Rule for NoPlusplus {
Expand Down
Loading