Update message displayed by pre-commit hook (#31)

A user suggested I add a message about stashing and commiting synced
changes separately

Author: George-Ogden

.github/workflows/lint.yaml

@@ -10,4 +10,4 @@ on:
 
 jobs:
   run-prek:
-    uses: George-Ogden/actions/.github/workflows/lint.yaml@v4.0.2
+    uses: George-Ogden/actions/.github/workflows/lint.yaml@v4.1.0

.github/workflows/readme-check.yaml

@@ -10,6 +10,6 @@ on:
 
 jobs:
   check-readme:
-    uses: George-Ogden/actions/.github/workflows/readme-check.yaml@v4.0.2
+    uses: George-Ogden/actions/.github/workflows/readme-check.yaml@v4.1.0
     with:
       prefix: "rev: v"

.github/workflows/release.yaml

@@ -11,7 +11,7 @@ permissions:
 
 jobs:
   tag-and-release:
-    uses: George-Ogden/actions/.github/workflows/python-release.yaml@v4.0.2
+    uses: George-Ogden/actions/.github/workflows/python-release.yaml@v4.1.0
     with:
       validation-code:
       validation-script: mirror sync

.github/workflows/test.yaml

@@ -10,7 +10,7 @@ on:
 
 jobs:
   run-pytest:
-    uses: George-Ogden/actions/.github/workflows/python-test.yaml@v4.0.2
+    uses: George-Ogden/actions/.github/workflows/python-test.yaml@v4.1.0
     with:
       python-versions: "['3.13']"
       pytest-flags: -vv -m "not local"

.gitignore

@@ -6,6 +6,7 @@ out.txt
 stderr.txt
 err.txt
 notes.txt
+refactor.list
 profile*.svg
 TODO
 *.pseudo
@@ -22,6 +23,9 @@ nohup*
 # Built Visual Studio Code Extensions
 *.vsix
 
+### PyCharm ###
+.idea/
+
 ### Python ###
 # Byte-compiled / optimized / DLL files
 __pycache__/

.mirror.lock

@@ -1,5 +1,5 @@
 # DANGER: EDIT AT YOUR OWN RISK. Track this file in version control so that others can sync files correctly.
-- commit: 92e853634a273b8e222ca470242ec1f4aa4022d0
+- commit: 9545249862376ee2534db54ad7f2b7d923938aff
   files:
   - .github/python-release.yaml
   - .github/python-test.yaml

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ ci:
 
 repos:
   - repo: https://github.com/George-Ogden/mirror-rorrim/
-    rev: v0.4.6
+    rev: v0.4.7
     hooks:
       - id: mirror-check
         fail_fast: true
@@ -24,7 +24,7 @@ repos:
       - id: requirements-txt-fixer
 
   - repo: https://github.com/George-Ogden/linter/
-    rev: v2.1.0
+    rev: v2.1.1
     hooks:
       - id: lint
         args: [--fix]
@@ -36,7 +36,7 @@ repos:
         args: [--severity=warning]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit/
-    rev: v0.15.4
+    rev: v0.15.5
     hooks:
       - id: ruff-check
         args: [--fix]
@@ -55,12 +55,12 @@ repos:
       - id: actionlint
 
   - repo: https://github.com/codespell-project/codespell/
-    rev: v2.4.1
+    rev: v2.4.2
     hooks:
       - id: codespell
 
   - repo: https://github.com/George-Ogden/pre-commit-hooks/
-    rev: v2.4.0
+    rev: v3.0.0
     hooks:
       - id: check-merge-conflict
         exclude: test_data/.*/snapshots/

README.md

@@ -145,7 +145,7 @@ If you use, `pre-commit`, consider adding this repo as a hook to check for updat
 
 ```yaml
 - repo: https://github.com/George-Ogden/mirror-rorrim/
-  rev: v0.4.7
+  rev: v0.4.8
   hooks:
     - id: mirror-check
 ```

mirror/main.py

@@ -121,7 +121,8 @@ def check(pre_commit: bool) -> ExitCode:
     checker = MirrorChecker(target=GitDir.cwd())
     if (return_value := checker.check()) and pre_commit:
         logger.critical(
-            f"{MIRROR_NAME} config files are not up to date; run `mirror sync` to update."
+            f"{MIRROR_NAME} config files are not up to date; run `mirror sync` to update.\n"
+            "(You may want to stash your changes and commit the sync separately.)"
         )
     return return_value
 

mirror/main_test.py

@@ -136,7 +136,9 @@ def remove_git_data(local: GitDir) -> None:
             # behind with pre-commit
             "check --pre-commit",
             1,
-            snapshot("Mirror|rorriM config files are not up to date; run `mirror sync` to update."),
+            snapshot(
+                "Mirror|rorriM config files are not up to date; run `mirror sync` to update.    (You may want to stash your changes and commit the sync separately.)"
+            ),
             "checker_tests/behind",
         ),
         # sync tests