lint-staged 15.5.0 → 15.5.1

package/lib/getDiffCommand.js

@@ -1,4 +1,5 @@
-export function getDiffCommand(diff, diffFilter) {
+/** @type {(diff?: string, diffFilter?: string) => string[]} */
+export const getDiffCommand = (diff, diffFilter) => {
   /**
    *  Docs for --diff-filter option:
    * @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203
@@ -12,7 +13,7 @@ export function getDiffCommand(diff, diffFilter) {
    * Docs for -z option:
    * @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt--z
    */
-  const diffCommand = ['diff', '--name-only', '-z', `--diff-filter=${diffFilterArg}`, ...diffArgs]
+  const diffCommand = ['diff', `--diff-filter=${diffFilterArg}`, ...diffArgs]
 
   return diffCommand
 }

package/lib/getStagedFiles.js

@@ -5,21 +5,51 @@ import { getDiffCommand } from './getDiffCommand.js'
 import { normalizePath } from './normalizePath.js'
 import { parseGitZOutput } from './parseGitZOutput.js'
 
-const listSubmoduleRoots = async ({ cwd }) => {
-  const lines = await execGit(['submodule', '--quiet', 'foreach', 'echo $displaypath'], { cwd })
-  return lines.split('\n').map((file) => normalizePath(path.resolve(cwd, file)))
-}
-
 export const getStagedFiles = async ({ cwd = process.cwd(), diff, diffFilter } = {}) => {
   try {
-    const lines = await execGit(getDiffCommand(diff, diffFilter), { cwd })
-    if (!lines) return []
+    /**
+     * With the raw output lines look like:
+     *
+     * :000000 100644 0000000 780ccd3\u0000A\u0000.gitmodules\u0000
+     * :000000 160000 0000000 1bb568e\u0000A\u0000submodule\u0000
+     *
+     * @see https://git-scm.com/docs/git-diff#_raw_output_format
+     */
+    const output = await execGit([...getDiffCommand(diff, diffFilter), '--raw', '-z'], { cwd })
+
+    if (!output) return []
+
+    /**
+     * Split from all colons and remove the first one, after which lines will look like:
+     *
+     * 000000 100644 0000000 780ccd3 A\u0000.gitmodules\u0000
+     * 000000 160000 0000000 47e5cff A\u0000submodule\u0000
+     *
+     * where '\u0000' is the NUL character from '-z' option. After that we
+     * parse the lines by splitting from NUL, and then split the first
+     * part from space. This yields us enough info both filter out submodule
+     * roots and get the filename.
+     */
+    return output
+      .split(':')
+      .slice(1)
+      .map(parseGitZOutput)
+      .flatMap(([info, src, dst]) => {
+        const [, dstMode, , , ,] = info.split(' ')
+
+        /**
+         * Filter out submodule root directory. "160000" is the object mode for submodules.
+         * @see https://github.com/git/git/blob/485f5f863615e670fd97ae40af744e14072cfe18/object.h#L114-L120
+         */
+        if (dstMode === '160000') {
+          return []
+        }
 
-    const submodules = await listSubmoduleRoots({ cwd })
+        /** "dst" exists when moving files, otherwise it's undefined and only "src" exists */
+        const filename = dst ?? src
 
-    return parseGitZOutput(lines)
-      .map((file) => normalizePath(path.resolve(cwd, file)))
-      .filter((file) => !submodules.includes(file))
+        return [normalizePath(path.resolve(cwd, filename))]
+      })
   } catch {
     return null
   }

package/lib/gitWorkflow.js

@@ -278,7 +278,12 @@ export class GitWorkflow {
 
     debugLog('Done adding task modifications to index!')
 
-    const stagedFilesAfterAdd = await this.execGit(getDiffCommand(this.diff, this.diffFilter))
+    const stagedFilesAfterAdd = await this.execGit([
+      ...getDiffCommand(this.diff, this.diffFilter),
+      '--name-only',
+      '-z',
+    ])
+
     if (!stagedFilesAfterAdd && !this.allowEmpty) {
       // Tasks reverted all staged changes and the commit would be empty
       // Throw error to stop commit unless `--allow-empty` was used

package/package.json

@@ -1,9 +1,16 @@
 {
   "name": "lint-staged",
-  "version": "15.5.0",
+  "version": "15.5.1",
   "description": "Lint files staged by git",
   "license": "MIT",
-  "repository": "https://github.com/lint-staged/lint-staged",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lint-staged/lint-staged.git"
+  },
+  "homepage": "https://github.com/lint-staged/lint-staged#readme",
+  "bugs": {
+    "url": "https://github.com/lint-staged/lint-staged/issues"
+  },
   "author": "Andrey Okonetchnikov <andrey@okonet.ru>",
   "maintainers": [
     "Lufty Wiranda <lufty.wiranda@gmail.com>",
@@ -17,7 +24,9 @@
     "node": ">=18.12.0"
   },
   "type": "module",
-  "bin": "./bin/lint-staged.js",
+  "bin": {
+    "lint-staged": "bin/lint-staged.js"
+  },
   "exports": {
     ".": "./lib/index.js",
     "./bin": "./bin/lint-staged.js",