fix: strip Git CRLF warning from output

iiroj · iiroj · commit 0109e8d15074 · 2026-03-09T23:33:49.000+02:00
diff --git a/.changeset/ninety-clubs-heal.md b/.changeset/ninety-clubs-heal.md
@@ -0,0 +1,5 @@
+---
+'lint-staged': patch
+---
+
+Make sure Git's warning about CRLF line-endings doesn't interfere with creating initial backup stash.
diff --git a/lib/execGit.js b/lib/execGit.js
@@ -4,6 +4,9 @@ import { createDebug } from './debug.js'
 
 const debugLog = createDebug('lint-staged:execGit')
 
+/** @example "warning: in the working copy of 'README.md', LF will be replaced by CRLF the next time Git touches it" */
+const GIT_CRLF_WARNING = /^warning.*CRLF.*the next time Git touches it/i
+
 /**
  * Explicitly never recurse commands into submodules, overriding local/global configuration.
  * @see https://git-scm.com/docs/git-config#Documentation/git-config.txt-submodulerecurse
@@ -25,6 +28,11 @@ export const execGit = async (cmd, options) => {
 
   let output = ''
   for await (const line of result) {
+    if (GIT_CRLF_WARNING.test(line)) {
+      debugLog('Stripped Git CRLF warning: %s', line)
+      continue
+    }
+
     output += line + '\n'
   }
   output = output.trimEnd()
diff --git a/test/unit/execGit.spec.js b/test/unit/execGit.spec.js
@@ -24,12 +24,28 @@ describe('execGit', () => {
 
   it('should execute git in a given working copy', async ({ expect }) => {
     const cwd = path.join(process.cwd(), 'test', '__fixtures__')
-    await execGit(['init', 'param'], { cwd })
+    const output = await execGit(['init', 'param'], { cwd })
     expect(exec).toHaveBeenCalledExactlyOnceWith('git', [...GIT_GLOBAL_OPTIONS, 'init', 'param'], {
       nodeOptions: {
         cwd,
         stdio: ['ignore'],
       },
     })
+
+    expect(output).toBe('test')
+  })
+
+  it('should strip Git CRLF warning from start of output', async ({ expect }) => {
+    vi.mocked(exec).mockReturnValueOnce({
+      async *[Symbol.asyncIterator]() {
+        yield "warning: in the working copy of 'README.md', LF will be replaced by CRLF the next time Git touches it"
+        yield "warning: in the working copy of 'package.json', LF will be replaced by CRLF the next time Git touches it"
+        yield '09756bc72fde5a4c77ff788ad49fa1c1111a8527'
+      },
+    })
+
+    const output = await execGit(['stash', 'create'])
+
+    expect(output).toBe('09756bc72fde5a4c77ff788ad49fa1c1111a8527')
   })
 })

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'lint-staged': patch
 +---
++
 +Make sure Git's warning about CRLF line-endings doesn't interfere with creating initial backup stash.