mind-cli 0.34.0

# Common developer tasks. Run `make help` for the list.

.PHONY: help build build-release fmt fmt-check clippy test audit check ci ci-local clean docs docs-build

# There is no release target: merging a version bump to main is the release
# (.github/workflows/release.yml tags and publishes it).

help:
	@echo "targets:"
	@echo "  build      cargo build"
	@echo "  build-release  release binary with an embedded SBOM (cargo auditable)"
	@echo "  fmt        cargo fmt"
	@echo "  fmt-check  cargo fmt --check"
	@echo "  clippy     cargo clippy (all targets + features, warnings as errors)"
	@echo "  test       cargo test (all features)"
	@echo "  audit      cargo audit (RustSec advisories; skipped if not installed or SKIP_AUDIT=1)"
	@echo "  check      local gate: fmt (fix) + clippy + test + audit"
	@echo "  ci         CI gate: fmt-check + clippy + test + audit"
	@echo "  ci-local   like ci but formats in place (fmt) instead of fmt-check"
	@echo "  docs       build the docs site and serve it locally with live reload"
	@echo "  docs-build build the docs site to docs/book"
	@echo "  clean      cargo clean"

build:
	cargo build

# The same build the release workflow ships (.github/workflows/release.yml):
# `cargo auditable` embeds a dependency SBOM in the binary, so `cargo audit bin
# <path>` can scan an already-built artifact without its source or lockfile.
# Keep this in step with the workflow's build step.
build-release:
	@command -v cargo-auditable >/dev/null || { echo "error: cargo-auditable not found; install the version release.yml pins: cargo install cargo-auditable --version 0.7.5 --locked"; exit 1; }
	cargo auditable build --release --locked --bin mind

fmt:
	cargo fmt

fmt-check:
	cargo fmt --check

clippy:
	cargo clippy --all-targets --all-features -- -D warnings

test:
	cargo test --all-features

# Scan the locked dependency tree against the RustSec advisory database.
#
# Skipped with a NOTE, not failed, when cargo-audit is absent: this runs inside
# `ci`, and the CI runner images do not ship the tool. The scan itself is gated
# in CI by a dedicated rustsec/audit-check job, in ci.yml for pushes and pull
# requests and in release.yml for a release. This target exists so the same scan is
# exercised LOCALLY, before a push, rather than being first seen in CI, and a
# hard failure here would break CI to re-check what CI already does.
#
# The skip means `make ci` passing does NOT imply an advisory scan ran. Install
# cargo-audit locally if you want the gate to mean that.
#
# `cargo audit` fetches the RustSec advisory database, so this is the one step
# in the gate that reaches the network, and the one whose result can change
# without the tree changing: an advisory published upstream today fails a gate
# that passed yesterday, including for a transitive dependency with no fixed
# release to move to. `make ci-local SKIP_AUDIT=1` opts out when you are offline
# or unblocking unrelated work. It is not a way to ship past an advisory: CI
# scans every push and every release and does not read this variable.
#
# `cargo audit` exits non-zero on a vulnerability but not on an informational
# advisory (`unmaintained`, `unsound`, `notice`), which matches the CI job's
# behavior: those are reported as warnings and are frequently in a transitive
# dependency with no fixed release to move to.
audit:
	@if [ -n "$(SKIP_AUDIT)" ]; then \
		echo "note: NO advisory scan ran (SKIP_AUDIT set; CI scans every push and every release)" >&2; \
		exit 0; \
	fi; \
	command -v cargo-audit >/dev/null 2>&1 \
		|| { echo "note: NO advisory scan ran (cargo-audit not installed; CI scans every push and every release). Install: cargo install cargo-audit --locked" >&2; exit 0; }; \
	cargo audit

# Local developer gate: format in place, then lint, test, and scan advisories.
check: fmt clippy test audit

# CI gate: the same lints and tests, but verify formatting (fail if unformatted)
# rather than rewriting files. CI runs this; see .github/workflows/ci.yml.
ci: fmt-check clippy test audit

# Local pre-commit gate: identical to `ci` but formats in place (cargo fmt)
# instead of just checking, so a single command both fixes formatting and runs
# the full lint + test gate. Same set as `check`.
ci-local: fmt clippy test audit

# Serve the mdBook docs (docs/) locally with live reload, opening a browser.
# Same tool the Pages workflow uses; install with `cargo install mdbook` (or grab
# a prebuilt binary from the mdBook releases).
docs:
	@command -v mdbook >/dev/null || { echo "error: mdbook not found; install with 'cargo install mdbook'"; exit 1; }
	mdbook serve docs --open

# Build the static site to docs/book (what CI deploys to Pages).
docs-build:
	@command -v mdbook >/dev/null || { echo "error: mdbook not found; install with 'cargo install mdbook'"; exit 1; }
	mdbook build docs

clean:
	cargo clean