eslint-plugin-public-api-imports v0.1.0

eslint-plugin-public-api-imports

Checking imports use only public api

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-public-api-imports:

npm install eslint-plugin-public-api-imports --save-dev

Usage

Add public-api-imports to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "public-api-imports"
    ]
}

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

{
    "rules": {
        "public-api-imports/rule-name": 2
    }
}

Configurations

TODO: Run eslint-doc-generator to generate the configs list (or delete this section if no configs are offered).

Rules

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