Merge pull request #78 from akhundMurad/core/33

chore(pre-commit): add pre-commit hooks and cleanup Makefile

Author: akhundMurad

.github/workflows/pr.yml

@@ -34,7 +34,7 @@ jobs:
 
       - name: Run linters
         run: |
-          make check-linting
+          make lint
 
   test:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+repos:
+  # ---------------------------------------------------------------------------
+  # Lint: Ruff + Black + mypy
+  # ---------------------------------------------------------------------------
+  - repo: local
+    hooks:
+      - id: lint
+        name: lint
+        entry: make lint
+        language: system
+        pass_filenames: false
+        stages: [pre-commit]
+
+  # ---------------------------------------------------------------------------
+  # Run tests: fast feedback on commits
+  # ---------------------------------------------------------------------------
+  - repo: local
+    hooks:
+      - id: test
+        name: test
+        entry: make test
+        language: system
+        pass_filenames: false
+        stages: [pre-commit]
+
+  # ---------------------------------------------------------------------------
+  # Run documentation tests: fast feedback on commits
+  # ---------------------------------------------------------------------------
+  - repo: local
+    hooks:
+      - id: test-docs
+        name: test-docs
+        entry: make test-docs
+        language: system
+        pass_filenames: false
+        stages: [pre-commit]

CONTRIBUTING.md

@@ -48,14 +48,18 @@ uv --version
 Create and sync the virtual environment (including dev dependencies):
 
 ```bash
-uv sync --all-groups
+uv sync --all-groups --all-extras
+
+uv run pre-commit install
 ```
 
 This will:
 
 - create a local `.venv/`
 - install dependencies according to `uv.lock`
 - keep the environment reproducible
+- setup pre-commit hooks
+
 
 ## Running tests
 
@@ -141,13 +145,13 @@ We use:
 Run all linters:
 
 ```bash
-make check-linting
+make lint
 ```
 
 Auto-fix formatting where possible:
 
 ```bash
-make fix-linting
+make lint-fix
 ```
 
 ## Building the package

Makefile

@@ -1,32 +1,81 @@
-check-linting:
-	uv run ruff check typeid/ tests/
-	uv run black --check --diff typeid/ tests/ --line-length 119
-	uv run mypy typeid/ --pretty
+# ==============================================================================
+# Project configuration
+# ==============================================================================
 
+PACKAGE      := typeid
+TESTS        := tests
+DIST_DIR     := dist
+VENV_DIR     := .venv
 
-fix-linting:
-	uv run ruff check --fix typeid/ tests/
-	uv run black typeid/ tests/ --line-length 119
+UV           := uv run
+PYTEST       := $(UV) pytest
+RUFF         := $(UV) ruff
+BLACK        := $(UV) black
+MYPY         := $(UV) mypy
 
+# ==============================================================================
+# Phony targets
+# ==============================================================================
 
-.PHONY: build-sdist
-build-sdist:
-	@rm -rf dist build *.egg-info .venv
-	@uv build --sdist -o dist
-	@ls -la dist
+.PHONY: help lint lint-fix test test-docs docs docs-build build-sdist clean
 
+# ==============================================================================
+# Help
+# ==============================================================================
 
-test:
-	uv run pytest -v
+help:
+	@echo "Available targets:"
+	@echo ""
+	@echo "  lint         Run all linters (ruff, black, mypy)"
+	@echo "  lint-fix     Automatically fix linting issues"
+	@echo "  test         Run test suite"
+	@echo "  test-docs    Run documentation tests"
+	@echo "  docs         Serve documentation locally"
+	@echo "  docs-build   Build documentation"
+	@echo "  build-sdist  Build source distribution"
+	@echo "  clean        Remove build artifacts"
+	@echo ""
+
+# ==============================================================================
+# Linting
+# ==============================================================================
+
+lint:
+	$(RUFF) check $(PACKAGE)/ $(TESTS)/
+	$(BLACK) --check --diff $(PACKAGE)/ $(TESTS)/
+	$(MYPY) $(PACKAGE)/
+
+lint-fix:
+	$(RUFF) check --fix $(PACKAGE)/ $(TESTS)/
+	$(BLACK) $(PACKAGE)/ $(TESTS)/
+
+# ==============================================================================
+# Testing
+# ==============================================================================
 
+test:
+	$(PYTEST) -v $(TESTS)
 
 test-docs:
-	uv run pytest README.md docs/ --markdown-docs
+	$(PYTEST) README.md docs/ --markdown-docs
 
+# ==============================================================================
+# Documentation
+# ==============================================================================
 
 docs:
 	mkdocs serve
 
-
-docs-build: 
+docs-build:
 	mkdocs build
+
+# ==============================================================================
+# Build & cleanup
+# ==============================================================================
+
+build-sdist: clean
+	@uv build --sdist -o $(DIST_DIR)
+	@ls -la $(DIST_DIR)
+
+clean:
+	@rm -rf $(DIST_DIR) build *.egg-info $(VENV_DIR)

pyproject.toml

@@ -49,8 +49,19 @@ dev = [
   "pytest-markdown-docs>=0.9.0",
   "pytest-benchmark>=5.0.1",
   "maturin>=1.5; platform_system != 'Windows'",
+  "pre-commit>=4.5.1",
 ]
 
+[tool.black]
+line-length = 119
+
+[tool.ruff]
+line-length = 119
+target-version = "py311"
+
+[tool.mypy]
+pretty = true
+
 [build-system]
 requires = ["maturin>=1.5"]
 build-backend = "maturin"