lint-staged 17.0.7 → 17.1.0

package/README.md

@@ -13,27 +13,21 @@ npm install --save-dev lint-staged # requires further setup
 ```
 $ git commit
 
-✔ Backed up original state in git stash (5bda95f)
-❯ Running tasks for staged files...
-  ❯ packages/frontend/.lintstagedrc.json — 1 file
-    ↓ *.js — no files [SKIPPED]
-    ❯ *.{json,md} — 1 file
-      ⠹ prettier --write
-  ↓ packages/backend/.lintstagedrc.json — 2 files
-    ❯ *.js — 2 files
-      ⠼ eslint --fix
-    ↓ *.{json,md} — no files [SKIPPED]
-◼ Updating Git index again...
-◼ Cleaning up temporary files...
+⋯ Backing up original state…
+✔ Done backing up original state (1f4c047d)!
+⋯ Running tasks for staged files…
+    *.{json,md} — 1 file
+      ⋯ prettier --write
+
+✔ prettier --write
+
+✔ Done running tasks for staged files!
+⋯ Staging changes from tasks…
+✔ Done staging changes from tasks!
+⋯ Cleaning up temporary files…
+✔ Done cleaning up temporary files!
 ```
 
-<details>
-<summary>See asciinema video</summary>
-
-[![asciicast](https://asciinema.org/a/199934.svg)](https://asciinema.org/a/199934)
-
-</details>
-
 > [!Tip]
 > Do you only want to check staged files for errors, but not edit them automatically?  
 > You might be interested in this simpler shell script: [`lint-staged.sh`](https://github.com/lint-staged/lint-staged.sh).
@@ -154,11 +148,7 @@ Change the working directory _lint-staged_ runs tasks in. Defaults to `process.c
 
 #### `--debug`
 
-Run in debug mode. When set, it does the following:
-
-- log additional information about staged files, commands being executed, location of binaries, etc.
-- uses [`verbose` renderer](https://listr2.kilic.dev/renderers/verbose-renderer/) for `listr2`; this causes serial, uncoloured output to the terminal, instead of the default (beautified, dynamic) output.
-  (the [`verbose` renderer](https://listr2.kilic.dev/renderers/verbose-renderer/) can also be activated by setting the `TERM=dumb` or `NODE_ENV=test` environment variables)
+Log additional information about staged files, commands being executed, location of binaries, etc.
 
 #### `--diff`
 

package/bin/lint-staged.js

@@ -3,14 +3,15 @@
 import { userInfo } from 'node:os'
 
 import { getVersionNumber, parseCliOptions, printHelpText } from '../lib/cli.js'
+import { enableColors } from '../lib/colors.js'
 import { createDebug, enableDebug } from '../lib/debug.js'
 import lintStaged from '../lib/index.js'
-import { CONFIG_STDIN_ERROR } from '../lib/messages.js'
 import { readStdin } from '../lib/readStdin.js'
 
+enableColors(!!process.stdout.hasColors?.())
 const debugLog = createDebug('lint-staged:bin')
 
-// Do not terminate main Listr process on SIGINT
+// SIGINT handled by an AbortController
 process.on('SIGINT', () => {})
 
 const cliOptions = parseCliOptions(process.argv)
@@ -44,9 +45,8 @@ if (cliOptions.configPath === '-') {
     debugLog('Reading config from stdin')
     cliOptions.config = JSON.parse(await readStdin())
   } catch (error) {
-    debugLog(CONFIG_STDIN_ERROR, error)
-    console.error(CONFIG_STDIN_ERROR)
-    process.exit(1)
+    console.error('Failed to read config from stdin!')
+    throw error
   }
 }
 

package/lib/colors.js

@@ -1,11 +1,29 @@
-/* eslint-disable n/no-unsupported-features/node-builtins */
-
 import util from 'node:util'
 
-export const SUPPORTS_COLOR = !!process.stdout.hasColors?.()
+export let COLORS_ENABLED = false
+
+/** @param {boolean} [enabled] */
+export const enableColors = (enabled) => {
+  if (enabled) {
+    COLORS_ENABLED = true
+  }
+}
+
+/**
+ * @param {util.InspectColor | readonly util.InspectColor[]} format
+ * @returns {(text: string) => string}
+ */
+const styleText = (format) => (text) =>
+  COLORS_ENABLED ? util.styleText(format, text, { validateStream: false }) : text
+
+export const green = styleText('green')
+
+export const red = styleText('red')
+
+export const yellow = styleText('yellow')
+
+export const blue = styleText('blue')
+
+export const dim = styleText('dim')
 
-export const red = (text) => (SUPPORTS_COLOR ? util.styleText('red', text) : text)
-export const yellow = (text) => (SUPPORTS_COLOR ? util.styleText('yellow', text) : text)
-export const blue = (text) => (SUPPORTS_COLOR ? util.styleText('blue', text) : text)
-export const dim = (text) => (SUPPORTS_COLOR ? util.styleText('dim', text) : text)
-export const bold = (text) => (SUPPORTS_COLOR ? util.styleText('bold', text) : text)
+export const bold = styleText('bold')

package/lib/debug.js

@@ -1,8 +1,8 @@
 import { formatWithOptions } from 'node:util'
 
-import { dim, SUPPORTS_COLOR } from './colors.js'
+import { COLORS_ENABLED, dim } from './colors.js'
 
-const format = (...args) => formatWithOptions({ colors: SUPPORTS_COLOR }, ...args)
+const format = (...args) => formatWithOptions({ colors: COLORS_ENABLED }, ...args)
 
 let activeLogger
 

package/lib/execGit.js

@@ -4,9 +4,6 @@ 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
@@ -19,27 +16,16 @@ export const GIT_GLOBAL_OPTIONS = [...NO_SUBMODULE_RECURSE]
 /** @type {(cmd: string[], options?: { cwd?: string }) => Promise<string>} */
 export const execGit = async (cmd, options) => {
   debugLog('Running git command:', cmd)
-  const result = exec('git', [...NO_SUBMODULE_RECURSE, ...cmd], {
+  const result = await exec('git', [...NO_SUBMODULE_RECURSE, ...cmd], {
     nodeOptions: {
       env: options?.env,
       cwd: options?.cwd,
     },
   })
 
-  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()
-
   if (result.exitCode > 0) {
-    throw new Error(output, { cause: result })
+    throw new Error(result.stderr.trimEnd(), { cause: result })
   }
 
-  return output
+  return result.stdout.trimEnd()
 }

package/lib/figures.js

@@ -1,9 +1,13 @@
-import { figures } from 'listr2'
+import { blue, dim, green, red, yellow } from './colors.js'
 
-import { blue, red, yellow } from './colors.js'
+export const wip = () => blue('⋯')
 
-export const info = blue(figures.arrowRight)
+export const done = () => green('✔')
 
-export const error = red(figures.cross)
+export const info = () => blue('→')
 
-export const warning = yellow(figures.warning)
+export const error = () => red('✖')
+
+export const warning = () => yellow('⚠')
+
+export const cancelled = () => dim('↓')

package/lib/getFunctionTask.js

@@ -1,4 +1,5 @@
 import { createDebug } from './debug.js'
+import { Signal } from './getAbortController.js'
 import { createTaskError } from './getSpawnedTask.js'
 
 const debugLog = createDebug('lint-staged:getFunctionTasks')
@@ -13,17 +14,25 @@ export const isFunctionTask = (commands) => typeof commands === 'object' && !Arr
 /**
  * Handles function configuration and pushes the tasks into the task array
  *
- * @param {object} command
- * @param {import('./getStagedFiles.js').StagedFile[]} files
+ * @param {object} options
+ * @param {AbortController} options.abortController
+ * @param {FunctionTask} options.command
+ * @param {boolean} options.continueOnError
+ * @param {import('./getStagedFiles.js').StagedFile[]} options.files
  * @throws {Error} If the function configuration is not valid
  */
-export const getFunctionTask = async (command, files) => {
-  debugLog('Creating Listr tasks for function %o', command)
+export const getFunctionTask = async ({ abortController, command, continueOnError, files }) => {
+  debugLog('Creating task for function %o', command)
 
   const task = async (ctx) => {
     try {
       await command.task(files.map((file) => file.filepath))
     } catch (e) {
+      if (continueOnError !== true) {
+        /** Other tasks should be killed */
+        abortController.abort(Signal.SIGKILL)
+      }
+
       throw createTaskError(command.title, e, ctx)
     }
   }

package/lib/getSpawnedTask.js

@@ -1,9 +1,9 @@
 import { parseArgsStringToArgv } from 'string-argv'
 import { exec } from 'tinyexec'
 
-import { dim, red } from './colors.js'
+import { COLORS_ENABLED, dim, red } from './colors.js'
 import { createDebug } from './debug.js'
-import { error, info } from './figures.js'
+import * as figures from './figures.js'
 import { Signal } from './getAbortController.js'
 import { killSubProcesses } from './killSubprocesses.js'
 import { getInitialState } from './state.js'
@@ -22,7 +22,9 @@ const debugLog = createDebug('lint-staged:getSpawnedTask')
  */
 const handleTaskOutput = (command, output, ctx, signal, errorResult) => {
   if (output) {
-    const outputTitle = errorResult ? red(`${error} ${command}:`) : `${info} ${command}:`
+    const outputTitle = errorResult
+      ? red(`${figures.error()} ${command}:`)
+      : `${figures.info()} ${command}:`
     ctx.output.push([...(ctx.quiet ? [] : ['', outputTitle]), output].join('\n'))
     return
   }
@@ -32,11 +34,11 @@ const handleTaskOutput = (command, output, ctx, signal, errorResult) => {
   }
 
   if (signal === 'SIGINT') {
-    ctx.output.push(red(`\n${error} Task interrupted: ${command}`))
+    ctx.output.push(red(`\n${figures.error()} Task interrupted: ${command}`))
   } else if (signal === 'SIGKILL') {
-    ctx.output.push(red(`\n${error} Task killed: ${command}`))
+    ctx.output.push(red(`\n${figures.error()} Task killed: ${command}`))
   } else if (errorResult) {
-    ctx.output.push(red(`\n${error} Task failed to spawn: ${command}`), signal)
+    ctx.output.push(red(`\n${figures.error()} Task failed to spawn: ${command}`), signal)
   }
 }
 
@@ -59,7 +61,6 @@ export const createTaskError = (command, result, ctx, signal = 'FAILED') => {
  *
  * @param {Object} options
  * @param {AbortController} options.abortController
- * @param {boolean} [options.color]
  * @param {string} options.command — Linter task
  * @param {string} [options.continueOnError]
  * @param {string} [options.cwd]
@@ -71,7 +72,6 @@ export const createTaskError = (command, result, ctx, signal = 'FAILED') => {
  */
 export const getSpawnedTask = ({
   abortController,
-  color,
   command,
   continueOnError = false,
   cwd = process.cwd(),
@@ -90,7 +90,7 @@ export const getSpawnedTask = ({
       // Only use topLevelDir as CWD if we are using the git binary
       // 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' },
+      env: COLORS_ENABLED ? { FORCE_COLOR: 'true' } : { NO_COLOR: 'true' },
     },
   }
 

package/lib/getSpawnedTasks.js

@@ -5,11 +5,10 @@ import { configurationError } from './messages.js'
 const debugLog = createDebug('lint-staged:getSpawnedTasks')
 
 /**
- * Creates and returns an array of listr tasks which map to the given commands.
+ * Creates and returns an array of tasks which map to the given commands.
  *
  * @param {object} options
  * @param {AbortController} options.abortController
- * @param {boolean} [options.color]
  * @param {Array<string|Function>|string|Function} options.commands
  * @param {string} options.continueOnError
  * @param {string} options.cwd
@@ -19,7 +18,6 @@ const debugLog = createDebug('lint-staged:getSpawnedTasks')
  */
 export const getSpawnedTasks = async ({
   abortController,
-  color,
   commands,
   continueOnError,
   cwd,
@@ -27,7 +25,7 @@ export const getSpawnedTasks = async ({
   topLevelDir,
   verbose,
 }) => {
-  debugLog('Creating Listr tasks for commands %o', commands)
+  debugLog('Creating tasks for commands %o', commands)
   const cmdTasks = []
 
   const commandArray = Array.isArray(commands) ? commands : [commands]
@@ -58,7 +56,6 @@ export const getSpawnedTasks = async ({
 
       const task = getSpawnedTask({
         abortController,
-        color,
         command,
         continueOnError,
         cwd,
@@ -68,7 +65,7 @@ export const getSpawnedTasks = async ({
         verbose,
       })
 
-      cmdTasks.push({ title: command, command, task })
+      cmdTasks.push({ title: command, task })
     }
   }