Skip to content

Commit 42c642a

Browse files
committed
Fix: lists now treats like a sentence in requireDescriptionCompleteSentence
Fixes #129
1 parent 9805a4e commit 42c642a

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

lib/rules/validate-jsdoc/require-description-complete-sentence.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ function requireDescriptionCompleteSentence(node, err) {
5858
.replace(/(")([^"]+)\1/, quotedSanitizer)
5959
.replace(/\{([^}]+)\}/, function(_, m) {
6060
return '{' + (new Array(m.length + 1)).join('*') + '}';
61+
})
62+
.replace(/\r/g, ' ')
63+
.replace(/:(\n+)/, function(_, n) {
64+
return ':' + n.replace(/\n/g, ' ');
6165
});
6266
var lines = sanitized.split(RE_END_DESCRIPTION);
6367

test/lib/rules/validate-jsdoc/require-description-complete-sentence.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,22 @@ describe('lib/rules/validate-jsdoc/require-description-complete-sentence', funct
216216
*/
217217
function fun(p) {}
218218
}
219+
}, {
220+
it: 'should not report correct sentences formatted as lists',
221+
code: function () {
222+
/**
223+
* Foo
224+
* `bar`.
225+
*
226+
* Baz:
227+
*
228+
* - qux
229+
* - Zot
230+
* - Qux
231+
* - zot
232+
*/
233+
function quux() {}
234+
}
219235
}
220236
/* jshint ignore:end */
221237
]);

0 commit comments

Comments
 (0)