eslint-plugin-function-name

> An eslint plugin to enforce method or function name conforms to conventions.

Installation

You'll first need to install ESLint:

``sh
npm i eslint --save-dev
`

Next, install eslint-plugin-function-name:

`sh
npm install eslint-plugin-function-name --save-dev
`

Usage

Add function-name to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

`json
{
"plugins": [
"function-name"
],
"rules": {
"function-name/starts-with-verb": "error"
}
}
`

Supported Rules

$3

Function is always do something, so it should start with a verb and to avoid confusion with variables.

👎 Examples of incorrect code for this rule:

`js
function cat(fish) {}
function dog(distance) {}
`

👍 Examples of correct code for this rule:

`js
function feedCat(fish) {}
function walkDog(distance) {}
`

#### options

`typescript
interface IOptions {
whitelist: string[];
blacklist: string[];
}
`

.eslintrc.js

`javascript
{
"rules": {
"function-name/starts-with-verb": ["error", {
"whitelist": ["success"],
"blacklist": ["init"]
}]
}
}
`

👎 Examples of incorrect code for this rule:

`js
// ..."blacklist": ["init"]...
const foo = {
init() {},
}
`

👍 Examples of correct code for this rule:

`js
// ..."whitelist": ["success"]...
const foo = {
success() {},
}
``

Develop

- Use Bun to manage everything for example installing.