-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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.
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
Docs: Mention Stylistic as the source of replacement rules for all the stylistic rules that got deprecated #18053
Comments
Hi @danfuzz, thanks for the issue. Just to confirm, this request is to link to the specific Something like this? Technically, these rules are not replaced by another rule in the core. They have just been moved to a 3rd party plugin. Maybe the wording could be different. |
I guess the request is to add both
|
I'd love to use a rule's As a side note, I actually disagree with the change to remove such information that occurred in: |
ping @eslint/eslint-team |
We actually mention the replacement rules on the rule page for all deprecated rules, like this: So, not opposed to surfacing that information on the rule index page, but we don't have the infrastructure in place to do that right now, so we'd need something like #18061 in place first. |
+1 from me on this issue. Going through https://eslint.org/docs/latest/rules anew, it does feel surprising that there's no link that reaches a page explaining where those rules went. Additional +1 from me on making the Edit: heh, posted at about the same time as #18053 (comment). +1 to that. |
Just a reminder to everyone on the team: please don't just comment on issues, we should be moving them through the triage board. Because it seems like there is support for this one the team, I'm marking as accepted as moving to "Blocked" pending #18061 |
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
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.)
The text was updated successfully, but these errors were encountered: