@@ -17,8 +17,6 @@ module.exports = {
17
17
'import/named' : 'error' ,
18
18
'import/default' : 'error' ,
19
19
'import/extensions' : [ 'error' , 'always' , { ignorePackages : true } ] ,
20
-
21
- // validity
22
20
'jsdoc/check-access' : 'error' ,
23
21
'jsdoc/check-param-names' : 'error' ,
24
22
'jsdoc/check-property-names' : 'error' ,
@@ -32,11 +30,9 @@ module.exports = {
32
30
'jsdoc/empty-tags' : 'error' ,
33
31
'jsdoc/implements-on-classes' : 'error' ,
34
32
'jsdoc/no-bad-blocks' : 'error' ,
35
- // "jsdoc/no-undefined-types": ['error', { 'definedTypes': ['ol'] }],
36
- // this fails because of https://github.com/gajus/eslint-plugin-jsdoc/issues/559
37
- // for main source this should not be needed because tsc already checks it
33
+ // "jsdoc/no-undefined-types": ['error', { 'definedTypes': ['ol'] }], // blocked by https://github.com/gajus/eslint-plugin-jsdoc/issues/559
38
34
'jsdoc/require-param' : 'error' ,
39
- 'jsdoc/require-param-description' : 'error' , // this fails because of https://github.com/gajus/eslint-plugin-jsdoc/issues/686
35
+ 'jsdoc/require-param-description' : 'error' ,
40
36
'jsdoc/require-param-name' : 'error' ,
41
37
'jsdoc/require-param-type' : 'error' ,
42
38
'jsdoc/require-property' : 'error' ,
@@ -47,31 +43,11 @@ module.exports = {
47
43
'jsdoc/require-returns-check' : 'error' ,
48
44
'jsdoc/require-returns-description' : 'error' ,
49
45
'jsdoc/require-returns-type' : 'error' ,
50
- // "jsdoc/valid-types": 'error', // this fails because of https://github.com/jsdoctypeparser/jsdoctypeparser/issues/133
51
- // for main source this should not be needed because tsc already checks it
52
- // "jsdoc/check-types": 'error', // for primitives. is aligned with mode 'typescript'. Not needed because of tsc?
53
-
54
- // stylistic
46
+ // "jsdoc/valid-types": 'error', // blocked by https://github.com/jsdoctypeparser/jsdoctypeparser/issues/133
47
+ 'jsdoc/check-types' : 'error' ,
55
48
'jsdoc/check-alignment' : 'error' ,
56
49
'jsdoc/check-examples' : 'error' ,
57
50
'jsdoc/require-hyphen-before-param-description' : [ 'error' , 'never' ] ,
58
-
59
- // turned off
60
- // "jsdoc/check-indentation": 'error', // we want indentation in certain cases
61
- // "jsdoc/check-line-alignment": 'error',
62
- // "jsdoc/check-values": 'error', // not needed
63
- // "jsdoc/match-description": 'error', // regex could get adjusted ...
64
- // "jsdoc/newline-after-description": 'error',
65
- // "jsdoc/no-defaults": 'error',
66
- // "jsdoc/no-types": 'error',
67
- // "jsdoc/require-description": 'error',
68
- // "jsdoc/require-description-complete-sentence": 'error', // some issues with description starting with line break
69
- // "jsdoc/require-example": 'error',
70
- // "jsdoc/require-file-overview": 'error',
71
- // "jsdoc/require-jsdoc": 'error',
72
- // "jsdoc/require-throws": 'error',
73
- // "jsdoc/require-yields": 'error',
74
-
75
51
'no-cond-assign' : 'error' ,
76
52
'no-console' : 'error' ,
77
53
'no-const-assign' : 'error' ,
@@ -128,6 +104,10 @@ module.exports = {
128
104
settings : {
129
105
jsdoc : {
130
106
mode : 'typescript' ,
107
+ preferredTypes : {
108
+ '[]' : 'Array<>' ,
109
+ '.<>' : '<>'
110
+ } ,
131
111
tagNamePreference : {
132
112
'returns' : 'return' ,
133
113
'file' : 'fileoverview' ,
0 commit comments