Skip to content

Commit 367c3ab

Browse files
authored
build: Migrate from Makefile to justfile (#333)
## Summary - Replace Makefile with justfile for task running - Update documentation to reference just commands ## Changes - Add root justfile with all project tasks - Add docs/justfile for documentation tasks - Remove Makefile and docs/Makefile - Update AGENTS.md/CLAUDE.md with just commands
2 parents cb7f2bf + 6f43a96 commit 367c3ab

6 files changed

Lines changed: 352 additions & 262 deletions

File tree

AGENTS.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,28 +42,28 @@ uv pip install --editable . -G dev
4242

4343
### Tests
4444
```bash
45-
make test # or: uv run pytest
45+
just test # or: uv run pytest
4646
uv run pytest tests/test_cli.py # single file
4747
uv run pytest tests/test_cli.py::test_info_command # single test
4848

49-
make start # run tests then watch with pytest-watcher
49+
just start # run tests then watch with pytest-watcher
5050
uv run ptw . # standalone watcher (doctests enabled by default)
5151
```
5252

5353
### Linting & Types
5454
```bash
55-
make ruff # uv run ruff check .
56-
make ruff_format # uv run ruff format .
55+
just ruff # uv run ruff check .
56+
just ruff-format # uv run ruff format .
5757
uv run ruff check . --fix --show-fixes
5858

59-
make mypy # strict type checking
59+
just mypy # strict type checking
6060
```
6161

6262
### Documentation
6363
```bash
64-
make build_docs # build Sphinx HTML in docs/_build
65-
make start_docs # autobuild + livereload
66-
make design_docs # update CSS/JS assets
64+
just build-docs # build Sphinx HTML in docs/_build
65+
just start-docs # autobuild + livereload
66+
just design-docs # update CSS/JS assets
6767
```
6868

6969
### Workflow (recommended)
@@ -82,7 +82,7 @@ make design_docs # update CSS/JS assets
8282
## Testing Strategy
8383
- Pytest with doctests enabled (`addopts` in `pyproject.toml`).
8484
- Prefer real `cihai` / `unihan_etl` integration over heavy mocking; reuse fixtures where present.
85-
- Watch mode: `uv run ptw .` (used in `make start`).
85+
- Watch mode: `uv run ptw .` (used in `just start`).
8686
- Coverage via `pytest-cov`; configuration in `pyproject.toml`.
8787
- Prefer fixtures over mocks (`server`, `session`, etc. when available); use `tmp_path` over `tempfile`, `monkeypatch` over `unittest.mock`.
8888

CHANGES

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,13 @@ $ uvx --from 'cihai-cli' --prerelease allow cihai
3434

3535
- _Changes for the upcoming release go here._
3636

37+
### Development
38+
39+
#### Makefile -> Justfile (#333)
40+
41+
- Migrate from `Makefile` to `justfile` for running development tasks
42+
- Update documentation to reference `just` commands
43+
3744
### Documentation
3845

3946
- Migrate docs deployment to AWS OIDC authentication and AWS CLI

Makefile

Lines changed: 0 additions & 64 deletions
This file was deleted.

docs/Makefile

Lines changed: 0 additions & 189 deletions
This file was deleted.

0 commit comments

Comments
 (0)