Process files from a list, or just README.md or README

Cache based on uv changes
Remove unnecessary verbosity from Junie guidelines

Author: andrewaylett

.github/workflows/pre-commit.yml

@@ -19,6 +19,7 @@ jobs:
       with:
         cache: pip
         python-version-file: .python-version
+        cache-dependency-path: uv.lock
     - uses: andrewaylett/pre-commit-action@c42755522779836e1cb55c8c3d1fa3b4f69167d4 # v4
     - name: Install the latest version of uv
       uses: astral-sh/setup-uv@bd01e18f51369d5a26f1651c3cb451d3417e3bba # v6

.junie/guidelines.md

@@ -26,50 +26,6 @@ The project uses pytest for testing. To run all tests:
 uv run pytest
 ```
 
-To run a specific test file:
-
-```bash
-uv run pytest tests/test_file.py
-```
-
-To run tests with verbose output:
-
-```bash
-uv run pytest -v
-```
-
-### Adding New Tests
-
-1. Create a new test file in the `tests/` directory with a name starting with `test_`.
-2. Import pytest and the modules you want to test.
-3. Write test functions with names starting with `test_`.
-
-#### Example Test with Cog
-
-Here's an example of a test that uses cog to generate code:
-
-```python
-"""Example test file to demonstrate testing with cog."""
-
-import pytest
-
-def example_function_with_cog():
-    """Example function with cog-generated content."""
-    # [[[cog
-    # import cog
-    # numbers = [1, 2, 3, 4, 5]
-    # cog.outl("    result = sum([" + ", ".join(str(n) for n in numbers) + "])")
-    # ]]]
-    result = sum([1, 2, 3, 4, 5])
-    # [[[end]]]
-    return result
-
-def test_example_function_with_cog():
-    """Test that the example function returns the expected value."""
-    result = example_function_with_cog()
-    assert result == 15
-```
-
 ## Additional Development Information
 
 ### How Cog Works

.pre-commit-config.yaml

@@ -47,3 +47,7 @@ repos:
   rev: 0.7.16
   hooks:
   - id: uv-lock
+#- repo: https://github.com/andrewaylett/pre-commit-hooks
+#  rev: v0.1.0
+#  hooks:
+#  - id: cog

README.md

@@ -1,46 +1,41 @@
 # Runs Cog as a pre-commit hook
 
-Rather than adding a local pre-commit hook to each of your repositories:
-
-```yaml
+Add this repo to your `.pre-commit-config.yaml`:
+
+<!-- [[[cog
+result = sp.run(
+    ["git", "describe", "--tags"],
+    capture_output=True,
+    text=True,
+    check=True
+)
+version = result.stdout.strip().split('-')[0]
+cog.outl(f"""```yaml
 repos:
-- repo: local
+- repo: https://github.com/andrewaylett/pre-commit-hooks
+  rev: {version}
   hooks:
-  - # https://github.com/nedbat/cog/issues/21#issuecomment-1919626992
-    id: cog
-    name: cog (regenerate files)
-    language: python
-    additional_dependencies:
-    - cogapp
-    entry: bash -c 'git grep -lzF "[[[""cog" | xargs -0 cog -r -c -p "import subprocess as sp, re, os, sys, pathlib as pl, cog" "$@"'
-    pass_filenames: false
-    always_run: true
-```
-
-We can use this repo to do the same thing:
-
+    - id: cog
+```""")
+]]] -->
 ```yaml
 repos:
 - repo: https://github.com/andrewaylett/pre-commit-hooks
+  rev: v0.1.0
   hooks:
     - id: cog
 ```
+<!-- [[[end]]] -->
 
 ## Development
 
 ### Running Tests
 
 This project uses pytest for testing. To run the tests:
 
-1. Install development dependencies:
-   ```bash
-   uv pip install -e ".[dev]"
-   ```
-
-2. Run the tests:
-   ```bash
-   uv run pytest
-   ```
+```bash
+uv run pytest
+```
 
 The test suite includes:
 - Tests for the pre-commit hook functionality

pyproject.toml

@@ -1,5 +1,5 @@
 [project]
-name = "pre-commit-hooks"
+name = "andrewaylett-pre-commit-hooks"
 version = "0.1.0"
 description = "Andrew's pre-commit hooks"
 readme = "README.md"
@@ -9,7 +9,6 @@ authors = [
 requires-python = ">=3.13"
 dependencies = [
   "cogapp>=3.5.1",
-  "python-ripgrep>=0.0.8",
 ]
 
 [dependency-groups]
@@ -42,7 +41,7 @@ testpaths = ["tests"]
 python_files = "test_*.py"
 
 [project.scripts]
-pre-commit-cog = "pre_commit_hooks.cog:main"
+pre-commit-cog = "andrewaylett_pre_commit_hooks.cog:main"
 
 [build-system]
 requires = ["hatchling"]

src/pre_commit_hooks/__init__.py …ndrewaylett_pre_commit_hooks/__init__.pysrc/pre_commit_hooks/__init__.py renamed to src/andrewaylett_pre_commit_hooks/__init__.py src/pre_commit_hooks/__init__.py renamed to src/andrewaylett_pre_commit_hooks/__init__.py

@@ -0,0 +1,99 @@
+import os
+import sys
+
+from cogapp import Cog
+
+
+def find_cog_files() -> set[str]:
+    """Find files to process with cog.
+
+    Looks for the first file that exists of `.cogfiles`, `README.md` or `README`.
+    - If `.cogfiles` exists, use it as a list of files to check
+    - If a README file exists, process just that file
+    - If neither exists, exit with an error
+    """
+    try:
+        # Check for .cogfiles first
+        if os.path.exists(".cogfiles"):
+            print("Using .cogfiles to determine which files to process")
+            with open(".cogfiles") as f:
+                # Read the file list, strip whitespace, and filter out empty lines
+                files = {line.strip() for line in f if line.strip()}
+            if not files:
+                print("Error: .cogfiles exists but is empty", file=sys.stderr)
+                sys.exit(1)
+            return files
+
+        # Check for README.md next
+        elif os.path.exists("README.md"):
+            print("Processing README.md")
+            return {"README.md"}
+
+        # Check for README last
+        elif os.path.exists("README"):
+            print("Processing README")
+            return {"README"}
+
+        # If none of the files exist, exit with an error
+        else:
+            print(
+                "Error: Could not find .cogfiles, README.md, or README", file=sys.stderr
+            )
+            sys.exit(1)
+
+    except Exception as e:
+        print(f"Error finding cog files: {e}", file=sys.stderr)
+        sys.exit(1)
+
+
+def run_cog_on_files(files: set[str]) -> bool:
+    """Run cog on the specified files.
+
+    Returns True if all files were processed successfully, False otherwise.
+    """
+    if not files:
+        print("No files with cog markers found.")
+        return True
+
+    print(f"Running cog on {len(files)} files...")
+    success = True
+
+    # Create a Cog instance with the appropriate options
+    cog_instance = Cog()
+
+    # Set options equivalent to command-line flags
+    cog_instance.options.replace = True  # -r: replace in-place
+    cog_instance.options.checksum = True  # -c: checksum
+    cog_instance.options.verbosity = 3
+
+    # Add imports to globals (equivalent to -p option)
+    cog_instance.options.defines = {
+        "subprocess": __import__("subprocess"),
+        "sp": __import__("subprocess"),
+        "re": __import__("re"),
+        "os": __import__("os"),
+        "sys": __import__("sys"),
+        "pathlib": __import__("pathlib"),
+        "pl": __import__("pathlib"),
+        "cog": __import__("cogapp.cogapp"),
+    }
+
+    for file in files:
+        try:
+            # Process the content using process_string
+            cog_instance.process_one_file(file)
+
+        except Exception as e:
+            print(f"Error processing {file}: {e}", file=sys.stderr)
+            success = False
+
+    return success
+
+
+def main() -> None:
+    """Find files with cog markers and run cog on them."""
+    files = find_cog_files()
+    success = run_cog_on_files(files)
+
+    if not success:
+        sys.exit(1)

src/andrewaylett_pre_commit_hooks/cog.py

@@ -22,15 +22,15 @@ def cog_content():
 
 def example_function():
     """Example function with cog-generated content."""
-    # [[[cog
+    # [ [ [cog
     # import cog
     # cog.outl("    print('This content was generated by cog!')")
     # ]]]
     # Content will be generated here
     # [[[end]]]
 
     return "Hello, world!"
-'''
+'''.replace("[ [ [", "[[[")
 
 
 @pytest.fixture