Skip to content
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.

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

Improve documentation of Makefile #249

Merged
merged 3 commits into from
Jul 15, 2024
Merged
Changes from 2 commits
Commits
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
25 changes: 10 additions & 15 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,31 @@
all: help

.PHONY: install_test
install_test:
install_test: ## Install test dependencies
@poetry install --with=development,testing

.PHONY: install_deps
install_deps:
install_deps: ## Install all dependencies
@poetry install --with=development,linting,testing,docs

.PHONY: update_deps
update_deps:
update_deps: ## Update dependencies
@poetry update --with=development,linting,testing,docs

.PHONY: test
test:
test: ## Run the unit tests
@poetry run pytest tests

.PHONY: lint
lint:
lint: ## Lint the code
@poetry run ruff check --fix quinn

.PHONY: format
format:
format: ## Format the code
@poetry run ruff format quinn

.PHONY: help
help:
@echo '................... Quin ..........................'
@echo 'help - print that message'
@echo 'lint - run linter'
@echo 'format - reformat the code'
@echo 'test - run tests'
@echo 'install_test - install test deps'
@echo 'install_deps - install dev deps'
@echo 'update_deps - update and install deps'
help: ## Show help for the commands
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
fpgmaas marked this conversation as resolved.
Show resolved Hide resolved

.DEFAULT_GOAL := help