add a basic pre-commit config

Author: adehad

Diff for: .pre-commit-config.yaml

@@ -0,0 +1,52 @@
+---
+repos:
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+        language_version: python3
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: check-byte-order-marker
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-vcs-permalinks
+      - id: debug-statements
+      - id: check-yaml
+        files: .*\.(yaml|yml)$
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+      - id: codespell
+        name: codespell
+        description: Checks for common misspellings in text files.
+        entry: codespell
+        language: python
+        types: [text]
+        args: []
+        require_serial: false
+        additional_dependencies: []
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.0.270"
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.31.0
+    hooks:
+      - id: yamllint
+        files: \.(yaml|yml)$
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.3.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - types-requests
+          - types-pkg_resources
+        args:
+          [--no-strict-optional, --ignore-missing-imports, --show-error-codes]

Diff for: Makefile

@@ -1,4 +1,4 @@
-.PHONY: compile debug test quicktest clean all gen-errors gen-types _touch
+.PHONY: compile debug lint test quicktest clean all gen-errors gen-types _touch
 
 
 PYTHON ?= python
@@ -51,6 +51,10 @@ debug: _touch
 	EDGEDB_DEBUG=1 $(PYTHON) setup.py build_ext --inplace
 
 
+lint:
+	$(PYTHON) -m pip install pre-commit
+	pre-commit run --all-files
+
 test:
 	PYTHONASYNCIODEBUG=1 $(PYTHON) setup.py test
 	$(PYTHON) setup.py test

Diff for: pyproject.toml

@@ -1,3 +1,54 @@
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
+
+
+########################################################################################
+# External Tool Config
+########################################################################################
+[tool.mypy]
+python_version = 3.8
+warn_unused_configs = true
+namespace_packages = true
+# plugins = "pydantic.mypy"
+
+[tool.ruff]
+select = [
+    "E", # pydocstyle
+    "W", # pydocstyle
+    "F", # pyflakes
+    "I", # isort
+    "UP", # pyupgrade
+    "D", # docstrings
+    "RUF", # ruff
+]
+ignore = [
+    "D100", # Missing docstring in public module
+    "D101", # Missing docstring in public class
+    "D102", # Missing docstring in public method
+    "D103", # Missing docstring in public function
+    "D104", # Missing docstring in public package
+    "D107", # Missing docstring in `__init__`
+    "D105", # Missing docstring in magic method
+    "D205" # 1 blank line required between summary line and description
+]
+
+# Same as Black.
+line-length = 88
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+# Assume Python 3.8. (minimum supported)
+target-version = "py38"
+
+# The source code paths to consider, e.g., when resolving first- vs. third-party imports
+src = ["edgedb", "tests"]
+
+[tool.ruff.isort]
+known-first-party = ["edgedb", "tests"]
+required-imports = ["from __future__ import annotations"]
+
+[tool.ruff.pydocstyle]
+# Use Google-style docstrings.
+convention = "google"

Diff for: tests/ruff.toml

@@ -0,0 +1 @@
+ignore = ["D101", "D102"]