chemigram/Makefile at main · chipi/chemigram · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# Chemigram Makefile — convenience wrappers for common dev commands.
# Most targets just shell out to `uv run ...`; the value is discoverability
# and keeping commands consistent across contributors.
#
# Run `make` or `make help` to see all targets.

.PHONY: help setup hooks test test-unit test-integration test-e2e \
        lint format typecheck check ci clean build \
        docs-deps docs-serve docs-build docs-deploy docs-clean docs-cli

# Default target: print available commands
help:
	@echo "Chemigram development targets:"
	@echo ""
	@echo "  make setup           First-time setup after clone (calls scripts/setup.sh)"
	@echo "  make hooks           Install pre-commit hooks"
	@echo ""
	@echo "  make test            Fast unit tests (default test target)"
	@echo "  make test-unit       Unit tests only"
	@echo "  make test-integration  Integration tests (no darktable needed)"
	@echo "  make test-e2e        End-to-end tests (requires darktable)"
	@echo ""
	@echo "  make lint            Ruff lint check"
	@echo "  make format          Ruff format (rewrites files)"
	@echo "  make typecheck       Mypy type check on src/chemigram"
	@echo "  make check           lint + typecheck + unit (fast, run before commit)"
	@echo "  make ci              Full CI parity: same steps as .github/workflows/ci.yml"
	@echo ""
	@echo "  make build           Build sdist + wheel into dist/"
	@echo ""
	@echo "  make docs-deps       Install docs build dependencies (extra: docs)"
	@echo "  make docs-serve      Live-reload docs preview at http://127.0.0.1:8000"
	@echo "  make docs-build      Build static site into site/"
	@echo "  make docs-deploy     (Local) push site to gh-pages — CI does this on main"
	@echo "  make docs-cli        Regenerate docs/guides/cli-reference.md from --help"
	@echo ""
	@echo "  make clean           Remove caches and build artifacts"

setup:
	@./scripts/setup.sh

hooks:
	uv run pre-commit install
	uv run pre-commit install --hook-type pre-push

# --- tests ---

test: test-unit

test-unit:
	uv run pytest tests/unit

test-integration:
	uv run pytest tests/integration

test-e2e:
	uv run pytest tests/e2e

# --- code quality ---

lint:
	uv run ruff check

format:
	uv run ruff format

typecheck:
	uv run mypy src/chemigram

# Run before committing: catches what CI catches in the fast path.
check: lint typecheck test-unit
	@echo ""
	@echo "✅ All checks passed."

# Full CI parity. Mirrors .github/workflows/ci.yml step-for-step so a
# clean `make ci` locally implies a clean GitHub Actions run.
# Per ADR-040: unit + integration tests, no E2E (E2E gated to releases
# via scripts/pre-release-check.sh).
ci:
	@echo "==> [1/10] uv sync --all-extras --dev"
	uv sync --all-extras --dev
	@echo "==> [2/10] ruff check --no-fix"
	uv run ruff check --no-fix
	@echo "==> [3/10] ruff format --check"
	uv run ruff format --check
	@echo "==> [4/10] mypy src/chemigram"
	uv run mypy src/chemigram
	@echo "==> [5/10] pytest tests/unit"
	uv run pytest tests/unit
	@echo "==> [6/10] pytest tests/integration"
	uv run pytest tests/integration
	@echo "==> [7/10] audit-cli-imports.sh (CLI + MCP thin-wrapper discipline, ADR-071)"
	./scripts/audit-cli-imports.py
	@echo "==> [8/10] verify-prompts.sh"
	./scripts/verify-prompts.sh
	@echo "==> [9/10] verify-vocab.sh (all packs)"
	./scripts/verify-vocab.sh vocabulary/starter
	./scripts/verify-vocab.sh vocabulary/packs/expressive-baseline
	@echo "==> [10/10] cli-reference sync check (RFC-020)"
	uv run scripts/generate-cli-reference.py --check
	@echo ""
	@echo "✅ CI parity check passed (matches ADR-040 / ci.yml)."

# --- build / cleanup ---

build:
	uv build

# --- docs site (MkDocs + Material) ---

docs-deps:
	uv sync --extra docs

docs-serve: docs-deps
	uv run mkdocs serve

docs-build: docs-deps
	uv run mkdocs build --strict

# Local fallback for the deploy step. Normal flow: push to main and let
# .github/workflows/docs.yml run `mkdocs gh-deploy`. Use this only to
# debug deployment from a workstation.
docs-deploy: docs-deps
	uv run mkdocs gh-deploy --force

docs-clean:
	rm -rf site/

# Regenerate docs/guides/cli-reference.md from `chemigram --help`.
# CI runs the same script with `--check` and fails on drift.
docs-cli:
	uv run scripts/generate-cli-reference.py

clean:
	rm -rf dist/ build/ *.egg-info src/*.egg-info
	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
	find . -type d -name .pytest_cache -exec rm -rf {} + 2>/dev/null || true
	find . -type d -name .ruff_cache -exec rm -rf {} + 2>/dev/null || true
	find . -type d -name .mypy_cache -exec rm -rf {} + 2>/dev/null || true
	@echo "✓ Cleaned caches and build artifacts"