Skip to content

Commit 2fce7d0

Browse files
fix: update jsdoc rules
1 parent 2f2020c commit 2fce7d0

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

src/plugins/jsdoc.ts

+26-1
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,31 @@ export const settings: Linter.Config = {
44
plugins: ["jsdoc"],
55

66
rules: {
7+
"jsdoc/check-access": "warn",
78
"jsdoc/check-alignment": "warn",
9+
// waiting on https://github.com/eslint/eslint/issues/14745
10+
// "jsdoc/check-examples": "warn",
811
"jsdoc/check-indentation": "warn",
12+
"jsdoc/check-line-alignment": "warn",
913
"jsdoc/check-param-names": "warn",
14+
"jsdoc/check-property-names": "warn",
1015
"jsdoc/check-tag-names": "warn",
16+
"jsdoc/check-types": "warn",
17+
"jsdoc/check-values": "warn",
18+
"jsdoc/empty-tags": "warn",
1119
"jsdoc/implements-on-classes": "warn",
20+
"jsdoc/multiline-blocks": "warn",
1221
"jsdoc/newline-after-description": "warn",
22+
"jsdoc/no-bad-blocks": "warn",
23+
"jsdoc/no-defaults": "warn",
24+
"jsdoc/no-multi-asterisks": "warn",
25+
// For TypeScript
1326
"jsdoc/no-types": "warn",
27+
"jsdoc/no-undefined-types": "warn",
28+
"jsdoc/require-asterisk-prefix": "warn",
1429
"jsdoc/require-description": "warn",
1530
// Rule is too strict.
16-
"jsdoc/require-description-complete-sentence": "off",
31+
// "jsdoc/require-description-complete-sentence": "off",
1732
"jsdoc/require-hyphen-before-param-description": "warn",
1833
"jsdoc/require-jsdoc": [
1934
"warn",
@@ -34,7 +49,17 @@ export const settings: Linter.Config = {
3449
],
3550
"jsdoc/require-param-description": "warn",
3651
"jsdoc/require-param-name": "warn",
52+
"jsdoc/require-property-description": "warn",
53+
"jsdoc/require-property-name": "warn",
3754
"jsdoc/require-returns-check": "warn",
3855
"jsdoc/require-returns-description": "warn",
56+
"jsdoc/require-yields": "warn",
57+
"jsdoc/require-yields-check": "warn",
58+
"jsdoc/tag-lines": [
59+
"warn",
60+
"never",
61+
{ tags: { example: { lines: "always" } } },
62+
],
63+
"jsdoc/valid-types": "warn",
3964
},
4065
};

0 commit comments

Comments
 (0)