-
Notifications
You must be signed in to change notification settings - Fork 0
feat: CLAUDE.md with instruction on updating rule count assertion #34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # CLAUDE.md | ||
|
|
||
| ## Project | ||
|
|
||
| laint is an AI Agent Lint Rules SDK — a programmatic API for linting JSX/TSX code, designed to integrate with Claude Code via PostToolUse hooks. | ||
|
|
||
| ## Commands | ||
|
|
||
| - `npm run build` — compile TypeScript + fix ESM imports | ||
| - `npm test` — run vitest | ||
| - `npm run lint` — eslint + prettier check | ||
| - `npm run lint:fix` — auto-fix lint + formatting | ||
| - `npm run knip` — dead code detection | ||
|
|
||
| ## Architecture | ||
|
|
||
| - `src/parser.ts` — Babel parser wrapper (JSX + TypeScript) | ||
| - `src/index.ts` — main API: `lintJsxCode()`, `getAllRuleNames()` | ||
| - `src/rules/` — individual lint rules, each a `RuleFunction(ast, code) => LintResult[]` | ||
| - `src/types.ts` — type definitions (`RuleFunction`, `LintResult`, etc.) | ||
| - `src/rules/index.ts` — rule registry (maps rule names to functions) | ||
| - `src/cli.ts` — CLI entry point (`laint init`, `laint check`) | ||
| - `src/cli/check.ts` — file mode and hook mode linting | ||
| - `src/cli/init.ts` — sets up `.claude/settings.json` PostToolUse hook | ||
|
|
||
| ## Adding a new rule | ||
|
|
||
| 1. Create `src/rules/my-rule.ts` exporting a `RuleFunction` | ||
| 2. Register it in `src/rules/index.ts` | ||
| 3. Create `tests/my-rule.test.ts` | ||
| 4. **Update the rule count assertion in `tests/config-modes.test.ts`** — the `getAllRuleNames` test has `expect(ruleNames.length).toBe(...)` that must match the total number of registered rules | ||
| 5. **Document the rule in `README.md`** — CI checks that every registered rule name appears in the README | ||
| 6. Run `npm test` to verify | ||
|
|
||
| ## Code style | ||
arnavsurve marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - Strict TypeScript, ESM modules | ||
| - Prettier: 2 spaces, 100 char width, trailing commas, single quotes | ||
| - No unnecessary type assertions — use Babel's type system directly | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.