-
-
Notifications
You must be signed in to change notification settings - Fork 153
/
requireReturnsCheck.js
executable file
·160 lines (154 loc) · 2.67 KB
/
requireReturnsCheck.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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
export default {
invalid: [
{
code: `
/**
* @returns
*/
function quux (foo) {
}
`,
errors: [
{
line: 2,
message: 'Present JSDoc @returns declaration but not available return expression in function.'
}
]
},
{
code: `
/**
* @return
*/
function quux (foo) {
}
`,
errors: [
{
line: 2,
message: 'Present JSDoc @return declaration but not available return expression in function.'
}
],
settings: {
jsdoc: {
tagNamePreference: {
returns: 'return'
}
}
}
},
{
code: `
/**
* @returns
*/
const quux = () => {}
`,
errors: [
{
line: 2,
message: 'Present JSDoc @returns declaration but not available return expression in function.'
}
]
},
{
code: `
/**
* @returns {undefined} Foo.
* @returns {String} Foo.
*/
function quux () {
return foo;
}
`,
errors: [
{
line: 2,
message: 'Found more than one @returns declaration.'
}
]
}
],
valid: [
{
code: `
/**
* @returns Foo.
*/
function quux () {
return foo;
}
`
},
{
code: `
/**
* @returns {void} Foo.
*/
function quux () {
return foo;
}
`
},
{
code: `
/**
* @returns {undefined} Foo.
*/
function quux () {
return foo;
}
`
},
{
code: `
/**
*
*/
function quux () {
}
`
},
{
code: `
/**
* @returns {*} Foo.
*/
const quux = () => foo;
`
},
{
code: `
/**
* @returns {Promise<void>}
*/
async function quux() {}
`,
parserOptions: {
ecmaVersion: 8
}
},
{
code: `
/**
* @returns {Promise<void>}
*/
async () => {}
`,
parserOptions: {
ecmaVersion: 8
}
},
{
code: `
/**
* @returns Foo.
* @abstract
*/
function quux () {
throw new Error('must be implemented by subclass!');
}
`
}
]
};