WordPress/gutenberg

Add ESLint rule to prevent usage of the order CSS property

Closed

#61,247 opened on Apr 30, 2024

View on GitHubContributor guide
 (12 comments) (0 reactions) (1 assignee)JavaScript (3,893 forks)batch import
Good First Issue[Focus] Accessibility (a11y)[Status] In Progress[Type] Code Quality

Repository metrics

Stars
 (9,607 stars)
PR merge metrics
 (Avg merge 12d 18h) (509 merged PRs in 30d)

Description

Description

See https://github.com/WordPress/gutenberg/issues/61241

Some components come with CSS in JS.

https://github.com/WordPress/gutenberg/issues/61241 and https://github.com/WordPress/gutenberg/pull/61243 aim to introduce a stylelint rule to prevent usage of the order CSS property, which is impactful for accessibility.

In the same way, it would be nice to add an ESLint rule to prevent usage of the order CSS property in any *.js file.

Unfortunately this isn't exactly my area of expertise so that I'd appreciate some guidance. I did see a similar rule added in https://github.com/WordPress/gutenberg/pull/58130

Step-by-step reproduction instructions

  • Add an order CSS property e.g. order: 1; to any CSS-in-JS for example in this file..
  • Run npm run lint:js.
  • Observe the linter does not report any error.

Screenshots, screen recording, code snippet

No response

Environment info

No response

Please confirm that you have searched existing issues in the repo.

Yes

Please confirm that you have tested with all plugins deactivated except Gutenberg.

Yes

Contributor guide

Research direction
Refer to the existing ESLint rule added in PR #58130 for implementation pattern. The rule should detect CSS 'order' property in CSS in JS strings. Test with files like packages/components/src/palette edit/styles.ts. Consider consulting the related stylelint rule issue #61241 for context.
Tech stack
javascript
Domain
accessibilitytooling
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.
Half day
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
Understanding of ESLint custom rulesFamiliarity with Gutenberg codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45