From 66982b7adeed0893b640571ad130364e8aa63abf Mon Sep 17 00:00:00 2001 From: d0whc3r Date: Thu, 26 Sep 2019 16:53:01 +0200 Subject: [PATCH] feat(props-must-be-readonly): disable rule to avoid issues --- README.md | 4 +++- src/configs/recommended.ts | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 393e9e8..00541a1 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,8 @@ This rule catches Stencil Props marked as private or protected. - [`@d0whc3r/stencil/props-must-be-readonly`](./docs/props-must-be-readonly.md) +> This rule is recommended to be "off" because it will trigger a bad autogenerated `components.d.ts` [more details here](https://github.com/ionic-team/stencil/issues/1896) + This rule catches Stencil Props marked as non readonly, excluding mutable ones. - [`@d0whc3r/stencil/render-returns-host`](./docs/render-returns-host.md) @@ -137,7 +139,7 @@ This rule catches Stencil Prop marked as mutable but not changing value in code. "@d0whc3r/stencil/own-props-must-be-private": "error", "@d0whc3r/stencil/prefer-vdom-listener": "error", "@d0whc3r/stencil/props-must-be-public": "error", - "@d0whc3r/stencil/props-must-be-readonly": "error", + "@d0whc3r/stencil/props-must-be-readonly": "off", "@d0whc3r/stencil/render-returns-host": "error", "@d0whc3r/stencil/required-jsdoc": "error", "@d0whc3r/stencil/reserved-member-names": "error", diff --git a/src/configs/recommended.ts b/src/configs/recommended.ts index 2ea06b0..e0ae51a 100644 --- a/src/configs/recommended.ts +++ b/src/configs/recommended.ts @@ -52,7 +52,7 @@ export default { '@d0whc3r/stencil/own-props-must-be-private': 'error', '@d0whc3r/stencil/prefer-vdom-listener': 'error', '@d0whc3r/stencil/props-must-be-public': 'error', - '@d0whc3r/stencil/props-must-be-readonly': 'error', + '@d0whc3r/stencil/props-must-be-readonly': 'off', '@d0whc3r/stencil/render-returns-host': 'error', '@d0whc3r/stencil/required-jsdoc': 'error', '@d0whc3r/stencil/reserved-member-names': 'error',