Skip to content

Commit a526dfa

Browse files
committed
Update eslint-plugin-jsdoc to v61.5.0
- Enable `jsdoc/require-rejects` as an error. - Enable `jsdoc/ts-method-signature-style` as a warning. - Enable `jsdoc/ts-no-empty-object-type` as an error. - Enable `jsdoc/ts-no-unnecessary-template-expression` as a warning. - Enable `jsdoc/ts-prefer-function-type` as a warning.
1 parent 4988250 commit a526dfa

File tree

4 files changed

+107
-37
lines changed

4 files changed

+107
-37
lines changed

package-lock.json

Lines changed: 74 additions & 35 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
"eslint-plugin-import": "^2.32.0",
4444
"eslint-plugin-jest": "^29.12.1",
4545
"eslint-plugin-jest-dom": "^5.5.0",
46-
"eslint-plugin-jsdoc": "~61.0.1",
46+
"eslint-plugin-jsdoc": "^61.5.0",
4747
"eslint-plugin-n": "^17.23.1",
4848
"eslint-plugin-prefer-arrow": "^1.2.3",
4949
"eslint-plugin-promise": "^7.2.1",
@@ -86,7 +86,7 @@
8686
"eslint-plugin-import": "2.32.0",
8787
"eslint-plugin-jest": "29.12.1",
8888
"eslint-plugin-jest-dom": "5.5.0",
89-
"eslint-plugin-jsdoc": "61.0.1",
89+
"eslint-plugin-jsdoc": "61.5.0",
9090
"eslint-plugin-n": "17.23.1",
9191
"eslint-plugin-prefer-arrow": "1.2.3",
9292
"eslint-plugin-promise": "7.2.1",

src/config/jsdoc/index.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,12 @@ Off in TypeScript.
268268
|
269269
| Error
270270

271+
| `link:{eslint-jsdoc-rules}/require-rejects.md[jsdoc/require-rejects]`
272+
|
273+
|
274+
| Error
275+
276+
271277
| `link:{eslint-jsdoc-rules}/require-returns.md[jsdoc/require-returns]`
272278
| Yes
273279
|
@@ -351,6 +357,26 @@ Off in TypeScript.
351357
| Warning
352358
4+| Use `jsdoc/sort-tags` to configure empty lines between tags.
353359

360+
| `link:{eslint-jsdoc-rules}/ts-method-signature-style.md[jsdoc/ts-method-signature-style]`
361+
|
362+
| Yes
363+
| Warning
364+
365+
| `link:{eslint-jsdoc-rules}/ts-no-empty-object-type.md[jsdoc/ts-no-empty-object-type]`
366+
| Yes
367+
|
368+
| Error
369+
370+
| `link:{eslint-jsdoc-rules}/ts-no-unnecessary-template-expression.md[jsdoc/ts-no-unnecessary-template-expression]`
371+
|
372+
| Yes
373+
| Warning
374+
375+
| `link:{eslint-jsdoc-rules}/ts-prefer-function-type.md[jsdoc/ts-prefer-function-type]`
376+
|
377+
| Yes
378+
| Warning
379+
354380
| `link:{eslint-jsdoc-rules}/type-formatting.md[jsdoc/type-formatting]`
355381
|
356382
| Yes

src/config/jsdoc/jsdoc-config.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ export function jsdocConfig(): Linter.Config {
125125
'jsdoc/require-property-description': 'error',
126126
'jsdoc/require-property-name': 'error',
127127
'jsdoc/require-property-type': 'error',
128+
'jsdoc/require-rejects': 'error',
128129
'jsdoc/require-returns': 'off',
129130
'jsdoc/require-returns-check': 'error',
130131
'jsdoc/require-returns-description': 'error',
@@ -352,6 +353,10 @@ export function jsdocConfig(): Linter.Config {
352353
maxBlockLines: null,
353354
tags: {},
354355
}],
356+
'jsdoc/ts-method-signature-style': 'warn',
357+
'jsdoc/ts-no-empty-object-type': 'error',
358+
'jsdoc/ts-no-unnecessary-template-expression': 'warn',
359+
'jsdoc/ts-prefer-function-type': 'warn',
355360
'jsdoc/type-formatting': ['warn', {
356361
arrayBrackets: 'square',
357362
arrowFunctionPostReturnMarkerSpacing: '',

0 commit comments

Comments
 (0)