An eslint plugin to enforce method or function name stick to the conventions.
npm install eslint-plugin-taro-function-name
> An eslint plugin to enforce method or function name stick to the conventions.
You'll first need to install ESLint:
``
$ npm i eslint --save-dev
Next, install eslint-plugin-taro-function-name:
`
$ npm install eslint-plugin-taro-function-name --save-dev
Add taro-function-name to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
`json`
{
"plugins": ["taro-function-name"]
}
Then configure the rules you want to use under the rules section.
`json`
{
"rules": {
"taro-function-name/full-name": "error"
}
}
Function is always do somethings, so it should start with a verb and to avoid confusion with variables.
#### options
`typescript`
interface IOptions {
blacklist: string[]
}
##### example
`javascript`
{
"rules": {
"taro-function-name/full-name": ["error", {
"blacklist": ["init"]
}]
}
}
code:
`js``
const foo = {
success() {}, // valid
init() {} // invalid
}