change: convert to Hatch, Pytest and Ruff

Author: brutus

.bumpversion.cfg

@@ -1,8 +1,10 @@
-*.pyc
+build/
+.copier/
+.coverage*
+dist/
 *.egg-info/
+*.pyc
+.pytest_cache/
 .tox/
-.coverage
-dist/
-build/
 .venv/
 .vscode/

.gitignore

@@ -1,52 +1,96 @@
 ---
-# INSTALL .: `pre-commit install --overwrite --install-hooks`
+# INSTALL .: `pre-commit install`
 # UPDATE ..: `pre-commit autoupdate`
-exclude: '^(CHANGELOG\.md)$'
+exclude: |
+  (?x)^(
+    CHANGELOG\..*|
+    \.copier-answers\..*|
+    \.copier/answers\..*|
+    .*/vendor/.*|
+    .+\.min\.(css|js)|
+    .+\.svg
+  )$
 default_language_version:
-  python: python3.9
+  python: python3.12
+default_install_hook_types:
+  - commit-msg
+  - pre-commit
 repos:
+  # General
+  # https://github.com/pre-commit/pre-commit-hooks
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
-      # Generall Stuff
+      # Whitespace
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: mixed-line-ending
         args:
           - "--fix=lf"
       # VCS
       - id: check-merge-conflict
+        args:
+          - "--assume-in-merge"
+      # Binaries
+      - id: check-shebang-scripts-are-executable
       # Config / Data Files (syntax check only)
+      - id: check-json
       - id: check-yaml
       - id: check-toml
+      - id: check-xml
       # Python
       - id: debug-statements
-      - id: requirements-txt-fixer
-  # Prettier (HTML, JS, CSS, Markdown, YAML…)
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v4.0.0-alpha.8
+      # Sensible Data
+      - id: detect-private-key
+  # Markdown
+  # https://github.com/executablebooks/mdformat
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.22
     hooks:
-      - id: prettier
-  # Python: check syntax
-  - repo: https://github.com/pycqa/flake8
-    rev: 7.1.1
+      - id: mdformat
+        additional_dependencies:
+          - mdformat-config
+          - mdformat-frontmatter
+          - mdformat-mkdocs
+          - mdformat-tables
+        # skip linting Hugo content b/c of this bug:
+        # https://github.com/executablebooks/mdformat/issues/402
+        exclude: ^site/content/.*
+  # Conventional Commits <https://www.conventionalcommits.org/>
+  # https://github.com/compilerla/conventional-pre-commit
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.0.0
     hooks:
-      - id: flake8
+      - id: conventional-pre-commit
+        stages:
+          - commit-msg
         args:
-          - "--select=F"
-  # Python: reorder imports
-  - repo: https://github.com/asottile/reorder-python-imports
-    rev: v3.14.0
+          - change
+          - chore
+          - feat
+          - fix
+  # Python: lint and format code
+  # https://github.com/astral-sh/ruff-pre-commit
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.4
     hooks:
-      - id: reorder-python-imports
+      - id: ruff
         args:
-          - "--application-directories=.:src:tests"
-          - "--py37-plus"
-  # Python: lint with black
-  - repo: https://github.com/psf/black
-    rev: 24.10.0
-    hooks:
-      - id: black
+          - "--fix"
+          - "--exit-non-zero-on-fix"
+          - "--target-version=py312"
+          # https://docs.astral.sh/ruff/rules/
+          - "--select=F,E4,E7,E9,I,UP,B,N"
+          - "--config"
+          - "lint.isort.force-single-line=true"
+          - "--config"
+          - "format.docstring-code-format=true"
+      - id: ruff-format
         args:
-          - "--line-length=88"
-          - "--target-version=py37"
+          - "--target-version=py312"
+  # Python: check project (i.e. `pyproject.toml`)
+  # https://github.com/abravalheri/validate-pyproject
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.23
+    hooks:
+      - id: validate-pyproject

.pre-commit-config.yaml

@@ -1,117 +1,94 @@
 .PHONY: \
-	setup setup-venv setup-requirements setup-pre-commit \
-	clean full-clean upgrade \
-	lint audit \
-	all-tests unittests doctests coverage \
+	clean full-clean \
+	lint check fmt \
+	tests doctests coverage \
+	build publish \
 	change clog \
-	release build publish
-
-
-PYTHON_VERSION := $(shell cat runtime.txt)
-
-RELEASE_LEVELS := patch minor major
-
-
-# SETUP
-
-setup: setup-venv setup-requirements setup-pre-commit
-
-setup-venv: version ?= $(cat runtime.txt)
-setup-venv:
-	python$(PYTHON_VERSION) -m venv --clear --upgrade-deps .venv
-
-export PATH := $(shell pwd)/.venv/bin:$(PATH)
-
-setup-requirements: req ?= requirements.txt
-setup-requirements:
-	pip install --isolated --no-input --quiet -r '$(req)'
-
-setup-pre-commit:
-	pre-commit install --install-hooks
+	release
 
 clean:
 	rm -rf MANIFEST build dist
 
 full-clean: clean
-	rm -rf .venv .tox .nox .pytest_cache .mypy_cache .coverage*
-
-upgrade:
-	pip-compile \
-		--upgrade \
-		--no-header \
-		--strip-extras \
-		--annotation-style line \
-		--output-file requirements/constraints.txt \
-		setup.cfg \
-		requirements/*.in
-
+	rm -rf .venv .tox .nox .pytest_cache .mypy_cache .ruff_cache .coverage*
 
 # LINTING
 
 lint:
-	pre-commit run --all-files
+	hatch run lint:pc
 
-audit:
-	safety check --file requirements/constraints.txt
+check:
+	hatch run lint:check
 
+fix:
+	hatch run lint:fix
+	hatch run lint:upgrade
 
 # TESTS
 
-all-tests:
-	tox $(args)
+test:
+	hatch test
+
+coverage:
+	hatch test --cover
 
-doctests:
-	xdoctest --quiet wtforms_html5
+version-test:
+	hatch test --all --cover
 
-unittests:
-	python -m unittest discover
+doctest:
+	hatch test -- --xdoctest src/
 
-coverage:
-	coverage erase
-	coverage run -m unittest discover $(args)
-	coverage report
+# PACKAGING
+
+build: clean
+	hatch build --clean --target wheel
 
+publish: build
+	hatch publish
 
 # CHANGELOG
 
+CHANGE_TYPES := fix rm feat change
+
 change: issue ?= _$(shell < /dev/urandom tr -dc A-Za-z0-9 | head -c9)
-change: type ?= feature
 change: change_file := changes/$(issue).$(type).md
 change:
+ifneq ($(filter $(type),$(CHANGE_TYPES)),)
 	touch '$(change_file)'
 	$(EDITOR) '$(change_file)'
+else
+	@echo "Given change type '$(type)' is not a suported value: $(CHANGE_TYPES)"
+endif
 
 clog:
-	towncrier --draft --version=Unreleased
+	hatch run project:towncrier build --draft --version Unreleased
 
 
-# PACKAGING
+# RELEASE
+
+RELEASE_LEVELS := patch minor major
 
 release:
 ifneq ($(filter $(part),$(RELEASE_LEVELS)),)
-	$(eval version = $(shell \
-		.venv/bin/bumpversion --dry-run --allow-dirty --list $(part) \
-		| grep '^current_version=' \
-		| cut -d= -f2 \
-	))
-	$(eval new = $(shell \
-		.venv/bin/bumpversion --dry-run --allow-dirty --list $(part) \
-		| grep '^new_version=' \
-		| cut -d= -f2 \
+	# check git status
+	@if ! git diff-index --quiet HEAD; then \
+		echo "ERROR: git unclean!"; \
+		exit 1; \
+	fi
+	# get next version (for changelog)
+	$(eval new_version := $(shell \
+	  hatch run project:bumpver update --dry --$(part) 2>&1 \
+	  | grep 'New Version:' \
+	  | awk '{print $$NF}' \
 	))
-	@echo "bump $(part) -> $(version) => $(new)"
-	towncrier --yes --version '$(new)'
+	@echo "bump -> '$(new_version)'"
+	# write changelog
+	hatch run project:towncrier --yes --version '$(new_version)'
 	if ! git diff --staged --exit-code; then \
-		git commit -m ':memo: add CHANGELOG for $(new)' --no-verify; \
+		git commit -m ':memo: add CHANGELOG for `$(new_version)`' --no-verify; \
 	fi
-	bumpversion '$(part)' --commit-args='--no-verify'
+	# bump version
+	hatch run project:bumpver update '--$(part)'
 else
 	@echo "Given part '$(part)' is not a suported value: $(RELEASE_LEVELS)"
 endif
-
-build: clean
-	python -m build
-
-publish: build
-	python -m twine check dist/*
-	python -m twine upload dist/*