chore: add AGENTS.md (#345)

Author: hardfist

AGENTS.md

@@ -0,0 +1,51 @@
+# Repository Guidelines
+
+This document summarizes how to work on rslint effectively and consistently.
+
+## Project Structure & Module Organization
+
+- `cmd/rslint/`: CLI entry (default), IPC API (`--api`), LSP (`--lsp`).
+- `internal/config/`: Config types/loader, rule registry and registration.
+- `internal/linter/`: Linter engine, traversal, and fix application.
+- `internal/rule/`: Rule framework, diagnostics, disable manager, listeners.
+- `internal/plugins/typescript/`: `@typescript-eslint` rules under `rules/<rule>/`.
+- `internal/plugins/import/`: `eslint-plugin-import` registration.
+- `internal/utils/`: JSONC, overlay VFS, TS program creation, helpers.
+- `internal/lsp/`: Language Server integration. Also see `website/` and `packages/` for UI/tooling.
+
+## Build, Test, and Development Commands
+
+- Build JS/TS: `pnpm build`
+- Run Go tests: `pnpm run test:go`
+- Run JS tests: `pnpm run test`
+- Run Check Spell: `pnpm run check-spell`
+- Lint Go: `pnpm run lint:go` | Format JS/TS/MD: `pnpm run format`
+- CLI: `go run ./cmd/rslint --help`
+  - Examples: `go run ./cmd/rslint --config rslint.jsonc`, `--fix`, `--format default|jsonline|github`, `--quiet`, `--max-warnings 0`
+- LSP: `go run ./cmd/rslint --lsp` | IPC API: `go run ./cmd/rslint --api`
+
+## Coding Style & Naming Conventions
+
+- Go uses gofmt/goimports; keep functions focused and small.
+- TS/JS/MD/CSS use Prettier via `pnpm run format`.
+- Rules: `internal/plugins/typescript/rules/<rule>/`; tests: `<rule>_test.go`.
+- Prefer table-driven tests and existing helpers in `internal/utils`.
+
+## Testing Guidelines
+
+- Co-locate Go tests with implementation; name files `*_test.go` and functions `TestXxx`.
+- Keep tests minimal and behavior-focused; avoid unrelated scenarios.
+- Run `pnpm run test:go` (Go) and `pnpm run test` (JS) before submitting.
+
+## Commit & Pull Request Guidelines
+
+- Use Conventional Commits: `feat:`, `fix:`, `chore:`, `docs:`, `ci:`, etc.
+- PRs should be small, with clear description, repro steps, and linked issues.
+- Include examples (commands or code) and update docs when behavior changes.
+- Preserve existing CLI behavior unless a change is explicitly requested.
+
+## Architecture & Configuration Tips
+
+- rslint loads `rslint.json`/`rslint.jsonc`; rules accept ESLint-style levels/options.
+- The linter walks each file once and dispatches to registered listeners; `--singleThreaded` disables parallelism.
+- Use `--format github` in CI to emit GitHub workflow annotations.

scripts/dictionary.txt

@@ -132,4 +132,15 @@ nsec
 walltime
 Ptrs
 getsp
-libsyncrpc
+libsyncrpc
+gofmt
+goimports
+jsonc
+GitHub
+github
+LSP
+IPC
+Prettier
+ESLint
+colocate
+co-locate