Skip to content

Commit

Permalink
feat: no-multi-asterisks rule to prevent multiple asterisks with mi…
Browse files Browse the repository at this point in the history
…ddle delimiters or at end of blocks
  • Loading branch information
brettz9 committed May 15, 2021
1 parent 06bbf37 commit 8848246
Show file tree
Hide file tree
Showing 7 changed files with 632 additions and 67 deletions.
1 change: 1 addition & 0 deletions .README/README.md
Expand Up @@ -557,6 +557,7 @@ selector).
{"gitdown": "include", "file": "./rules/no-bad-blocks.md"}
{"gitdown": "include", "file": "./rules/no-defaults.md"}
{"gitdown": "include", "file": "./rules/no-missing-syntax.md"}
{"gitdown": "include", "file": "./rules/no-multi-asterisks.md"}
{"gitdown": "include", "file": "./rules/no-restricted-syntax.md"}
{"gitdown": "include", "file": "./rules/no-types.md"}
{"gitdown": "include", "file": "./rules/no-undefined-types.md"}
Expand Down
41 changes: 41 additions & 0 deletions .README/rules/no-multi-asterisks.md
@@ -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 -->

0 comments on commit 8848246

Please sign in to comment.