Skip to content

Commit

Permalink
docs: update readme with new rules
Browse files Browse the repository at this point in the history
  • Loading branch information
d0whc3r committed Sep 15, 2019
1 parent d062bb2 commit 602d381
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ This rule catches Stencil public methods that are not async.

This rule catches Stencil Component banned tag name prefix.

- [`@d0whc3r/stencil/class-suffix`](./docs/class-suffix.md)

This rule catches Stencil Component suffix for class name.

- [`@d0whc3r/stencil/decorators-context`](./docs/decorators-context.md)

This rule catches Stencil decorators in bad locations.
Expand Down Expand Up @@ -67,6 +71,10 @@ This rule catches Stencil Props marked as non readonly, excluding mutable ones.

This rule catches Stencil Render returning array instead of Host tag.

- [`@d0whc3r/stencil/required-jsdoc`](./docs/required-jsdoc.md)

This rule catches Stencil Props, Methods and Events to define jsdoc.

- [`@d0whc3r/stencil/required-prefix`](./docs/required-prefix.md)

This rule catches Stencil Component required tag name prefix.
Expand All @@ -84,7 +92,8 @@ This rule catches modules that expose more than just the Stencil Component itsel
```json
{
"@d0whc3r/stencil/async-methods": "error",
"@d0whc3r/stencil/ban-prefix": "error",
"@d0whc3r/stencil/ban-prefix": ["error", ["stencil", "stnl", "st"]],
"@d0whc3r/stencil/class-suffix": "error",
"@d0whc3r/stencil/decorators-context": "error",
"@d0whc3r/stencil/decorators-style": [
"error", {
Expand All @@ -102,6 +111,7 @@ This rule catches modules that expose more than just the Stencil Component itsel
"@d0whc3r/stencil/props-must-be-public": "error",
"@d0whc3r/stencil/props-must-be-readonly": "error",
"@d0whc3r/stencil/render-returns-host": "error",
"@d0whc3r/stencil/required-jsdoc": "error",
"@d0whc3r/stencil/reserved-member-names": "error",
"@d0whc3r/stencil/single-export": "error"
}
Expand Down

0 comments on commit 602d381

Please sign in to comment.