eslint-plugin-document-env

An ESLint plugin that validates that all process.env usages are properly documented in markdown-style block comments.

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 documentation 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.