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

Update: Improve report location for getter-return (refs #12334) #13164

Merged
merged 1 commit into from Apr 23, 2020

Conversation

mdjermanovic
Copy link
Member

Prerequisites checklist

  • I have read the contributing guidelines.
  • The team has reached consensus on the changes proposed in this pull request. If not, I understand that the evaluation process will begin with this pull request and won't be merged until the team has reached consensus.

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

[X] Other, please explain:

refs #12334

Change reported location in the getter-return rule.

This change can produce more warnings in existing code, depending on the location of eslint-disable-* comments.

What changes did you make? (Give an overview)

The rule will now use astUtils.getFunctionHeadLoc instead of its own code for the reported getter's location.

Some notable differences

Before:

image

After:

image

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

In edge cases where get and the opening paren are not on the same line, this change can produce more warnings. For example, the following code will be invalid now:

/* eslint getter-return: error */

var x = {
  get 
    foo () {} // eslint-disable-line getter-return 
};

@mdjermanovic mdjermanovic added enhancement This change enhances an existing feature of ESLint rule Relates to ESLint's core rules accepted There is consensus among the team that this change meets the criteria for inclusion labels Apr 8, 2020
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

I think the location changes make sense. While disable comments might not be quite the same, I think this is a better experience. Thanks!

Copy link
Member

@kaicataldo kaicataldo 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!

@kaicataldo kaicataldo merged commit 5c1bdeb into master Apr 23, 2020
@kaicataldo kaicataldo deleted the getterreturn-loc branch April 23, 2020 04:08
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Oct 21, 2020
@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 Oct 21, 2020
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 enhancement This change enhances an existing feature of ESLint rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants