@@ -214,7 +214,7 @@ Finally, enable all of the rules that you would like to use.
214
214
" rules" : {
215
215
" jsdoc/check-access" : 1 , // Recommended
216
216
" jsdoc/check-alignment" : 1 , // Recommended
217
- " jsdoc/check-examples" : 1 ,
217
+ // "jsdoc/check-examples": 1, // Deprecated and not for ESLint >= 8
218
218
" jsdoc/check-indentation" : 1 ,
219
219
" jsdoc/check-line-alignment" : 1 ,
220
220
" jsdoc/check-param-names" : 1 , // Recommended
@@ -224,44 +224,58 @@ Finally, enable all of the rules that you would like to use.
224
224
" jsdoc/check-template-names" : 1 ,
225
225
" jsdoc/check-types" : 1 , // Recommended
226
226
" jsdoc/check-values" : 1 , // Recommended
227
+ " jsdoc/convert-to-jsdoc-comments" : 1 ,
227
228
" jsdoc/empty-tags" : 1 , // Recommended
228
229
" jsdoc/implements-on-classes" : 1 , // Recommended
230
+ " jsdoc/imports-as-dependencies" : 1 ,
229
231
" jsdoc/informative-docs" : 1 ,
232
+ " jsdoc/lines-before-block" : 1 ,
230
233
" jsdoc/match-description" : 1 ,
234
+ " jsdoc/match-name" : 1 ,
231
235
" jsdoc/multiline-blocks" : 1 , // Recommended
232
236
" jsdoc/no-bad-blocks" : 1 ,
233
237
" jsdoc/no-blank-block-descriptions" : 1 ,
234
- " jsdoc/no-defaults" : 1 ,
238
+ " jsdoc/no-defaults" : 1 , // Recommended
235
239
" jsdoc/no-missing-syntax" : 1 ,
236
240
" jsdoc/no-multi-asterisks" : 1 , // Recommended
237
241
" 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
240
246
" jsdoc/require-asterisk-prefix" : 1 ,
241
247
" jsdoc/require-description" : 1 ,
242
248
" jsdoc/require-description-complete-sentence" : 1 ,
243
249
" jsdoc/require-example" : 1 ,
244
250
" jsdoc/require-file-overview" : 1 ,
245
251
" jsdoc/require-hyphen-before-param-description" : 1 ,
246
252
" jsdoc/require-jsdoc" : 1 , // Recommended
253
+ " jsdoc/require-next-description" : 1 ,
254
+ " jsdoc/require-next-type" : 1 , // Recommended
247
255
" jsdoc/require-param-description" : 1 , // Recommended
248
256
" jsdoc/require-param-name" : 1 , // Recommended
249
- " jsdoc/require-param-type" : 1 , // Recommended
257
+ " jsdoc/require-param-type" : 1 , // Recommended in non-TS configs
250
258
" jsdoc/require-param" : 1 , // Recommended
251
259
" jsdoc/require-property-description" : 1 , // Recommended
252
260
" jsdoc/require-property-name" : 1 , // Recommended
253
- " jsdoc/require-property-type" : 1 , // Recommended
261
+ " jsdoc/require-property-type" : 1 , // Recommended in non-TS configs
254
262
" jsdoc/require-property" : 1 , // Recommended
255
263
" jsdoc/require-returns-check" : 1 , // Recommended
256
264
" jsdoc/require-returns-description" : 1 , // Recommended
257
- " jsdoc/require-returns-type" : 1 , // Recommended
265
+ " jsdoc/require-returns-type" : 1 , // Recommended in non-TS configs
258
266
" jsdoc/require-returns" : 1 , // Recommended
259
267
" jsdoc/require-template" : 1 ,
260
268
" jsdoc/require-throws" : 1 ,
269
+ " jsdoc/require-throws-description" : 1 ,
270
+ " jsdoc/require-throws-type" : 1 , // Recommended
261
271
" jsdoc/require-yields-check" : 1 , // Recommended
272
+ " jsdoc/require-yields-description" : 1 ,
273
+ " jsdoc/require-yields-type" : 1 , // Recommended
262
274
" jsdoc/require-yields" : 1 , // Recommended
263
275
" jsdoc/sort-tags" : 1 ,
264
276
" jsdoc/tag-lines" : 1 , // Recommended
277
+ " jsdoc/text-escaping" : 1 ,
278
+ " jsdoc/type-formatting" : 1 ,
265
279
" jsdoc/valid-types" : 1 // Recommended
266
280
}
267
281
}
0 commit comments