Merge pull request #1150 from GitGuardian/gg-hh/1143/husky_install

feat(install): allow to install hook locally with husky

Author: agateau-gg

changelog.d/20251114_husky_local_install.md

@@ -0,0 +1,3 @@
+### Fixed
+
+- Install `ggshield` hooks inside `.husky/` when the repository uses Husky-managed hooks so local installs work out of the box. (#1143)

ggshield/cmd/install.py

@@ -103,15 +103,52 @@ def get_global_hook_dir_path() -> Optional[Path]:
 def install_local(hook_type: str, force: bool, append: bool) -> int:
     """Local pre-commit/pre-push hook installation."""
     check_git_dir()
+    hook_dir_path = get_local_hook_dir_path()
     return create_hook(
-        hook_dir_path=Path(".git/hooks"),
+        hook_dir_path=hook_dir_path,
         force=force,
         local_hook_support=False,
         hook_type=hook_type,
         append=append,
     )
 
 
+def get_local_hook_dir_path() -> Path:
+    """
+    Return the directory where local hooks should be installed.
+
+    If core.hooksPath is configured, honor it and detect Husky-managed repositories
+    to avoid overwriting Husky's shim scripts.
+    """
+    hooks_path = get_git_local_hooks_path()
+    if hooks_path is None:
+        return Path(".git/hooks")
+
+    if is_husky_hooks_path(hooks_path):
+        return hooks_path.parent
+
+    return hooks_path
+
+
+def get_git_local_hooks_path() -> Optional[Path]:
+    """Return the hooks path defined in the repository config, if any."""
+    try:
+        out = git(
+            ["config", "--local", "--get", "core.hooksPath"], ignore_git_config=False
+        )
+    except subprocess.CalledProcessError:
+        return None
+    return Path(click.format_filename(out)).expanduser()
+
+
+def is_husky_hooks_path(path: Path) -> bool:
+    """Detect Husky-generated hooks directories (.husky/_)."""
+    try:
+        return path.name == "_" and path.parent.name == ".husky"
+    except IndexError:
+        return False
+
+
 def create_hook(
     hook_dir_path: Path,
     force: bool,

tests/unit/cmd/test_install.py

@@ -6,7 +6,7 @@
 from click.testing import CliRunner
 
 from ggshield.__main__ import cli
-from ggshield.cmd.install import get_default_global_hook_dir_path
+from ggshield.cmd.install import get_default_global_hook_dir_path, install_local
 from ggshield.core.errors import ExitCode
 from tests.unit.conftest import assert_invoke_exited_with, assert_invoke_ok
 
@@ -177,6 +177,39 @@ def test_prepush_install(
         assert f"pre-push successfully added in {hook_path}\n" in result.output
         assert_invoke_ok(result)
 
+    @patch("ggshield.cmd.install.check_git_dir")
+    @patch("ggshield.cmd.install.git")
+    def test_install_local_detects_husky(
+        self,
+        git_mock: Mock,
+        check_dir_mock: Mock,
+        cli_fs_runner: CliRunner,
+    ):
+        """
+        GIVEN a repository configured with Husky (.husky/_ directory as hooks path)
+        WHEN install_local is called
+        THEN it should create the hook in .husky/pre-commit instead of .git/hooks
+        """
+        husky_dir = Path(".husky")
+        husky_hooks_dir = husky_dir / "_"
+        husky_hooks_dir.mkdir(parents=True)
+
+        # Mock git to return .husky/_ as the local hooks path
+        git_mock.return_value = ".husky/_"
+
+        return_code = install_local(hook_type="pre-commit", force=False, append=False)
+
+        assert return_code == 0
+
+        # Hook should be in .husky/pre-commit, not .husky/_/pre-commit
+        husky_hook = husky_dir / "pre-commit"
+        assert husky_hook.is_file()
+        assert 'ggshield secret scan pre-commit "$@"' in husky_hook.read_text()
+
+        # Hook should NOT be in .git/hooks/pre-commit
+        default_hook = Path(".git/hooks/pre-commit")
+        assert not default_hook.exists()
+
 
 @pytest.fixture()
 def custom_global_git_config_path(tmp_path, monkeypatch):