npm-pkg-lint 1.9.0 → 1.11.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.
Files changed (3) hide show
  1. package/README.md +29 -0
  2. package/dist/index.js +22 -22
  3. package/package.json +16 -16
package/README.md CHANGED
@@ -102,6 +102,35 @@ If your `package.json` contains the `"eslint"` keyword the ESLint packages can b
102
102
  }
103
103
  ```
104
104
 
105
+ ### Prettier
106
+
107
+ If your `package.json` contains the `"prettier"` keyword the Prettier packages can be included as dependencies, e.g. if you publish a sharable config including a plugin you must include `"prettier"` as a keyword.
108
+
109
+ **OK**:
110
+
111
+ ```json
112
+ {
113
+ "name": "prettier-config-myfancyconfig",
114
+ "version": "1.0.0",
115
+ "keywords": ["prettier"],
116
+ "dependencies": {
117
+ "prettier-plugin-myfancyplugin": "^1.2.0"
118
+ }
119
+ }
120
+ ```
121
+
122
+ **Fail**:
123
+
124
+ ```json
125
+ {
126
+ "name": "prettier-config-myfancyconfig",
127
+ "version": "1.0.0",
128
+ "dependencies": {
129
+ "prettier-plugin-myfancyplugin": "^1.2.0"
130
+ }
131
+ }
132
+ ```
133
+
105
134
  ## Shebang
106
135
 
107
136
  Require all binaries to have UNIX-style shebang at the beginning of the file.