Merge pull request #239 from jirigrill/makefile-refactoring

sim-ln/refactor: Update help, add new cmds in Makefile

Author: carlaKC

Makefile

@@ -1,6 +1,8 @@
 LOG_LEVEL ?= info
 DEFAULT_DATA_DIR ?= /data_dir
 DEFAULT_SIMFILE_PATH ?= /data_dir/sim.json
+FMT_CMD = cargo fmt --verbose --all -- --color always --config-path=./rustfmt.toml
+CLIPPY_CMD = cargo clippy --all-features --all-targets --color always
 
 build-docker:
 	docker build -f docker/Dockerfile -t sim-ln .
@@ -10,19 +12,25 @@ mount-volume:
 
 help:
 	@echo "Makefile commands:"
-	@echo "build-docker      Builds the Docker image."
-	@echo "mount-volume      Mounts the specified volume."
-	@echo "run               Runs the Docker container."
-	@echo "run-interactive   Runs the Docker container in interactive mode."
-	@echo "stop              Stops the Docker container."
+	@echo "  build-docker       Builds the Docker image."
+	@echo "  mount-volume       Mounts the specified volume."
+	@echo "  run-docker         Runs the Docker container in detached mode."
+	@echo "  run-interactive    Runs the Docker container in interactive mode."
+	@echo "  stop-docker        Stops the Docker container."
+	@echo "  check              Runs code formatting and linting checks."
+	@echo "  check-code         Runs code formatting and linting without stability check."
+	@echo "  format             Fixes both formatting and linting issues in one go."
+	@echo "  stable-output      Checks for unstaged/uncommitted changes after checks."
+	@echo "  install            Installs the simulation CLI."
+	@echo "  dev-install        Installs the simulation CLI with development features."
 	@echo ""
 	@echo "Variables:"
-	@echo "SIMFILE_PATH      Path to the sim.json file."
-	@echo "LOG_LEVEL         Set the logging level (default: info) e.g. <make run LOG_LEVEL=debug>."
-	@echo "HELP              Set to true to print the help message (default: false) e.g. <make run HELP=true>."
-	@echo "PRINT_BATCH_SIZE  Set the batch size for printing the results e.g. <make run PRINT_BATCH_SIZE=100>."
-	@echo "TOTAL_TIME        Set the total time for the simulation e.g. <make run TOTAL_TIME=1000>."
-	@echo "DATA_DIR          Set the data directory for the simulation containing simulation files and results e.g. <make run-docker DATA_DIR="/Users/anon/data_dir>"."
+	@echo "  SIMFILE_PATH      Path to the sim.json file."
+	@echo "  LOG_LEVEL         Set the logging level (default: info) e.g. <make run-docker LOG_LEVEL=debug>."
+	@echo "  HELP              Set to true to print the help message (default: false) e.g. <make run-docker HELP=true>."
+	@echo "  PRINT_BATCH_SIZE  Set the batch size for printing the results e.g. <make run-docker PRINT_BATCH_SIZE=100>."
+	@echo "  TOTAL_TIME        Set the total time for the simulation e.g. <make run-docker TOTAL_TIME=1000>."
+	@echo "  DATA_DIR          Set the data directory for the simulation containing simulation files and results e.g. <make run-docker DATA_DIR=\"/Users/anon/data_dir\">."
 
 run-docker:
 	docker run -d --rm --name sim-ln --init -v simln-data:${DEFAULT_DATA_DIR} -e SIMFILE_PATH=${DEFAULT_SIMFILE_PATH} -e LOG_LEVEL=$(LOG_LEVEL) -e HELP=${HELP} -e PRINT_BATCH_SIZE=${PRINT_BATCH_SIZE} -e TOTAL_TIME=${TOTAL_TIME} sim-ln
@@ -34,8 +42,8 @@ stop-docker:
 	docker stop sim-ln
 
 check-code:
-	cargo fmt --verbose --check --all -- --color always
-	cargo clippy --all-features --all-targets --color always -- -D warnings
+	$(FMT_CMD) --check
+	$(CLIPPY_CMD) -- -D warnings
 
 stable-output:
 	@if [ -n "$$(git status --porcelain)" ]; then \
@@ -52,3 +60,7 @@ install:
 
 dev-install:
 	RUSTFLAGS="--cfg tokio_unstable" cargo install --locked --path sim-cli --features dev
+
+format:
+	$(FMT_CMD)
+	$(CLIPPY_CMD) --fix --allow-dirty --allow-staged -- -D warnings