Rule proposal: `prefer-regexp-code-point-escape`

Repository metrics

Stars

5,022 stars (5,022 stars)

PR merge metrics

Avg merge 1d 16h (Avg merge 1d 16h)399 merged PRs in 30d (399 merged PRs in 30d)

Description

const foo = '\123'; // Octal
const foo = '\cA'; // Control escape sequence
const foo = '\x7A'; // Hex
const foo = '\u2661'; // Unicode escape sequence
const foo = '\uD83D\uDCA9'; // Unicode surrogate pair

const foo = '\u{7A}';
const foo = '\u{1F4A9}';

Contributor guide

Research direction

First, read the linked articles on Unicode code point escapes and the existing no hex escapes rule to understand the context. Then, examine the eslint plugin unicorn repository structure, especially existing rules under the 'rules' directory, to learn the pattern for implementing a new rule. Implement the rule logic that detects octal, control, hex, and unicode escapes and suggests using code point escapes. Ensure to add appropriate tests and documentation. Finally, consider the overlap with the no hex escapes rule and decide whether to deprecate it or keep both.

Tech stack

javascript

Domain

toolingdeveloper experience

Issue type

Feature

DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.

3

Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.

3-5 days

Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.

Fresh

ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.

Clear

Prerequisites

ESLint rule writing basicsJavaScript regex escapes

Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.

70