Merge pull request #18 from George-Ogden/pre-commit

Pre Commit

Author: George-Ogden

.github/workflows/test.yaml

@@ -14,3 +14,13 @@ jobs:
     with:
       python-versions: "['3.13']"
       pytest-flags: -vv -m "not local"
+
+  readme-check:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Check version in README
+        run: |
+          grep -Fq --  "rev: v$(cat version.txt)" README.md

.pre-commit-hooks.yaml

@@ -0,0 +1,9 @@
+- id: mirror-check
+  name: mirror check
+  language: python
+  entry: mirror -q check
+  flags: [--pre-commit]
+  always_run: true
+  pass_filenames: false
+  require_serial: true
+  description: Mirror|rorriM

README.md

@@ -1,3 +1,80 @@
 # Mirror|rorriM
 
-Still under construction
+## Motivation
+
+How many Git repos do you have?
+I have over 100 (but most of them are stale).
+Even in the last two weeks (when this was made), I'd edited over 10 different ones.
+They also rely on multiple configuration files that I frequently update (see all the ones in the root of this repo).
+How do I manage them all?
+I mirror them from a centralized config repo (https://github.com/George-Ogden/config).
+
+## Usage
+
+You have the same problem? Just follow these three steps:
+
+0. Install from GitHub:
+
+```bash
+uv pip install git+https://github.com/George-Ogden/mirror-rorrim
+```
+
+(miss off the `uv` if you're still using `pip`).
+
+1. Make a configuration file called `.mirror.yaml` in the root of your repository (skip this step if you already have a config you want to use):
+
+```yaml
+repos:
+  - source: <location of config files> # anything you can git clone ...
+    files:
+      - mypy.ini # shorthand for mypy.ini: mypy.ini
+      - pytest.ini: pytest.ini # format is target: source
+      - ruff.toml
+
+    # add more sources in the same format to sync from multiple repos
+  - source: https://github.com/github/gitignore
+    files:
+      - .gitignore: Python.gitignore
+
+  - source: https://github.com/licenses/license-templates
+    files:
+      - LICENSE: templates/mit.txt
+```
+
+2. Install the mirror (make sure you've already run `git init`):
+
+```bash
+mirror install
+```
+
+For more advanced options, including using a remote config, see the help text:
+
+```bash
+mirror install --help
+```
+
+_After installing, it's a good idea to commit._
+
+3. Periodically, sync your config files:
+
+```bash
+mirror sync
+```
+
+Make updates in the repos you're syncing from.
+_You can still edit your local files manually, but you may need to resolve conflicts when you sync._
+
+### Pre-Commit
+
+If you use, `pre-commit`, consider adding this repo as a hook to check for updates:
+
+```yaml
+- repo: https://github.com/George-Ogden/mirror-rorrim/
+  rev: v0.4.0
+  hooks:
+    - id: mirror-check
+```
+
+## Contributing
+
+Use GitHub for bugs/feature requests.

mirror/logger.py

@@ -103,9 +103,9 @@ def log_level_name(quiet: int, verbose: int) -> str | int:
         case 2:
             return "TRACE"
         case n if n < 0:
-            return 0
-        case n if n > 0:
             return 50
+        case n if n > 0:
+            return 0
     raise TypeError()
 
 

mirror/logger_test.py

@@ -177,19 +177,19 @@ def log(x: int) -> int:
         # -vv
         (0, 2, "trace"),
         # -vvv
-        (0, 3, 50),
+        (0, 3, 0),
         # -vvvv
-        (0, 4, 50),
+        (0, 4, 0),
         # -q
         (1, 0, "warning"),
         # -qq
         (2, 0, "error"),
         # -qqq
         (3, 0, "critical"),
         # -qqqq
-        (4, 0, 0),
+        (4, 0, 50),
         # -qqqqq
-        (5, 0, 0),
+        (5, 0, 50),
         # mixed equally
         (1, 1, "info"),
         # mixed verbose

mirror/main.py

@@ -12,7 +12,7 @@
 from loguru import logger
 
 from .checker import MirrorChecker
-from .constants import MIRROR_FILE
+from .constants import MIRROR_FILE, MIRROR_NAME
 from .githelper import GitHelper
 from .installer import InstallSource, MirrorInstaller
 from .logger import ProgramState, setup_logger
@@ -106,9 +106,10 @@ def install(config_file: str, config_repo: str | None) -> None:
 
 
 @main.command()
+@click.option("--pre-commit", is_flag=True)
 @check_for_errors
 @ProgramState.record_command
-def check() -> ExitCode:
+def check(pre_commit: bool) -> ExitCode:
     """Check whether files from Mirror|rorriM are up to date with their remotes.
 
     \b
@@ -117,7 +118,11 @@ def check() -> ExitCode:
     mirror check
     """
     checker = MirrorChecker(target=GitDir.cwd())
-    return checker.check()
+    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."
+        )
+    return return_value
 
 
 @main.command()

mirror/main_test.py

@@ -93,6 +93,20 @@ def remove_git_data(local: GitDir) -> None:
             ),
             "installer_tests/existing_lock",
         ),
+        (
+            # overwrite local mirror file
+            "install --config-repo https://github.com/George-Ogden/mirror-rorrim-test-data --config-file config-only.yaml",
+            0,
+            snapshot("'.mirror.yaml' has been overwritten during installation."),
+            "installer_tests/remote_config_overwrite",
+        ),
+        (
+            # overwrite local mirror file with itself
+            "install",
+            0,
+            snapshot(""),
+            "installer_tests/remote_config_overwrite",
+        ),
         # check tests
         (
             # works fine
@@ -111,18 +125,11 @@ def remove_git_data(local: GitDir) -> None:
             remove_git_data,
         ),
         (
-            # overwrite local mirror file
-            "install --config-repo https://github.com/George-Ogden/mirror-rorrim-test-data --config-file config-only.yaml",
-            0,
-            snapshot("'.mirror.yaml' has been overwritten during installation."),
-            "installer_tests/remote_config_overwrite",
-        ),
-        (
-            # overwrite local mirror file with itself
-            "install",
-            0,
-            snapshot(""),
-            "installer_tests/remote_config_overwrite",
+            # behind with pre-commit
+            "check --pre-commit",
+            1,
+            snapshot("Mirror|rorriM config files are not up to date; run `mirror sync` to update."),
+            "checker_tests/behind",
         ),
         # sync tests
         (

version.txt

@@ -1 +1 @@
-0.3.1
+0.4.0