lint-staged 17.0.5 → 17.0.7

package/README.md

@@ -772,6 +772,23 @@ module.exports = {
 
 ## Frequently Asked Questions
 
+### How does `lint-staged`'s stashing work?
+
+<details>
+<summary>Click to expand</summary>
+
+When running `lint-staged` with the default configuration, the following happens:
+
+1. The entire original state is backed up in a git stash using `git stash create` and `git stash store`. This leaves all files in the worktree by default — the regular `git stash` command would also remove them. This most probably ignores any untracked files, which is the default behavior of `git stash`.
+1. If some file is "_partially staged_", meaning there's both staged and unstaged changes in the same file, lint-staged will additionally save all of these in a patch file, basically like `git diff --patch >> .git/lint-staged_unstaged.patch`. After this, the unstaged changes to these files are removed from the worktree so that tasks only see the staged changes
+1. After running tasks, any new modifications to the originally staged files are added to the index
+1. After this, any originally unstaged changes to "_partially staged_" files are restored by applying the patch file from step 2.
+1. In case of any errors, the state is reset with `git reset` and the original state restored from the git stash created in step 1.
+
+If the process is interrupted at any point, it should be possible to restore changes from the git stash created in step 1. because it's only dropped in the last step, after successfully completing all previous steps in the process.
+
+</details>
+
 ### The output of commit hook looks weird (no colors, duplicate lines, verbose output on Windows, …)
 
 <details>

package/lib/execGit.js

@@ -23,7 +23,6 @@ export const execGit = async (cmd, options) => {
     nodeOptions: {
       env: options?.env,
       cwd: options?.cwd,
-      stdio: ['ignore'],
     },
   })
 

package/lib/getSpawnedTask.js

@@ -91,7 +91,6 @@ export const getSpawnedTask = ({
       // e.g `npm` should run tasks in the actual CWD
       cwd: /^git(\.exe)?/i.test(cmd) ? topLevelDir : cwd,
       env: color ? { FORCE_COLOR: 'true' } : { NO_COLOR: 'true' },
-      stdio: ['ignore'],
     },
   }
 

package/lib/gitWorkflow.js

@@ -1,4 +1,5 @@
 import crypto from 'node:crypto'
+import fs from 'node:fs/promises'
 import path from 'node:path'
 
 import { createDebug } from './debug.js'
@@ -80,13 +81,23 @@ export class GitWorkflow {
   /**
    * @param {Object} opts
    */
-  constructor({ allowEmpty, diff, diffFilter, failOnChanges, gitConfigDir, topLevelDir }) {
+  constructor({
+    allowEmpty,
+    diff,
+    diffFilter,
+    failOnChanges,
+    gitConfigDir,
+    matchedFileChunks,
+    topLevelDir,
+  }) {
     this.execGit = (args, options = {}) => execGit(args, { ...options, cwd: topLevelDir })
     this.allowEmpty = allowEmpty
     this.diff = diff
     this.diffFilter = diffFilter
     this.gitConfigDir = gitConfigDir
     this.failOnChanges = !!failOnChanges
+    /** @type {import('./getStagedFiles.js').StagedFile[][]} */
+    this.matchedFileChunks = matchedFileChunks
     this.topLevelDir = topLevelDir
 
     /**
@@ -299,30 +310,46 @@ export class GitWorkflow {
       ? normalizePath(process.env.GIT_INDEX_FILE)
       : process.env.GIT_INDEX_FILE
 
-    debugLog('Updating active Git index again: %s', activeIndexFile)
-    await this.execGit(['update-index', '--again'])
-    debugLog('Done updating Git index again: %s', activeIndexFile)
+    /** Needs to be run serially because of locking Git operation */
+    for (const files of this.matchedFileChunks) {
+      const accessCheckedFiles = await Promise.allSettled(
+        files.map(async (f) => {
+          if (f.status === 'D') {
+            await fs.access(f.filepath)
+            return f.filepath // File is no longer deleted and can be added
+          } else {
+            return f.filepath
+          }
+        })
+      )
 
-    if (activeIndexFile?.endsWith('.lock')) {
-      const defaultIndexLock = normalizePath(
-        await this.execGit(['rev-parse', '--path-format=absolute', '--git-path', 'index.lock'])
+      const addableFiles = accessCheckedFiles.flatMap((r) =>
+        r.status === 'fulfilled' ? [r.value] : []
       )
 
-      /**
-       * If the active index file is a non-default lockfile, we are committing with a pathspec
-       * without having explicitly run `git add`. In this case we need to also update the
-       * default index, otherwise there will be leftover diff after committing
-       */
-      if (activeIndexFile !== defaultIndexLock) {
-        debugLog('Updating default Git index lock again: %s', defaultIndexLock)
+      debugLog('Updating active Git index: %s', activeIndexFile)
+      await this.execGit(['add', '--', ...addableFiles])
+      debugLog('Done updating Git index: %s', activeIndexFile)
 
-        await this.execGit(['update-index', '--again'], {
-          env: {
-            GIT_INDEX_FILE: defaultIndexLock,
-          },
-        })
+      if (activeIndexFile?.endsWith('.lock')) {
+        const defaultIndexLock = normalizePath(
+          await this.execGit(['rev-parse', '--path-format=absolute', '--git-path', 'index.lock'])
+        )
 
-        debugLog('Done updating default Git index lock again: %s', defaultIndexLock)
+        /**
+         * If the active index file is a non-default lockfile, we are committing with a pathspec
+         * without having explicitly run `git add`. In this case we need to also update the
+         * default index, otherwise there will be leftover diff after committing
+         */
+        if (activeIndexFile !== defaultIndexLock) {
+          debugLog('Updating default Git index again: %s', defaultIndexLock)
+          await this.execGit(['add', '--', ...addableFiles], {
+            env: {
+              GIT_INDEX_FILE: defaultIndexLock,
+            },
+          })
+          debugLog('Done updating default Git index lock: %s', defaultIndexLock)
+        }
       }
     }
 

package/lib/runAll.js

@@ -302,12 +302,23 @@ export const runAll = async (
     return ctx
   }
 
+  // Chunk matched files for better Windows compatibility
+  /** @type {import('./getStagedFiles.js').StagedFile[][]} */
+  const matchedFileChunks = chunkFiles({
+    // matched files are relative to `cwd`, not `topLevelDir`, when `relative` is used
+    baseDir: cwd,
+    files: Array.from(matchedFiles),
+    maxArgLength,
+    relative: false,
+  })
+
   const git = new GitWorkflow({
     allowEmpty,
     diff,
     diffFilter,
     failOnChanges,
     gitConfigDir,
+    matchedFileChunks,
     topLevelDir,
   })
 
@@ -328,7 +339,7 @@ export const runAll = async (
         skip: () => listrTasks.every((task) => task.skip()),
       },
       {
-        title: 'Updating Git index again...',
+        title: 'Staging changes from tasks...',
         task: (ctx) => git.updateIndex(ctx),
         skip: updateIndexSkipped,
       },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "17.0.5",
+  "version": "17.0.7",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": {
@@ -18,6 +18,10 @@
   "funding": {
     "url": "https://opencollective.com/lint-staged"
   },
+  "publishConfig": {
+    "provenance": true,
+    "access": "public"
+  },
   "engines": {
     "node": ">=22.22.1"
   },
@@ -51,31 +55,31 @@
     "listr2": "^10.2.1",
     "picomatch": "^4.0.4",
     "string-argv": "^0.3.2",
-    "tinyexec": "^1.1.2"
+    "tinyexec": "^1.2.4"
   },
   "optionalDependencies": {
-    "yaml": "^2.8.4"
+    "yaml": "^2.9.0"
   },
   "devDependencies": {
     "@changesets/changelog-github": "0.7.0",
     "@changesets/cli": "2.31.0",
-    "@commitlint/cli": "21.0.0",
-    "@commitlint/config-conventional": "21.0.0",
+    "@commitlint/cli": "21.0.2",
+    "@commitlint/config-conventional": "21.0.2",
     "@eslint/js": "10.0.1",
-    "@vitest/coverage-istanbul": "4.1.5",
-    "@vitest/eslint-plugin": "1.6.17",
+    "@vitest/coverage-istanbul": "4.1.7",
+    "@vitest/eslint-plugin": "1.6.18",
     "consolemock": "1.1.0",
     "cross-env": "10.1.0",
-    "eslint": "10.3.0",
+    "eslint": "10.4.1",
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-n": "18.0.1",
-    "eslint-plugin-prettier": "5.5.5",
+    "eslint-plugin-prettier": "5.5.6",
     "eslint-plugin-simple-import-sort": "13.0.0",
     "husky": "9.1.7",
     "mock-stdin": "1.0.0",
     "prettier": "3.8.3",
-    "semver": "7.8.0",
-    "vitest": "4.1.5"
+    "semver": "7.8.1",
+    "vitest": "4.1.7"
   },
   "keywords": [
     "lint",