eslint-plugin-function-name

    2.0.1 • Public • Published

    eslint-plugin-function-name

    npm version npm downloads License: MIT linter by git commit msg linter

    An eslint plugin to enforce method or function name stick to the conventions.

    Installation

    You'll first need to install ESLint:

    npm i eslint --save-dev

    Next, install eslint-plugin-function-name:

    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:

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

    Supported Rules

    function-name/starts-with-verb

    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) {}

    options

    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() {},
    }

    Install

    npm i eslint-plugin-function-name

    DownloadsWeekly Downloads

    115

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    13.3 kB

    Total Files

    8

    Last publish

    Collaborators

    • legend80s