midenup 0.3.0

The Miden toolchain manager
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

# -- linting --------------------------------------------------------------------------------------

.PHONY: clippy
clippy: ## Runs Clippy with configs
	cargo clippy --all --all-targets -- -D clippy::all -D warnings

.PHONY: fix
fix: ## Runs Fix with configs
	cargo fix --allow-staged --allow-dirty --all-targets

.PHONY: format
format: format-manifest ## Runs Format using nightly toolchain
	cargo +nightly fmt --all

.PHONY: format-check
format-check: ## Runs Format using nightly toolchain but only in check mode
	cargo +nightly fmt --all --check

.PHONY: check-manifest
check-manifest: update-manifest
	bin/update-manifest --manifest-path manifest/channel-manifest.json check

.PHONY: format-manifest
format-manifest: update-manifest
	bin/update-manifest --manifest-path manifest/channel-manifest.json format

.PHONY: lint
lint: format clippy ## Runs all linting tasks at once (Clippy, formatting)

# --- testing -------------------------------------------------------------------------------------

.PHONY: test-build
test-build: ## Build the test binary
	cargo nextest run --no-run

.PHONY: test
test: ## Run all tests, except integration
	cargo nextest run --no-fail-fast -- --skip integration

.PHONY: integration-test
integration-test: ## Run all integration tests
	cargo nextest run --no-fail-fast integration

# --- building ------------------------------------------------------------------------------------

.PHONY: check
check: ## Perform a check build with default parameters
	cargo check

.PHONY: build
build: ## Builds with default parameters
	cargo build

.PHONY: build-release
build-release: ## Builds with release profile
	cargo build --release

.PHONY: install
install: ## Installs midenup in release configuration
	cargo install --locked --path . --force --bin midenup

.PHONY: update-manifest
update-manifest: ## Builds the update-manifest tool
	cargo +nightly -Z unstable-options build -p update-manifest --artifact-dir bin

# --- docs ----------------------------------------------------------------------------------------
.PHONY: serve-docs
serve-docs: ## Builds docusaurus documentation & serves documentation site
	$(MAKE) -C docs/