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

Update: add fixer for no-useless-computed-key #7207

Merged
merged 2 commits into from Sep 30, 2016
Merged

Update: add fixer for no-useless-computed-key #7207

merged 2 commits into from Sep 30, 2016

Conversation

not-an-aardvark
Copy link
Member

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

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

Please check each item to ensure your pull request is ready:

  • I've read the pull request guide
  • I've included tests for my change
  • I've updated documentation for my change (if appropriate)

What changes did you make? (Give an overview)

This adds a fixer for no-useless-computed-key.

The fixer removes the square brackets around unnecessary computed keys. For example, ({ ['x']: 0 }) is fixed to ({ 'x': 0 }).

If there are comments between the square brackets and the key, no fix is performed.

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

Nothing in particular.

@mention-bot
Copy link

@not-an-aardvark, thanks for your PR! By analyzing the annotation information on this pull request, we identified @vitorbal, @alberto and @BYK to be potential reviewers

@eslintbot
Copy link

LGTM

platinumazure
platinumazure reviewed Sep 22, 2016
View reviewed changes
Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question about the square bracket search. (Accidentally started a review, this isn't really a review, sorry.)

lib/rules/no-useless-computed-key.js
data: { property: sourceCode.getText(key) },
fix(fixer) {
const leftSquareBracket = sourceCode.getTokenBefore(node.key);
const rightSquareBracket = sourceCode.getTokenAfter(node.key);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: Can parentheses get in the way here?

const obj = {
    [('x')]: null
};

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, yes, that does cause issues; it causes the parens to be removed and not the square brackets. Thanks, I'll figure out how to fix that.

(Technically it doesn't cause incorrect behavior overall since the square brackets would be removed on the next pass, but it's worth fixing regardless.)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to fix that case (and added a test for it).

@eslintbot
Copy link

LGTM

@mysticatea
Copy link
Member

mysticatea commented Sep 23, 2016 •
edited

Could you add the following 2 tests?

  • ({ *['x']() {} })
  • ({ async ['x']() {} })

@mysticatea mysticatea added enhancement This change enhances an existing feature of ESLint rule Relates to ESLint's core rules evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Sep 23, 2016
@eslintbot
Copy link

LGTM

@not-an-aardvark
Copy link
Member Author

Updated to work properly for generator and async properties, and added tests for them.

platinumazure
platinumazure approved these changes Sep 23, 2016
View reviewed changes
Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! (I'd like at least one more review, though.)

mysticatea
mysticatea approved these changes Sep 24, 2016
View reviewed changes
Copy link
Member

@mysticatea mysticatea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you!

@kaicataldo kaicataldo self-assigned this Sep 29, 2016
@kaicataldo
Copy link
Member

I'll champion this.

@kaicataldo kaicataldo added accepted There is consensus among the team that this change meets the criteria for inclusion and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Sep 29, 2016
@kaicataldo kaicataldo merged commit c36d842 into eslint:master Sep 30, 2016
@kaicataldo
Copy link
Member

LGTM. Thanks for contributing to ESLint!

@not-an-aardvark not-an-aardvark deleted the no-useless-computed-key-fixer branch September 30, 2016 04:25
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@platinumazure platinumazure platinumazure approved these changes

@mysticatea mysticatea mysticatea approved these changes

Assignees

@kaicataldo kaicataldo

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 enhancement This change enhances an existing feature of ESLint rule Relates to ESLint's core rules
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@not-an-aardvark @mention-bot @eslintbot @mysticatea @kaicataldo @platinumazure @jquerybot