lint-staged 10.2.4 → 10.2.8

package/lib/gitWorkflow.js

@@ -19,19 +19,20 @@ const MERGE_HEAD = 'MERGE_HEAD'
 const MERGE_MODE = 'MERGE_MODE'
 const MERGE_MSG = 'MERGE_MSG'
 
-// In git status, renames are presented as `from` -> `to`.
+// In git status machine output, renames are presented as `to`NUL`from`
 // When diffing, both need to be taken into account, but in some cases on the `to`.
-const RENAME = / -> /
+// eslint-disable-next-line no-control-regex
+const RENAME = /\x00/
 
 /**
- * From list of files, split renames and flatten into two files `from` -> `to`.
+ * From list of files, split renames and flatten into two files `to`NUL`from`.
  * @param {string[]} files
  * @param {Boolean} [includeRenameFrom=true] Whether or not to include the `from` renamed file, which is no longer on disk
  */
 const processRenames = (files, includeRenameFrom = true) =>
   files.reduce((flattened, file) => {
     if (RENAME.test(file)) {
-      const [from, to] = file.split(RENAME)
+      const [to, from] = file.split(RENAME)
       if (includeRenameFrom) flattened.push(from)
       flattened.push(to)
     } else {
@@ -158,15 +159,20 @@ class GitWorkflow {
    */
   async getPartiallyStagedFiles() {
     debug('Getting partially staged files...')
-    const status = await this.execGit(['status', '--porcelain'])
+    const status = await this.execGit(['status', '-z'])
+    /**
+     * See https://git-scm.com/docs/git-status#_short_format
+     * Entries returned in machine format are separated by a NUL character.
+     * The first letter of each entry represents current index status,
+     * and second the working tree. Index and working tree status codes are
+     * separated from the file name by a space. If an entry includes a
+     * renamed file, the file names are separated by a NUL character
+     * (e.g. `to`\0`from`)
+     */
     const partiallyStaged = status
-      .split('\n')
+      // eslint-disable-next-line no-control-regex
+      .split(/\x00(?=[ AMDRCU?!]{2} |$)/)
       .filter((line) => {
-        /**
-         * See https://git-scm.com/docs/git-status#_short_format
-         * The first letter of the line represents current index status,
-         * and second the working tree
-         */
         const [index, workingTree] = line
         return index !== ' ' && workingTree !== ' ' && index !== '?' && workingTree !== '?'
       })

package/lib/makeCmdTasks.js

@@ -1,9 +1,27 @@
 'use strict'
 
+const cliTruncate = require('cli-truncate')
+const debug = require('debug')('lint-staged:make-cmd-tasks')
+
 const resolveTaskFn = require('./resolveTaskFn')
 const { createError } = require('./validateConfig')
 
-const debug = require('debug')('lint-staged:make-cmd-tasks')
+const STDOUT_COLUMNS_DEFAULT = 80
+
+const listrPrefixLength = {
+  update: `    X `.length, // indented task title where X is a checkmark or a cross (failure)
+  verbose: `[STARTED] `.length, // verbose renderer uses 7-letter STARTED/SUCCESS prefixes
+}
+
+/**
+ * Get length of title based on the number of available columns prefix length
+ * @param {string} renderer The name of the Listr renderer
+ * @returns {number}
+ */
+const getTitleLength = (renderer, columns = process.stdout.columns) => {
+  const prefixLength = listrPrefixLength[renderer] || 0
+  return (columns || STDOUT_COLUMNS_DEFAULT) - prefixLength
+}
 
 /**
  * Creates and returns an array of listr tasks which map to the given commands.
@@ -12,10 +30,11 @@ const debug = require('debug')('lint-staged:make-cmd-tasks')
  * @param {Array<string|Function>|string|Function} options.commands
  * @param {Array<string>} options.files
  * @param {string} options.gitDir
+ * @param {string} options.renderer
  * @param {Boolean} shell
  * @param {Boolean} verbose
  */
-module.exports = async function makeCmdTasks({ commands, files, gitDir, shell, verbose }) {
+const makeCmdTasks = async ({ commands, files, gitDir, renderer, shell, verbose }) => {
   debug('Creating listr tasks for commands %o', commands)
   const commandArray = Array.isArray(commands) ? commands : [commands]
   const cmdTasks = []
@@ -28,32 +47,26 @@ module.exports = async function makeCmdTasks({ commands, files, gitDir, shell, v
     const resolvedArray = Array.isArray(resolved) ? resolved : [resolved] // Wrap non-array command as array
 
     for (const command of resolvedArray) {
-      let title = isFn ? '[Function]' : command
-
-      if (isFn) {
-        // If the function linter didn't return string | string[]  it won't work
-        // Do the validation here instead of `validateConfig` to skip evaluating the function multiple times
-        if (typeof command !== 'string') {
-          throw new Error(
-            createError(
-              title,
-              'Function task should return a string or an array of strings',
-              resolved
-            )
+      // If the function linter didn't return string | string[]  it won't work
+      // Do the validation here instead of `validateConfig` to skip evaluating the function multiple times
+      if (isFn && typeof command !== 'string') {
+        throw new Error(
+          createError(
+            '[Function]',
+            'Function task should return a string or an array of strings',
+            resolved
           )
-        }
-
-        const [startOfFn] = command.split(' ')
-        title += ` ${startOfFn} ...` // Append function name, like `[Function] eslint ...`
+        )
       }
 
-      cmdTasks.push({
-        title,
-        command,
-        task: resolveTaskFn({ command, files, gitDir, isFn, shell, verbose }),
-      })
+      // Truncate title to single line based on renderer
+      const title = cliTruncate(command, getTitleLength(renderer))
+      const task = resolveTaskFn({ command, files, gitDir, isFn, shell, verbose })
+      cmdTasks.push({ title, command, task })
     }
   }
 
   return cmdTasks
 }
+
+module.exports = makeCmdTasks

package/lib/runAll.js

@@ -119,6 +119,7 @@ const runAll = async (
     ctx,
     exitOnError: false,
     nonTTYRenderer: 'verbose',
+    registerSignalListeners: false,
     ...getRenderer({ debug, quiet }),
   }
 
@@ -136,6 +137,7 @@ const runAll = async (
         commands: task.commands,
         files: task.fileList,
         gitDir,
+        renderer: listrOptions.renderer,
         shell,
         verbose,
       })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "10.2.4",
+  "version": "10.2.8",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -33,6 +33,7 @@
   },
   "dependencies": {
     "chalk": "^4.0.0",
+    "cli-truncate": "2.1.0",
     "commander": "^5.1.0",
     "cosmiconfig": "^6.0.0",
     "debug": "^4.1.1",
@@ -62,7 +63,6 @@
     "husky": "^4.2.5",
     "jest": "^26.0.1",
     "jest-snapshot-serializer-ansi": "^1.0.0",
-    "nanoid": "^3.1.7",
     "prettier": "^2.0.5"
   },
   "config": {