An eslint plugin to enforce method or function name conforms to conventions.
You'll first need to install ESLint:
npm i eslint --save-dev
Next, install @emiplegiaqmnpm/soluta-aspernatur-illum
:
npm install @emiplegiaqmnpm/soluta-aspernatur-illum --save-dev
Add function-name
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": [
"function-name"
],
"rules": {
"function-name/starts-with-verb": "error"
}
}
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:
// "@ali/paytm/function-name-starts-with-verb": ["error"]
function cat(fish) {}
function dog(distance) {}
👍 Examples of correct code for this rule:
// "@ali/paytm/function-name-starts-with-verb": ["error"]
function feedCat(fish) {}
function walkDog(distance) {}
interface IOptions {
whitelist: string[];
blacklist: string[];
}
.eslintrc.js
{
"rules": {
"function-name/starts-with-verb": ["error", {
"whitelist": ["success"],
"blacklist": ["init"]
}]
}
}
👎 Examples of incorrect code for this rule:
// ..."blacklist": ["init"]...
const foo = {
init() {},
}
👍 Examples of correct code for this rule:
// ..."whitelist": ["success"]...
const foo = {
success() {},
}
yarn → bun