-
Notifications
You must be signed in to change notification settings - Fork 0
/
jsdoc.js
88 lines (88 loc) · 2.2 KB
/
jsdoc.js
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
module.exports = {
plugins: [
"jsdoc"
],
extends: [
"plugin:jsdoc/recommended"
],
rules: {
"jsdoc/check-param-names": "warn",
"jsdoc/check-template-names": "warn",
"jsdoc/lines-before-block": "warn",
"jsdoc/require-jsdoc": "off",
"jsdoc/require-returns": "off",
"jsdoc/require-template": "warn",
"jsdoc/check-indentation": ["warn", {
excludeTags: ["import", "example"]
}],
"jsdoc/no-bad-blocks": "warn",
"jsdoc/tag-lines": ["warn", "never"],
"jsdoc/no-defaults": "off",
"jsdoc/require-hyphen-before-param-description": ["warn", "always", {
tags: {
property: "always",
template: "always",
return: "never"
}
}],
"jsdoc/check-line-alignment": ["warn", "never"],
"jsdoc/match-name": ["warn", {
match: [
{
allowName: "/^_?([A-Z][a-z]+)+$/",
message: "The name should be written in PascalCase.",
tags: ["typedef"]
},
{
allowName: "/^([A-Z][a-z]+)+$/",
message: "The name should be written in PascalCase.",
tags: ["callback"]
},
{
allowName: "/^[A-Z]{1}$/",
message: "The name should be a single capital letter.",
tags: ["template"]
}
]
}],
"jsdoc/match-description": ["warn", {
contexts: ["any"],
mainDescription: {
message: "The main description should be written in the third person, begin with a capital letter and end with a period.",
match: "/^[A-Z][.^\\w]*s\\b.*\\.$/us"
},
matchDescription: "^[A-Z].*[^\\.]$",
tags: {
param: {
message: "@param description should begin with a capital letter and not end with a period.",
match: true
},
property: {
message: "@property description should begin with a capital letter and not end with a period.",
match: true
},
returns: {
message: "@returns description should begin with a capital letter and not end with a period.",
match: true
},
template: {
message: "@template description should begin with a capital letter and not end with a period.",
match: true
}
}
}]
},
settings: {
jsdoc: {
maxLines: 2,
mode: "typescript",
preferredTypes: {
"object<>": false,
"Object<>": "Record<>",
"Object": "object",
".<>": "<>",
"*": "any"
}
}
}
};