-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjsdoc.yaml
70 lines (67 loc) · 1.98 KB
/
jsdoc.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
extends:
- "plugin:jsdoc/recommended"
plugins:
- jsdoc
settings:
jsdoc:
mode: "jsdoc"
tagNamePreference:
linkcode: link
linkplain: link
preferredTypes:
"any": "*"
"[]": "<>"
".<>": "<>"
rules:
jsdoc/check-access: [error]
jsdoc/check-alignment: [error]
jsdoc/check-param-names: [error]
jsdoc/check-property-names: [error]
jsdoc/check-syntax: [error]
jsdoc/check-tag-names: [error]
jsdoc/check-types: [error, { unifyParentAndChildTypeChecks: false }]
jsdoc/check-values: [error]
jsdoc/empty-tags: [error]
jsdoc/implements-on-classes: [error]
jsdoc/multiline-blocks: [off]
jsdoc/newline-after-description: [error, always]
jsdoc/no-bad-blocks: [error]
jsdoc/no-multi-asterisks: [error]
jsdoc/no-undefined-types: [off]
jsdoc/require-asterisk-prefix: [error]
jsdoc/require-description-complete-sentence: [error]
jsdoc/require-description: [error, { descriptionStyle: body }]
jsdoc/require-hyphen-before-param-description: [error]
jsdoc/require-jsdoc:
[
error,
{
require:
{
ArrowFunctionExpression: false,
ClassDeclaration: true,
ClassExpression: true,
FunctionDeclaration: false,
FunctionExpression: false,
MethodDefinition: true,
},
},
]
jsdoc/require-param-description: [error]
jsdoc/require-param-name: [error]
jsdoc/require-param-type: [error]
jsdoc/require-param: [error]
jsdoc/require-property: [error]
jsdoc/require-property-description: [error]
jsdoc/require-property-name: [error]
jsdoc/require-property-type: [error]
jsdoc/require-returns-check: [error]
jsdoc/require-returns-description: [error]
jsdoc/require-returns-type: [error]
jsdoc/require-returns: [error, { forceReturnsWithAsync: true }]
jsdoc/require-throws: [error]
jsdoc/require-yields: [error]
jsdoc/require-yields-check: [error]
jsdoc/sort-tags: [error]
jsdoc/tag-lines: [off]
jsdoc/valid-types: [error]