nulid 0.8.0

Nanosecond-Precision Universally Lexicographically Sortable Identifier
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

# ==============================================================================
# Makefile for nulid workspace
# ==============================================================================
#
# This Makefile provides convenient commands for development, testing, and
# publishing the nulid workspace. It uses the same commands as the GitHub
# Actions CI/CD workflows to ensure consistency between local development
# and continuous integration.
#
# The Rust version is automatically extracted from the workspace Cargo.toml
# to ensure alignment with the project's rust-version requirement.
#
# Usage:
#   make help          - Show all available targets
#   make ci            - Run all CI checks (fmt-check, clippy, test, etc.)
#   make pre-commit    - Run pre-commit checks (fmt, clippy, test)
#   make publish       - Publish all crates to crates.io
#
# ==============================================================================

.PHONY: help
help: ## Show this help message
	@echo "Available targets:"
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-20s\033[0m %s\n", $$1, $$2}'

# Rust version - automatically extracted from workspace Cargo.toml
RUST_VERSION := $(shell grep 'rust-version = ' Cargo.toml | head -1 | sed 's/.*rust-version = "\(.*\)"/\1/')

.PHONY: install-rust
install-rust: ## Install Rust toolchain with required components
	rustup toolchain install $(RUST_VERSION)
	rustup component add rustfmt clippy --toolchain $(RUST_VERSION)

.PHONY: check
check: ## Run cargo check on all workspace members
	cargo +$(RUST_VERSION) check --all-features --workspace

.PHONY: fmt
fmt: ## Format all code
	cargo +$(RUST_VERSION) fmt --all

.PHONY: fmt-check
fmt-check: ## Check code formatting
	cargo +$(RUST_VERSION) fmt --all --check

.PHONY: clippy
clippy: ## Run clippy lints
	cargo +$(RUST_VERSION) clippy --all-features --all-targets -- -D warnings

.PHONY: test
test: ## Run all tests
	cargo +$(RUST_VERSION) test --all-features

.PHONY: test-doc
test-doc: ## Run documentation tests
	cargo +$(RUST_VERSION) test --doc --all-features

.PHONY: bench
bench: ## Run benchmarks
	cargo +$(RUST_VERSION) bench --all-features

.PHONY: bench-test
bench-test: ## Run benchmarks in test mode (CI)
	cargo +$(RUST_VERSION) bench --all-features -- --test

.PHONY: examples
examples: ## Run all examples
	@echo "Running basic example..."
	cargo +$(RUST_VERSION) run --example basic
	@echo "Running monotonic example..."
	cargo +$(RUST_VERSION) run --example monotonic
	@echo "Running derive_wrapper example..."
	cargo +$(RUST_VERSION) run --example derive_wrapper --features derive
	@echo "Running macros example..."
	cargo +$(RUST_VERSION) run --example macros --features macros
	@echo "Running combined_features example..."
	cargo +$(RUST_VERSION) run --example combined_features --features derive,macros
	@echo "Running derive_features example..."
	cargo +$(RUST_VERSION) run --example derive_features --features derive,serde,uuid,sqlx,postgres-types
	@echo "Running serde_example..."
	cargo +$(RUST_VERSION) run --example serde_example --features serde
	@echo "Running uuid_conversion example..."
	cargo +$(RUST_VERSION) run --example uuid_conversion --features uuid
	@echo "Running rkyv_example..."
	cargo +$(RUST_VERSION) run --example rkyv_example --features rkyv
	@echo "Running postgres_types_example..."
	cargo +$(RUST_VERSION) run --example postgres_types_example --features postgres-types
	@echo "Running chrono_example..."
	cargo +$(RUST_VERSION) run --example chrono_example --features chrono
	@echo "Running jiff_example..."
	cargo +$(RUST_VERSION) run --example jiff_example --features jiff

.PHONY: build
build: ## Build all workspace members
	cargo +$(RUST_VERSION) build --all-features --workspace

.PHONY: build-release
build-release: ## Build all workspace members in release mode
	cargo +$(RUST_VERSION) build --all-features --workspace --release

.PHONY: doc
doc: ## Generate documentation
	cargo +$(RUST_VERSION) doc --all-features --workspace --no-deps

.PHONY: doc-open
doc-open: ## Generate and open documentation
	cargo +$(RUST_VERSION) doc --all-features --workspace --no-deps --open

.PHONY: clean
clean: ## Clean build artifacts
	cargo clean

.PHONY: ci
ci: fmt-check clippy test test-doc bench-test examples ## Run all CI checks

.PHONY: pre-commit
pre-commit: fmt clippy test ## Run pre-commit checks

.PHONY: verify-version
verify-version: ## Verify version consistency across workspace
	@echo "Checking workspace configuration..."
	@VERSION=$$(grep '^\s*version = ' Cargo.toml | head -1 | sed 's/.*version = "\(.*\)"/\1/'); \
	echo "  Workspace version: $$VERSION"; \
	EDITION=$$(grep '^\s*edition = ' Cargo.toml | head -1 | sed 's/.*edition = "\(.*\)"/\1/'); \
	echo "  Workspace edition: $$EDITION"; \
	RUST_VER=$$(grep '^\s*rust-version = ' Cargo.toml | head -1 | sed 's/.*rust-version = "\(.*\)"/\1/'); \
	echo "  Workspace rust-version: $$RUST_VER"; \
	echo ""; \
	echo "Checking sub-crates..."; \
	DERIVE_CHECK=$$(grep 'version.workspace = true' nulid_derive/Cargo.toml > /dev/null && echo "workspace ($$VERSION)" || grep '^version = ' nulid_derive/Cargo.toml | sed 's/version = "\(.*\)"/\1/'); \
	echo "  nulid_derive version: $$DERIVE_CHECK"; \
	MACROS_CHECK=$$(grep 'version.workspace = true' nulid_macros/Cargo.toml > /dev/null && echo "workspace ($$VERSION)" || grep '^version = ' nulid_macros/Cargo.toml | sed 's/version = "\(.*\)"/\1/'); \
	echo "  nulid_macros version: $$MACROS_CHECK"

.PHONY: publish-dry-run
publish-dry-run: ## Dry run of publishing to crates.io
	@echo "Dry run: Publishing nulid_derive..."
	cd nulid_derive && cargo publish --dry-run
	@echo "Dry run: Publishing nulid_macros..."
	cd nulid_macros && cargo publish --dry-run
	@echo "Dry run: Publishing nulid..."
	cargo publish --dry-run --all-features

.PHONY: publish
publish: ## Publish all crates to crates.io (requires CARGO_REGISTRY_TOKEN)
	@echo "Publishing nulid_derive..."
	cd nulid_derive && cargo publish
	@echo "Waiting for crates.io propagation..."
	sleep 30
	@echo "Publishing nulid_macros..."
	cd nulid_macros && cargo publish
	@echo "Waiting for crates.io propagation..."
	sleep 30
	@echo "Publishing nulid..."
	cargo publish --all-features

.PHONY: update-deps
update-deps: ## Update dependencies
	cargo update

.PHONY: all
all: ci doc ## Run all checks and build documentation