Merge pull request #40 from Jibola/add-precommit

PYTHON-4687: Adding precommit and linting to repo

Author: Jibola

.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: Pipeline Lint
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash -eux {0}
+
+jobs:
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Install Python dependencies
+        run: |
+          python -m pip install -U pip pre-commit
+      - name: Run linters
+        run: |
+          pre-commit run --hook-stage=manual --all-files

.pre-commit-config.yaml

@@ -0,0 +1,55 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-toml
+      - id: check-yaml
+        exclude: template.yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+        exclude: WHEEL
+        exclude_types: [json]
+      - id: forbid-new-submodules
+      - id: trailing-whitespace
+        exclude: .patch
+        exclude_types: [json]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.1.3
+    hooks:
+      - id: ruff
+        args: ["--fix", "--show-fixes"]
+      - id: ruff-format
+
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: "1.16.0"
+    hooks:
+      - id: blacken-docs
+        additional_dependencies:
+          - black==22.3.0
+
+  # We use the Python version instead of the original version which seems to require Docker
+  # https://github.com/koalaman/shellcheck-precommit
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.9.0.6
+    hooks:
+      - id: shellcheck
+        name: shellcheck
+        args: ["--severity=warning"]
+        stages: [manual]
+
+  - repo: https://github.com/sirosen/check-jsonschema
+    rev: 0.29.0
+    hooks:
+      - id: check-github-workflows
+      - id: check-github-actions
+      - id: check-jsonschema
+        files: .*/(database|indexes)/.json$
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: "v2.2.6"
+    hooks:
+      - id: codespell