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: no-multi-spaces false positive with irregular indent whitespace #8412

Merged
merged 1 commit into from Apr 7, 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:
  no-multi-spaces: error

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

foo
<FF>  bar; // <FF> represents a form feed character

What did you expect to happen?

I expected no error to be reported because the whitespace is at the beginning of the line.

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

The code was autofixed to invalid syntax:

foo bar;

What changes did you make? (Give an overview)

The no-multi-spaces rule is not intended to check whitespace at the beginning of a line, because consecutive spaces are often used for indentation. Due to a bug, the rule previously matched against consecutive spaces that appeared after an irreglar whitespace character at the beginning of a line. The rule's autofixer assumes that the detected spaces are always between two tokens on the same line, so it would sometimes produce invalid syntax if the rule matched whitespace at the beginning of a line. This commit updates the rule to avoid matching whitespace at the beginning of a line.

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

Nothing in particular

The no-multi-spaces rule is not intended to check whitespace at the beginning of a line, because consecutive spaces are often used for indentation. Due to a bug, the rule previously matched against consecutive spaces that appeared after an irreglar whitespace character at the beginning of a line. The rule's autofixer assumes that the detected spaces are always between two tokens on the *same* line, so it would sometimes produce invalid syntax if the rule matched whitespace at the *beginning* of a line. This commit updates the rule to avoid matching whitespace at the beginning of a line.
@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 Apr 5, 2017
@eslintbot
Copy link

LGTM

@mention-bot
Copy link

@not-an-aardvark, thanks for your PR! By analyzing the history of the files in this pull request, we identified @btmills, @nzakas and @vegetableman to be potential reviewers.

@not-an-aardvark
Copy link
Member Author

not-an-aardvark commented Apr 5, 2017

CI is failing due to nodejs/nodejs.org#1191

edit: it's passing now

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.

A bit concerned about the Travis failures but LGTM

@not-an-aardvark not-an-aardvark merged commit 3c87e85 into master Apr 7, 2017
@not-an-aardvark not-an-aardvark deleted the no-multi-spaces-bad-whitespace branch April 7, 2017 07:08
@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

5 participants