This project is not maintained

There are bugs and areas of improvement. I have no plans on maintaining this.

---

eslint-plugin-checked-exceptions

Encourages handling of documented errors

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-checked-exceptions:

(Here for design purposes, there is no package on NPM.)

npm install eslint-plugin-checked-exceptions --save-dev

Usage

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

{
    "plugins": [
        "checked-exceptions"
    ]
}

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

{
    "rules": {
        "checked-exceptions/rule-name": 2
    }
}

Rules

TODO: Run eslint-doc-generator to generate the rules list.