Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Bug: deprecate lines-around-comment #15292

Closed
1 task
gajus opened this issue Nov 11, 2021 · 1 comment · Fixed by #15293
Closed
1 task

Bug: deprecate lines-around-comment #15292

gajus opened this issue Nov 11, 2021 · 1 comment · Fixed by #15293
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation rule Relates to ESLint's core rules
Projects
Triage

Comments

@gajus
Copy link
Contributor

gajus commented Nov 11, 2021 •
edited

What did you expect to happen?

meta.deprecated to be set.

What actually happened?

meta.deprecated is not set.

Participation

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

Additional comments

This rule is deprecated in documentation, but not in meta.

https://eslint.org/docs/rules/lines-around-comment
@gajus gajus added bug ESLint is working incorrectly repro:needed labels Nov 11, 2021
@eslint-github-bot eslint-github-bot bot added this to Needs Triage in Triage Nov 11, 2021
gajus added a commit to gajus/eslint-config-canonical that referenced this issue Nov 11, 2021
@gajus
chore: add utility to identify deprecated rules
463f281 
This has been useful to catch a few improperly deprecated rules like:

* jsx-eslint/eslint-plugin-jsx-a11y#825
* eslint/eslint#15292
@mdjermanovic mdjermanovic moved this from Needs Triage to Triaging in Triage Nov 11, 2021
mdjermanovic added a commit that referenced this issue Nov 11, 2021
@mdjermanovic
docs: remove deprecation note from lines-around-comment
d4a4ed3 
This rule was mistakenly marked as deprecated in the documentation.

Fixes #15292
@mdjermanovic mdjermanovic mentioned this issue Nov 11, 2021
Merged
1 task
@mdjermanovic
Copy link
Member

Hi @gajus, thanks for finding this!

This rule is deprecated in documentation, but not in meta.

https://eslint.org/docs/rules/lines-around-comment

lines-around-comment isn't deprecated, this is a documentation bug. I prepared #15293 to fix that.

@mdjermanovic mdjermanovic moved this from Triaging to Pull Request Opened in Triage Nov 11, 2021
@mdjermanovic mdjermanovic added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation rule Relates to ESLint's core rules and removed repro:needed bug ESLint is working incorrectly labels Nov 11, 2021
Triage automation moved this from Pull Request Opened to Complete Nov 12, 2021
nzakas pushed a commit that referenced this issue Nov 12, 2021
@mdjermanovic
docs: remove deprecation note from lines-around-comment (#15293)
da238cc 
This rule was mistakenly marked as deprecated in the documentation.

Fixes #15292
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators May 12, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label May 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation rule Relates to ESLint's core rules
Projects
Triage
Archived in project
Triage
Complete
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: remove deprecation note from lines-around-comment eslint/eslint
2 participants
@gajus @mdjermanovic