Skip to content

Commit 34e889e

Browse files
Merge docs: add AGENTS.md
docs: add AGENTS.md
2 parents 1d25cb8 + 56e8d90 commit 34e889e

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# deadcode
2+
3+
## Purpose
4+
Detect and remove unused exports, dead routes, orphaned CSS, and unreferenced components in TypeScript/React/Next.js projects.
5+
6+
## Build & Test Commands
7+
- Install: `pip install -e .` or `pip install deadcode-cli`
8+
- Test: `pytest tests/` (or `python -m pytest tests/ -v --tb=short`)
9+
- Lint: `ruff check .`
10+
- Build: `pip install build twine && python -m build && twine check dist/*`
11+
- CLI check: `deadcode --help`
12+
13+
## Architecture
14+
Key directories:
15+
- `src/deadcode/` — Main package (CLI, analyzers for TS/JS/CSS/React/Next.js)
16+
- `tests/` — Test suite
17+
- `.github/workflows/` — CI/CD (ci.yml, pages.yml, publish.yml)
18+
- `dist/` — Built distributions
19+
20+
## Conventions
21+
- Language: Python 3.10+ (with Node.js for TS analysis)
22+
- Test framework: pytest
23+
- CI: GitHub Actions (ci.yml, pages.yml, publish.yml)
24+
- Linting: ruff
25+
- Build system: setuptools
26+
- Package layout: src/ layout
27+
- Dependencies: click, rich, tree-sitter, tree-sitter-typescript, esprima
28+
- CLI entry point: deadcode.cli:cli
29+
- Default branch: main

0 commit comments

Comments
 (0)