eslint-plugin-tick-tock-jsdoc v0.0.2

eslint-plugin-tick-tock-jsdoc

Towards more useful jsdoc types: {Object}, {Promise} and {*} are unfortunate. Lets not use those.

There's only 1 rule in this plugin: make-nice.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-tick-tock-jsdoc:

$ npm install eslint-plugin-tick-tock-jsdoc --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-tick-tock-jsdoc globally.

Usage

Add tick-tock-jsdoc to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "tick-tock-jsdoc"
    ]
}

Then configure the rules you want to use under the rules section.

{
    "rules": {
        "tick-tock-jsdoc/make-nice": 2
    }
}

Supported Rules

• Prohibit use of and provide guidance on {Object}, {Promise} and {*} (make-nice)