Merge pull request #1967 from vkomarov-r7/feature/directory-hooks

Add the ability to restrict which directories isort works against

Author: timothycrosley

isort/hooks.py

@@ -6,7 +6,7 @@
 import os
 import subprocess  # nosec - Needed for hook
 from pathlib import Path
-from typing import List
+from typing import List, Optional
 
 from isort import Config, api, exceptions
 
@@ -32,7 +32,8 @@ def get_lines(command: List[str]) -> List[str]:
 
 
 def git_hook(
-    strict: bool = False, modify: bool = False, lazy: bool = False, settings_file: str = ""
+    strict: bool = False, modify: bool = False, lazy: bool = False, settings_file: str = "",
+    directories: Optional[List[str]] = None,
 ) -> int:
     """Git pre-commit hook to check staged files for isort errors
 
@@ -50,13 +51,16 @@ def git_hook(
         When settings_file is the empty string, the configuration file
         will be searched starting at the directory containing the first
         staged file, if any, and going upward in the directory structure.
+    :param list[str] directories - A list of directories to restrict the hook to.
 
     :return number of errors if in strict mode, 0 otherwise.
     """
     # Get list of files modified and staged
     diff_cmd = ["git", "diff-index", "--cached", "--name-only", "--diff-filter=ACMRTUXB", "HEAD"]
     if lazy:
         diff_cmd.remove("--cached")
+    if directories:
+        diff_cmd.extend(directories)
 
     files_modified = get_lines(diff_cmd)
     if not files_modified: