Makefile

DJANGO_PORT = 9001

.PHONY: help
help:
	@echo "Usage:"
	@echo "    make help             prints this help."
	@echo "    make build            build js and css resources for development"
	@echo "    make cov-html         generate html coverage report"
	@echo "    make lint             run css, js and python linting."
	@echo "    make lint-fix         try fixing plausible python linting issues."
	@echo "    make py-test          run all python tests and display coverage"
	@echo "    make test             run linting and test and generate html coverage report"
	@echo "    make serve-docs       run documentation development server"
	@echo "    make serve-django     run Django development server on port 9001."
	@echo "    make serve            run Django and docs preview server, also watch and compile frontend changes"
	@echo "    make watch            watch js and css resources for development"

.PHONY: serve
serve:
	$(MAKE) -j3 watch serve-django serve-docs

.PHONY: build
build:
	@echo "Build js and css resources for development."
	npm run dev:build

.PHONY: cov-html
cov-html:
ifneq ("$(wildcard .coverage)","")
	@rm -rf htmlcov
	@echo "Generate html coverage report…"
	coverage html
	@echo "Open 'htmlcov/index.html' in your browser to see the report."
else
	$(error Unable to generate html coverage report, please run 'make test' or 'make py-test')
endif

.PHONY: lint
lint:
	@echo "Checking python code style with ruff"
	ruff .
	@echo "Checking js and css code style."
	npm run lint

.PHONY: lint-fix
lint-fix:
	@echo "Try fixing plausible python linting issues."
	ruff --fix .

.PHONY: py-test
py-test:
	@echo "Running python tests"
	pytest --reuse-db --cov --cov-report term:skip-covered

.PHONY: serve-django
serve-django:
	python manage.py runserver 0.0.0.0:$(DJANGO_PORT) --settings=hypha.settings.dev

.PHONY: test
test: lint py-test cov-html

.PHONY: serve-docs
serve-docs:
	@echo "Serve and watch documentation locally:"
	mkdocs serve

.PHONY: watch
watch:
	@echo "Watch js and css resources for development."
	npm run watch