Skip to content

refactor(linter): improve unicorn/escape-case #9568

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
graphite-app merged 1 commit into from
Mar 5, 2025
Merged

refactor(linter): improve unicorn/escape-case #9568

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
70 changes: 29 additions & 41 deletions crates/oxc_linter/src/rules/unicorn/escape_case.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
use std::str::Chars;

use oxc_ast::{
AstKind,
ast::{StringLiteral, TemplateLiteral},
};
use oxc_ast::AstKind;
use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_span::Span;
Expand All @@ -21,16 +18,17 @@ pub struct EscapeCase;
declare_oxc_lint!(
/// ### What it does
///
/// Enforces defining escape sequence values with uppercase characters rather than lowercase ones. This promotes readability by making the escaped value more distinguishable from the identifier.
/// Enforces defining escape sequence values with uppercase characters rather than lowercase ones.
/// This promotes readability by making the escaped value more distinguishable from the identifier.
///
/// ### Why is this bad?
///
/// Using lowercase characters in escape sequences makes them less readable and harder to distinguish
/// from surrounding code. Most style guides recommend uppercase for consistency and clarity.
///
/// ### Examples
///
/// Examples of **incorrect** code for this rule:
///
/// <!-- prettier-ignore-start -->
///
/// ```javascript
/// const foo = "\xa9";
/// const foo = "\ud834";
Expand All @@ -45,63 +43,51 @@ declare_oxc_lint!(
/// const foo = "\u{1D306}";
/// const foo = "\cA";
/// ```
///
/// <!-- prettier-ignore-end -->
EscapeCase,
unicorn,
pedantic,
fix
);

fn is_hex_char(c: char) -> bool {
c.is_ascii_hexdigit()
}
fn is_hex(iter: &Chars, count: i32) -> bool {
let mut iter = iter.clone();
for _ in 0..count {
if !matches!(iter.next(), Some(c) if is_hex_char(c)) {
return false;
}
}
true
fn is_hex(iter: &Chars, count: usize) -> bool {
iter.clone().take(count).all(|c| c.is_ascii_hexdigit())
}

// /(?<=(?:^|[^\\])(?:\\\\)*\\)(?<data>x[\dA-Fa-f]{2}|u[\dA-Fa-f]{4}|u{[\dA-Fa-f]+})/g
fn check_case(value: &str, is_regex: bool) -> Option<String> {
let mut in_escape = false;
let mut result = String::with_capacity(value.len());

let mut in_escape = false;
let mut p = value.chars();
while let Some(c) = p.next() {
result.push(c);
if in_escape {
match c {
'x' => {
if is_hex(&p, 2) {
for _ in 0..2 {
result.push(p.next().unwrap().to_ascii_uppercase());
}
'x' if is_hex(&p, 2) => {
for _ in 0..2 {
result.push(p.next().unwrap().to_ascii_uppercase());
}
}
'u' => {
let mut iter = p.clone();
let c = iter.next();
if c == Some('{') {
let mut count = 0;
let mut is_match = false;
let mut chars = vec![];
for c in iter {
if c == '}' {
is_match = true;
break;
} else if is_hex_char(c) {
chars.push(c);
} else if c.is_ascii_hexdigit() {
count += 1;
} else {
break;
}
}
if is_match {
p.next();
result.push('{');
for _ in 0..chars.len() {
for _ in 0..count {
result.push(p.next().unwrap().to_ascii_uppercase());
}
p.next();
Expand All @@ -126,24 +112,24 @@ fn check_case(value: &str, is_regex: bool) -> Option<String> {
}
}

if result == value { None } else { Some(result) }
(result != value).then_some(result)
}

impl Rule for EscapeCase {
fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) {
match node.kind() {
AstKind::StringLiteral(StringLiteral { span, .. }) => {
let text = span.source_text(ctx.source_text());
AstKind::StringLiteral(lit) => {
let text = lit.span.source_text(ctx.source_text());
if let Some(fixed) = check_case(text, false) {
ctx.diagnostic_with_fix(escape_case_diagnostic(*span), |fixer| {
fixer.replace(*span, fixed)
ctx.diagnostic_with_fix(escape_case_diagnostic(lit.span), |fixer| {
fixer.replace(lit.span, fixed)
});
}
}
AstKind::TemplateLiteral(TemplateLiteral { quasis, .. }) => {
quasis.iter().for_each(|quasi| {
if let Some(fixed) =
check_case(quasi.span.source_text(ctx.source_text()), false)
{
AstKind::TemplateLiteral(lit) => {
lit.quasis.iter().for_each(|quasi| {
let text = quasi.span.source_text(ctx.source_text());
if let Some(fixed) = check_case(text, false) {
ctx.diagnostic_with_fix(escape_case_diagnostic(quasi.span), |fixer| {
fixer.replace(quasi.span, fixed)
});
Expand Down Expand Up @@ -211,12 +197,14 @@ fn test() {
r#"const foo = new RegExp("/\ca/")"#,
r#"const foo = new RegExp("/\cA/")"#,
];

let fail = vec![
r#"const foo = "\xAab\xaab\xAAb\uAaAab\uaaaab\uAAAAb\u{AaAa}b\u{aaaa}b\u{AAAA}";"#,
r"const foo = `\xAab\xaab\xAA${foo}\uAaAab\uaaaab\uAAAAb\u{AaAa}${foo}\u{aaaa}b\u{AAAA}`;",
r"const foo = `\ud834${foo}\ud834${foo}\ud834`;",
r#"const foo = new RegExp("/\u{1d306}/", "u")"#,
];

let fix = vec![
(r#"const foo = "\xa9";"#, r#"const foo = "\xA9";"#, None),
(r#"const foo = "\xAa";"#, r#"const foo = "\xAA";"#, None),
Expand Down
Loading