Package Exports

@mimik/eslint-plugin-document-env
@mimik/eslint-plugin-document-env/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mimik/eslint-plugin-document-env) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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.