Skip to content

Commit 48e1323

Browse files
docs(eslint-plugin): add rule table to package README
The npm README had no rule listing. Add the four rules with defaults and descriptions so users see them without visiting the monorepo root. Co-authored-by: Andrew <andrewxhill@gmail.com>
1 parent 1ef4695 commit 48e1323

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

packages/eslint-plugin/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@ import codecontext from "@recallnet/codecontext-eslint-plugin";
1616
export default [codecontext.configs.recommended];
1717
```
1818

19+
## Rules
20+
21+
| Rule | Default | Description |
22+
| ----------------------------- | ------- | --------------------------------------------------------------- |
23+
| `context-hierarchy` | error | Type/subtype combinations must be valid |
24+
| `valid-context-refs` | error | Local `{@link file:...}` targets must resolve to existing files |
25+
| `require-context-for-complex` | warn | Complex functions (cyclomatic > 5) should have `@context` |
26+
| `no-stale-context` | error | Verification dates too old, or code changed without date bump |
27+
1928
## Docs
2029

2130
- Repo: https://github.com/recallnet/codecontext

0 commit comments

Comments
 (0)