Skip to content

Commit 76c8f71

Browse files
author
Christopher Willis-Ford
committed
feat(jsdoc): add more checks to valid-jsdoc rule
BREAKING CHANGE: Added stricter options from http://eslint.org/docs/rules/valid-jsdoc
1 parent dcad861 commit 76c8f71

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

index.js

+15-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,22 @@ module.exports = {
44
// Errors
55
'valid-jsdoc': [2, {
66
prefer: {
7-
return: 'return'
7+
arg: 'param',
8+
argument: 'param',
9+
class: 'constructor',
10+
return: 'return',
11+
virtual: 'abstract'
812
},
9-
requireReturn: false
13+
preferType: {
14+
Boolean: 'boolean',
15+
Number: 'number',
16+
Object: 'object',
17+
String: 'string'
18+
},
19+
requireReturn: false,
20+
requireReturnType: true,
21+
requireParamDescription: true,
22+
requireReturnDescription: true
1023
}],
1124

1225
// Best practices

0 commit comments

Comments
 (0)