Skip to content

Commit af006ab

Browse files
committed
docs: update list of non-table rules on README
1 parent 9a2763b commit af006ab

File tree

2 files changed

+42
-14
lines changed

2 files changed

+42
-14
lines changed

.README/README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ Finally, enable all of the rules that you would like to use.
214214
"rules": {
215215
"jsdoc/check-access": 1, // Recommended
216216
"jsdoc/check-alignment": 1, // Recommended
217-
"jsdoc/check-examples": 1,
217+
// "jsdoc/check-examples": 1, // Deprecated and not for ESLint >= 8
218218
"jsdoc/check-indentation": 1,
219219
"jsdoc/check-line-alignment": 1,
220220
"jsdoc/check-param-names": 1, // Recommended
@@ -224,44 +224,58 @@ Finally, enable all of the rules that you would like to use.
224224
"jsdoc/check-template-names": 1,
225225
"jsdoc/check-types": 1, // Recommended
226226
"jsdoc/check-values": 1, // Recommended
227+
"jsdoc/convert-to-jsdoc-comments": 1,
227228
"jsdoc/empty-tags": 1, // Recommended
228229
"jsdoc/implements-on-classes": 1, // Recommended
230+
"jsdoc/imports-as-dependencies": 1,
229231
"jsdoc/informative-docs": 1,
232+
"jsdoc/lines-before-block": 1,
230233
"jsdoc/match-description": 1,
234+
"jsdoc/match-name": 1,
231235
"jsdoc/multiline-blocks": 1, // Recommended
232236
"jsdoc/no-bad-blocks": 1,
233237
"jsdoc/no-blank-block-descriptions": 1,
234-
"jsdoc/no-defaults": 1,
238+
"jsdoc/no-defaults": 1, // Recommended
235239
"jsdoc/no-missing-syntax": 1,
236240
"jsdoc/no-multi-asterisks": 1, // Recommended
237241
"jsdoc/no-restricted-syntax": 1,
238-
"jsdoc/no-types": 1,
239-
"jsdoc/no-undefined-types": 1, // Recommended
242+
"jsdoc/no-types": 1, // Recommended for TS configs
243+
"jsdoc/no-undefined-types": 1, // Recommended for non-TS configs
244+
"jsdoc/rejct-any-type": 1, // Recommended
245+
"jsdoc/reject-function-type": 1, // Recommended
240246
"jsdoc/require-asterisk-prefix": 1,
241247
"jsdoc/require-description": 1,
242248
"jsdoc/require-description-complete-sentence": 1,
243249
"jsdoc/require-example": 1,
244250
"jsdoc/require-file-overview": 1,
245251
"jsdoc/require-hyphen-before-param-description": 1,
246252
"jsdoc/require-jsdoc": 1, // Recommended
253+
"jsdoc/require-next-description": 1,
254+
"jsdoc/require-next-type": 1, // Recommended
247255
"jsdoc/require-param-description": 1, // Recommended
248256
"jsdoc/require-param-name": 1, // Recommended
249-
"jsdoc/require-param-type": 1, // Recommended
257+
"jsdoc/require-param-type": 1, // Recommended in non-TS configs
250258
"jsdoc/require-param": 1, // Recommended
251259
"jsdoc/require-property-description": 1, // Recommended
252260
"jsdoc/require-property-name": 1, // Recommended
253-
"jsdoc/require-property-type": 1, // Recommended
261+
"jsdoc/require-property-type": 1, // Recommended in non-TS configs
254262
"jsdoc/require-property": 1, // Recommended
255263
"jsdoc/require-returns-check": 1, // Recommended
256264
"jsdoc/require-returns-description": 1, // Recommended
257-
"jsdoc/require-returns-type": 1, // Recommended
265+
"jsdoc/require-returns-type": 1, // Recommended in non-TS configs
258266
"jsdoc/require-returns": 1, // Recommended
259267
"jsdoc/require-template": 1,
260268
"jsdoc/require-throws": 1,
269+
"jsdoc/require-throws-description": 1,
270+
"jsdoc/require-throws-type": 1, // Recommended
261271
"jsdoc/require-yields-check": 1, // Recommended
272+
"jsdoc/require-yields-description": 1,
273+
"jsdoc/require-yields-type": 1, // Recommended
262274
"jsdoc/require-yields": 1, // Recommended
263275
"jsdoc/sort-tags": 1,
264276
"jsdoc/tag-lines": 1, // Recommended
277+
"jsdoc/text-escaping": 1,
278+
"jsdoc/type-formatting": 1,
265279
"jsdoc/valid-types": 1 // Recommended
266280
}
267281
}

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ Finally, enable all of the rules that you would like to use.
241241
"rules": {
242242
"jsdoc/check-access": 1, // Recommended
243243
"jsdoc/check-alignment": 1, // Recommended
244-
"jsdoc/check-examples": 1,
244+
// "jsdoc/check-examples": 1, // Deprecated and not for ESLint >= 8
245245
"jsdoc/check-indentation": 1,
246246
"jsdoc/check-line-alignment": 1,
247247
"jsdoc/check-param-names": 1, // Recommended
@@ -251,44 +251,58 @@ Finally, enable all of the rules that you would like to use.
251251
"jsdoc/check-template-names": 1,
252252
"jsdoc/check-types": 1, // Recommended
253253
"jsdoc/check-values": 1, // Recommended
254+
"jsdoc/convert-to-jsdoc-comments": 1,
254255
"jsdoc/empty-tags": 1, // Recommended
255256
"jsdoc/implements-on-classes": 1, // Recommended
257+
"jsdoc/imports-as-dependencies": 1,
256258
"jsdoc/informative-docs": 1,
259+
"jsdoc/lines-before-block": 1,
257260
"jsdoc/match-description": 1,
261+
"jsdoc/match-name": 1,
258262
"jsdoc/multiline-blocks": 1, // Recommended
259263
"jsdoc/no-bad-blocks": 1,
260264
"jsdoc/no-blank-block-descriptions": 1,
261-
"jsdoc/no-defaults": 1,
265+
"jsdoc/no-defaults": 1, // Recommended
262266
"jsdoc/no-missing-syntax": 1,
263267
"jsdoc/no-multi-asterisks": 1, // Recommended
264268
"jsdoc/no-restricted-syntax": 1,
265-
"jsdoc/no-types": 1,
266-
"jsdoc/no-undefined-types": 1, // Recommended
269+
"jsdoc/no-types": 1, // Recommended for TS configs
270+
"jsdoc/no-undefined-types": 1, // Recommended for non-TS configs
271+
"jsdoc/rejct-any-type": 1, // Recommended
272+
"jsdoc/reject-function-type": 1, // Recommended
267273
"jsdoc/require-asterisk-prefix": 1,
268274
"jsdoc/require-description": 1,
269275
"jsdoc/require-description-complete-sentence": 1,
270276
"jsdoc/require-example": 1,
271277
"jsdoc/require-file-overview": 1,
272278
"jsdoc/require-hyphen-before-param-description": 1,
273279
"jsdoc/require-jsdoc": 1, // Recommended
280+
"jsdoc/require-next-description": 1,
281+
"jsdoc/require-next-type": 1, // Recommended
274282
"jsdoc/require-param-description": 1, // Recommended
275283
"jsdoc/require-param-name": 1, // Recommended
276-
"jsdoc/require-param-type": 1, // Recommended
284+
"jsdoc/require-param-type": 1, // Recommended in non-TS configs
277285
"jsdoc/require-param": 1, // Recommended
278286
"jsdoc/require-property-description": 1, // Recommended
279287
"jsdoc/require-property-name": 1, // Recommended
280-
"jsdoc/require-property-type": 1, // Recommended
288+
"jsdoc/require-property-type": 1, // Recommended in non-TS configs
281289
"jsdoc/require-property": 1, // Recommended
282290
"jsdoc/require-returns-check": 1, // Recommended
283291
"jsdoc/require-returns-description": 1, // Recommended
284-
"jsdoc/require-returns-type": 1, // Recommended
292+
"jsdoc/require-returns-type": 1, // Recommended in non-TS configs
285293
"jsdoc/require-returns": 1, // Recommended
286294
"jsdoc/require-template": 1,
287295
"jsdoc/require-throws": 1,
296+
"jsdoc/require-throws-description": 1,
297+
"jsdoc/require-throws-type": 1, // Recommended
288298
"jsdoc/require-yields-check": 1, // Recommended
299+
"jsdoc/require-yields-description": 1,
300+
"jsdoc/require-yields-type": 1, // Recommended
289301
"jsdoc/require-yields": 1, // Recommended
290302
"jsdoc/sort-tags": 1,
291303
"jsdoc/tag-lines": 1, // Recommended
304+
"jsdoc/text-escaping": 1,
305+
"jsdoc/type-formatting": 1,
292306
"jsdoc/valid-types": 1 // Recommended
293307
}
294308
}

0 commit comments

Comments
 (0)