lint-staged 16.1.6 → 16.2.1

package/lib/getSpawnedTask.js

@@ -1,16 +1,16 @@
-import chalk from 'chalk'
-import debug from 'debug'
 import spawn from 'nano-spawn'
 import pidtree from 'pidtree'
 import { parseArgsStringToArgv } from 'string-argv'
 
+import { blackBright, red } from './colors.js'
+import { createDebug } from './debug.js'
 import { error, info } from './figures.js'
 import { getInitialState } from './state.js'
 import { TaskError } from './symbols.js'
 
 const TASK_ERROR = 'lint-staged:taskError'
 
-const debugLog = debug('lint-staged:getSpawnedTask')
+const debugLog = createDebug('lint-staged:getSpawnedTask')
 
 /** @type {(error: import('nano-spawn').SubprocessError) => string} */
 const getTag = (error) => {
@@ -27,13 +27,13 @@ const getTag = (error) => {
  */
 const handleOutput = (command, result, ctx, isError = false) => {
   if (result.output) {
-    const outputTitle = isError ? chalk.redBright(`${error} ${command}:`) : `${info} ${command}:`
+    const outputTitle = isError ? red(`${error} ${command}:`) : `${info} ${command}:`
     const output = [...(ctx.quiet ? [] : ['', outputTitle]), result.output]
     ctx.output.push(output.join('\n'))
   } else if (isError) {
     // Show generic error when task had no output
     const tag = getTag(result)
-    const message = chalk.redBright(`\n${error} ${command} failed without output (${tag}).`)
+    const message = red(`\n${error} ${command} failed without output (${tag}).`)
     if (!ctx.quiet) ctx.output.push(message)
   }
 }
@@ -108,13 +108,14 @@ export const makeErr = (command, error, ctx) => {
 
   handleOutput(command, error, ctx, true)
   const tag = getTag(error)
-  return new Error(`${chalk.redBright(command)} ${chalk.dim(`[${tag}]`)}`)
+  return new Error(`${red(command)} ${blackBright(`[${tag}]`)}`)
 }
 
 /**
  * Returns the task function for the linter.
  *
  * @param {Object} options
+ * @param {boolean} [options.color]
  * @param {string} options.command — Linter task
  * @param {string} [options.cwd]
  * @param {String} options.topLevelDir - Current git repo top-level path
@@ -124,6 +125,7 @@ export const makeErr = (command, error, ctx) => {
  * @returns {() => Promise<Array<string>>}
  */
 export const getSpawnedTask = ({
+  color,
   command,
   cwd = process.cwd(),
   files,
@@ -141,6 +143,7 @@ export const getSpawnedTask = ({
     cwd: /^git(\.exe)?/i.test(cmd) ? topLevelDir : cwd,
     preferLocal: true,
     stdin: 'ignore',
+    env: color ? { FORCE_COLOR: 'true' } : { NO_COLOR: 'true' },
   }
 
   debugLog('Spawn options:', spawnOptions)

package/lib/getSpawnedTasks.js

@@ -1,21 +1,21 @@
-import debug from 'debug'
-
+import { createDebug } from './debug.js'
 import { getSpawnedTask } from './getSpawnedTask.js'
 import { configurationError } from './messages.js'
 
-const debugLog = debug('lint-staged:getSpawnedTasks')
+const debugLog = createDebug('lint-staged:getSpawnedTasks')
 
 /**
  * Creates and returns an array of listr tasks which map to the given commands.
  *
  * @param {object} options
+ * @param {boolean} [options.color]
  * @param {Array<string|Function>|string|Function} options.commands
  * @param {string} options.cwd
  * @param {import('./getStagedFiles.js').StagedFile[]} options.files
  * @param {string} options.topLevelDir
  * @param {Boolean} verbose
  */
-export const getSpawnedTasks = async ({ commands, cwd, files, topLevelDir, verbose }) => {
+export const getSpawnedTasks = async ({ color, commands, cwd, files, topLevelDir, verbose }) => {
   debugLog('Creating Listr tasks for commands %o', commands)
   const cmdTasks = []
 
@@ -45,7 +45,16 @@ export const getSpawnedTasks = async ({ commands, cwd, files, topLevelDir, verbo
         )
       }
 
-      const task = getSpawnedTask({ command, cwd, files: filepaths, topLevelDir, isFn, verbose })
+      const task = getSpawnedTask({
+        color,
+        command,
+        cwd,
+        files: filepaths,
+        topLevelDir,
+        isFn,
+        verbose,
+      })
+
       cmdTasks.push({ title: command, command, task })
     }
   }

package/lib/gitWorkflow.js

@@ -1,13 +1,15 @@
+import crypto from 'node:crypto'
 import fs from 'node:fs/promises'
 import path from 'node:path'
 
-import debug from 'debug'
-
+import { createDebug } from './debug.js'
 import { execGit } from './execGit.js'
 import { readFile, unlink, writeFile } from './file.js'
 import { getDiffCommand } from './getDiffCommand.js'
+import { parseGitZOutput } from './parseGitZOutput.js'
 import {
   ApplyEmptyCommitError,
+  ExitCodeError,
   GetBackupStashError,
   GitError,
   HideUnstagedChangesError,
@@ -16,7 +18,7 @@ import {
   RestoreUnstagedChangesError,
 } from './symbols.js'
 
-const debugLog = debug('lint-staged:GitWorkflow')
+const debugLog = createDebug('lint-staged:GitWorkflow')
 
 const MERGE_HEAD = 'MERGE_HEAD'
 const MERGE_MODE = 'MERGE_MODE'
@@ -66,21 +68,38 @@ const handleError = (error, ctx, symbol) => {
   throw error
 }
 
+const calculateSha256 = (input) => crypto.createHash('sha256').update(input, 'utf-8').digest('hex')
+
+/**
+ * The lines are wrapped in double quotes
+ * @returns {string[]}
+ */
+const cleanGitStashOutput = (lines) => lines.map((line) => line.replace(/^"(.*)"$/, '$1'))
+
 export class GitWorkflow {
   /**
    * @param {Object} opts
    * @param {import('./getStagedFiles.js').StagedFile[][]} opts.matchedFileChunks
    */
-  constructor({ allowEmpty, gitConfigDir, topLevelDir, matchedFileChunks, diff, diffFilter }) {
+  constructor({
+    allowEmpty,
+    diff,
+    diffFilter,
+    failOnChanges,
+    gitConfigDir,
+    matchedFileChunks,
+    topLevelDir,
+  }) {
     this.execGit = (args, options = {}) => execGit(args, { ...options, cwd: topLevelDir })
+    this.allowEmpty = allowEmpty
     this.deletedFiles = []
-    this.gitConfigDir = gitConfigDir
-    this.topLevelDir = topLevelDir
     this.diff = diff
     this.diffFilter = diffFilter
-    this.allowEmpty = allowEmpty
+    this.gitConfigDir = gitConfigDir
+    this.failOnChanges = !!failOnChanges
     /** @type {import('./getStagedFiles.js').StagedFile[][]} */
     this.matchedFileChunks = matchedFileChunks
+    this.topLevelDir = topLevelDir
 
     /**
      * These three files hold state about an ongoing git merge
@@ -103,11 +122,12 @@ export class GitWorkflow {
    * Get name of backup stash
    */
   async getBackupStash(ctx) {
-    const stashes = await this.execGit(['stash', 'list'])
+    /** Print stash list with short hash and subject */
+    const stashes = await this.execGit(['stash', 'list', '--format="%h %s"', '-z'])
+      .then(parseGitZOutput)
+      .then(cleanGitStashOutput)
 
-    const index = stashes
-      .split('\n')
-      .findIndex((line) => line.includes(STASH) && line.includes(ctx.backupHash))
+    const index = stashes.findIndex((line) => line.startsWith(ctx.backupHash))
 
     if (index === -1) {
       ctx.errors.add(GetBackupStashError)
@@ -172,7 +192,7 @@ export class GitWorkflow {
    * Renames have special treatment, since the single status line includes
    * both the "from" and "to" filenames, where "from" is no longer on disk.
    */
-  async getPartiallyStagedFiles() {
+  async getUnstagedFiles({ onlyPartial = false } = {}) {
     debugLog('Getting partially staged files...')
     const status = await this.execGit(['status', '-z'])
     /**
@@ -184,80 +204,96 @@ export class GitWorkflow {
      * renamed file, the file names are separated by a NUL character
      * (e.g. `to`\0`from`)
      */
-    const partiallyStaged = status
+    const unstagedFiles = status
       // eslint-disable-next-line no-control-regex
       .split(/\x00(?=[ AMDRCU?!]{2} |$)/)
       .filter((line) => {
         const [index, workingTree] = line
-        return index !== ' ' && workingTree !== ' ' && index !== '?' && workingTree !== '?'
+        const updatedInIndex = index !== ' ' && index !== '?'
+        const updatedInWorkingTree = workingTree !== ' ' && workingTree !== '?'
+
+        if (onlyPartial) {
+          return updatedInIndex && updatedInWorkingTree
+        }
+
+        return updatedInWorkingTree
       })
       .map((line) => line.slice(3)) // Remove first three letters (index, workingTree, and a whitespace)
-      .filter(Boolean) // Filter empty string
-    debugLog('Found partially staged files:', partiallyStaged)
-    return partiallyStaged.length ? partiallyStaged : null
+      .filter(Boolean) // Filter empty strings
+    debugLog(`Found ${onlyPartial ? 'partially staged' : 'unstaged'} files:`, unstagedFiles)
+    return unstagedFiles.length ? unstagedFiles : null
   }
 
   /**
-   * Create a diff of partially staged files and backup stash if enabled.
+   * Create a diff of unstaged or partially staged files and backup stash if enabled.
    */
   async prepare(ctx, task) {
     try {
       debugLog(task.title)
 
-      // Get a list of files with both staged and unstaged changes.
-      // Unstaged changes to these files should be hidden before the tasks run.
-      this.partiallyStagedFiles = await this.getPartiallyStagedFiles()
+      if (ctx.shouldBackup) {
+        // When backup is enabled, the revert will clear ongoing merge status.
+        await this.backupMergeStatus()
+
+        // Get a list of unstaged deleted files, because certain bugs might cause them to reappear:
+        // - in git versions =< 2.13.0 the `git stash --keep-index` option resurrects deleted files
+        // - git stash can't infer RD or MD states correctly, and will lose the deletion
+        this.deletedFiles = await this.getDeletedFiles()
+      }
 
-      if (this.partiallyStagedFiles) {
-        ctx.hasPartiallyStagedFiles = true
+      if (ctx.shouldHideUnstaged) {
+        this.unstagedFiles = await this.getUnstagedFiles({ onlyPartial: false })
+        ctx.hasFilesToHide = !!this.unstagedFiles
+      } else if (ctx.shouldHidePartiallyStaged) {
+        this.unstagedFiles = await this.getUnstagedFiles({ onlyPartial: true })
+        ctx.hasFilesToHide = !!this.unstagedFiles
+      }
+
+      if (this.unstagedFiles) {
         const unstagedPatch = this.getHiddenFilepath(PATCH_UNSTAGED)
         ctx.unstagedPatch = unstagedPatch
-        const files = processRenames(this.partiallyStagedFiles)
+        const files = processRenames(this.unstagedFiles)
         await this.execGit(['diff', ...GIT_DIFF_ARGS, '--output', unstagedPatch, '--', ...files])
-      } else {
-        ctx.hasPartiallyStagedFiles = false
       }
 
-      /**
-       * If backup stash should be skipped, no need to continue
-       */
-      if (!ctx.shouldBackup) return
-
-      // When backup is enabled, the revert will clear ongoing merge status.
-      await this.backupMergeStatus()
-
-      // Get a list of unstaged deleted files, because certain bugs might cause them to reappear:
-      // - in git versions =< 2.13.0 the `git stash --keep-index` option resurrects deleted files
-      // - git stash can't infer RD or MD states correctly, and will lose the deletion
-      this.deletedFiles = await this.getDeletedFiles()
-
-      // Save stash of all staged files.
-      // The `stash create` command creates a dangling commit without removing any files,
-      // and `stash store` saves it as an actual stash.
-      const stashHash = await this.execGit(['stash', 'create'])
-      ctx.backupHash = await this.execGit(['rev-parse', '--short', stashHash])
-      await this.execGit([
-        'stash',
-        'store',
-        '--quiet',
-        '--message',
-        `${STASH} (${ctx.backupHash})`,
-        ctx.backupHash,
-      ])
+      if (ctx.shouldBackup) {
+        if (ctx.shouldHideUnstaged) {
+          /** Save stash of all changes, clearing the working tree but keeping staged files as-is */
+          await this.execGit(['stash', 'push', '--keep-index', '--message', STASH])
+          /** Print stash list with short hash and subject */
+          const stashes = await this.execGit(['stash', 'list', '--format="%h %s"', '-z'])
+            .then(parseGitZOutput)
+            .then(cleanGitStashOutput)
+
+          /** The stash line starts with the short hash, so we split from space and choose the first part */
+          ctx.backupHash = stashes.find((line) => line.includes(STASH))?.split(' ')[0]
+        } else {
+          /** Save stash of all changes, keeping all files as-is */
+          const stashHash = await this.execGit(['stash', 'create'])
+          ctx.backupHash = await this.execGit(['rev-parse', '--short', stashHash])
+          await this.execGit(['stash', 'store', '--quiet', '--message', STASH, ctx.backupHash])
+        }
+
+        task.title = `Backed up original state in git stash (${ctx.backupHash})`
+        debugLog(task.title)
+      }
 
-      task.title = `Backed up original state in git stash (${ctx.backupHash})`
-      debugLog(task.title)
+      if (this.failOnChanges) {
+        debugLog(
+          'Calculating SHA-256 hash of unstaged changes because "--fail-on-changes" was used...'
+        )
+        const diff = await this.execGit(['diff', '--patch', '--unified=0'])
+        this.unstagedDiffSha256 = calculateSha256(diff)
+        debugLog('SHA-256 hash of unstaged changes is %S', this.unstagedDiffSha256)
+      }
     } catch (error) {
       handleError(error, ctx)
     }
   }
 
-  /**
-   * Remove unstaged changes to all partially staged files, to avoid tasks from seeing them
-   */
-  async hideUnstagedChanges(ctx) {
+  async hidePartiallyStagedChanges(ctx) {
     try {
-      const files = processRenames(this.partiallyStagedFiles, false)
+      const files = processRenames(this.unstagedFiles, false)
       await this.execGit(['checkout', '--force', '--', ...files])
     } catch (error) {
       /**
@@ -273,6 +309,19 @@ export class GitWorkflow {
    * In case of a merge-conflict retry with 3-way merge.
    */
   async applyModifications(ctx) {
+    if (this.failOnChanges) {
+      debugLog(
+        'Calculating SHA-256 hash of changes after tasks because "--fail-on-changes" was used...'
+      )
+      const diff = await this.execGit(['diff', '--patch', '--unified=0'])
+      const diffSha256 = calculateSha256(diff)
+      debugLog('SHA-256 hash of changes after tasks is %S', this.diffSha256)
+      if (this.unstagedDiffSha256 !== diffSha256) {
+        ctx.errors.add(ExitCodeError)
+        throw new Error('Tasks modified files and --fail-on-changes was used!')
+      }
+    }
+
     debugLog('Adding task modifications to index...')
 
     // `matchedFileChunks` includes staged files that lint-staged originally detected and matched against a task.
@@ -327,8 +376,8 @@ export class GitWorkflow {
       debugLog('Error while restoring changes:')
       debugLog(applyError)
       debugLog('Retrying with 3-way merge')
+      // Retry with a 3-way merge if normal apply fails
       try {
-        // Retry with a 3-way merge if normal apply fails
         await this.execGit(['apply', ...GIT_APPLY_ARGS, '--3way', unstagedPatch])
       } catch (threeWayApplyError) {
         debugLog('Error while restoring unstaged changes using 3-way merge:')

package/lib/groupFilesByConfig.js

@@ -1,8 +1,8 @@
 import path from 'node:path'
 
-import debug from 'debug'
+import { createDebug } from './debug.js'
 
-const debugLog = debug('lint-staged:groupFilesByConfig')
+const debugLog = createDebug('lint-staged:groupFilesByConfig')
 
 /**
  * @typedef {import('./getStagedFiles.js').StagedFile} StagedFile

package/lib/index.d.ts

@@ -1,12 +1,12 @@
-type SyncGenerateTask = (stagedFileNames: string[]) => string | string[]
+type SyncGenerateTask = (stagedFileNames: readonly string[]) => string | string[]
 
-type AsyncGenerateTask = (stagedFileNames: string[]) => Promise<string | string[]>
+type AsyncGenerateTask = (stagedFileNames: readonly string[]) => Promise<string | string[]>
 
 type GenerateTask = SyncGenerateTask | AsyncGenerateTask
 
 type TaskFunction = {
   title: string
-  task: (stagedFileNames: string[]) => void | Promise<void>
+  task: (stagedFileNames: readonly string[]) => void | Promise<void>
 }
 
 export type Configuration =
@@ -19,6 +19,11 @@ export type Options = {
    * @default false
    */
   allowEmpty?: boolean
+  /**
+   * Enable or disable ANSI color codes in output. By default value is auto-detected
+   * and controlled by `FORCE_COLOR` or `NO_COLOR` env variables.
+   */
+  color?: boolean
   /**
    * The number of tasks to run concurrently, or `false` to run tasks serially
    * @default true
@@ -32,6 +37,11 @@ export type Options = {
    * Path to single configuration file; disables automatic config file discovery when used
    */
   configPath?: string
+  /**
+   * Run all tasks to completion even if one fails
+   * @default false
+   */
+  continueOnError?: boolean
   /**
    * Working directory to run all tasks in, defaults to current working directory
    */
@@ -52,10 +62,25 @@ export type Options = {
    * @default "ACMR"
    */
   diffFilter?: string
+  /**
+   * Fail with exit code 1 when tasks modify tracked files
+   * @default false
+   */
+  failOnChanges?: boolean
   /**
    * Maximum argument string length, by default automatically detected
    */
   maxArgLength?: number
+  /**
+   * Whether to hide unstaged changes from partially staged files before running tasks
+   * @default true
+   */
+  hidePartiallyStaged?: boolean
+  /**
+   * Whether to hide all unstaged changes before running tasks
+   * @default false
+   */
+  hideUnstaged?: boolean
   /**
    * Disable lint-staged’s own console output
    * @default false
@@ -77,11 +102,6 @@ export type Options = {
    * @default true
    */
   stash?: boolean
-  /**
-   * Whether to hide unstaged changes from partially staged files before running tasks
-   * @default true
-   */
-  hidePartiallyStaged?: boolean
   /**
    * Show task output even when tasks succeed; by default only failed output is shown
    * @default false
@@ -89,12 +109,13 @@ export type Options = {
   verbose?: boolean
 }
 
-type LogFunction = (...params: any) => void
+type LogFunction = typeof console.log
 
 type Logger = {
   log: LogFunction
   warn: LogFunction
   error: LogFunction
+  debug: LogFunction
 }
 
 /**

package/lib/index.js

@@ -1,10 +1,11 @@
-import debugLib from 'debug'
-
+import { SUPPORTS_COLOR } from './colors.js'
+import { createDebug, enableDebug } from './debug.js'
 import { execGit } from './execGit.js'
 import {
   GIT_ERROR,
   NO_CONFIGURATION,
   PREVENTED_EMPTY_COMMIT,
+  PREVENTED_TASK_MODIFICATIONS,
   RESTORE_STASH_EXAMPLE,
   UNSTAGED_CHANGES_BACKUP_STASH_LOCATION,
 } from './messages.js'
@@ -14,6 +15,7 @@ import { cleanupSkipped } from './state.js'
 import {
   ApplyEmptyCommitError,
   ConfigNotFoundError,
+  ExitCodeError,
   GetBackupStashError,
   GitError,
   RestoreUnstagedChangesError,
@@ -21,7 +23,7 @@ import {
 import { validateOptions } from './validateOptions.js'
 import { getVersion } from './version.js'
 
-const debugLog = debugLib('lint-staged')
+const debugLog = createDebug('lint-staged')
 
 /**
  * Get the maximum length of a command-line argument string based on current platform
@@ -49,13 +51,18 @@ const getMaxArgLength = () => {
  *
  * @param {object} options
  * @param {Object} [options.allowEmpty] - Allow empty commits when tasks revert all staged changes
+ * @param {boolean} [options.color] - Enable or disable ANSI color codes in output.
  * @param {boolean | number} [options.concurrent] - The number of tasks to run concurrently, or false to run tasks serially
  * @param {object}  [options.config] - Object with configuration for programmatic API
  * @param {string} [options.configPath] - Path to configuration file
+ * @param {boolean} [options.continueOnError] - Run all tasks to completion even if one fails
  * @param {Object} [options.cwd] - Current working directory
  * @param {boolean} [options.debug] - Enable debug mode
  * @param {string} [options.diff] - Override the default "--staged" flag of "git diff" to get list of files
  * @param {string} [options.diffFilter] - Override the default "--diff-filter=ACMR" flag of "git diff" to get list of files
+ * @param {boolean} [options.failOnChanges] - Fail with exit code 1 when tasks modify tracked files
+ * @param {boolean} [options.hidePartiallyStaged] - Whether to hide unstaged changes from partially staged files before running tasks
+ * @param {boolean} [options.hideUnstaged] - Whether to hide all unstaged changes before running tasks
  * @param {number} [options.maxArgLength] - Maximum argument string length
  * @param {boolean} [options.quiet] - Disable lint-staged’s own console output
  * @param {boolean} [options.relative] - Pass relative filepaths to tasks
@@ -69,28 +76,32 @@ const getMaxArgLength = () => {
 const lintStaged = async (
   {
     allowEmpty = false,
+    color = SUPPORTS_COLOR,
     concurrent = true,
     config: configObject,
     configPath,
+    continueOnError = false,
     cwd,
     debug = false,
     diff,
     diffFilter,
+    failOnChanges = false,
+    hideUnstaged = false,
+    hidePartiallyStaged = !hideUnstaged,
     maxArgLength = getMaxArgLength() / 2,
     quiet = false,
     relative = false,
     // Stashing should be disabled by default when the `diff` option is used
     stash = diff === undefined,
-    // Cannot revert to original state without stash
-    revert = stash,
-    hidePartiallyStaged = true,
+    // Default to false when using failOnChanges; cannot revert to original state without stash
+    revert = !failOnChanges && !!stash,
     verbose = false,
   } = {},
   logger = console
 ) => {
   // Seemingly enable debug twice (also done in bin), so that it also works when using the Node.js API
   if (debug) {
-    debugLib.enable('lint-staged*')
+    enableDebug(logger)
 
     debugLog(
       'Running `lint-staged@%s` on Node.js %s (%s)',
@@ -105,19 +116,23 @@ const lintStaged = async (
 
   const options = {
     allowEmpty,
+    color,
     concurrent,
     configObject,
     configPath,
+    continueOnError,
     cwd,
     debug,
     diff,
     diffFilter,
+    failOnChanges,
+    hidePartiallyStaged,
+    hideUnstaged,
     maxArgLength,
     quiet,
     relative,
     revert,
     stash,
-    hidePartiallyStaged,
     verbose,
   }
 
@@ -140,6 +155,8 @@ const lintStaged = async (
         logger.error(NO_CONFIGURATION)
       } else if (ctx.errors.has(ApplyEmptyCommitError)) {
         logger.warn(PREVENTED_EMPTY_COMMIT)
+      } else if (ctx.errors.has(ExitCodeError)) {
+        logger.warn(PREVENTED_TASK_MODIFICATIONS)
       } else if (ctx.errors.has(RestoreUnstagedChangesError)) {
         logger.warn(UNSTAGED_CHANGES_BACKUP_STASH_LOCATION)
         logger.warn(ctx.unstagedPatch)