wagtail/Makefile

.PHONY: clean-pyc develop lint test coverage

help:
	@echo "clean-pyc - remove Python file artifacts"
	@echo "develop - install development dependencies"
	@echo "lint - check style with black, flake8, sort python with isort, indent html, and lint frontend css/js"
	@echo "test - run tests"
	@echo "coverage - check code coverage"

clean-pyc:
	find . -name '*.pyc' -exec rm -f {} +
	find . -name '*.pyo' -exec rm -f {} +
	find . -name '*~' -exec rm -f {} +

develop: clean-pyc
	pip install -e .[testing,docs]
	npm install --no-save && npm run build

lint:
	black --target-version py37 --check --diff .
	flake8
	isort --check-only --diff .
	# Filter out known false positives, while preserving normal output and error codes.
	# See https://github.com/motet-a/jinjalint/issues/18.
	jinjalint --parse-only wagtail | grep -v 'welcome_page.html:6:76' | tee /dev/tty | wc -l | grep -q '0'
	git ls-files '*.html' | xargs djhtml --check
	npm run lint:css --silent
	npm run lint:js --silent
	npm run lint:format --silent
	doc8 docs

format:
	black --target-version py37 .
	isort .
	git ls-files '*.html' | xargs djhtml -i
	npm run format
	npm run fix:js

test:
	python runtests.py

coverage:
	coverage run --source wagtail runtests.py
	coverage report -m
	coverage html
	open coverage_html_report/index.html