Skip to content

Commit

Permalink
Update README with further installation instructions and available rules
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit88 committed Mar 28, 2024
1 parent 268ca10 commit 58d6726
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions packages/eslint-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,28 @@ Then configure the rules you want to use under the rules section.
```json
{
"rules": {
"opticks/rule-name": 2
"opticks/toggle": "warn",
}
}
```

## Rules

<!-- begin auto-generated rules list -->
TODO: Run eslint-doc-generator to generate the rules list.
<!-- end auto-generated rules list -->
For the opticks rules to work, you also need to add your `experiments` configuration settings section.

```json
{
"settings": {
"opticks": {
"experiments": {
"foo": "a",
"bar": null,
"baz": "b"
}
}
}
}
```

## Rules

* `opticks/toggle`: Detects stale code from expired Opticks experiments, and other common mistakes

0 comments on commit 58d6726

Please sign in to comment.