Skip to content

Commit d6e2355

Browse files
committed
docs: recommended-error config
1 parent a7381c0 commit d6e2355

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

.README/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,15 @@ which enables the rules commented above as "recommended":
107107

108108
You can then selectively add to or override the recommended rules.
109109

110+
Alternatively, if you wish to have all linting issues reported
111+
as failing errors, you may use the "recommended-error" config:
112+
113+
```json
114+
{
115+
"extends": ["plugin:jsdoc/recommended-error"]
116+
}
117+
```
118+
110119
## Options
111120

112121
Rules may, as per the [ESLint user guide](https://eslint.org/docs/user-guide/configuring), have their own individual options. In `eslint-plugin-jsdoc`, a few options,

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,15 @@ which enables the rules commented above as "recommended":
178178

179179
You can then selectively add to or override the recommended rules.
180180

181+
Alternatively, if you wish to have all linting issues reported
182+
as failing errors, you may use the "recommended-error" config:
183+
184+
```json
185+
{
186+
"extends": ["plugin:jsdoc/recommended-error"]
187+
}
188+
```
189+
181190
<a name="user-content-eslint-plugin-jsdoc-options"></a>
182191
<a name="eslint-plugin-jsdoc-options"></a>
183192
## Options

0 commit comments

Comments
 (0)