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: don't modify operator precedence in operator-assignment autofixer #8358

Merged
merged 2 commits into from Mar 31, 2017

Conversation

not-an-aardvark
Copy link
Member

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

[x] Bug fix

Tell us about your environment

  • ESLint Version: master
  • Node Version: 7.8.0
  • npm Version: 4.2.0

What parser (default, Babel-ESLint, etc.) are you using?

default

Please show your full configuration:

rules:
  operator-assignment: [error, never]

What did you do? Please include the actual source code causing the issue.

foo *= bar + baz

What did you expect to happen?

I expected the code to be autofixed to

foo = foo * (bar + baz)

What actually happened? Please include the actual, raw output from ESLint.

The code was autofixed to

foo = foo * bar + baz

What changes did you make? (Give an overview)

Previously, the operator-assignment autofixer could sometimes modify semantics or produce a syntax error due to different operator precedence. This commit updates the fixer to surround the right side of an assignment with parentheses if it has lower precedence than its new neighbor.

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

Nothing in particular

Previously, the operator-assignment autofixer could sometimes modify semantics or produce a syntax error due to different operator precedence. This commit updates the fixer to surround the right side of an assignment with parentheses if it has lower precedence than its new neighbor.
@not-an-aardvark not-an-aardvark added accepted There is consensus among the team that this change meets the criteria for inclusion bug ESLint is working incorrectly rule Relates to ESLint's core rules labels Mar 29, 2017
@eslintbot
Copy link

LGTM

options: ["never"],
errors: UNEXPECTED_OPERATOR_ASSIGNMENT
}, {
code: "foo *= (bar + 1)",
Copy link
Member

Choose a reason for hiding this comment

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

Can you add some tests for fixes that don't modify precedence? Like foo += bar + 1

Copy link
Member Author

Choose a reason for hiding this comment

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

I added a similar test for foo -= bar - baz, but I can add one for + as well.

Note that addition isn't associative in JS, so the parentheses on the right would still be necessary:

foo = 1;
bar = 2;
baz = '3';
foo += bar + baz // => foo is "123"
foo = foo + (bar + baz) // => foo is "123"
foo = foo + bar + baz // => foo is "33"

Copy link
Member

Choose a reason for hiding this comment

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

Good point. Thanks.

@eslintbot
Copy link

LGTM

@not-an-aardvark not-an-aardvark merged commit 3342e9f into master Mar 31, 2017
@not-an-aardvark not-an-aardvark deleted the operator-assignment-precedence branch March 31, 2017 18:29
@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.
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 bug ESLint is working incorrectly rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants