Skip to content

Docs: Mention Stylistic as the source of replacement rules for all the stylistic rules that got deprecated #18053

@danfuzz

Description

@danfuzz

Docs page(s)

https://eslint.org/docs/latest/rules/#deprecated

What documentation issue do you want to solve?

In the "deprecated rules" section, the ESLint docs sometimes indicate what a deprecated rule is replaced by. However, in the case of the rules that moved to Stylistic, there's no indication that that's where to find them.

I noticed this because, while perusing the docs, I was surprised that semi was deprecated with no apparent-in-the-docs replacement. Since deprecated rules aren't linked to their documentation page, it took a bit of spelunking to figure out what happened. To be clear, the documentation page at https://eslint.org/docs/latest/rules/semi does indicate where to find the replacement, but there's no link to that page from the main rules page.

What do you think is the correct solution?

I'd like the ESLint "rules" page to prominently link to Stylistic on each of the deprecated rules for which that would be appropriate. Perhaps the links to the deprecated rules' doc pages should be restored too?

Participation

  • I am willing to submit a pull request for this change.

Additional comments

(I'm only reluctant to submit a pull request because I am not convinced I know how to efficiently fix all the docs in a way that the project would deem acceptable.)

Metadata

Metadata

Assignees

Labels

acceptedThere is consensus among the team that this change meets the criteria for inclusiondocumentationRelates to ESLint's documentation

Type

No type

Projects

Status

Complete

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions