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: class-methods-use-this reports 'undefined' names #12103

Merged
merged 1 commit into from Aug 18, 2019
Merged

Fix: class-methods-use-this reports 'undefined' names #12103

merged 1 commit into from Aug 18, 2019

Conversation

mdjermanovic
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: 6.1.0
  • Node Version: 10.16.0
  • npm Version: 6.9.0

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

default

Please show your full configuration:

Configuration
module.exports = {
  parserOptions: {
    ecmaVersion: 2015,
  },
};

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

/*eslint class-methods-use-this: "error"*/

class A {
  "foo"() {}
  123() {}
  [f()]() {}
}

What did you expect to happen?

Error messages with method names, where it is possible.

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

  5:8  error  Expected 'this' to be used by class method 'undefined'  class-methods-use-this
  6:6  error  Expected 'this' to be used by class method 'undefined'  class-methods-use-this
  7:8  error  Expected 'this' to be used by class method 'undefined'  class-methods-use-this

What changes did you make? (Give an overview)

Fixed class-methods-use-this to use astUtils.getFunctionNameWithKind(), like other rules.

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

In most cases the message before the fix should remain exactly the same after the fix.

The differences are:

  • "foo"(){} and 123(){} are fixed to show the name instead of 'undefined'.
  • Computed keys such as [f()](){} are fixed to just ... class method. instead of ... class method 'undefined'.
  • The previous also applies to computed keys with only an identifier like [a](){}, but the old message was showing 'a'. This is in line with how other rules work, it could be a future enhancement in getFunctionNameWithKind().
  • For accessors e.g. getters it's now ... class getter 'foo' instead of class method 'foo'.
  • The message can now have additional details, e.g. class generator method 'foo'

There is a new test case with full messages.

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Aug 15, 2019
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!

@platinumazure platinumazure 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 and removed triage An ESLint team member will look at this issue soon labels Aug 15, 2019
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!

@platinumazure platinumazure merged commit acce6de into eslint:master Aug 18, 2019
@platinumazure
Copy link
Member

Merged. Thanks for contributing!

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

3 participants