Skip to content

Add 'make help' #602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cceckman-at-fastly wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add 'make help' #602

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 25 additions & 19 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,27 @@
VICEROY_CARGO=cargo

.PHONY: format
format:
format: ## Apply standard formatting with `cargo fmt`.
$(VICEROY_CARGO) fmt
cd wasm_abi/adapter && $(VICEROY_CARGO) fmt

.PHONY: format-check
format-check:
format-check: ## Check formatting, without updating.
$(VICEROY_CARGO) fmt -- --check

.PHONY: clippy
clippy:
clippy: ## Ask for Clippy lints.
$(VICEROY_CARGO) clippy --all -- -D warnings

.PHONY: test
test: test-crates trap-test
test: test-crates trap-test ## Run all tests.

.PHONY: test-crates
test-crates: fix-build
RUST_BACKTRACE=1 $(VICEROY_CARGO) test --all

# Build test fixtures.
# You typically don't need to do this yourself, as the test suites depend on this target.
.PHONY: fix-build
fix-build:
cd test-fixtures && $(VICEROY_CARGO) build --target=wasm32-wasip1
Expand All @@ -29,36 +31,32 @@ fix-build:
trap-test: fix-build
cd cli/tests/trap-test && RUST_BACKTRACE=1 $(VICEROY_CARGO) test fatal_error_traps -- --nocapture

# The main `ci` target runs everything except `trap-test`.
.PHONY: ci
ci: VICEROY_CARGO=cargo --locked
ci: format-check test-crates ## The main CI target; runs all tests except `trap-test`.

# The `trap-test` is its own top-level target for CI in order to achieve better build parallelism.
.PHONY: trap-test-ci
trap-test-ci: VICEROY_CARGO=cargo --locked
trap-test-ci: trap-test

# The main `ci` target runs everything except `trap-test`.
.PHONY: ci
ci: VICEROY_CARGO=cargo --locked
ci: format-check test-crates

.PHONY: clean
clean:
clean: ## Clean up Cargo outputs and cache.
$(VICEROY_CARGO) clean
cd cli/tests/trap-test/ && $(VICEROY_CARGO) clean

# Open the documentation for the workspace in a browser.
.PHONY: doc
doc:
doc: ## Open the documentation for the workspace in a browser.
$(VICEROY_CARGO) doc --workspace --open

# Open the documentation for the workspace in a browser.
#
# Note: This includes private items, which can be useful for development.
.PHONY: doc-dev
doc-dev:
doc-dev: ## Open the documentation for the workspace in a browser, including private items. Useful for development.
$(VICEROY_CARGO) doc --no-deps --document-private-items --workspace --open

# Run `cargo generate-lockfile` for all of the crates in the project.

.PHONY: generate-lockfile
generate-lockfile:
generate-lockfile: ## Run `cargo generate-lockfile` for all of the crates in the project, updating dependencies.
$(VICEROY_CARGO) generate-lockfile
$(VICEROY_CARGO) generate-lockfile --manifest-path=test-fixtures/Cargo.toml
$(VICEROY_CARGO) generate-lockfile --manifest-path=cli/tests/trap-test/Cargo.toml
Expand Down Expand Up @@ -116,4 +114,12 @@ build-adapter:
cp wasm_abi/adapter/target/wasm32-unknown-unknown/release-library/viceroy_component_adapter.wasm \
wasm_abi/data/viceroy-component-adapter.library.wasm
cp wasm_abi/adapter/target/wasm32-unknown-unknown/release-library-noshift/viceroy_component_adapter.wasm \
wasm_abi/data/viceroy-component-adapter.library.noshift.wasm
wasm_abi/data/viceroy-component-adapter.library.noshift.wasm


.PHONY: help
help: ## Print help text for all documented commands. (Document with a ## comment.)
@grep -E '^[a-zA-Z_-]+:[^#]*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":[^#]*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
# Note that we don't sort; targets appear in the order they are in the file.
# So, put more important targets first (or is it last?)

Loading