Skip to content

Commit 5eec464

Browse files
committed
ci: enhance Makefile with help command and update README for usage instructions
1 parent bc1bca9 commit 5eec464

2 files changed

Lines changed: 20 additions & 2 deletions

File tree

Makefile

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
.PHONY: setup lint test coverage
1+
.PHONY: setup lint test coverage help
2+
3+
.DEFAULT_GOAL := help
4+
5+
help: ## Show this help message
6+
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
7+
awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-15s\033[0m %s\n", $$1, $$2}'
28

39
setup: ## Install dev dependencies and git hooks
410
uv sync --dev

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,9 +150,21 @@ To install all packages, including all development requirements:
150150

151151
```bash
152152
npm install
153-
uv sync --dev
153+
make setup
154154
```
155155

156+
### Makefile Targets
157+
158+
A `Makefile` is provided for common development tasks. Run `make help` to
159+
see all available targets:
160+
161+
| Command | Description |
162+
|-----------------|--------------------------------------|
163+
| `make setup` | Install dev dependencies & git hooks |
164+
| `make lint` | Run all pre-commit hooks |
165+
| `make test` | Run tests |
166+
| `make coverage` | Run tests with coverage report |
167+
156168
As this repository uses [prek][prek] (a faster, Rust-based drop-in replacement
157169
for pre-commit), all changes are linted and tested with each commit. You can
158170
run all checks and tests manually, using the following command:

0 commit comments

Comments
 (0)