Skip to content

docs(linter): Add configuration option docs for eslint/no-misleading-character-class rule. #15058

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 eslint/no-misleading-character-class rule. #15058

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
46 changes: 22 additions & 24 deletions crates/oxc_linter/src/rules/eslint/no_misleading_character_class.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ use oxc_regular_expression::{
visit::{RegExpAstKind, Visit},
};
use oxc_span::Span;
use schemars::JsonSchema;

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

Expand All @@ -29,8 +30,27 @@ fn zwj_diagnostic(span: Span) -> OxcDiagnostic {
OxcDiagnostic::warn("Unexpected joined character sequence in character class.").with_label(span)
}

#[derive(Debug, Default, Clone)]
#[derive(Debug, Default, Clone, JsonSchema)]
#[serde(rename_all = "camelCase", default)]
pub struct NoMisleadingCharacterClass {
/// When set to `true`, the rule allows any grouping of code points
/// inside a character class as long as they are written using escape sequences.
///
/// Examples of **incorrect** code for this rule with `{ "allowEscape": true }`:
/// ```javascript
/// /[\uD83D]/; // backslash can be omitted
/// new RegExp("[\ud83d" + "\udc4d]");
/// ```
///
/// Examples of **correct** code for this rule with `{ "allowEscape": true }`:
/// ```javascript
/// /[\ud83d\udc4d]/;
/// /[\u00B7\u0300-\u036F]/u;
/// /[👨\u200d👩]/u;
/// new RegExp("[\x41\u0301]");
/// new RegExp(`[\u{1F1EF}\u{1F1F5}]`, "u");
/// new RegExp("[\\u{1F1EF}\\u{1F1F5}]", "u");
/// ```
allow_escape: bool,
}

Expand Down Expand Up @@ -77,32 +97,10 @@ declare_oxc_lint!(
/// /[\u00B7\u0300-\u036F]/u;
/// new RegExp("^[\u{1F1EF}\u{1F1F5}]", "u");
/// ```
///
/// #### Options
///
/// This rule has an object option:
///
/// - `allowEscape`: When set to `true`, the rule allows any grouping of code points
/// inside a character class as long as they are written using escape sequences.
///
/// Examples of **incorrect** code for this rule with `{ "allowEscape": true }`:
/// ```javascript
/// /[\uD83D]/; // backslash can be omitted
/// new RegExp("[\ud83d" + "\udc4d]");
/// ```
///
/// Examples of **correct** code for this rule with `{ "allowEscape": true }`:
/// ```javascript
/// /[\ud83d\udc4d]/;
/// /[\u00B7\u0300-\u036F]/u;
/// /[👨\u200d👩]/u;
/// new RegExp("[\x41\u0301]");
/// new RegExp(`[\u{1F1EF}\u{1F1F5}]`, "u");
/// new RegExp("[\\u{1F1EF}\\u{1F1F5}]", "u");
/// ```
NoMisleadingCharacterClass,
eslint,
nursery, // TODO: change category to `correctness`, after oxc-project/oxc#13660 and oxc-project/oxc#13436
config = NoMisleadingCharacterClass,
);

#[derive(Debug)]
Expand Down
Loading