Merge pull request #3126 from pre-commit/crlf-only-diff

asottile · web-flow · commit 92678c3fa2bb · 2024-02-10T14:10:29.000-05:00
staged_files_only can handle a crlf-only diff
diff --git a/pre_commit/staged_files_only.py b/pre_commit/staged_files_only.py
@@ -59,6 +59,11 @@ def _unstaged_changes_cleared(patch_dir: str) -> Generator[None, None, None]:
         # There weren't any staged files so we don't need to do anything
         # special
         yield
+    elif retcode == 1 and not diff_stdout.strip():
+        # due to behaviour (probably a bug?) in git with crlf endings and
+        # autocrlf set to either `true` or `input` sometimes git will refuse
+        # to show a crlf-only diff to us :(
+        yield
     elif retcode == 1 and diff_stdout.strip():
         patch_filename = f'patch{int(time.time())}-{os.getpid()}'
         patch_filename = os.path.join(patch_dir, patch_filename)
diff --git a/tests/staged_files_only_test.py b/tests/staged_files_only_test.py
@@ -358,6 +358,21 @@ def test_crlf(in_git_dir, patch_dir, crlf_before, crlf_after, autocrlf):
         assert_no_diff()
 
 
+@pytest.mark.parametrize('autocrlf', ('true', 'input'))
+def test_crlf_diff_only(in_git_dir, patch_dir, autocrlf):
+    # due to a quirk (?) in git -- a diff only in crlf does not show but
+    # still results in an exit code of `1`
+    # we treat this as "no diff" -- though ideally it would discard the diff
+    # while committing
+    cmd_output('git', 'config', '--local', 'core.autocrlf', autocrlf)
+
+    _write(b'1\r\n2\r\n3\r\n')
+    cmd_output('git', 'add', 'foo')
+    _write(b'1\n2\n3\n')
+    with staged_files_only(patch_dir):
+        pass
+
+
 def test_whitespace_errors(in_git_dir, patch_dir):
     cmd_output('git', 'config', '--local', 'apply.whitespace', 'error')
     test_crlf(in_git_dir, patch_dir, True, True, 'true')
