Skip to content

Commit 75d51dc

Browse files
author
john
committed
feat: make require-returns-description accept void functions (fixes #157)
1 parent af5a9a9 commit 75d51dc

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

src/rules/requireReturnsDescription.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ export default iterateJsdoc(({
1313
});
1414

1515
_.forEach(jsdocTags, (jsdocTag) => {
16+
const type = jsdocTag.type && jsdocTag.type.trim();
17+
18+
if (type === 'void' || type === 'undefined') {
19+
return;
20+
}
21+
1622
if (!jsdocTag.description) {
1723
report('Missing JSDoc @' + targetTagName + ' description.', null, jsdocTag);
1824
}

test/rules/assertions/requireReturnsDescription.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,26 @@ export default {
5858
*/
5959
function quux () {
6060
61+
}
62+
`
63+
},
64+
{
65+
code: `
66+
/**
67+
* @returns {undefined}
68+
*/
69+
function quux () {
70+
71+
}
72+
`
73+
},
74+
{
75+
code: `
76+
/**
77+
* @returns {void}
78+
*/
79+
function quux () {
80+
6181
}
6282
`
6383
}

0 commit comments

Comments
 (0)