eslint-plugin-method-names v0.1.0

eslint-plugin-method-names

Installation

npm install --save-dev eslint-plugin-method-names

Usage

In your .eslintrc:

{
  "plugins": [
    "method-names"
  ],
  "rules": {
    "method-names/method-names": [2, { regex: '^[a-z].*' }]
  }
}

Rule

Restrict class method names to a regex. It applies to methods and static properties defining a function.

Example

With the configuration above, the following patterns are considered valid

class Foo {
  bar() {}
}

class Foo {
  bar = () => {}
}

class Foo {
  _bar = 40 + 2
}

whereas the following are considered errors

class Foo {
  _bar() {}
}

class Foo {
  _bar = () => {}
}

Why

This is useful for enforcing conventions like "methods should never start with an underscore".