chore: add pre-commit basic checks

Signed-off-by: Henry Schreiner <[email protected]>

.github/workflows/mypy.yml

@@ -1,11 +1,19 @@
 name: Python type check
 on: [push, pull_request]
 jobs:
-  build:
+  type:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
       - name: Lint with mypy
         run: pipx run tox -e type
+
+  pre-commit:
+    name: Format
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+# To use:
+#
+#     pre-commit run -a
+#
+# Or:
+#
+#     pre-commit install  # (runs every time you commit in git)
+#
+# To update this file:
+#
+#     pre-commit autoupdate
+#
+# See https://github.com/pre-commit/pre-commit
+
+repos:
+# Standard hooks
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: "v4.2.0"
+  hooks:
+    - id: check-added-large-files
+    - id: check-case-conflict
+    - id: check-merge-conflict
+    - id: check-symlinks
+    - id: check-toml
+    - id: check-yaml
+    - id: debug-statements
+    - id: end-of-file-fixer
+      exclude: '(^tests/.*\.lark|\.svg)$'
+    - id: mixed-line-ending
+    - id: requirements-txt-fixer
+    - id: trailing-whitespace
+      exclude: '(^tests/.*\.lark|\.svg)$'

docs/requirements.txt

@@ -1,6 +1,6 @@
 # https://docs.readthedocs.io/en/stable/guides/specifying-dependencies.html#specifying-a-requirements-file
+pillow
+recommonmark
 sphinx-gallery
 sphinx_markdown_tables
-recommonmark
 sphinx_rtd_theme
-pillow

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py36, py37, py38, py39, py310, pypy3, type
+envlist = lint, type, py36, py37, py38, py39, py310, pypy3
 skip_missing_interpreters = true
 
 [testenv]
@@ -28,3 +28,12 @@ deps =
     rich
 commands =
     mypy
+
+[testenv:lint]
+description = run linters on code base
+skip_install = true
+recreate = false
+deps =
+    pre-commit
+commands =
+    pre-commit run --all-files --show-diff-on-failure