Skip to content

Commit 1fe9d22

Browse files
authoredJan 24, 2018
docs: add missing documentation (#502)
* docs: add missing rules * docs: add missing documentation Fix #501
1 parent 00cf07c commit 1fe9d22

File tree

8 files changed

+56
-3
lines changed

8 files changed

+56
-3
lines changed
 

‎README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,9 +282,12 @@ Below you can find a recommended configuration which is based on the [Angular St
282282
| `use-input-property-decorator` | Stable |
283283
| `use-output-property-decorator` | Stable |
284284
| `trackBy-function` | Stable |
285+
| `import-destructuring-spacing` | Stable |
286+
| `no-output-named-after-standard-event` | Stable |
285287
| `i18n` | *Experimental* |
286288
| `no-unused-css` | *Experimental* |
287289
| `angular-whitespace` | *Experimental* |
290+
| `pipe-naming` | *Deprecated* |
288291

289292
## Disable a rule that validates Template or Styles
290293

‎docs/_data/rules.json

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@
2121
"optionExamples": [
2222
"[true, \"check-interpolation\"]"
2323
],
24-
"typescriptOnly": true
24+
"typescriptOnly": true,
25+
"hasFix": true
2526
},
2627
{
2728
"ruleName": "banana-in-box",
@@ -30,7 +31,8 @@
3031
"rationale": "The parens \"()\" should have been inside the brackets \"[]\".",
3132
"options": null,
3233
"optionsDescription": "Not configurable.",
33-
"typescriptOnly": true
34+
"typescriptOnly": true,
35+
"hasFix": true
3436
},
3537
{
3638
"ruleName": "component-class-suffix",
@@ -240,6 +242,15 @@
240242
"optionsDescription": "Not configurable.",
241243
"typescriptOnly": true
242244
},
245+
{
246+
"ruleName": "no-output-named-after-standard-event",
247+
"type": "maintainability",
248+
"description": "Disallows naming directive outputs after a standard DOM event.",
249+
"rationale": "Listeners subscribed to an output with such a name will also be invoked when the native event is raised.",
250+
"options": null,
251+
"optionsDescription": "Not configurable.",
252+
"typescriptOnly": true
253+
},
243254
{
244255
"ruleName": "no-output-on-prefix",
245256
"type": "maintainability",
@@ -266,7 +277,8 @@
266277
"description": "Disallows having an unused CSS rule in the component's stylesheet.",
267278
"options": null,
268279
"optionsDescription": "Not configurable.",
269-
"typescriptOnly": true
280+
"typescriptOnly": true,
281+
"hasFix": true
270282
},
271283
{
272284
"ruleName": "pipe-impure",
@@ -312,6 +324,16 @@
312324
"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.",
313325
"options": null,
314326
"optionsDescription": "Not configurable.",
327+
"typescriptOnly": true,
328+
"hasFix": true
329+
},
330+
{
331+
"ruleName": "trackBy-function",
332+
"type": "functionality",
333+
"description": "Ensures a TrackBy function is used.",
334+
"rationale": "Using TrackBy is considired as a best pratice.",
335+
"options": null,
336+
"optionsDescription": "Not configurable.",
315337
"typescriptOnly": true
316338
},
317339
{

‎docs/rules/angular-whitespace/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
optionExamples:
2323
- '[true, "check-interpolation"]'
2424
typescriptOnly: true
25+
hasFix: true
2526
layout: rule
2627
title: 'Rule: angular-whitespace'
2728
optionsJSON: |-

‎docs/rules/banana-in-box/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
options: null
77
optionsDescription: Not configurable.
88
typescriptOnly: true
9+
hasFix: true
910
layout: rule
1011
title: 'Rule: banana-in-box'
1112
optionsJSON: 'null'
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
ruleName: no-output-named-after-standard-event
3+
type: maintainability
4+
description: Disallows naming directive outputs after a standard DOM event.
5+
rationale: Listeners subscribed to an output with such a name will also be invoked when the native event is raised.
6+
options: null
7+
optionsDescription: Not configurable.
8+
typescriptOnly: true
9+
layout: rule
10+
title: 'Rule: no-output-named-after-standard-event'
11+
optionsJSON: 'null'
12+
---

‎docs/rules/no-unused-css/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
options: null
66
optionsDescription: Not configurable.
77
typescriptOnly: true
8+
hasFix: true
89
layout: rule
910
title: 'Rule: no-unused-css'
1011
optionsJSON: 'null'

‎docs/rules/templates-no-negated-async/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
options: null
99
optionsDescription: Not configurable.
1010
typescriptOnly: true
11+
hasFix: true
1112
layout: rule
1213
title: 'Rule: templates-no-negated-async'
1314
optionsJSON: 'null'
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
ruleName: trackBy-function
3+
type: functionality
4+
description: Ensures a TrackBy function is used.
5+
rationale: Using TrackBy is considired as a best pratice.
6+
options: null
7+
optionsDescription: Not configurable.
8+
typescriptOnly: true
9+
layout: rule
10+
title: 'Rule: trackBy-function'
11+
optionsJSON: 'null'
12+
---

0 commit comments

Comments
 (0)