add pre-commit checks

.github/workflows/conda_unit_test.yml

@@ -16,35 +16,35 @@ defaults:
 
 jobs:
 
-  lint:
-    name: Code style
-    runs-on: ubuntu-latest
+  # lint:
+  #   name: Code style
+  #   runs-on: ubuntu-latest
 
-    steps:
-      - uses: actions/checkout@v4
+  #   steps:
+  #     - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
-        with:
-          python-version: '3.11'
+  #     - uses: actions/setup-python@v4
+  #       with:
+  #         python-version: '3.11'
 
-      - name: Install Dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install flake8
+  #     - name: Install Dependencies
+  #       run: |
+  #         python -m pip install --upgrade pip
+  #         pip install flake8
 
-      - name: Run flake8
-        run: |
-          flake8
+  #     - name: Run flake8
+  #       run: |
+  #         flake8
 
-      - name: Run black
-        uses: rickstaa/action-black@v1
-        with:
-          black_args: ". --check"
+  #     - name: Run black
+  #       uses: rickstaa/action-black@v1
+  #       with:
+  #         black_args: ". --check"
 
-  build:
+  testing:
 
     runs-on: ubuntu-latest
-    needs: lint
+    # needs: lint
     strategy:
       matrix:
         python-version:

.github/workflows/pre-commit.yml

@@ -0,0 +1,21 @@
+name: pre-commit
+
+# from: https://github.com/NSLS-II/scientific-python-cookiecutter/ ... /.github/workflows/pre-commit.yml
+
+on:
+  pull_request:
+  push:
+  workflow_dispatch:
+
+jobs:
+  pre-commit:
+    # pull requests are a duplicate of a branch push if within the same repo.
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+      - uses: pre-commit/[email protected]
+        with:
+          extra_args: --all-files

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+ci:
+  default_language_version: python3.11
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    - id: check-added-large-files
+    - id: check-ast
+    - id: check-case-conflict
+    - id: check-merge-conflict
+    - id: check-symlinks
+    - id: check-yaml
+    - id: check-json
+    - id: debug-statements
+    - id: check-executables-have-shebangs
+    - id: mixed-line-ending
+    # - id: end-of-file-fixer
+    # - id: trailing-whitespace
+
+# -   repo: https://github.com/pycqa/flake8
+#     rev: 4.0.1
+#     hooks:
+#     -   id: flake8
+
+# -   repo: https://github.com/timothycrosley/isort
+#     rev: 5.12.0
+#     hooks:
+#     -   id: isort
+
+# -   repo: https://github.com/psf/black
+#     rev: 22.8.0
+#     hooks:
+#     -   id: black