require-description-complete-sentence false positives #337
Comments
|
Regarding making the fixer optional and changing the logic, I've added a notation on #336, so that can be tracked there. Regarding abbreviations, have you tried adding a comma, as in As far as the first issue mentioned re: |
|
Actually, on further examination of the tags, I think we should implement with a |
…n default tags likely to have descriptions or by `tags` array for additional choices; fixes gajus#337 Tags that are checked for description by default are: 'param', 'arg', 'argument', 'property', 'prop', 'returns', 'return', 'summary', 'file', 'fileoverview', 'overview', 'classdesc', 'todo', 'deprecated', 'throws', 'exception', 'yields', 'yield'. Note that `see` and `copyright` are not included by default because of potentially allowing a non-description or potential sensitivity, respectively.
…n default tags likely to have descriptions or by `tags` array for additional choices; fixes #337 Tags that are checked for description by default are: 'param', 'arg', 'argument', 'property', 'prop', 'returns', 'return', 'summary', 'file', 'fileoverview', 'overview', 'classdesc', 'todo', 'deprecated', 'throws', 'exception', 'yields', 'yield'. Note that `see` and `copyright` are not included by default because of potentially allowing a non-description or potential sensitivity, respectively.
|
🎉 This issue has been resolved in version 15.5.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
* master: (46 commits) feat(require-description-complete-sentence): limit checking to certain default tags likely to have descriptions or by `tags` array for additional choices; fixes gajus#337 docs(newline-after-description): indicate applies on doc block docs(match-description): add alias `desc` to separate column docs(match-description): indicate application by default to `description`/`desc` and allowance for `property`/`prop`; clarify fix(match-description): ensure `prop` and `property` matching excludes name testing(require-param): fix test source (part of gajus#332) testing(require-param): fix test expectation (part of gajus#332) docs: generate docs chore: update devDeps (eslint-config-canonical, gitdown) fix(no-undefined-types): ensure working in all contexts; fixes gajus#324 refactor(iterateJsdoc): reduce retrieval calls docs(check-examples): allow for whitespace at end feat(check-examples): add `paddedIndent` option fix(check-examples): preserve whitespace so as to report issues with whitespace-related rules such as `indent` (fixes gajus#211) chore(travis): fix Travis to use older unicorn version that supports Node 6 (and the canonical config that requires the earlier unicorn version) docs(require-returns, require-returns-check): indicate that these will report if multiple `returns` tags are present refactor: use `String.prototype.repeat` over lodash `repeat` refactor: apply (jsdoc-related) eslint rule fixes chore: add `lint-fix` script fix(newline-after-description): avoid matching duplicate or partial matches within tag descriptions after the block description; fixes gajus#328 ...
|
🎉 This issue has been resolved in version 15.9.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Looks like commit 78f9b61 to fix #333 has introduced a regression.
@exampletags contain code and should not be treated as a sentence. Since it looks like the rule runs on all JSDoc tags, maybe an option to disable the check for certain tags would be useful.The autofix for the rule is quite annoying so a way to disable the autofix would be great too. It breaks things like changing
/** @jest-environment node */to/** @jest-environment Node */, causing jest to fail.Starting a line with a capital character also often trigger a false positive. This typically happens when using words which should be capitalised, e.g. names; JavaScript, TypeScript, ProductName. Could the logic be relaxed to only trigger if the previous line ends with a
.or is a line break?Abbreviation which contain
.s also trigger false positives, e.g.e.g. Text.The text was updated successfully, but these errors were encountered: