Skip to content

fix(require-rejects): reflect proper tag name in error message #1608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brettz9 merged 1 commit into from
Dec 6, 2025
+35 −35
Merged

fix(require-rejects): reflect proper tag name in error message #1608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/rules/require-rejects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,23 +56,23 @@ The following patterns are considered problems:
async function quux () {
throw new Error('abc');
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
*/
const quux = async () => {
throw new Error('abc');
};
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
*/
const quux = async function () {
throw new Error('abc');
};
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -86,7 +86,7 @@ async function quux () {
}
}
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -96,7 +96,7 @@ function quux () {
reject(new Error('abc'));
});
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -106,7 +106,7 @@ async function quux () {
throw new Error('abc');
}
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -119,15 +119,15 @@ async function quux () {
}
inner();
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
*/
async function quux () {
return Promise.reject(new Error('abc'));
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -137,7 +137,7 @@ function quux () {
return Promise.reject(new Error('abc'));
}
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -149,7 +149,7 @@ async function quux () {
}
}
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -159,7 +159,7 @@ async function quux () {
throw new Error('abc');
}
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -172,7 +172,7 @@ async function quux () {
break;
}
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -185,7 +185,7 @@ async function quux () {
}
}
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -198,7 +198,7 @@ async function quux () {
}
}
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -208,7 +208,7 @@ async function quux () {
throw new Error('abc');
} while (cond);
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -218,7 +218,7 @@ async function quux () {
throw new Error('abc');
}
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag

/**
*
Expand All @@ -230,7 +230,7 @@ async function quux () {
throw new Error('cleanup failed');
}
}
// Message: Promise-rejecting function requires `@reject` tag
// Message: Promise-rejecting function requires `@rejects` tag
````


Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireRejects.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ export default iterateJsdoc(({
};

if (shouldReport()) {
report('Promise-rejecting function requires `@reject` tag');
report('Promise-rejecting function requires `@rejects` tag');
}
}, {
contextDefaults: true,
Expand Down
34 changes: 17 additions & 17 deletions test/rules/assertions/requireRejects.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -32,7 +32,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -48,7 +48,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -70,7 +70,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -88,7 +88,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -106,7 +106,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -127,7 +127,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -143,7 +143,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -161,7 +161,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -181,7 +181,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -199,7 +199,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -220,7 +220,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -241,7 +241,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -262,7 +262,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -280,7 +280,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -298,7 +298,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand All @@ -318,7 +318,7 @@ export default /** @type {import('../index.js').TestCases} */ ({
errors: [
{
line: 2,
message: 'Promise-rejecting function requires `@reject` tag',
message: 'Promise-rejecting function requires `@rejects` tag',
},
],
},
Expand Down
Loading