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.

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

Fix: preserve formatting when rules are removed from disable directives #15081

Merged
merged 1 commit into from Sep 24, 2021

Conversation

mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Sep 19, 2021

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[x] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

refs #14878, fixes #14617 (comment)

This fix aims at preserving the original formatting of eslint-disable-* directives when individual rules are being removed during the autofix.

What changes did you make? (Give an overview)

Extended the removal range for the first and the last element in the rule list.

If the first rule is being removed, the removal range will include all whitespace up to the name of the second rule in the list. This way, used will start at the same position where unused was.

// eslint-disable-line unused , used
                       ^^^^^^^^^

If the last rule is being removed, the removal range will include all whitespace on the left side up to the name of the previous rule in the list. This way, used will end at the same position where unused was ending, relative to the content that comes after.

// eslint-disable-line used , unused -- comment
                           ^^^^^^^^^

Is there anything you'd like reviewers to focus on?

@mdjermanovic mdjermanovic added bug ESLint is working incorrectly core Relates to ESLint's core APIs and features accepted There is consensus among the team that this change meets the criteria for inclusion autofix This change is related to ESLint's autofixing capabilities labels Sep 19, 2021
nzakas
nzakas approved these changes Sep 23, 2021
Copy link
Member

@nzakas nzakas left a comment

Nice job!

@mdjermanovic mdjermanovic merged commit c9efb5f into master Sep 24, 2021
13 checks passed
@mdjermanovic mdjermanovic deleted the issue14878 branch Sep 24, 2021
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 24, 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 Mar 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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 autofix This change is related to ESLint's autofixing capabilities bug ESLint is working incorrectly core Relates to ESLint's core APIs and features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants