crema 0.1.1

A high-performance, sharded Key-Value store utilizing a Multi-Raft consensus architecture
Documentation 
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
141

.PHONY: all build check test test-verbose nextest nextest-ci nextest-quick clippy fmt clean doc run-basic run-cluster help

# Default target
all: check clippy test

# Build the project
build:
	cargo build

# Build in release mode
release:
	cargo build --release

# Check code without building
check:
	cargo check

# Run all tests
test:
	cargo test

# Run tests with output
test-verbose:
	cargo test -- --nocapture

# Run a specific test
test-one:
	@test -n "$(TEST)" || (echo "Usage: make test-one TEST=<test_name>" && exit 1)
	cargo test $(TEST)

# Run tests with nextest (recommended)
nextest:
	cargo nextest run --features full,dashboard

# Run nextest with CI profile
nextest-ci:
	cargo nextest run --features full,dashboard --profile ci

# Run nextest quick (fail-fast)
nextest-quick:
	cargo nextest run --features full,dashboard --profile quick

# Run nextest with filter (usage: make nextest-filter FILTER=slot)
nextest-filter:
	@test -n "$(FILTER)" || (echo "Usage: make nextest-filter FILTER=<pattern>" && exit 1)
	cargo nextest run --features full,dashboard -E 'test($(FILTER))'

# Run clippy lints
clippy:
	cargo clippy

# Run clippy with warnings as errors
clippy-strict:
	cargo clippy -- -D warnings

# Format code
fmt:
	cargo fmt

# Check formatting without modifying
fmt-check:
	cargo fmt -- --check

# Generate documentation
doc:
	cargo doc --no-deps

# Open documentation in browser
doc-open:
	cargo doc --no-deps --open

# Clean build artifacts
clean:
	cargo clean

# Run basic example
run-basic:
	cargo run --example basic

# Run cluster node (usage: make run-cluster NODE=1)
run-cluster:
	@test -n "$(NODE)" || (echo "Usage: make run-cluster NODE=<node_id>" && exit 1)
	RUST_LOG=info cargo run --example cluster -- $(NODE)

# Run memberlist cluster example
run-memberlist:
	@test -n "$(NODE)" || (echo "Usage: make run-memberlist NODE=<node_id>" && exit 1)
	RUST_LOG=info cargo run --example memberlist-cluster -- $(NODE)

# Run auto-discovery example
run-discovery:
	cargo run --example auto-discovery

# Run all checks (CI)
ci: fmt-check clippy-strict test

# Watch for changes and run tests
watch:
	cargo watch -x test

# Show help
help:
	@echo "Crema - Distributed Cache Makefile"
	@echo ""
	@echo "Usage: make [target]"
	@echo ""
	@echo "Build targets:"
	@echo "  build          Build the project (debug)"
	@echo "  release        Build the project (release)"
	@echo "  check          Check code without building"
	@echo "  clean          Clean build artifacts"
	@echo ""
	@echo "Test targets:"
	@echo "  nextest        Run tests with nextest (recommended)"
	@echo "  nextest-ci     Run nextest with CI profile (more retries)"
	@echo "  nextest-quick  Run nextest quick (fail-fast)"
	@echo "  nextest-filter Run nextest with filter (FILTER=<pattern>)"
	@echo "  test           Run all tests (legacy cargo test)"
	@echo "  test-verbose   Run tests with output"
	@echo "  test-one       Run a specific test (TEST=<name>)"
	@echo ""
	@echo "Code quality:"
	@echo "  clippy         Run clippy lints"
	@echo "  clippy-strict  Run clippy with warnings as errors"
	@echo "  fmt            Format code"
	@echo "  fmt-check      Check formatting"
	@echo "  ci             Run all CI checks"
	@echo ""
	@echo "Documentation:"
	@echo "  doc            Generate documentation"
	@echo "  doc-open       Generate and open documentation"
	@echo ""
	@echo "Examples:"
	@echo "  run-basic      Run basic example"
	@echo "  run-cluster    Run cluster node (NODE=1|2|3)"
	@echo "  run-memberlist Run memberlist cluster (NODE=1|2|3)"
	@echo "  run-discovery  Run auto-discovery example"
	@echo ""
	@echo "Other:"
	@echo "  watch          Watch for changes and run tests"
	@echo "  help           Show this help message"