🧪 TESTS: Add pre-commit hook CI test

Author: chrisjsewell

.github/workflows/tests.yml

@@ -44,10 +44,37 @@ jobs:
     - name: Run pytest
       run: pytest
 
+  pre-commit-hook:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install tox
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+
+    - name: run initial
+      # the first run should populate the files with a non-zero exit code
+      continue-on-error: true
+      run: tox -e try-repo
+
+    - name: run secondary
+      # the second run should not change any files and exit cleanly
+      run: tox -e try-repo
+
   publish:
 
     name: Publish to PyPi
-    needs: [pre-commit, tests]
+    needs: [pre-commit, tests, pre-commit-hook]
     if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -129,3 +129,4 @@ dmypy.json
 .pyre/
 
 .vscode/
+tests/example_dist/

.pre-commit-hooks.yaml

@@ -5,5 +5,6 @@
     language: python
     language_version: python3
     require_serial: true
+    pass_filenames: false
     # types: [css, javascript, jinja2, json, scss, toml, yaml]
     types: [text]

README.md

@@ -33,13 +33,14 @@ Add to your `.pre-commit-config.yaml`
         args: [--config=config.yml]
         files: >-
             (?x)^(
+                web-compile-config.yml|
                 src/.*|
                 dist/.*
             )$
 ```
 
 By default, the hook will be initiated for all text file changes.
-But it is advisable to constrain this to the known input and output folders.
+But it is advisable to constrain this to the known configuration file, and input/output folders.
 
 ## Configuration
 
@@ -319,6 +320,12 @@ To test out the CLI:
 tox -e py37-cli
 ```
 
+To test the pre-commit hook:
+
+```console
+tox -e try-repo
+```
+
 For code style:
 
 ```console

web-compile-config.yml

@@ -18,8 +18,9 @@ web-compile:
       tests/example_src/example3.j2: tests/example_dist/example3.txt
     variables:
       a: b
-  exit_code: 2
-  verbose: false
+  exit_code: 3
+  verbose: true
   test_run: false
   continue_on_error: true
   quiet: false
+  git_add: false

web_compile/__init__.py

@@ -5,7 +5,6 @@
 import os
 from pathlib import Path
 import sys
-from typing import List
 
 import click
 from git import Repo, InvalidGitRepositoryError
@@ -110,7 +109,6 @@
 @QUIET
 @VERBOSE
 def run_compile(
-    files: List[str],
     config_path: Path,
     sass_files: dict,
     sass_format: str,