@mimik/eslint-plugin-document-env

1.0.6 • Public • Published

eslint-plugin-document-env

Usage

npm install @mimik/eslint-plugin-document-env

In your .eslintrc:

{
  "plugins": [
    "@mimik/document-env"
  ],
  "rules": {
    "@mimik/document-env/validate-document-env": 2
  }
}

Rules

An eslint plugin that ...

document-env/validate-document-env

Verifies that when an environment variable is used, there is a document ation about it after the following header:

  • | Env variable name | Description | Default | Comments |
  • | ----------------- | ----------- | ------- | -------- |

The plugin also verifies that there is a non empty or blank description and that the description is not duplicated.

Package Sidebar

Install

npm i @mimik/eslint-plugin-document-env

Weekly Downloads

0

Version

1.0.6

License

MIT

Unpacked Size

4.14 kB

Total Files

3

Last publish

Collaborators

  • sasan.raisdana
  • miburger
  • hofachiang
  • mimik-npm-editor
  • mimikopensource