|
1 | 1 | # deadcode |
2 | 2 |
|
3 | | -Repo guide for agents. |
| 3 | +## Purpose |
| 4 | +CLI tool to detect and auto-remove unused exports, dead routes, and orphaned CSS in TypeScript/React/Next.js projects. |
4 | 5 |
|
5 | | -## Workflow |
6 | | -- Use `pytest` for tests. |
7 | | -- Use `ruff` for lint/format. |
8 | | -- Build/publish via GitHub Actions in `.github/workflows/`. |
| 6 | +## Build & Test Commands |
| 7 | +- Install: `pip install -e .` or `pip install git+https://github.com/Coding-Dev-Tools/deadcode.git` |
| 8 | +- Test: `pytest tests/` (or `python -m pytest tests/ -v --tb=short`) |
| 9 | +- Lint: `ruff check src/ tests/` |
| 10 | +- Format: `ruff format src/ tests/` |
| 11 | +- Build: `pip install build twine && python -m build && twine check dist/*` |
| 12 | +- CLI check: `deadcode --help` |
| 13 | + |
| 14 | +## Architecture |
| 15 | +Key directories: |
| 16 | +- `src/deadcode/` — Main package (CLI, scanner, config) |
| 17 | +- `tests/` — Test suite |
| 18 | +- `.github/workflows/` — CI/CD (auto-code-review.yml, ci.yml, publish.yml) |
9 | 19 |
|
10 | 20 | ## Conventions |
11 | | -- Package code under `src/deadcode` per `pyproject.toml` packaging config. |
12 | | -- Keep branches `improve/<repo>-<timestamp>` for structural fixes. |
13 | | -- Do not modify dependencies without updating `pyproject.toml`. |
| 21 | +- Language: Python 3.10+ |
| 22 | +- Test framework: pytest (with coverage) |
| 23 | +- CI: GitHub Actions (matrix: Python 3.10, 3.11, 3.12, 3.13) |
| 24 | +- Linting/formatting: ruff (line-length 120, target py310) |
| 25 | +- Package layout: src/ layout with setuptools |
| 26 | +- Type checking: py.typed included |
| 27 | +- Dependencies: click, rich, pathspec, pyyaml |
| 28 | +- CLI entry point: deadcode.cli:cli |
| 29 | +- Default branch: master |
| 30 | +- Branch naming: `improve/<repo>-<timestamp>` for structural fixes |
0 commit comments