Skip to content

Commit db22e3c

Browse files
committed
Added troubleshooting section to docs/reactivity.md
1 parent 62aacbd commit db22e3c

File tree

3 files changed

+197
-57
lines changed

3 files changed

+197
-57
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,10 @@ options you can set.
100100
}
101101
```
102102

103-
### Disabling Rules
103+
### Troubleshooting
104104

105-
The rules in this plugin provide sensible guidelines, but there may be occasions where you _know
106-
what you're doing_ and want to ignore a warning. Just [add a
105+
The rules in this plugin provide sensible guidelines as well as possible, but there may be times
106+
where the you better than the rule and want to ignore a warning. Just [add a
107107
comment](https://eslint.org/docs/latest/user-guide/configuring/rules#disabling-rules) like the
108108
following:
109109

@@ -112,6 +112,10 @@ following:
112112
const [editedValue, setEditedValue] = createSignal(props.value);
113113
```
114114

115+
_However_, there may also be times where a rule correctly warns about a subtle problem,
116+
even if it looks like a false positive at first. With `solid/reactivity`, please look at the
117+
[docs](./docs/reactivity.md#troubleshooting) before deciding to disable the rule.
118+
115119
## Rules
116120

117121
✔: Enabled in the `recommended` configuration.
@@ -138,7 +142,7 @@ const [editedValue, setEditedValue] = createSignal(props.value);
138142
| | 🔧 | [solid/prefer-classlist](docs/prefer-classlist.md) | Enforce using the classlist prop over importing a classnames helper. The classlist prop accepts an object `{ [class: string]: boolean }` just like classnames. |
139143
|| 🔧 | [solid/prefer-for](docs/prefer-for.md) | Enforce using Solid's `<For />` component for mapping an array to JSX elements. |
140144
| | 🔧 | [solid/prefer-show](docs/prefer-show.md) | Enforce using Solid's `<Show />` component for conditionally showing content. Solid's compiler covers this case, so it's a stylistic rule only. |
141-
|| | [solid/reactivity](docs/reactivity.md) | Enforce that reactive expressions (props, signals, memos, etc.) are only used in tracked scopes; otherwise, they won't update the view as expected. |
145+
|| | [solid/reactivity](docs/reactivity.md) | Enforce that reactivity (props, signals, memos, etc.) is properly used, so changes in those values will be tracked and update the view as expected. |
142146
|| 🔧 | [solid/self-closing-comp](docs/self-closing-comp.md) | Disallow extra closing tags for components without children. |
143147
|| 🔧 | [solid/style-prop](docs/style-prop.md) | Require CSS properties in the `style` prop to be valid and kebab-cased (ex. 'font-size'), not camel-cased (ex. 'fontSize') like in React, and that property values with dimensions are strings, not numbers with implicit 'px' units. |
144148
<!-- AUTO-GENERATED-CONTENT:END -->

0 commit comments

Comments
 (0)