sindresorhus/eslint-plugin-unicorn

Rule proposal: `require-css-escape`

Closed

#2,318 opened on Apr 10, 2024

View on GitHubContributor guide
 (2 comments) (3 reactions) (0 assignees)JavaScript (468 forks)user submission
help wantednew rule

Repository metrics

Stars
 (5,022 stars)
PR merge metrics
 (Avg merge 1d 16h) (399 merged PRs in 30d)

Description

Description

CSS.escape should always be used when interpolating arbritrary variables into a CSS selector to ensure correct escaping.

Fail

document.querySelector(`#${id}`);

el.querySelectorAll(`a[href^="#${hash}"]`);

Pass

document.querySelector(`#${CSS.escape(id)}`);

el.querySelectorAll(`a[href^="#${CSS.escape(hash)}"]`);

Any tagged template should not trigger the rule:

document.querySelector(cssEscape`#${id}`);

Contributor guide

Research direction
Examine existing ESLint rules in eslint plugin unicorn to understand the pattern for rule creation, then implement a rule that detects direct variable interpolation in CSS selectors without CSS.escape.
Tech stack
javascript
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ESLintASTJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75