CURRENT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
.PHONY: all
all: test fmt lint build
.PHONY: build
build:
cargo build --workspace --all-targets --all-features
.PHONY: release
release:
cargo build --workspace --release
.PHONY: test
test:
LOGLEVEL=WARN cargo test --workspace --all-features
.PHONY: wasm-build
wasm-build:
cargo +nightly build --target wasm32-unknown-unknown --release
.PHONY: wasm-test
wasm-test:
cargo +nightly test --target wasm32-unknown-unknown --release
.PHONY: fmt
fmt:
cargo +stable fmt --all
.PHONY: fmt-check
fmt-check:
cargo +stable fmt --all --check
.PHONY: lint
lint:
cargo clippy --workspace --all-targets --all-features -- -D warnings
.PHONY: lint-wasm
lint-wasm:
cargo +nightly clippy --target wasm32-unknown-unknown --release --all-features -- -D warnings
.PHONY: lint-fix
lint-fix:
cargo clippy --fix --workspace --all-targets --all-features --allow-dirty --allow-staged -- -D warnings
.PHONY: lint-wasm-fix
lint-wasm-fix:
cargo +nightly clippy --fix --target wasm32-unknown-unknown --release --all-features --allow-dirty --allow-staged -- -D warnings
.PHONY: clean
clean:
cargo clean
.PHONY: check
check: fmt-check lint test check-spanish doc-check
.PHONY: run
run:
cargo run
.PHONY: fix
fix:
cargo fix --allow-staged --allow-dirty
.PHONY: pre-push
pre-push: fix fmt lint-fix test
.PHONY: doc
doc: doc-check
cargo doc --open
.PHONY: doc-check
doc-check:
RUSTDOCFLAGS="-D warnings" cargo doc --workspace --all-features --no-deps
.PHONY: publish
publish: coverage
cargo login ${CARGO_REGISTRY_TOKEN}
cargo package
cargo publish
.PHONY: coverage
coverage:
export LOGLEVEL=WARN
cargo install cargo-tarpaulin
mkdir -p coverage
cargo tarpaulin --all-features --workspace --timeout 120 --out Xml --output-dir coverage
.PHONY: coverage-html
coverage-html:
export LOGLEVEL=WARN
cargo install cargo-tarpaulin
mkdir -p coverage
cargo tarpaulin --all-features --workspace --timeout 120 --out Html --output-dir coverage
.PHONY: coverage-json
coverage-json:
export LOGLEVEL=WARN
cargo install cargo-tarpaulin
mkdir -p coverage
cargo tarpaulin --all-features --workspace --timeout 120 --out Json --output-dir coverage
.PHONY: open-coverage
open-coverage:
open coverage/tarpaulin-report.html
git-log:
@if [ "$(CURRENT_BRANCH)" = "HEAD" ]; then \
echo "You are in a detached HEAD state. Please check out a branch."; \
exit 1; \
fi; \
echo "Showing git log for branch $(CURRENT_BRANCH) against main:"; \
git log main..$(CURRENT_BRANCH) --pretty=full
.PHONY: create-doc
create-doc:
cargo doc --no-deps --document-private-items
.PHONY: check-cargo-deny
check-cargo-deny:
@command -v cargo-deny > /dev/null || (echo "Installing cargo-deny..."; cargo install cargo-deny --locked)
.PHONY: deny
deny: check-cargo-deny deny-expiry
cargo deny check
.PHONY: deny-expiry
deny-expiry:
@dates=$$(grep -oE 'expires=[0-9]{4}-[0-9]{2}-[0-9]{2}' deny.toml | cut -d= -f2); \
ignores=$$(grep -cE '^[[:space:]]*\{ id = "RUSTSEC' deny.toml); \
found=$$(printf '%s\n' "$$dates" | grep -c '[0-9]' || true); \
if [ "$$found" != "$$ignores" ]; then \
echo "deny-expiry: $$ignores exception(s) but $$found expiry marker(s)."; \
echo "Every ignore needs owner=<login> expires=<YYYY-MM-DD> in its reason."; \
exit 1; \
fi; \
today=$$(date -u +%Y-%m-%d); \
expired=$$(printf '%s\n' "$$dates" | awk -v today="$$today" 'length($$0) > 0 && $$0 < today'); \
if [ -n "$$expired" ]; then \
echo "deny-expiry: advisory exception(s) expired on: $$expired"; \
echo "Re-justify in deny.toml with a new date and owner, or drop the dependency."; \
exit 1; \
fi; \
echo "deny-expiry: $$ignores exception(s), none expired"
SPANISH_ROOTS := src cli/src examples/*/src
SPANISH_WORDS := que|los|las|una|unos|unas|para|con|pero|desde|hasta|cuando|donde|tambien|ademas|aqui|puede|debe|este|esta|esto|estos|estas|del|por|como|mas|asi|solo|cada|sobre|entre|hacer|tiene|ser|codigo|respuesta|solicitud|ejemplo|advertencia|cuenta|error de
.PHONY: check-spanish
check-spanish:
@comments=$$(grep -rn --include='*.rs' -E '^[[:space:]]*//' $(SPANISH_ROOTS) | grep -vE 'Joaqu|Author:|Email:'); \
hits=$$( { printf '%s\n' "$$comments" | grep -iE '[áéíóúñ¿¡]'; \
printf '%s\n' "$$comments" | grep -iwE '($(SPANISH_WORDS))'; } | sort -u | grep -v '^$$' ); \
if [ -n "$$hits" ]; then \
echo "check-spanish: Spanish found in comments:"; \
printf '%s\n' "$$hits"; \
exit 1; \
fi; \
echo "check-spanish: clean"
.PHONY: zip
zip:
@echo "Creating $(ZIP_NAME) without any 'target' directories, 'Cargo.lock', and hidden files..."
@find . -type f \
! -path "*/target/*" \
! -path "./.*" \
! -name "Cargo.lock" \
! -name ".*" \
| zip -@ $(ZIP_NAME)
@echo "$(ZIP_NAME) created successfully."
.PHONY: check-cargo-criterion
check-cargo-criterion:
@command -v cargo-criterion > /dev/null || (echo "Installing cargo-criterion..."; cargo install cargo-criterion)
.PHONY: bench
bench: check-cargo-criterion
cargo criterion --output-format=quiet
.PHONY: bench-show
bench-show:
open target/criterion/report/index.html
.PHONY: bench-save
bench-save: check-cargo-criterion
cargo criterion --output-format quiet --history-id v0.3.2 --history-description "Version 0.3.2 baseline"
.PHONY: bench-compare
bench-compare: check-cargo-criterion
cargo criterion --output-format verbose
.PHONY: bench-json
bench-json: check-cargo-criterion
cargo criterion --message-format json
.PHONY: bench-clean
bench-clean:
rm -rf target/criterion
.PHONY: workflow-coverage
workflow-coverage:
DOCKER_HOST="$${DOCKER_HOST}" act push --job code_coverage_report \
-P ubuntu-latest=catthehacker/ubuntu:latest \
--privileged
.PHONY: workflow-build
workflow-build:
DOCKER_HOST="$${DOCKER_HOST}" act push --job build \
-P ubuntu-latest=catthehacker/ubuntu:latest
.PHONY: workflow-lint
workflow-lint:
DOCKER_HOST="$${DOCKER_HOST}" act push --job lint
.PHONY: workflow-test
workflow-test:
DOCKER_HOST="$${DOCKER_HOST}" act push --job run_tests
.PHONY: workflow
workflow: workflow-build workflow-lint workflow-test workflow-coverage