Skip to content

Commit 5ff55de

Browse files
docs(docs): updated documentation for rule
updated documentation for ensure-matching-remove-event-listener rule
1 parent 9173842 commit 5ff55de

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,7 @@ module.exports = [
294294
| [destructuring-assignment](docs/rules/destructuring-assignment.md) | Enforce consistent usage of destructuring assignment of props, state, and context | | 🔧 | | |
295295
| [display-name](docs/rules/display-name.md) | Disallow missing displayName in a React component definition | 💼 | | | |
296296
| [forbid-component-props](docs/rules/forbid-component-props.md) | Disallow certain props on components | | | | |
297+
| [ensure-matching-remove-event-listener](docs/rules/ensure-matching-remove-event-listener.md) | Enforces that every addEventListener has a matching removeEventListener in the return statement of the same useEffect block | | | | |
297298
| [forbid-dom-props](docs/rules/forbid-dom-props.md) | Disallow certain props on DOM Nodes | | | | |
298299
| [forbid-elements](docs/rules/forbid-elements.md) | Disallow certain elements | | | | |
299300
| [forbid-foreign-prop-types](docs/rules/forbid-foreign-prop-types.md) | Disallow using another component's propTypes | | | | |

docs/rules/ensure-matching-remove-event-listener.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Enforces that every addEventListener should have a matching removeEventListener in the return statement of the same useEffect block (ensure-matching-remove-event-listener)
1+
# Enforces that every addEventListener has a matching removeEventListener in the return statement of the same useEffect block (`react/ensure-matching-remove-event-listener`)
2+
3+
<!-- end auto-generated rule header -->
24

35
💼 This rule is enabled in the following [configs](https://github.com/jsx-eslint/eslint-plugin-react#shareable-configurations): `all`.
46

0 commit comments

Comments
 (0)