Merge pull request #5 from fdehau/ft-refactor-makefile

Refactor Makefile

Makefile

@@ -1,16 +1,94 @@
-build:
-	cargo build
-test:
-	cargo test
-doc:
-	cargo doc
-clippy:
-	rustup run nightly cargo clippy
-watch:
-	watchman-make -p 'src/**/*.rs' -t build -p 'test/**/*.rs' -t test
-
-watch-test:
+# 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
+  CARGO = rustup run $(RUST_CHANNEL) cargo
+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}'
+
+
+# ================================ Tools ======================================
+
+
+CLIPPY_VERSION = 0.0.134
+RUSTFMT_VERSION = 0.8.4
+
+install: install-rustfmt install-clippy ## Install tools dependencies
+
+install-rustfmt: RUST_CHANNEL = nightly
+install-rustfmt: ## Intall rustfmt
+	$(CARGO) install --vers $(RUSTFMT_VERSION) --force rustfmt
+
+install-clippy: RUST_CHANNEL = nightly
+install-clippy: ## Install clippy
+	$(CARGO) install --vers $(CLIPPY_VERSION) --force clippy
+
+
+# =============================== 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 -- --write-mode=$(RUSTFMT_WRITEMODE)
+
+clippy: RUST_CHANNEL = nightly
+clippy: ## Check the style of the source code and catch common errors
+	$(CARGO) clippy
+
+
+# ================================ 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-doc: ## Watch file changes and rebuild the documentation if any
 	watchman-make -p 'src/**/*.rs' -t doc