lint-staged 13.0.0 → 13.0.3

package/README.md

@@ -2,6 +2,10 @@
 
 Run linters against staged git files and don't let :poop: slip into your code base!
 
+```bash
+npm install --save-dev lint-staged # requires further setup
+```
+
 ```
 $ git commit
 
@@ -44,13 +48,17 @@ This project contains a script that will run arbitrary shell tasks with a list o
 
 ## Installation and setup
 
-The fastest way to start using lint-staged is to run the following command in your terminal:
+To install _lint-staged_ in the recommended way, you need to:
 
-```bash
-npx mrm@2 lint-staged
-```
-
-This command will install and configure [husky](https://github.com/typicode/husky) and lint-staged depending on the code quality tools from your project's `package.json` dependencies, so please make sure you install (`npm install --save-dev`) and configure all code quality tools like [Prettier](https://prettier.io) and [ESLint](https://eslint.org) prior to that.
+1. Install _lint-staged_ itself:
+   - `npm install --save-dev lint-staged`
+1. Set up the `pre-commit` git hook to run _lint-staged_
+   - [Husky](https://github.com/typicode/husky) is a popular choice for configuring git hooks
+   - Read more about git hooks [here](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
+1. Install some linters, like [ESLint](https://eslint.org) or [Prettier](https://prettier.io)
+1. Configure _lint-staged_ to run linters and other tasks:
+   - for example: `{ "*.js": "eslint" }` to run ESLint for all staged JS files
+   - See [Configuration](#Configuration) for more info
 
 Don't forget to commit changes to `package.json` and `.husky` to share this setup with your team!
 
@@ -110,7 +118,7 @@ Options:
 ```
 
 - **`--allow-empty`**: By default, when linter tasks undo all staged changes, lint-staged will exit with an error and abort the commit. Use this flag to allow creating empty git commits.
-- **`--concurrent [number|boolean]`**: Controls the concurrency of tasks being run by lint-staged. **NOTE**: This does NOT affect the concurrency of subtasks (they will always be run sequentially). Possible values are:
+- **`--concurrent [number|boolean]`**: Controls the [concurrency of tasks](#task-concurrency) being run by lint-staged. **NOTE**: This does NOT affect the concurrency of subtasks (they will always be run sequentially). Possible values are:
   - `false`: Run all tasks serially
   - `true` (default) : _Infinite_ concurrency. Runs as many tasks in parallel as possible.
   - `{number}`: Run the specified number of tasks in parallel, where `1` is equivalent to `false`.
@@ -130,7 +138,7 @@ Options:
 
 ## Configuration
 
-Starting with v3.1 you can now use different ways of configuring lint-staged:
+_Lint-staged_ can be configured in many ways:
 
 - `lint-staged` object in your `package.json`
 - `.lintstagedrc` file in JSON or YML format, or you can be explicit with the file extension:
@@ -173,6 +181,37 @@ So, considering you did `git add file1.ext file2.ext`, lint-staged will run the
 
 `your-cmd file1.ext file2.ext`
 
+### Task concurrency
+
+By default _lint-staged_ will run configured tasks concurrently. This means that for every glob, all the commands will be started at the same time. With the following config, both `eslint` and `prettier` will run at the same time:
+
+```json
+{
+  "*.ts": "eslint",
+  "*.md": "prettier --list-different"
+}
+```
+
+This is typically not a problem since the globs do not overlap, and the commands do not make changes to the files, but only report possible errors (aborting the git commit). If you want to run multiple commands for the same set of files, you can use the array syntax to make sure commands are run in order. In the following example, `prettier` will run for both globs, and in addition `eslint` will run for `*.ts` files _after_ it. Both sets of commands (for each glob) are still started at the same time (but do not overlap).
+
+```json
+{
+  "*.ts": ["prettier --list-different", "eslint"],
+  "*.md": "prettier --list-different"
+}
+```
+
+Pay extra attention when the configured globs overlap, and tasks make edits to files. For example, in this configuration `prettier` and `eslint` might try to make changes to the same `*.ts` file at the same time, causing a _race condition_:
+
+```json
+{
+  "*": "prettier --write",
+  "*.ts": "eslint --fix"
+}
+```
+
+If necessary, you can limit the concurrency using `--concurrent <number>` or disable it entirely with `--concurrent false`.
+
 ## Filtering files
 
 Linter commands work on a subset of all staged files, defined by a _glob pattern_. lint-staged uses [micromatch](https://github.com/micromatch/micromatch) for matching files with the following rules:

package/lib/getDiffCommand.js

@@ -0,0 +1,18 @@
+export function getDiffCommand(diff, diffFilter) {
+  /**
+   *  Docs for --diff-filter option:
+   * @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203
+   */
+  const diffFilterArg = diffFilter !== undefined ? diffFilter.trim() : 'ACMR'
+
+  /** Use `--diff branch1...branch2` or `--diff="branch1 branch2", or fall back to default staged files */
+  const diffArgs = diff !== undefined ? diff.trim().split(' ') : ['--staged']
+
+  /**
+   * 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]
+
+  return diffCommand
+}

package/lib/getStagedFiles.js

@@ -3,27 +3,12 @@ import path from 'node:path'
 import normalize from 'normalize-path'
 
 import { execGit } from './execGit.js'
+import { getDiffCommand } from './getDiffCommand.js'
 import { parseGitZOutput } from './parseGitZOutput.js'
 
 export const getStagedFiles = async ({ cwd = process.cwd(), diff, diffFilter } = {}) => {
   try {
-    /**
-     *  Docs for --diff-filter option:
-     * @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203
-     */
-    const diffFilterArg = diffFilter !== undefined ? diffFilter.trim() : 'ACMR'
-
-    /** Use `--diff branch1...branch2` or `--diff="branch1 branch2", or fall back to default staged files */
-    const diffArgs = diff !== undefined ? diff.trim().split(' ') : ['--staged']
-
-    /**
-     * Docs for -z option:
-     * @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt--z
-     */
-    const lines = await execGit(
-      ['diff', '--name-only', '-z', `--diff-filter=${diffFilterArg}`, ...diffArgs],
-      { cwd }
-    )
+    const lines = await execGit(getDiffCommand(diff, diffFilter), { cwd })
     if (!lines) return []
 
     return parseGitZOutput(lines).map((file) => normalize(path.resolve(cwd, file)))

package/lib/gitWorkflow.js

@@ -4,6 +4,7 @@ import debug from 'debug'
 
 import { execGit } from './execGit.js'
 import { readFile, unlink, writeFile } from './file.js'
+import { getDiffCommand } from './getDiffCommand.js'
 import {
   GitError,
   RestoreOriginalStateError,
@@ -42,7 +43,7 @@ const processRenames = (files, includeRenameFrom = true) =>
     return flattened
   }, [])
 
-const STASH = 'lint-staged automatic backup'
+export const STASH = 'lint-staged automatic backup'
 
 const PATCH_UNSTAGED = 'lint-staged_unstaged.patch'
 
@@ -65,12 +66,13 @@ const handleError = (error, ctx, symbol) => {
 }
 
 export class GitWorkflow {
-  constructor({ allowEmpty, gitConfigDir, gitDir, matchedFileChunks }) {
+  constructor({ allowEmpty, gitConfigDir, gitDir, matchedFileChunks, diff, diffFilter }) {
     this.execGit = (args, options = {}) => execGit(args, { ...options, cwd: gitDir })
     this.deletedFiles = []
     this.gitConfigDir = gitConfigDir
     this.gitDir = gitDir
-    this.unstagedDiff = null
+    this.diff = diff
+    this.diffFilter = diffFilter
     this.allowEmpty = allowEmpty
     this.matchedFileChunks = matchedFileChunks
 
@@ -101,6 +103,16 @@ export class GitWorkflow {
       ctx.errors.add(GetBackupStashError)
       throw new Error('lint-staged automatic backup is missing!')
     }
+
+    /**
+     * https://github.com/okonet/lint-staged/issues/1121
+     * Detect MSYS in login shell mode and escape braces
+     * to prevent interpolation
+     */
+    if (!!process.env.MSYSTEM && !!process.env.LOGINSHELL) {
+      return `refs/stash@\\{${index}\\}`
+    }
+
     return `refs/stash@{${index}}`
   }
 
@@ -262,7 +274,7 @@ export class GitWorkflow {
 
     debugLog('Done adding task modifications to index!')
 
-    const stagedFilesAfterAdd = await this.execGit(['diff', '--name-only', '--cached'])
+    const stagedFilesAfterAdd = await this.execGit(getDiffCommand(this.diff, this.diffFilter))
     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/lib/resolveTaskFn.js

@@ -8,7 +8,7 @@ import { error, info } from './figures.js'
 import { getInitialState } from './state.js'
 import { TaskError } from './symbols.js'
 
-const ERROR_CHECK_INTERVAL = 200
+const TASK_ERROR = 'lint-staged:taskError'
 
 const debugLog = debug('lint-staged:resolveTaskFn')
 
@@ -46,37 +46,52 @@ const handleOutput = (command, result, ctx, isError = false) => {
   }
 }
 
+/**
+ * Kill an execa process along with all its child processes.
+ * @param {execa.ExecaChildProcess<string>} execaProcess
+ */
+const killExecaProcess = async (execaProcess) => {
+  try {
+    const childPids = await pidTree(execaProcess.pid)
+    for (const childPid of childPids) {
+      try {
+        process.kill(childPid)
+      } catch (error) {
+        debugLog(`Failed to kill process with pid "%d": %o`, childPid, error)
+      }
+    }
+  } catch (error) {
+    // Suppress "No matching pid found" error. This probably means
+    // the process already died before executing.
+    debugLog(`Failed to kill process with pid "%d": %o`, execaProcess.pid, error)
+  }
+
+  // The execa process is killed separately in order to get the `KILLED` status.
+  execaProcess.kill()
+}
+
 /**
  * Interrupts the execution of the execa process that we spawned if
  * another task adds an error to the context.
  *
  * @param {Object} ctx
  * @param {execa.ExecaChildProcess<string>} execaChildProcess
- * @returns {function(): void} Function that clears the interval that
+ * @returns {() => Promise<void>} Function that clears the interval that
  * checks the context.
  */
 const interruptExecutionOnError = (ctx, execaChildProcess) => {
-  let loopIntervalId
-
-  async function loop() {
-    if (ctx.errors.size > 0) {
-      clearInterval(loopIntervalId)
-
-      const childPids = await pidTree(execaChildProcess.pid)
-      for (const pid of childPids) {
-        process.kill(pid)
-      }
+  let killPromise
 
-      // The execa process is killed separately in order
-      // to get the `KILLED` status.
-      execaChildProcess.kill()
-    }
+  const errorListener = async () => {
+    killPromise = killExecaProcess(execaChildProcess)
+    await killPromise
   }
 
-  loopIntervalId = setInterval(loop, ERROR_CHECK_INTERVAL)
+  ctx.events.on(TASK_ERROR, errorListener, { once: true })
 
-  return () => {
-    clearInterval(loopIntervalId)
+  return async () => {
+    ctx.events.off(TASK_ERROR, errorListener)
+    await killPromise
   }
 }
 
@@ -95,6 +110,10 @@ const interruptExecutionOnError = (ctx, execaChildProcess) => {
  */
 const makeErr = (command, result, ctx) => {
   ctx.errors.add(TaskError)
+
+  // https://nodejs.org/api/events.html#error-events
+  ctx.events.emit(TASK_ERROR, TaskError)
+
   handleOutput(command, result, ctx, true)
   const tag = getTag(result)
   return new Error(`${redBright(command)} ${dim(`[${tag}]`)}`)
@@ -111,7 +130,7 @@ const makeErr = (command, result, ctx) => {
  * @param {Array<string>} options.files — Filepaths to run the linter task against
  * @param {Boolean} [options.shell] — Whether to skip parsing linter task for better shell support
  * @param {Boolean} [options.verbose] — Always show task verbose
- * @returns {function(): Promise<Array<string>>}
+ * @returns {() => Promise<Array<string>>}
  */
 export const resolveTaskFn = ({
   command,
@@ -144,7 +163,7 @@ export const resolveTaskFn = ({
 
     const quitInterruptCheck = interruptExecutionOnError(ctx, execaChildProcess)
     const result = await execaChildProcess
-    quitInterruptCheck()
+    await quitInterruptCheck()
 
     if (result.failed || result.killed || result.signal != null) {
       throw makeErr(command, result, ctx)

package/lib/runAll.js

@@ -203,15 +203,15 @@ export const runAll = async (
             const fileCount = task.fileList.length
 
             return {
-              title: `${task.pattern}${dim(` — ${fileCount} ${fileCount > 1 ? 'files' : 'file'}`)}`,
-              task: async () =>
-                new Listr(subTasks, {
-                  // In sub-tasks we don't want to run concurrently
-                  // and we want to abort on errors
-                  ...listrOptions,
-                  concurrent: false,
-                  exitOnError: true,
-                }),
+              title: `${task.pattern}${dim(
+                ` — ${fileCount} ${fileCount === 1 ? 'file' : 'files'}`
+              )}`,
+              task: async (ctx, task) =>
+                task.newListr(
+                  subTasks,
+                  // Subtasks should not run in parallel, and should exit on error
+                  { concurrent: false, exitOnError: true }
+                ),
               skip: () => {
                 // Skip task when no files matched
                 if (fileCount === 0) {
@@ -228,7 +228,7 @@ export const runAll = async (
         title:
           `${configName}${dim(` — ${files.length} ${files.length > 1 ? 'files' : 'file'}`)}` +
           (chunkCount > 1 ? dim(` (chunk ${index + 1}/${chunkCount})...`) : ''),
-        task: () => new Listr(chunkListrTasks, { ...listrOptions, concurrent, exitOnError: true }),
+        task: (ctx, task) => task.newListr(chunkListrTasks, { concurrent, exitOnError: true }),
         skip: () => {
           // Skip if the first step (backup) failed
           if (ctx.errors.has(GitError)) return SKIPPED_GIT_ERROR
@@ -262,7 +262,14 @@ export const runAll = async (
     relative: false,
   })
 
-  const git = new GitWorkflow({ allowEmpty, gitConfigDir, gitDir, matchedFileChunks })
+  const git = new GitWorkflow({
+    allowEmpty,
+    gitConfigDir,
+    gitDir,
+    matchedFileChunks,
+    diff,
+    diffFilter,
+  })
 
   const runner = new Listr(
     [
@@ -277,7 +284,7 @@ export const runAll = async (
       },
       {
         title: `Running tasks for staged files...`,
-        task: () => new Listr(listrTasks, { ...listrOptions, concurrent }),
+        task: (ctx, task) => task.newListr(listrTasks, { concurrent }),
         skip: () => listrTasks.every((task) => task.skip()),
       },
       {

package/lib/state.js

@@ -1,3 +1,5 @@
+import EventEmitter from 'events'
+
 import { GIT_ERROR, TASK_ERROR } from './messages.js'
 import {
   ApplyEmptyCommitError,
@@ -11,6 +13,7 @@ export const getInitialState = ({ quiet = false } = {}) => ({
   hasPartiallyStagedFiles: null,
   shouldBackup: null,
   errors: new Set([]),
+  events: new EventEmitter(),
   output: [],
   quiet,
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "13.0.0",
+  "version": "13.0.3",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "cli-truncate": "^3.1.0",
-    "colorette": "^2.0.16",
+    "colorette": "^2.0.17",
     "commander": "^9.3.0",
     "debug": "^4.3.4",
     "execa": "^6.1.0",
@@ -42,7 +42,7 @@
     "micromatch": "^4.0.5",
     "normalize-path": "^3.0.0",
     "object-inspect": "^1.12.2",
-    "pidtree": "^0.5.0",
+    "pidtree": "^0.6.0",
     "string-argv": "^0.3.1",
     "yaml": "^2.1.1"
   },
@@ -50,17 +50,17 @@
     "@babel/core": "^7.18.2",
     "@babel/eslint-parser": "^7.18.2",
     "@babel/preset-env": "^7.18.2",
-    "babel-jest": "^28.1.0",
+    "babel-jest": "^28.1.1",
     "babel-plugin-transform-imports": "2.0.0",
     "consolemock": "^1.1.0",
-    "eslint": "^8.16.0",
+    "eslint": "^8.17.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "fs-extra": "^10.1.0",
     "husky": "^8.0.1",
-    "jest": "^28.1.0",
+    "jest": "^28.1.1",
     "jest-snapshot-serializer-ansi": "^1.0.0",
     "prettier": "^2.6.2"
   },