Skip to content

Commit

Permalink
docs: breakdown addition
Browse files Browse the repository at this point in the history
  • Loading branch information
barelyhuman authored Dec 16, 2024
1 parent 8e3a537 commit a21e508
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Add `valtio` to the `extends` section of your `.eslintrc` configuration file.
}
```

## Rules

Alternatively, you can enable rules in the plugin, selectively.

```json
Expand All @@ -57,6 +59,9 @@ Alternatively, you can enable rules in the plugin, selectively.

This plugin helps you catch common mistakes that can occur in [valtio](https://github.com/pmndrs/valtio). Here are some cases that this plugin catches.


## Rules Breakdown

### Snapshots in callbacks are not recommended

We shouldn't use snapshots in callbacks, because snapshots can be stale there.
Expand Down

0 comments on commit a21e508

Please sign in to comment.