From 1fe9d22a8ef6426899cd1759053d31004658aef8 Mon Sep 17 00:00:00 2001 From: Minko Gechev Date: Wed, 24 Jan 2018 09:59:42 -0800 Subject: [PATCH] docs: add missing documentation (#502) * docs: add missing rules * docs: add missing documentation Fix #501 --- README.md | 3 ++ docs/_data/rules.json | 28 +++++++++++++++++-- docs/rules/angular-whitespace/index.html | 1 + docs/rules/banana-in-box/index.html | 1 + .../index.html | 12 ++++++++ docs/rules/no-unused-css/index.html | 1 + .../templates-no-negated-async/index.html | 1 + docs/rules/trackBy-function/index.html | 12 ++++++++ 8 files changed, 56 insertions(+), 3 deletions(-) create mode 100644 docs/rules/no-output-named-after-standard-event/index.html create mode 100644 docs/rules/trackBy-function/index.html diff --git a/README.md b/README.md index 422ecd232..f243a9a85 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/_data/rules.json b/docs/_data/rules.json index 336e9bb6e..84c81c04b 100644 --- a/docs/_data/rules.json +++ b/docs/_data/rules.json @@ -21,7 +21,8 @@ "optionExamples": [ "[true, \"check-interpolation\"]" ], - "typescriptOnly": true + "typescriptOnly": true, + "hasFix": true }, { "ruleName": "banana-in-box", @@ -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", @@ -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", @@ -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", @@ -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 }, { diff --git a/docs/rules/angular-whitespace/index.html b/docs/rules/angular-whitespace/index.html index 08df35262..7cd42e0f1 100644 --- a/docs/rules/angular-whitespace/index.html +++ b/docs/rules/angular-whitespace/index.html @@ -22,6 +22,7 @@ optionExamples: - '[true, "check-interpolation"]' typescriptOnly: true +hasFix: true layout: rule title: 'Rule: angular-whitespace' optionsJSON: |- diff --git a/docs/rules/banana-in-box/index.html b/docs/rules/banana-in-box/index.html index 6ed77952c..2fdb07430 100644 --- a/docs/rules/banana-in-box/index.html +++ b/docs/rules/banana-in-box/index.html @@ -6,6 +6,7 @@ options: null optionsDescription: Not configurable. typescriptOnly: true +hasFix: true layout: rule title: 'Rule: banana-in-box' optionsJSON: 'null' diff --git a/docs/rules/no-output-named-after-standard-event/index.html b/docs/rules/no-output-named-after-standard-event/index.html new file mode 100644 index 000000000..f7fdea770 --- /dev/null +++ b/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' +--- \ No newline at end of file diff --git a/docs/rules/no-unused-css/index.html b/docs/rules/no-unused-css/index.html index a5069a1c9..565e7245d 100644 --- a/docs/rules/no-unused-css/index.html +++ b/docs/rules/no-unused-css/index.html @@ -5,6 +5,7 @@ options: null optionsDescription: Not configurable. typescriptOnly: true +hasFix: true layout: rule title: 'Rule: no-unused-css' optionsJSON: 'null' diff --git a/docs/rules/templates-no-negated-async/index.html b/docs/rules/templates-no-negated-async/index.html index 564c433d1..f13a46cfa 100644 --- a/docs/rules/templates-no-negated-async/index.html +++ b/docs/rules/templates-no-negated-async/index.html @@ -8,6 +8,7 @@ options: null optionsDescription: Not configurable. typescriptOnly: true +hasFix: true layout: rule title: 'Rule: templates-no-negated-async' optionsJSON: 'null' diff --git a/docs/rules/trackBy-function/index.html b/docs/rules/trackBy-function/index.html new file mode 100644 index 000000000..1df9eaef3 --- /dev/null +++ b/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' +--- \ No newline at end of file