diff --git a/docs/rules/require-rejects.md b/docs/rules/require-rejects.md index abbd899d0..0a8cb6fbb 100644 --- a/docs/rules/require-rejects.md +++ b/docs/rules/require-rejects.md @@ -56,7 +56,7 @@ 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 /** * @@ -64,7 +64,7 @@ async function quux () { const quux = async () => { throw new Error('abc'); }; -// Message: Promise-rejecting function requires `@reject` tag +// Message: Promise-rejecting function requires `@rejects` tag /** * @@ -72,7 +72,7 @@ const quux = async () => { const quux = async function () { throw new Error('abc'); }; -// Message: Promise-rejecting function requires `@reject` tag +// Message: Promise-rejecting function requires `@rejects` tag /** * @@ -86,7 +86,7 @@ async function quux () { } } } -// Message: Promise-rejecting function requires `@reject` tag +// Message: Promise-rejecting function requires `@rejects` tag /** * @@ -96,7 +96,7 @@ function quux () { reject(new Error('abc')); }); } -// Message: Promise-rejecting function requires `@reject` tag +// Message: Promise-rejecting function requires `@rejects` tag /** * @@ -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 /** * @@ -119,7 +119,7 @@ async function quux () { } inner(); } -// Message: Promise-rejecting function requires `@reject` tag +// Message: Promise-rejecting function requires `@rejects` tag /** * @@ -127,7 +127,7 @@ async function quux () { async function quux () { return Promise.reject(new Error('abc')); } -// Message: Promise-rejecting function requires `@reject` tag +// Message: Promise-rejecting function requires `@rejects` tag /** * @@ -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 /** * @@ -149,7 +149,7 @@ async function quux () { } } } -// Message: Promise-rejecting function requires `@reject` tag +// Message: Promise-rejecting function requires `@rejects` tag /** * @@ -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 /** * @@ -172,7 +172,7 @@ async function quux () { break; } } -// Message: Promise-rejecting function requires `@reject` tag +// Message: Promise-rejecting function requires `@rejects` tag /** * @@ -185,7 +185,7 @@ async function quux () { } } } -// Message: Promise-rejecting function requires `@reject` tag +// Message: Promise-rejecting function requires `@rejects` tag /** * @@ -198,7 +198,7 @@ async function quux () { } } } -// Message: Promise-rejecting function requires `@reject` tag +// Message: Promise-rejecting function requires `@rejects` tag /** * @@ -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 /** * @@ -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 /** * @@ -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 ```` diff --git a/src/rules/requireRejects.js b/src/rules/requireRejects.js index 7938ee882..fde8e52f6 100644 --- a/src/rules/requireRejects.js +++ b/src/rules/requireRejects.js @@ -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, diff --git a/test/rules/assertions/requireRejects.js b/test/rules/assertions/requireRejects.js index 6e611d784..faffacc50 100644 --- a/test/rules/assertions/requireRejects.js +++ b/test/rules/assertions/requireRejects.js @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], }, @@ -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', }, ], },