Skip to content

Commit

Permalink
docs: update readme and changelog (#795)
Browse files Browse the repository at this point in the history
* docs(changelog): group template accessibility rules

* docs(readme): add missing rules
  • Loading branch information
rafaelss95 authored and mgechev committed Mar 19, 2019
1 parent 951aa09 commit 201d6ee
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
14 changes: 7 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,18 @@ This release contains many breaking changes due to the rename of several rules (
### Features

- **rule:** add component-change-detection ([#737](https://github.com/mgechev/codelyzer/issues/737)) ([a23ccde](https://github.com/mgechev/codelyzer/commit/a23ccde)), closes [#135](https://github.com/mgechev/codelyzer/issues/135)
- **rule:** add template-accessibility-alt-text ([#741](https://github.com/mgechev/codelyzer/issues/741)) ([0815ec5](https://github.com/mgechev/codelyzer/commit/0815ec5))
- **rule:** add relative-url-prefix ([#725](https://github.com/mgechev/codelyzer/issues/725)) ([f12f27b](https://github.com/mgechev/codelyzer/commit/f12f27b))
- **rule:** add template-accessibility-alt-text ([#741](https://github.com/mgechev/codelyzer/issues/741)) ([0815ec5](https://github.com/mgechev/codelyzer/commit/0815ec5))
- **rule:** add template-accessibility-elements-content ([#742](https://github.com/mgechev/codelyzer/issues/742)) ([6ff8c56](https://github.com/mgechev/codelyzer/commit/6ff8c56))
- **rule:** add template-no-autofocus ([#749](https://github.com/mgechev/codelyzer/issues/749)) ([799382f](https://github.com/mgechev/codelyzer/commit/799382f))
- **rule:** add template-click-events-have-key-events ([#761](https://github.com/mgechev/codelyzer/issues/761)) ([b0b330f](https://github.com/mgechev/codelyzer/commit/b0b330f))
- **rule:** add template-accessibility-label-for ([#739](https://github.com/mgechev/codelyzer/issues/739)) ([76c24fa](https://github.com/mgechev/codelyzer/commit/76c24fa))
- **rule:** add template-mouse-events-have-key-events ([#759](https://github.com/mgechev/codelyzer/issues/759)) ([3a7b15d](https://github.com/mgechev/codelyzer/commit/3a7b15d))
- **rule:** add template-no-distracting-elements ([#760](https://github.com/mgechev/codelyzer/issues/760)) ([6b21a9e](https://github.com/mgechev/codelyzer/commit/6b21a9e))
- **rule:** add template-accessibility-table-scope ([#743](https://github.com/mgechev/codelyzer/issues/743)) ([2832615](https://github.com/mgechev/codelyzer/commit/2832615))
- **rule:** add template-no-any rule ([#755](https://github.com/mgechev/codelyzer/issues/755)) ([77a5e32](https://github.com/mgechev/codelyzer/commit/77a5e32))
- **rule:** add template-accessibility-tabindex-no-positive ([#744](https://github.com/mgechev/codelyzer/issues/744)) ([43902f7](https://github.com/mgechev/codelyzer/commit/43902f7))
- **rule:** add template-accessibility-table-scope ([#743](https://github.com/mgechev/codelyzer/issues/743)) ([2832615](https://github.com/mgechev/codelyzer/commit/2832615))
- **rule:** add template-accessibility-valid-aria ([#746](https://github.com/mgechev/codelyzer/issues/746)) ([762f67f](https://github.com/mgechev/codelyzer/commit/762f67f))
- **rule:** add template-click-events-have-key-events ([#761](https://github.com/mgechev/codelyzer/issues/761)) ([b0b330f](https://github.com/mgechev/codelyzer/commit/b0b330f))
- **rule:** add template-mouse-events-have-key-events ([#759](https://github.com/mgechev/codelyzer/issues/759)) ([3a7b15d](https://github.com/mgechev/codelyzer/commit/3a7b15d))
- **rule:** add template-no-autofocus ([#749](https://github.com/mgechev/codelyzer/issues/749)) ([799382f](https://github.com/mgechev/codelyzer/commit/799382f))
- **rule:** add template-no-distracting-elements ([#760](https://github.com/mgechev/codelyzer/issues/760)) ([6b21a9e](https://github.com/mgechev/codelyzer/commit/6b21a9e))
- **rule:** add template-no-any ([#755](https://github.com/mgechev/codelyzer/issues/755)) ([77a5e32](https://github.com/mgechev/codelyzer/commit/77a5e32))

<a name="4.5.0"></a>

Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,8 +255,8 @@ Below you can find a recommended configuration which is based on the [Angular St

```js
{
// The rule have the following arguments:
// [ENABLED, "attribute" | "element", "selectorPrefix" | ["listOfPrefixes"], "camelCase" | "kebab-case"]
// The rules component-selector and directive-selector have the following arguments:
// [ENABLED, "attribute" | "element", "prefix" | ["listOfPrefixes"], "camelCase" | "kebab-case"]
"component-selector": [true, "element", ["cmp-prefix1", "cmp-prefix2"], "kebab-case"],
"directive-selector": [true, "attribute", ["dir-prefix1", "dir-prefix2"], "camelCase"],

Expand All @@ -270,8 +270,10 @@ Below you can find a recommended configuration which is based on the [Angular St
"no-queries-metadata-property": true,
"prefer-inline-decorator": true,
"use-lifecycle-interface": true,
// [ENABLED, "Suffix" | ["listOfSuffixes"]]
// Where "Suffix" is/are your custom(s) suffix(s), for instance "Page" for Ionic components.

// The rules component-class-suffix and directive-class-suffix have the following arguments:
// [ENABLED, "suffix" | ["listOfSuffixes"]]
// Where "suffix" is/are your custom(s) suffix(es), for instance "Page" for Ionic components.
"component-class-suffix": [true, "Component"],
"directive-class-suffix": [true, "Directive"]
}
Expand Down Expand Up @@ -314,12 +316,13 @@ Below you can find a recommended configuration which is based on the [Angular St
| `use-lifecycle-interface` | Stable |
| `use-pipe-decorator` | Stable |
| `use-pipe-transform-interface` | Stable |
| `component-change-detection` | _Experimental_ |
| `no-conflicting-lifecycle` | _Experimental_ |
| `no-unused-css` | _Experimental_ |
| `pipe-prefix` | _Experimental_ |
| `relative-url-prefix` | _Experimental_ |
| `template-accessibility-alt-text` | _Experimental_ |
| `template-accessibility-element-content` | _Experimental_ |
| `template-accessibility-elements-content` | _Experimental_ |
| `template-accessibility-label-for` | _Experimental_ |
| `template-accessibility-tabindex-no-positive` | _Experimental_ |
| `template-accessibility-table-scope` | _Experimental_ |
Expand Down

0 comments on commit 201d6ee

Please sign in to comment.