Skip to content

Commit

Permalink
docs: add missing documentation (#502)
Browse files Browse the repository at this point in the history
* docs: add missing rules

* docs: add missing documentation

Fix #501
  • Loading branch information
mgechev committed Jan 24, 2018
1 parent 00cf07c commit 1fe9d22
Show file tree
Hide file tree
Showing 8 changed files with 56 additions and 3 deletions.
3 changes: 3 additions & 0 deletions README.md
Expand Up @@ -282,9 +282,12 @@ Below you can find a recommended configuration which is based on the [Angular St
| `use-input-property-decorator` | Stable |
| `use-output-property-decorator` | Stable |
| `trackBy-function` | Stable |
| `import-destructuring-spacing` | Stable |
| `no-output-named-after-standard-event` | Stable |
| `i18n` | *Experimental* |
| `no-unused-css` | *Experimental* |
| `angular-whitespace` | *Experimental* |
| `pipe-naming` | *Deprecated* |

## Disable a rule that validates Template or Styles

Expand Down
28 changes: 25 additions & 3 deletions docs/_data/rules.json
Expand Up @@ -21,7 +21,8 @@
"optionExamples": [
"[true, \"check-interpolation\"]"
],
"typescriptOnly": true
"typescriptOnly": true,
"hasFix": true
},
{
"ruleName": "banana-in-box",
Expand All @@ -30,7 +31,8 @@
"rationale": "The parens \"()\" should have been inside the brackets \"[]\".",
"options": null,
"optionsDescription": "Not configurable.",
"typescriptOnly": true
"typescriptOnly": true,
"hasFix": true
},
{
"ruleName": "component-class-suffix",
Expand Down Expand Up @@ -240,6 +242,15 @@
"optionsDescription": "Not configurable.",
"typescriptOnly": true
},
{
"ruleName": "no-output-named-after-standard-event",
"type": "maintainability",
"description": "Disallows naming directive outputs after a standard DOM event.",
"rationale": "Listeners subscribed to an output with such a name will also be invoked when the native event is raised.",
"options": null,
"optionsDescription": "Not configurable.",
"typescriptOnly": true
},
{
"ruleName": "no-output-on-prefix",
"type": "maintainability",
Expand All @@ -266,7 +277,8 @@
"description": "Disallows having an unused CSS rule in the component's stylesheet.",
"options": null,
"optionsDescription": "Not configurable.",
"typescriptOnly": true
"typescriptOnly": true,
"hasFix": true
},
{
"ruleName": "pipe-impure",
Expand Down Expand Up @@ -312,6 +324,16 @@
"rationale": "Async pipe evaluate to `null` before the observable or promise emits, which can lead to layout thrashing as components load. Prefer strict `=== false` checks instead.",
"options": null,
"optionsDescription": "Not configurable.",
"typescriptOnly": true,
"hasFix": true
},
{
"ruleName": "trackBy-function",
"type": "functionality",
"description": "Ensures a TrackBy function is used.",
"rationale": "Using TrackBy is considired as a best pratice.",
"options": null,
"optionsDescription": "Not configurable.",
"typescriptOnly": true
},
{
Expand Down
1 change: 1 addition & 0 deletions docs/rules/angular-whitespace/index.html
Expand Up @@ -22,6 +22,7 @@
optionExamples:
- '[true, "check-interpolation"]'
typescriptOnly: true
hasFix: true
layout: rule
title: 'Rule: angular-whitespace'
optionsJSON: |-
Expand Down
1 change: 1 addition & 0 deletions docs/rules/banana-in-box/index.html
Expand Up @@ -6,6 +6,7 @@
options: null
optionsDescription: Not configurable.
typescriptOnly: true
hasFix: true
layout: rule
title: 'Rule: banana-in-box'
optionsJSON: 'null'
Expand Down
12 changes: 12 additions & 0 deletions docs/rules/no-output-named-after-standard-event/index.html
@@ -0,0 +1,12 @@
---
ruleName: no-output-named-after-standard-event
type: maintainability
description: Disallows naming directive outputs after a standard DOM event.
rationale: Listeners subscribed to an output with such a name will also be invoked when the native event is raised.
options: null
optionsDescription: Not configurable.
typescriptOnly: true
layout: rule
title: 'Rule: no-output-named-after-standard-event'
optionsJSON: 'null'
---
1 change: 1 addition & 0 deletions docs/rules/no-unused-css/index.html
Expand Up @@ -5,6 +5,7 @@
options: null
optionsDescription: Not configurable.
typescriptOnly: true
hasFix: true
layout: rule
title: 'Rule: no-unused-css'
optionsJSON: 'null'
Expand Down
1 change: 1 addition & 0 deletions docs/rules/templates-no-negated-async/index.html
Expand Up @@ -8,6 +8,7 @@
options: null
optionsDescription: Not configurable.
typescriptOnly: true
hasFix: true
layout: rule
title: 'Rule: templates-no-negated-async'
optionsJSON: 'null'
Expand Down
12 changes: 12 additions & 0 deletions docs/rules/trackBy-function/index.html
@@ -0,0 +1,12 @@
---
ruleName: trackBy-function
type: functionality
description: Ensures a TrackBy function is used.
rationale: Using TrackBy is considired as a best pratice.
options: null
optionsDescription: Not configurable.
typescriptOnly: true
layout: rule
title: 'Rule: trackBy-function'
optionsJSON: 'null'
---

0 comments on commit 1fe9d22

Please sign in to comment.