Skip to content

Commit bebf438

Browse files
committed
docs: call out "recommended" rules in README with instructions on how to extend
1 parent 4383525 commit bebf438

File tree

2 files changed

+58
-36
lines changed

2 files changed

+58
-36
lines changed

.README/README.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -72,39 +72,50 @@ Add `plugins` section and specify `eslint-plugin-jsdoc` as a plugin.
7272

7373
Finally, enable all of the rules that you would like to use.
7474

75-
```json
75+
```javascript
7676
{
7777
"rules": {
78-
"jsdoc/check-alignment": 1,
78+
"jsdoc/check-alignment": 1, // Recommended
7979
"jsdoc/check-examples": 1,
8080
"jsdoc/check-indentation": 1,
81-
"jsdoc/check-param-names": 1,
81+
"jsdoc/check-param-names": 1, // Recommended
8282
"jsdoc/check-syntax": 1,
83-
"jsdoc/check-tag-names": 1,
84-
"jsdoc/check-types": 1,
85-
"jsdoc/implements-on-classes": 1,
83+
"jsdoc/check-tag-names": 1, // Recommended
84+
"jsdoc/check-types": 1, // Recommended
85+
"jsdoc/implements-on-classes": 1, // Recommended
8686
"jsdoc/match-description": 1,
87-
"jsdoc/newline-after-description": 1,
87+
"jsdoc/newline-after-description": 1, // Recommended
8888
"jsdoc/no-types": 1,
89-
"jsdoc/no-undefined-types": 1,
89+
"jsdoc/no-undefined-types": 1, // Recommended
9090
"jsdoc/require-description": 1,
9191
"jsdoc/require-description-complete-sentence": 1,
9292
"jsdoc/require-example": 1,
9393
"jsdoc/require-hyphen-before-param-description": 1,
94-
"jsdoc/require-jsdoc": 1,
95-
"jsdoc/require-param": 1,
96-
"jsdoc/require-param-description": 1,
97-
"jsdoc/require-param-name": 1,
98-
"jsdoc/require-param-type": 1,
99-
"jsdoc/require-returns": 1,
100-
"jsdoc/require-returns-check": 1,
101-
"jsdoc/require-returns-description": 1,
102-
"jsdoc/require-returns-type": 1,
103-
"jsdoc/valid-types": 1
94+
"jsdoc/require-jsdoc": 1, // Recommended
95+
"jsdoc/require-param": 1, // Recommended
96+
"jsdoc/require-param-description": 1, // Recommended
97+
"jsdoc/require-param-name": 1, // Recommended
98+
"jsdoc/require-param-type": 1, // Recommended
99+
"jsdoc/require-returns": 1, // Recommended
100+
"jsdoc/require-returns-check": 1, // Recommended
101+
"jsdoc/require-returns-description": 1, // Recommended
102+
"jsdoc/require-returns-type": 1, // Recommended
103+
"jsdoc/valid-types": 1 // Recommended
104104
}
105105
}
106106
```
107107

108+
You may also use the following which enables the rules commented
109+
above as "recommended":
110+
111+
```json
112+
{
113+
"extends": ["plugin:jsdoc/recommended"]
114+
}
115+
```
116+
117+
You can then selectively add to or override the recommended rules.
118+
108119
## Settings
109120

110121
### Allow `@private` to disable rules for that comment block

README.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -118,39 +118,50 @@ Add `plugins` section and specify `eslint-plugin-jsdoc` as a plugin.
118118

119119
Finally, enable all of the rules that you would like to use.
120120

121-
```json
121+
```javascript
122122
{
123123
"rules": {
124-
"jsdoc/check-alignment": 1,
124+
"jsdoc/check-alignment": 1, // Recommended
125125
"jsdoc/check-examples": 1,
126126
"jsdoc/check-indentation": 1,
127-
"jsdoc/check-param-names": 1,
127+
"jsdoc/check-param-names": 1, // Recommended
128128
"jsdoc/check-syntax": 1,
129-
"jsdoc/check-tag-names": 1,
130-
"jsdoc/check-types": 1,
131-
"jsdoc/implements-on-classes": 1,
129+
"jsdoc/check-tag-names": 1, // Recommended
130+
"jsdoc/check-types": 1, // Recommended
131+
"jsdoc/implements-on-classes": 1, // Recommended
132132
"jsdoc/match-description": 1,
133-
"jsdoc/newline-after-description": 1,
133+
"jsdoc/newline-after-description": 1, // Recommended
134134
"jsdoc/no-types": 1,
135-
"jsdoc/no-undefined-types": 1,
135+
"jsdoc/no-undefined-types": 1, // Recommended
136136
"jsdoc/require-description": 1,
137137
"jsdoc/require-description-complete-sentence": 1,
138138
"jsdoc/require-example": 1,
139139
"jsdoc/require-hyphen-before-param-description": 1,
140-
"jsdoc/require-jsdoc": 1,
141-
"jsdoc/require-param": 1,
142-
"jsdoc/require-param-description": 1,
143-
"jsdoc/require-param-name": 1,
144-
"jsdoc/require-param-type": 1,
145-
"jsdoc/require-returns": 1,
146-
"jsdoc/require-returns-check": 1,
147-
"jsdoc/require-returns-description": 1,
148-
"jsdoc/require-returns-type": 1,
149-
"jsdoc/valid-types": 1
140+
"jsdoc/require-jsdoc": 1, // Recommended
141+
"jsdoc/require-param": 1, // Recommended
142+
"jsdoc/require-param-description": 1, // Recommended
143+
"jsdoc/require-param-name": 1, // Recommended
144+
"jsdoc/require-param-type": 1, // Recommended
145+
"jsdoc/require-returns": 1, // Recommended
146+
"jsdoc/require-returns-check": 1, // Recommended
147+
"jsdoc/require-returns-description": 1, // Recommended
148+
"jsdoc/require-returns-type": 1, // Recommended
149+
"jsdoc/valid-types": 1 // Recommended
150150
}
151151
}
152152
```
153153

154+
You may also use the following which enables the rules commented
155+
above as "recommended":
156+
157+
```json
158+
{
159+
"extends": ["plugin:jsdoc/recommended"]
160+
}
161+
```
162+
163+
You can then selectively add to or override the recommended rules.
164+
154165
<a name="eslint-plugin-jsdoc-settings"></a>
155166
## Settings
156167

0 commit comments

Comments
 (0)