Skip to content

Commit

Permalink
docs: add missing aliases sections
Browse files Browse the repository at this point in the history
Also add info on `internal` and missing tags to `empty-tags` and missing Tags section to `require-property-*`
  • Loading branch information
brettz9 committed Oct 19, 2020
1 parent 2e0f2a6 commit b7622cb
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 14 deletions.
3 changes: 2 additions & 1 deletion .README/rules/check-line-alignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ line's parts. **Only the non-default `"always"` is implemented for now.**
|---|---|
|Context|everywhere|
|Options|(a string matching `"always"|"never"`)|
|Tags|`param`, `arg`, `argument`, `property`, `prop`|
|Tags|`param`, `property`|
|Aliases|`arg`, `argument`, `prop`|

<!-- assertions checkLineAlignment -->
2 changes: 1 addition & 1 deletion .README/rules/check-param-names.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ Whether to check destructured properties. Defaults to `true`.
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
|Options|`allowExtraTrailingParamDocs`, `checkDestructured`, `checkRestProperty`, `checkTypesPattern`|
|Tags|`param`|

|Aliases|`arg`, `argument`|
<!-- assertions checkParamNames -->
1 change: 1 addition & 0 deletions .README/rules/check-property-names.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,6 @@ be removed even if it has a different type or description).
|Context|Everywhere|
|Options|`enableFixer`|
|Tags|`property`|
|Aliases|`prop`|

<!-- assertions checkPropertyNames -->
4 changes: 2 additions & 2 deletions .README/rules/empty-tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Expects the following tags to be empty of any content:
- `@inheritdoc`
- `@inner`
- `@instance`
- `@internal` (used by TypeScript)
- `@override`
- `@readonly`

Expand Down Expand Up @@ -46,7 +47,6 @@ add them within this option.
|||
|---|---|
|Context|everywhere|
|Tags| and others added by `tags`|
|Aliases||
|Tags| `abstract`, `async`, `generator`, `global`, `hideconstructor`, `ignore`, `inheritdoc`, `inner`, `instance`, `internal`, `override`, `readonly`, `package`, `private`, `protected`, `public`, `static` and others added by `tags`|
|Options|`tags`|
<!-- assertions emptyTags -->
3 changes: 2 additions & 1 deletion .README/rules/require-property-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Requires that each `@property` tag has a `description` value.
|||
|---|---|
|Context|everywhere|
|Tags|N/A|
|Tags|`property`|
|Aliases|`prop`|

<!-- assertions requirePropertyDescription -->
3 changes: 2 additions & 1 deletion .README/rules/require-property-name.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Requires that all function `@property` tags have names.
|||
|---|---|
|Context|everywhere|
|Tags|N/A|
|Tags|`property`|
|Aliases|`prop`|

<!-- assertions requirePropertyName -->
3 changes: 2 additions & 1 deletion .README/rules/require-property-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Requires that each `@property` tag has a `type` value.
|||
|---|---|
|Context|everywhere|
|Tags|N/A|
|Tags|`property`|
|Aliases|`prop`|

<!-- assertions requirePropertyType -->
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1717,7 +1717,8 @@ line's parts. **Only the non-default `"always"` is implemented for now.**
|---|---|
|Context|everywhere|
|Options|(a string matching `"always"|"never"`)|
|Tags|`param`, `arg`, `argument`, `property`, `prop`|
|Tags|`param`, `property`|
|Aliases|`arg`, `argument`, `prop`|

The following patterns are considered problems:

Expand Down Expand Up @@ -2049,7 +2050,7 @@ Whether to check destructured properties. Defaults to `true`.
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
|Options|`allowExtraTrailingParamDocs`, `checkDestructured`, `checkRestProperty`, `checkTypesPattern`|
|Tags|`param`|

|Aliases|`arg`, `argument`|
The following patterns are considered problems:

````js
Expand Down Expand Up @@ -2799,6 +2800,7 @@ be removed even if it has a different type or description).
|Context|Everywhere|
|Options|`enableFixer`|
|Tags|`property`|
|Aliases|`prop`|

The following patterns are considered problems:

Expand Down Expand Up @@ -5090,6 +5092,7 @@ Expects the following tags to be empty of any content:
- `@inheritdoc`
- `@inner`
- `@instance`
- `@internal` (used by TypeScript)
- `@override`
- `@readonly`
Expand Down Expand Up @@ -5127,8 +5130,7 @@ add them within this option.
|||
|---|---|
|Context|everywhere|
|Tags| and others added by `tags`|
|Aliases||
|Tags| `abstract`, `async`, `generator`, `global`, `hideconstructor`, `ignore`, `inheritdoc`, `inner`, `instance`, `internal`, `override`, `readonly`, `package`, `private`, `protected`, `public`, `static` and others added by `tags`|
|Options|`tags`|
The following patterns are considered problems:
Expand Down Expand Up @@ -12825,7 +12827,8 @@ Requires that each `@property` tag has a `description` value.
|||
|---|---|
|Context|everywhere|
|Tags|N/A|
|Tags|`property`|
|Aliases|`prop`|

The following patterns are considered problems:

Expand Down Expand Up @@ -12883,7 +12886,8 @@ Requires that all function `@property` tags have names.
|||
|---|---|
|Context|everywhere|
|Tags|N/A|
|Tags|`property`|
|Aliases|`prop`|

The following patterns are considered problems:

Expand Down Expand Up @@ -12941,7 +12945,8 @@ Requires that each `@property` tag has a `type` value.
|||
|---|---|
|Context|everywhere|
|Tags|N/A|
|Tags|`property`|
|Aliases|`prop`|

The following patterns are considered problems:

Expand Down

0 comments on commit b7622cb

Please sign in to comment.