mirror of
https://github.com/ratatui-org/ratatui
synced 2024-11-29 16:10:34 +00:00
91 lines
2.4 KiB
Makefile
91 lines
2.4 KiB
Makefile
# Makefile for the tui-rs project (https://github.com/fdehau/tui-rs)
|
|
|
|
|
|
# ================================ Cargo ======================================
|
|
|
|
|
|
RUST_CHANNEL ?= stable
|
|
CARGO_FLAGS =
|
|
RUSTUP_INSTALLED = $(shell command -v rustup 2> /dev/null)
|
|
|
|
ifndef RUSTUP_INSTALLED
|
|
CARGO = cargo
|
|
else
|
|
ifdef CI
|
|
CARGO = cargo
|
|
else
|
|
CARGO = rustup run $(RUST_CHANNEL) cargo
|
|
endif
|
|
endif
|
|
|
|
|
|
# ================================ Help =======================================
|
|
|
|
|
|
help: ## Print all the available commands
|
|
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
|
|
awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
|
|
|
|
|
|
# =============================== Build =======================================
|
|
|
|
check: ## Validate the project code
|
|
$(CARGO) check
|
|
|
|
build: ## Build the project in debug mode
|
|
$(CARGO) build $(CARGO_FLAGS)
|
|
|
|
release: CARGO_FLAGS += --release
|
|
release: build ## Build the project in release mode
|
|
|
|
|
|
# ================================ Lint =======================================
|
|
|
|
RUSTFMT_WRITEMODE ?= 'diff'
|
|
|
|
lint: fmt clippy ## Lint project files
|
|
|
|
fmt: ## Check the format of the source code
|
|
cargo fmt --all -- --check
|
|
|
|
clippy: RUST_CHANNEL = nightly
|
|
clippy: ## Check the style of the source code and catch common errors
|
|
$(CARGO) clippy --features="termion rustbox"
|
|
|
|
|
|
# ================================ Test =======================================
|
|
|
|
|
|
test: ## Run the tests
|
|
$(CARGO) test
|
|
|
|
# ================================ Doc ========================================
|
|
|
|
|
|
doc: ## Build the documentation (available at ./target/doc)
|
|
$(CARGO) doc
|
|
|
|
|
|
# ================================= Watch =====================================
|
|
|
|
# Requires watchman and watchman-make (https://facebook.github.io/watchman/docs/install.html)
|
|
|
|
watch: ## Watch file changes and build the project if any
|
|
watchman-make -p 'src/**/*.rs' -t check build
|
|
|
|
watch-test: ## Watch files changes and run the tests if any
|
|
watchman-make -p 'src/**/*.rs' 'tests/**/*.rs' 'examples/**/*.rs' -t test
|
|
|
|
watch-doc: ## Watch file changes and rebuild the documentation if any
|
|
watchman-make -p 'src/**/*.rs' -t doc
|
|
|
|
# ================================= Pipelines =================================
|
|
|
|
stable: RUST_CHANNEL = stable
|
|
stable: build test ## Run build and tests for stable
|
|
|
|
beta: RUST_CHANNEL = beta
|
|
beta: build test ## Run build and tests for beta
|
|
|
|
nightly: RUST_CHANNEL = nightly
|
|
nightly: build lint test ## Run build, lint and tests for nightly
|