dryip 0.2.0

Short 🩸 Rust 🦀 code snippets for inspiration.
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

SHELL := /bin/bash
.DEFAULT_GOAL := help

help: # https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

setup: ## Setup the repository.
	git cliff --version || cargo install git-cliff
	cargo-set-version --help || cargo install cargo-edit
	cargo watch --version || cargo install cargo-watch
	cargo outdated --version || cargo install --locked cargo-outdated
	cargo tarpaulin --version || cargo install --locked cargo-tarpaulin
	cargo udeps --version || cargo install --locked cargo-udeps
	dprint --version || cargo install dprint

dev: # Develop the app.
	cargo watch -x clippy

fmt: ## Format the codebase.
	cargo fmt --all
	dprint fmt --config configs/dprint.json

fmt_check: ## Check is the codebase properly formatted.
	cargo fmt --all -- --check
	dprint check --config configs/dprint.json

lint: ## Lint the codebase.
	cargo clippy --all-targets --all-features

doc_check: ## Check the documentation.
	cargo doc --all-features --no-deps

test: ## Test the codebase.
	cargo test --all-targets

comply: fmt lint test ## Tasks to make the code-base comply with the rules. Mostly used in git hooks.

check: fmt_check lint test doc_check ## Check if the repository comply with the rules and ready to be pushed.

release: ## Create a new release. Example `make release version=v2.2.0`
	bash scripts/release.sh $(version)

#
# Misc
#

check_dependencies: ## Check dependencies health.
	cargo +nightly udeps
	cargo outdated --root-deps-only