npm-pkg-lint 1.8.0 → 1.9.0
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 +29 -0
- package/dist/index.js +18 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -73,6 +73,35 @@ Examples of disallowed packages:
|
|
|
73
73
|
|
|
74
74
|
By default `@types/*` is disallowed but this can be disabled with `--allow-types-dependencies`.
|
|
75
75
|
|
|
76
|
+
### ESLint
|
|
77
|
+
|
|
78
|
+
If your `package.json` contains the `"eslint"` keyword the ESLint packages can be included as dependencies, e.g. if you publish a sharable config including a plugin you must include `"eslint"` as a keyword.
|
|
79
|
+
|
|
80
|
+
**OK**:
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"name": "eslint-config-myfancyconfig",
|
|
85
|
+
"version": "1.0.0",
|
|
86
|
+
"keywords": ["eslint"],
|
|
87
|
+
"dependencies": {
|
|
88
|
+
"eslint-plugin-myfancyplugin": "^1.2.0"
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
**Fail**:
|
|
94
|
+
|
|
95
|
+
```json
|
|
96
|
+
{
|
|
97
|
+
"name": "eslint-config-myfancyconfig",
|
|
98
|
+
"version": "1.0.0",
|
|
99
|
+
"dependencies": {
|
|
100
|
+
"eslint-plugin-myfancyplugin": "^1.2.0"
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
76
105
|
## Shebang
|
|
77
106
|
|
|
78
107
|
Require all binaries to have UNIX-style shebang at the beginning of the file.
|