@mimik/eslint-plugin-document-env 2.0.7 → 2.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# eslint-plugin-document-env
|
|
2
|
-
|
|
2
|
+
An ESLint plugin that validates that all process.env usages are properly documented in markdown-style block comments.
|
|
3
3
|
## Usage
|
|
4
4
|
|
|
5
5
|
```sh
|
|
@@ -24,8 +24,8 @@ An [eslint](https://github.com/eslint/eslint) plugin that ...
|
|
|
24
24
|
|
|
25
25
|
### `document-env/validate-document-env`
|
|
26
26
|
|
|
27
|
-
Verifies that when an environment variable is used, there is a
|
|
27
|
+
Verifies that when an environment variable is used, there is a documentation about it after the following header:
|
|
28
28
|
* | Env variable name | Description | Default | Comments |
|
|
29
29
|
* | ----------------- | ----------- | ------- | -------- |
|
|
30
30
|
|
|
31
|
-
The plugin also verifies that there is a non
|
|
31
|
+
The plugin also verifies that there is a non-empty or blank description and that the description is not duplicated.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mimik/eslint-plugin-document-env",
|
|
3
|
-
"version": "2.0.
|
|
4
|
-
"description": "validation of
|
|
3
|
+
"version": "2.0.8",
|
|
4
|
+
"description": "validation of environment variable documentation",
|
|
5
5
|
"main": "./index.js",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"scripts": {
|
|
@@ -29,9 +29,9 @@
|
|
|
29
29
|
"url": "git+https://bitbucket.org/mimiktech/eslint-plugin-document-env.git"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
|
-
"@eslint/js": "9.
|
|
33
|
-
"@stylistic/eslint-plugin": "5.
|
|
34
|
-
"eslint": "9.
|
|
32
|
+
"@eslint/js": "9.31.0",
|
|
33
|
+
"@stylistic/eslint-plugin": "5.2.0",
|
|
34
|
+
"eslint": "9.31.0",
|
|
35
35
|
"eslint-plugin-import": "2.32.0",
|
|
36
36
|
"husky": "9.1.7"
|
|
37
37
|
}
|