This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
JSDoc rule should not block arbitrary comments like /********/ #1543
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
There are 2 prime examples of comments that confuse tslint JSDoc detection regex:
A separator:
and
These can be used as visual separator or guides, and are definitely not JSDocs.
Was also reported in issue #1121 several months ago.
Solution
Instead of matching any
/^\s*\/\*\*/
, I suggest that when there are more than 2 asterisks in a row, it should not be tested as a JSDoc comment.Thus, the regex is updated to
/^\s*\/\*\*([^*]|$)/
which would accept/**
followed by anything but another*
.matched as jsdoc
not jsdoc