eslint-plugin-object-literal-jsdoc v1.0.0

eslint-plugin-object-literal-jsdoc

lint literal object function

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install @xkeshi/eslint-plugin-object-literal-jsdoc:

$ npm install @xkeshi/eslint-plugin-object-literal-jsdoc --save-dev

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

Usage

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

{
    "plugins": [
        "@xkeshi/object-literal-jsdoc"
    ]
}

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

{
    "rules": {
        "object-literal-jsdoc/obj-doc": 2
    }
}

Supported Rules

• Fill in provided rules here