gitsnitch 0.2.1

Lints your Git commit history against a declarative ruleset
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

SHELL := /bin/sh

BIN_NAME := gitsnitch
CARGO := $(shell command -v cargo 2>/dev/null || echo $(HOME)/.cargo/bin/cargo)
LLVM_COV := $(shell [ -x "$(HOME)/.cargo/bin/cargo-llvm-cov" ] && echo "$(HOME)/.cargo/bin/cargo-llvm-cov" || command -v cargo-llvm-cov 2>/dev/null || echo cargo-llvm-cov)
JSONSCHEMA := $(shell [ -x "$(HOME)/.cargo/bin/jsonschema-cli" ] && echo "$(HOME)/.cargo/bin/jsonschema-cli" || command -v jsonschema-cli 2>/dev/null || command -v jsonschema 2>/dev/null || echo jsonschema-cli)
PLANTUML := $(shell command -v plantuml 2>/dev/null || echo plantuml)
SCHEMA_DOC := $(shell command -v generate-schema-doc 2>/dev/null || echo generate-schema-doc)
JQ := $(shell command -v jq 2>/dev/null || echo jq)

ifeq ($(OS),Windows_NT)
EXE_EXT := .exe
else
EXE_EXT :=
endif

BIN_DIR := bin
BIN_PATH := $(BIN_DIR)/$(BIN_NAME)$(EXE_EXT)

.PHONY: help local build test clippy fmt check quality clean install-tools validate-examples update-api-design-svg update-api-schema-md fmt-json docs maintenance generate-coverage

help:
	@echo "Targets:"
	@echo "  local   - fmt + clippy + test + build (host-native)"
	@echo "  build   - build release binary for current host"
	@echo "  test    - run tests"
	@echo "  clippy  - run clippy with warnings denied"
	@echo "  fmt     - check formatting"
	@echo "  check   - cargo check"
	@echo "  quality - run core quality gates (fmt + clippy + test + check)"
	@echo "  generate-coverage - generate test coverage report (LCOV + HTML)"
	@echo "  maintenance - update lockfile + dependency hygiene checks"
	@echo "  docs    - generate Rust API docs (no deps)"
	@echo "  clean   - remove build artifacts"
	@echo "  install-tools - install contributor CLI tools"
	@echo "  validate-examples - validate API example JSON against schema"
	@echo "  update-api-design-svg - regenerate docs/api_design/api_design.svg from PlantUML"
	@echo "  update-api-schema-md - generate Markdown documentation from JSON schema"
	@echo "  fmt-json - prettify JSON files (schema and example)"

local: fmt clippy test build

build:
	@echo "Building $(BIN_NAME) for current host"
	$(CARGO) build --release
	mkdir -p $(BIN_DIR)
	cp target/release/$(BIN_NAME)$(EXE_EXT) $(BIN_PATH)
	@echo "Built: $(BIN_PATH)"
	@echo "./bin/gitsnitch --preset forbid-wip --preset conventional-commits --source-ref HEAD --target-ref master"

test:
	$(CARGO) test --all-features

clippy:
	$(CARGO) clippy --all-targets --all-features -- -D warnings

fmt:
	$(CARGO) fmt --check

check:
	$(CARGO) check --all-targets --all-features

quality: fmt clippy test check

maintenance:
	$(CARGO) update
	$(CARGO) machete
	$(CARGO) deny check
	$(CARGO) test --all-features

generate-coverage:
	$(LLVM_COV) llvm-cov --all-features --workspace --lcov --output-path lcov.info
	$(LLVM_COV) llvm-cov --all-features --workspace --html
	@echo "Coverage outputs: lcov.info and target/llvm-cov/html"

docs:
	$(CARGO) doc --no-deps

clean:
	$(CARGO) clean

install-tools:
	$(CARGO) install cargo-audit cargo-deny cargo-machete cargo-llvm-cov jsonschema-cli

validate-examples:
	$(JSONSCHEMA) validate docs/api_design/api_v1.schema.json --instance docs/api_design/api_v1.example.json

update-api-design-svg:
	$(PLANTUML) -tsvg docs/api_design/api_design.plantuml

fmt-json:
	$(JQ) --indent 2 . docs/api_design/api_v1.schema.json > /tmp/schema.tmp && mv /tmp/schema.tmp docs/api_design/api_v1.schema.json
	$(JQ) --indent 2 . docs/api_design/api_v1.example.json > /tmp/example.tmp && mv /tmp/example.tmp docs/api_design/api_v1.example.json
	@echo "JSON files formatted"