puerto 0.18.0

Puerto — Rust full-stack DDD framework CLI. Scaffolds Clean Architecture projects with auto-wired DI, SQLx support, and zero manual wiring. Formerly puerto-framework.
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

.PHONY: help setup run \
        test test/domain test/application test/infrastructure \
        lint format format/fix check clean \
        audit audit/fix \
        generate/entity generate/use-case generate/bootstrap \
        web/install web/require-install web/dev web/test web/lint web/sync

CARGO := cargo
BUN   := bun

# The escape byte itself, not `\033`: `echo` does not interpret escapes where `sh` is bash.
GREEN  := $(shell printf '\033[1;32m')
YELLOW := $(shell printf '\033[1;33m')
CYAN   := $(shell printf '\033[1;36m')
RED    := $(shell printf '\033[1;31m')
NC     := $(shell printf '\033[0m')

help: ## Show available commands
	@echo ""
	@echo "${CYAN}Available targets:${NC}"
	@echo ""
	@grep -E '^[a-zA-Z/_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "  ${YELLOW}%-32s${NC} %s\n", $$1, $$2}'
	@echo ""

setup: ## Install required dev tools (run once after cloning)
	@echo "${CYAN}Setting up development environment...${NC}"
	$(CARGO) install cargo-nextest --locked
	$(CARGO) install cargo-audit --locked

run: ## Run the API server (http://localhost:8080)
	@echo "${GREEN}Starting API server (in memory: data is lost on restart)...${NC}"
	$(CARGO) run -p presentation

test: ## Run all tests
	@echo "${YELLOW}Running all tests...${NC}"
	$(CARGO) nextest run --workspace
	@if [ -d web ]; then $(MAKE) web/test; fi

test/domain: ## Run domain layer tests
	@echo "${YELLOW}Running domain tests...${NC}"
	$(CARGO) nextest run -p business -E 'test(domain)'

test/application: ## Run application layer tests
	@echo "${YELLOW}Running application layer tests...${NC}"
	$(CARGO) nextest run -p business -E 'test(application)'

test/infrastructure: ## Run infrastructure layer tests (requires DB)
	@echo "${YELLOW}Running infrastructure tests...${NC}"
	$(CARGO) nextest run -p infrastructure

lint: ## Clippy with -D warnings
	@echo "${CYAN}Linting code...${NC}"
	$(CARGO) clippy --workspace -- -D warnings
	@if [ -d web ]; then $(MAKE) web/lint; fi

format: ## Check code formatting
	@echo "${CYAN}Checking code formatting...${NC}"
	$(CARGO) fmt --all -- --check

format/fix: ## Fix code formatting
	@echo "${CYAN}Fixing code formatting...${NC}"
	$(CARGO) fmt --all

check: ## Fast compile check (no binary)
	@echo "${CYAN}Checking code...${NC}"
	$(CARGO) check --workspace

clean: ## Remove build artifacts
	@echo "${RED}Cleaning build artifacts...${NC}"
	$(CARGO) clean

audit: ## Run security audit on dependencies
	@echo "${CYAN}Running security audit...${NC}"
	$(CARGO) audit

audit/fix: ## Preview security fixes (dry-run)
	@echo "${CYAN}Previewing security fixes (dry-run)...${NC}"
	$(CARGO) audit fix --dry-run

generate/entity: ## Scaffold a new DDD entity — make generate/entity NAME=Product
	@if [ -z "$$NAME" ]; then \
		echo "${RED}Error: provide entity name — make generate/entity NAME=Product${NC}"; \
		exit 1; \
	fi
	@echo "${GREEN}Scaffolding entity '$$NAME'...${NC}"
	puerto generate scaffold $$NAME

generate/use-case: ## Add a use case to an entity — make generate/use-case ENTITY=Product ACTION=delete_product
	@if [ -z "$$ENTITY" ] || [ -z "$$ACTION" ]; then \
		echo "${RED}Error: provide entity and action — make generate/use-case ENTITY=Product ACTION=delete_product${NC}"; \
		exit 1; \
	fi
	@echo "${GREEN}Adding use case '$$ACTION' to '$$ENTITY'...${NC}"
	puerto generate use-case $$ENTITY $$ACTION

generate/bootstrap: ## Regenerate bootstrap.rs from puerto.toml
	@echo "${GREEN}Regenerating bootstrap.rs...${NC}"
	puerto generate bootstrap

web/install: ## Install the frontend dependencies (needs Bun)
	@echo "${CYAN}Installing frontend dependencies...${NC}"
	cd web && $(BUN) install

# Not in `make help`: the prerequisite of every target that runs the frontend's tools.
web/require-install:
	@if [ ! -d web/node_modules ]; then \
		echo "${RED}web/node_modules is missing — run: make web/install${NC}"; \
		exit 1; \
	fi

web/dev: web/require-install ## Run the frontend dev server (http://localhost:5173, /api proxied to :8080)
	@echo "${GREEN}Starting frontend dev server...${NC}"
	cd web && $(BUN) run dev

web/test: web/require-install ## Run the frontend tests
	@echo "${YELLOW}Running frontend tests...${NC}"
	cd web && $(BUN) test

web/lint: web/require-install ## Typecheck, lint and check the frontend Dependency Rule
	@echo "${CYAN}Linting frontend...${NC}"
	cd web && $(BUN) run typecheck && $(BUN) run lint && $(BUN) run lint:arch

web/sync: web/require-install ## After a scaffold or a DTO change: export the OpenAPI spec, regenerate the web types
	@echo "${CYAN}Exporting docs/api/openapi.json...${NC}"
	UPDATE_OPENAPI=1 $(CARGO) test -p presentation openapi
	@echo "${CYAN}Generating web/src/infrastructure/http/schema.d.ts...${NC}"
	cd web && $(BUN) run openapi:types
	@echo "${CYAN}Formatting web/ (Biome, no lint fixes)...${NC}"
	cd web && $(BUN) run format