forked from gajus/eslint-plugin-jsdoc
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat:
no-multi-asterisks
rule to prevent multiple asterisks with mi…
…ddle delimiters or at end of blocks
- Loading branch information
Showing
7 changed files
with
632 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
### `no-multi-asterisks` | ||
|
||
Prevents use of multiple asterisks at the beginning of lines. | ||
|
||
Note that if you wish to prevent multiple asterisks at the very beginning of | ||
the jsdoc block, you should use `no-bad-blocks` (as that is not proper jsdoc | ||
and that rule is for catching blocks which only seem like jsdoc). | ||
|
||
#### Options | ||
|
||
##### `preventAtMiddleLines` (defaults to `true`) | ||
|
||
Prevent the likes of this: | ||
|
||
```js | ||
/** | ||
* | ||
** | ||
*/ | ||
``` | ||
|
||
##### `preventAtEnd` (defaults to `true`) | ||
|
||
Prevent the likes of this: | ||
|
||
```js | ||
/** | ||
* | ||
* | ||
**/ | ||
``` | ||
|
||
||| | ||
|---|---| | ||
|Context|everywhere| | ||
|Tags|(any)| | ||
|Recommended|true| | ||
|Settings|| | ||
|Options|`preventAtEnd`, `preventAtMiddleLines`| | ||
|
||
<!-- assertions noMultiAsterisks --> |
Oops, something went wrong.