Support workdir - experiment

sterliakov · sterliakov · commit 72c59b3fa925 · 2024-10-18T19:06:08.000+02:00
diff --git a/README.md b/README.md
@@ -1,8 +1,40 @@
-[![build status](https://github.com/pre-commit/pre-commit/actions/workflows/main.yml/badge.svg)](https://github.com/pre-commit/pre-commit/actions/workflows/main.yml)
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pre-commit/pre-commit/main.svg)](https://results.pre-commit.ci/latest/github/pre-commit/pre-commit/main)
+A fork of [pre-commit](https://pre-commit.com/) with experimental `workdir` setting support.
 
-## pre-commit
+Using this fork, you can configure some hooks to run "as-if" the selected subfolders were in repository root.
 
-A framework for managing and maintaining multi-language pre-commit hooks.
+E.g., with the following directory structure:
 
-For more information see: https://pre-commit.com/
+```
+.
+├── .git
+├── backend
+│   ├── pyproject.toml
+│   └── uv.lock
+├── frontend
+│   ├── package.json
+│   ├── pnpm-lock.yaml
+│   ├── biome.jsonc
+│   ├── src
+│   ├── tsconfig.json
+│   └── vite.config.js
+└── .pre-commig-config.yaml
+```
+
+the following file will find backend-related and frontend-related files correctly:
+
+```yaml
+repos:
+-   repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.4.24
+    hooks:
+    -   id: uv-lock
+        workdir: backend
+
+-   repo: https://github.com/biomejs/pre-commit
+    rev: "v0.5.0"
+    hooks:
+    -   id: biome-check
+        additional_dependencies: ["@biomejs/biome"]
+        language_version: "20.18.0"
+        workdir: frontend
+```
diff --git a/pre_commit/clientlib.py b/pre_commit/clientlib.py
@@ -219,6 +219,7 @@ def remove_default(self, dct: dict[str, Any]) -> None:
     cfgv.Optional('fail_fast', cfgv.check_bool, False),
     cfgv.Optional('pass_filenames', cfgv.check_bool, True),
     cfgv.Optional('description', cfgv.check_string, ''),
+    cfgv.Optional('workdir', cfgv.check_string, ''),
     cfgv.Optional('language_version', cfgv.check_string, C.DEFAULT),
     cfgv.Optional('log_file', cfgv.check_string, ''),
     cfgv.Optional('require_serial', cfgv.check_bool, False),
diff --git a/pre_commit/commands/run.py b/pre_commit/commands/run.py
@@ -13,6 +13,7 @@
 from collections.abc import Iterable
 from collections.abc import MutableMapping
 from collections.abc import Sequence
+from pathlib import Path
 from typing import Any
 
 from identify.identify import tags_from_path
@@ -27,6 +28,7 @@
 from pre_commit.repository import install_hook_envs
 from pre_commit.staged_files_only import staged_files_only
 from pre_commit.store import Store
+from pre_commit.util import chdir_context
 from pre_commit.util import cmd_output_b
 
 
@@ -61,12 +63,21 @@ def filter_by_include_exclude(
         names: Iterable[str],
         include: str,
         exclude: str,
+        workdir: str = '',
 ) -> Generator[str]:
     include_re, exclude_re = re.compile(include), re.compile(exclude)
+    if not workdir:
+        return (
+            filename for filename in names
+            if include_re.search(filename)
+            if not exclude_re.search(filename)
+        )
     return (
-        filename for filename in names
-        if include_re.search(filename)
-        if not exclude_re.search(filename)
+        str(filename)
+        for filename in map(Path, names)
+        if filename.is_relative_to(workdir) and
+        include_re.search(str(filename.relative_to(workdir))) and
+        not exclude_re.search(str(filename.relative_to(workdir)))
     )
 
 
@@ -103,6 +114,7 @@ def filenames_for_hook(self, hook: Hook) -> Generator[str]:
                 self.filenames,
                 hook.files,
                 hook.exclude,
+                hook.workdir,
             ),
             hook.types,
             hook.types_or,
@@ -189,7 +201,16 @@ def _run_single_hook(
             filenames = ()
         time_before = time.monotonic()
         language = languages[hook.language]
-        with language.in_env(hook.prefix, hook.language_version):
+        with contextlib.ExitStack() as stack:
+            stack.enter_context(
+                language.in_env(hook.prefix, hook.language_version),
+            )
+            if hook.workdir:
+                stack.enter_context(chdir_context(hook.workdir))
+                filenames = tuple(
+                    str(Path(filename).relative_to(hook.workdir))
+                    for filename in filenames
+                )
             retcode, out = language.run_hook(
                 hook.prefix,
                 hook.entry,
diff --git a/pre_commit/hook.py b/pre_commit/hook.py
@@ -29,6 +29,7 @@ class Hook(NamedTuple):
     fail_fast: bool
     pass_filenames: bool
     description: str
+    workdir: str
     language_version: str
     log_file: str
     minimum_pre_commit_version: str
diff --git a/pre_commit/util.py b/pre_commit/util.py
@@ -16,6 +16,19 @@
 from pre_commit import parse_shebang
 
 
+if sys.version_info >= (3, 11, 0):
+    from contextlib import chdir as chdir_context
+else:
+    @contextlib.contextmanager  # type: ignore[no-redef]
+    def chdir_context(target: str) -> Generator[None]:
+        cwd = os.getcwd()
+        os.chdir(target)
+        try:
+            yield
+        finally:
+            os.chdir(cwd)
+
+
 def force_bytes(exc: Any) -> bytes:
     with contextlib.suppress(TypeError):
         return bytes(exc)
diff --git a/tests/repository_test.py b/tests/repository_test.py
@@ -426,6 +426,7 @@ def test_manifest_hooks(tempdir_factory, store):
         always_run=False,
         args=[],
         description='',
+        workdir='',
         entry='bin/hook.sh',
         exclude='^$',
         exclude_types=[],
