Skip to content

Commit 44b2631

Browse files
brettz9brettz9
committed
fix(require-rejects): reflect proper tag name in error message
1 parent f776d63 commit 44b2631

File tree

3 files changed

+35
-35
lines changed

3 files changed

+35
-35
lines changed

‎docs/rules/require-rejects.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -56,23 +56,23 @@ The following patterns are considered problems:
5656
async function quux () {
5757
throw new Error('abc');
5858
}
59-
// Message: Promise-rejecting function requires `@reject` tag
59+
// Message: Promise-rejecting function requires `@rejects` tag
6060

6161
/**
6262
*
6363
*/
6464
const quux = async () => {
6565
throw new Error('abc');
6666
};
67-
// Message: Promise-rejecting function requires `@reject` tag
67+
// Message: Promise-rejecting function requires `@rejects` tag
6868

6969
/**
7070
*
7171
*/
7272
const quux = async function () {
7373
throw new Error('abc');
7474
};
75-
// Message: Promise-rejecting function requires `@reject` tag
75+
// Message: Promise-rejecting function requires `@rejects` tag
7676

7777
/**
7878
*
@@ -86,7 +86,7 @@ async function quux () {
8686
}
8787
}
8888
}
89-
// Message: Promise-rejecting function requires `@reject` tag
89+
// Message: Promise-rejecting function requires `@rejects` tag
9090

9191
/**
9292
*
@@ -96,7 +96,7 @@ function quux () {
9696
reject(new Error('abc'));
9797
});
9898
}
99-
// Message: Promise-rejecting function requires `@reject` tag
99+
// Message: Promise-rejecting function requires `@rejects` tag
100100

101101
/**
102102
*
@@ -106,7 +106,7 @@ async function quux () {
106106
throw new Error('abc');
107107
}
108108
}
109-
// Message: Promise-rejecting function requires `@reject` tag
109+
// Message: Promise-rejecting function requires `@rejects` tag
110110

111111
/**
112112
*
@@ -119,15 +119,15 @@ async function quux () {
119119
}
120120
inner();
121121
}
122-
// Message: Promise-rejecting function requires `@reject` tag
122+
// Message: Promise-rejecting function requires `@rejects` tag
123123

124124
/**
125125
*
126126
*/
127127
async function quux () {
128128
return Promise.reject(new Error('abc'));
129129
}
130-
// Message: Promise-rejecting function requires `@reject` tag
130+
// Message: Promise-rejecting function requires `@rejects` tag
131131

132132
/**
133133
*
@@ -137,7 +137,7 @@ function quux () {
137137
return Promise.reject(new Error('abc'));
138138
}
139139
}
140-
// Message: Promise-rejecting function requires `@reject` tag
140+
// Message: Promise-rejecting function requires `@rejects` tag
141141

142142
/**
143143
*
@@ -149,7 +149,7 @@ async function quux () {
149149
}
150150
}
151151
}
152-
// Message: Promise-rejecting function requires `@reject` tag
152+
// Message: Promise-rejecting function requires `@rejects` tag
153153

154154
/**
155155
*
@@ -159,7 +159,7 @@ async function quux () {
159159
throw new Error('abc');
160160
}
161161
}
162-
// Message: Promise-rejecting function requires `@reject` tag
162+
// Message: Promise-rejecting function requires `@rejects` tag
163163

164164
/**
165165
*
@@ -172,7 +172,7 @@ async function quux () {
172172
break;
173173
}
174174
}
175-
// Message: Promise-rejecting function requires `@reject` tag
175+
// Message: Promise-rejecting function requires `@rejects` tag
176176

177177
/**
178178
*
@@ -185,7 +185,7 @@ async function quux () {
185185
}
186186
}
187187
}
188-
// Message: Promise-rejecting function requires `@reject` tag
188+
// Message: Promise-rejecting function requires `@rejects` tag
189189

190190
/**
191191
*
@@ -198,7 +198,7 @@ async function quux () {
198198
}
199199
}
200200
}
201-
// Message: Promise-rejecting function requires `@reject` tag
201+
// Message: Promise-rejecting function requires `@rejects` tag
202202

203203
/**
204204
*
@@ -208,7 +208,7 @@ async function quux () {
208208
throw new Error('abc');
209209
} while (cond);
210210
}
211-
// Message: Promise-rejecting function requires `@reject` tag
211+
// Message: Promise-rejecting function requires `@rejects` tag
212212

213213
/**
214214
*
@@ -218,7 +218,7 @@ async function quux () {
218218
throw new Error('abc');
219219
}
220220
}
221-
// Message: Promise-rejecting function requires `@reject` tag
221+
// Message: Promise-rejecting function requires `@rejects` tag
222222

223223
/**
224224
*
@@ -230,7 +230,7 @@ async function quux () {
230230
throw new Error('cleanup failed');
231231
}
232232
}
233-
// Message: Promise-rejecting function requires `@reject` tag
233+
// Message: Promise-rejecting function requires `@rejects` tag
234234
````
235235

236236

‎src/rules/requireRejects.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ export default iterateJsdoc(({
183183
};
184184

185185
if (shouldReport()) {
186-
report('Promise-rejecting function requires `@reject` tag');
186+
report('Promise-rejecting function requires `@rejects` tag');
187187
}
188188
}, {
189189
contextDefaults: true,

‎test/rules/assertions/requireRejects.js‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
1616
errors: [
1717
{
1818
line: 2,
19-
message: 'Promise-rejecting function requires `@reject` tag',
19+
message: 'Promise-rejecting function requires `@rejects` tag',
2020
},
2121
],
2222
},
@@ -32,7 +32,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
3232
errors: [
3333
{
3434
line: 2,
35-
message: 'Promise-rejecting function requires `@reject` tag',
35+
message: 'Promise-rejecting function requires `@rejects` tag',
3636
},
3737
],
3838
},
@@ -48,7 +48,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
4848
errors: [
4949
{
5050
line: 2,
51-
message: 'Promise-rejecting function requires `@reject` tag',
51+
message: 'Promise-rejecting function requires `@rejects` tag',
5252
},
5353
],
5454
},
@@ -70,7 +70,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
7070
errors: [
7171
{
7272
line: 2,
73-
message: 'Promise-rejecting function requires `@reject` tag',
73+
message: 'Promise-rejecting function requires `@rejects` tag',
7474
},
7575
],
7676
},
@@ -88,7 +88,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
8888
errors: [
8989
{
9090
line: 2,
91-
message: 'Promise-rejecting function requires `@reject` tag',
91+
message: 'Promise-rejecting function requires `@rejects` tag',
9292
},
9393
],
9494
},
@@ -106,7 +106,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
106106
errors: [
107107
{
108108
line: 2,
109-
message: 'Promise-rejecting function requires `@reject` tag',
109+
message: 'Promise-rejecting function requires `@rejects` tag',
110110
},
111111
],
112112
},
@@ -127,7 +127,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
127127
errors: [
128128
{
129129
line: 2,
130-
message: 'Promise-rejecting function requires `@reject` tag',
130+
message: 'Promise-rejecting function requires `@rejects` tag',
131131
},
132132
],
133133
},
@@ -143,7 +143,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
143143
errors: [
144144
{
145145
line: 2,
146-
message: 'Promise-rejecting function requires `@reject` tag',
146+
message: 'Promise-rejecting function requires `@rejects` tag',
147147
},
148148
],
149149
},
@@ -161,7 +161,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
161161
errors: [
162162
{
163163
line: 2,
164-
message: 'Promise-rejecting function requires `@reject` tag',
164+
message: 'Promise-rejecting function requires `@rejects` tag',
165165
},
166166
],
167167
},
@@ -181,7 +181,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
181181
errors: [
182182
{
183183
line: 2,
184-
message: 'Promise-rejecting function requires `@reject` tag',
184+
message: 'Promise-rejecting function requires `@rejects` tag',
185185
},
186186
],
187187
},
@@ -199,7 +199,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
199199
errors: [
200200
{
201201
line: 2,
202-
message: 'Promise-rejecting function requires `@reject` tag',
202+
message: 'Promise-rejecting function requires `@rejects` tag',
203203
},
204204
],
205205
},
@@ -220,7 +220,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
220220
errors: [
221221
{
222222
line: 2,
223-
message: 'Promise-rejecting function requires `@reject` tag',
223+
message: 'Promise-rejecting function requires `@rejects` tag',
224224
},
225225
],
226226
},
@@ -241,7 +241,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
241241
errors: [
242242
{
243243
line: 2,
244-
message: 'Promise-rejecting function requires `@reject` tag',
244+
message: 'Promise-rejecting function requires `@rejects` tag',
245245
},
246246
],
247247
},
@@ -262,7 +262,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
262262
errors: [
263263
{
264264
line: 2,
265-
message: 'Promise-rejecting function requires `@reject` tag',
265+
message: 'Promise-rejecting function requires `@rejects` tag',
266266
},
267267
],
268268
},
@@ -280,7 +280,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
280280
errors: [
281281
{
282282
line: 2,
283-
message: 'Promise-rejecting function requires `@reject` tag',
283+
message: 'Promise-rejecting function requires `@rejects` tag',
284284
},
285285
],
286286
},
@@ -298,7 +298,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
298298
errors: [
299299
{
300300
line: 2,
301-
message: 'Promise-rejecting function requires `@reject` tag',
301+
message: 'Promise-rejecting function requires `@rejects` tag',
302302
},
303303
],
304304
},
@@ -318,7 +318,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
318318
errors: [
319319
{
320320
line: 2,
321-
message: 'Promise-rejecting function requires `@reject` tag',
321+
message: 'Promise-rejecting function requires `@rejects` tag',
322322
},
323323
],
324324
},

0 commit comments

Comments
 (0)