35 lines
1.2 KiB
Makefile
35 lines
1.2 KiB
Makefile
.DEFAULT_GOAL := help
|
||
.PHONY: docs
|
||
SRC_DIRS = ./tutordiscovery
|
||
BLACK_OPTS = --exclude templates ${SRC_DIRS}
|
||
|
||
# Warning: These checks are run on every PR.
|
||
test: test-lint test-types test-format # Run some static checks.
|
||
|
||
test-format: ## Run code formatting tests.
|
||
black --check --diff $(BLACK_OPTS)
|
||
|
||
test-lint: ## Run code linting tests
|
||
pylint --errors-only --enable=unused-import,unused-argument --ignore=templates --ignore=docs/_ext ${SRC_DIRS}
|
||
|
||
test-types: ## Run type checks.
|
||
mypy --exclude=templates --ignore-missing-imports --implicit-reexport --strict ${SRC_DIRS}
|
||
|
||
format: ## Format code automatically.
|
||
black $(BLACK_OPTS)
|
||
|
||
isort: ## Sort imports. This target is not mandatory because the output may be incompatible with black formatting. Provided for convenience purposes.
|
||
isort --skip=templates ${SRC_DIRS}
|
||
|
||
changelog-entry: ## Create a new changelog entry.
|
||
scriv create
|
||
|
||
changelog: ## Collect changelog entries in the CHANGELOG.md file.
|
||
scriv collect
|
||
|
||
ESCAPE =
|
||
help: ## Print this help.
|
||
@grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \
|
||
| sed 's/######* \(.*\)/@ $(ESCAPE)[1;31m\1$(ESCAPE)[0m/g' | tr '@' '\n' \
|
||
| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'
|
