lint-staged 10.0.3 → 10.0.7

package/README.md

@@ -166,7 +166,19 @@ Supported are any executables installed locally or globally via `npm` as well as
 
 Pass arguments to your commands separated by space as you would do in the shell. See [examples](#examples) below.
 
-Starting from [v2.0.0](https://github.com/okonet/lint-staged/releases/tag/2.0.0) sequences of commands are supported. Pass an array of commands instead of a single one and they will run sequentially. This is useful for running autoformatting tools like `eslint --fix` or `stylefmt` but can be used for any arbitrary sequences.
+## Running multiple commands in a sequence
+
+You can run multiple commands in a sequence on every glob. To do so, pass an array of commands instead of a single one. This is useful for running autoformatting tools like `eslint --fix` or `stylefmt` but can be used for any arbitrary sequences. 
+
+For example:
+
+```json
+{
+  "*.js": ["eslint", "prettier --write"]
+}
+```
+
+going to execute `eslint` and if it exits with `0` code, it will execute `prettier --write` on all staged `*.js` files.
 
 ## Using JS functions to customize tasks
 
@@ -332,23 +344,11 @@ For example, here is `jest` running on all `.js` files with the `NODE_ENV` varia
 }
 ```
 
-### Automatically fix code style with `prettier` for javascript + flow, typescript, markdown or html
-
-```json
-{
-  "*.{js,jsx}": "prettier --write"
-}
-```
-
-```json
-{
-  "*.{ts,tsx}": "prettier --write"
-}
-```
+### Automatically fix code style with `prettier` for javascript, typescript, markdown, HTML, or CSS
 
 ```json
 {
-  "*.{md,html}": "prettier --write"
+  "*.{js,jsx,ts,tsx,md,html,css}": "prettier --write"
 }
 ```
 
@@ -365,7 +365,7 @@ For example, here is `jest` running on all `.js` files with the `NODE_ENV` varia
 
 ```json
 {
-  "*.scss": "postcss --config path/to/your/config --replace", "stylelint"
+  "*.scss": ["postcss --config path/to/your/config --replace", "stylelint"]
 }
 ```
 

package/bin/{lint-staged → lint-staged.js}

@@ -3,10 +3,9 @@
 'use strict'
 
 // Force colors for packages that depend on https://www.npmjs.com/package/supports-color
-// but do this only in TTY mode
-if (process.stdout.isTTY) {
-  // istanbul ignore next
-  process.env.FORCE_COLOR = '1'
+const { supportsColor } = require('chalk')
+if (supportsColor) {
+  process.env.FORCE_COLOR = supportsColor.level.toString()
 }
 
 // Do not terminate main Listr process on SIGINT
@@ -36,7 +35,7 @@ cmdline
     '-p, --concurrent <parallel tasks>',
     'the number of tasks to run concurrently, or false to run tasks serially',
     true
-    )
+  )
   .option('-q, --quiet', 'disable lint-staged’s own console output', false)
   .option('-r, --relative', 'pass relative filepaths to tasks', false)
   .option('-x, --shell', 'skip parsing of tasks for better shell support', false)
@@ -74,7 +73,7 @@ const options = {
   maxArgLength: getMaxArgLength() / 2,
   quiet: !!cmdline.quiet,
   relative: !!cmdline.relative,
-  shell: !!cmdline.shell,
+  shell: !!cmdline.shell
 }
 
 debug('Options parsed from command-line:', options)

package/lib/file.js

@@ -2,67 +2,80 @@
 
 const debug = require('debug')('lint-staged:file')
 const fs = require('fs')
+const { promisify } = require('util')
 
-const fsPromises = fs.promises
+const fsAccess = promisify(fs.access)
+const fsReadFile = promisify(fs.readFile)
+const fsUnlink = promisify(fs.unlink)
+const fsWriteFile = promisify(fs.writeFile)
 
 /**
- * Check if a file exists. Returns the filepath if exists.
- * @param {string} filepath
+ * Check if a file exists. Returns the filename if exists.
+ * @param {String} filename
+ * @returns {String|Boolean}
  */
-const exists = async filepath => {
+const exists = async filename => {
   try {
-    await fsPromises.access(filepath)
-    return filepath
+    await fsAccess(filename)
+    return filename
   } catch {
     return false
   }
 }
 
 /**
+ * Read contents of a file to buffer
  * @param {String} filename
- * @returns {Promise<Buffer|Null>}
+ * @param {Boolean} [ignoreENOENT=true] — Whether to throw if the file doesn't exist
+ * @returns {Promise<Buffer>}
  */
-const readBufferFromFile = (filename, rejectENOENT = false) =>
-  new Promise(resolve => {
-    debug('Reading buffer from file `%s`', filename)
-    fs.readFile(filename, (error, buffer) => {
-      if (!rejectENOENT && error && error.code === 'ENOENT') {
-        debug("File `%s` doesn't exist, ignoring...", filename)
-        return resolve(null) // no-op file doesn't exist
-      }
-      debug('Done reading buffer from file `%s`!', filename)
-      resolve(buffer)
-    })
-  })
+const readFile = async (filename, ignoreENOENT = true) => {
+  debug('Reading file `%s`', filename)
+  try {
+    return await fsReadFile(filename)
+  } catch (error) {
+    if (ignoreENOENT && error.code === 'ENOENT') {
+      debug("File `%s` doesn't exist, ignoring...", filename)
+      return null // no-op file doesn't exist
+    } else {
+      throw error
+    }
+  }
+}
 
 /**
  * Unlink a file if it exists
- * @param {*} filepath
+ * @param {String} filename
+ * @param {Boolean} [ignoreENOENT=true] — Whether to throw if the file doesn't exist
  */
-const unlink = async filepath => {
-  if (filepath) {
-    await fsPromises.access(filepath)
-    await fsPromises.unlink(filepath)
+const unlink = async (filename, ignoreENOENT = true) => {
+  if (filename) {
+    debug('Unlinking file `%s`', filename)
+    try {
+      await fsUnlink(filename)
+    } catch (error) {
+      if (ignoreENOENT && error.code === 'ENOENT') {
+        debug("File `%s` doesn't exist, ignoring...", filename)
+      } else {
+        throw error
+      }
+    }
   }
 }
 
 /**
+ * Write buffer to file
  * @param {String} filename
  * @param {Buffer} buffer
- * @returns {Promise<Void>}
  */
-const writeBufferToFile = (filename, buffer) =>
-  new Promise(resolve => {
-    debug('Writing buffer to file `%s`', filename)
-    fs.writeFile(filename, buffer, () => {
-      debug('Done writing buffer to file `%s`!', filename)
-      resolve()
-    })
-  })
+const writeFile = async (filename, buffer) => {
+  debug('Writing file `%s`', filename)
+  await fsWriteFile(filename, buffer)
+}
 
 module.exports = {
   exists,
-  readBufferFromFile,
+  readFile,
   unlink,
-  writeBufferToFile
+  writeFile
 }

package/lib/getStagedFiles.js

@@ -6,7 +6,7 @@ module.exports = async function getStagedFiles(options) {
   try {
     const lines = await execGit(['diff', '--staged', '--diff-filter=ACMR', '--name-only'], options)
     return lines ? lines.split('\n') : []
-  } catch (error) {
+  } catch {
     return null
   }
 }

package/lib/gitWorkflow.js

@@ -4,7 +4,7 @@ const debug = require('debug')('lint-staged:git')
 const path = require('path')
 
 const execGit = require('./execGit')
-const { exists, readBufferFromFile, unlink, writeBufferToFile } = require('./file')
+const { exists, readFile, unlink, writeFile } = require('./file')
 
 const MERGE_HEAD = 'MERGE_HEAD'
 const MERGE_MODE = 'MERGE_MODE'
@@ -18,23 +18,6 @@ const PATCH_UNTRACKED = 'lint-staged_untracked.patch'
 const GIT_APPLY_ARGS = ['apply', '-v', '--whitespace=nowarn', '--recount', '--unidiff-zero']
 const GIT_DIFF_ARGS = ['--binary', '--unified=0', '--no-color', '--no-ext-diff', '--patch']
 
-/**
- * Delete untracked files using `git clean`
- * @param {Function} execGit function for executing git commands using execa
- * @returns {Promise<void>}
- */
-const cleanUntrackedFiles = async execGit => {
-  const untrackedFiles = await execGit(['ls-files', '--others', '--exclude-standard'])
-  if (untrackedFiles) {
-    debug('Detected unstaged, untracked files: ', untrackedFiles)
-    debug(
-      'This is probably due to a bug in git =< 2.13.0 where `git stash --keep-index` resurrects deleted files.'
-    )
-    debug('Deleting the files using `git clean`...')
-    await execGit(['clean', '--force', ...untrackedFiles.split('\n')])
-  }
-}
-
 const handleError = (error, ctx) => {
   ctx.gitError = true
   throw error
@@ -44,6 +27,7 @@ class GitWorkflow {
   constructor({ allowEmpty, gitConfigDir, gitDir, stagedFileChunks }) {
     this.execGit = (args, options = {}) => execGit(args, { ...options, cwd: gitDir })
     this.gitConfigDir = gitConfigDir
+    this.gitDir = gitDir
     this.unstagedDiff = null
     this.allowEmpty = allowEmpty
     this.stagedFileChunks = stagedFileChunks
@@ -73,7 +57,7 @@ class GitWorkflow {
     const resolved = this.getHiddenFilepath(filename)
     const pathIfExists = await exists(resolved)
     if (!pathIfExists) return false
-    const buffer = await readBufferFromFile(pathIfExists)
+    const buffer = await readFile(pathIfExists)
     const patch = buffer.toString().trim()
     return patch.length ? filename : false
   }
@@ -97,9 +81,9 @@ class GitWorkflow {
   async backupMergeStatus() {
     debug('Backing up merge state...')
     await Promise.all([
-      readBufferFromFile(this.mergeHeadFilename).then(buffer => (this.mergeHeadBuffer = buffer)),
-      readBufferFromFile(this.mergeModeFilename).then(buffer => (this.mergeModeBuffer = buffer)),
-      readBufferFromFile(this.mergeMsgFilename).then(buffer => (this.mergeMsgBuffer = buffer))
+      readFile(this.mergeHeadFilename).then(buffer => (this.mergeHeadBuffer = buffer)),
+      readFile(this.mergeModeFilename).then(buffer => (this.mergeModeBuffer = buffer)),
+      readFile(this.mergeMsgFilename).then(buffer => (this.mergeMsgBuffer = buffer))
     ])
     debug('Done backing up merge state!')
   }
@@ -111,9 +95,9 @@ class GitWorkflow {
     debug('Restoring merge state...')
     try {
       await Promise.all([
-        this.mergeHeadBuffer && writeBufferToFile(this.mergeHeadFilename, this.mergeHeadBuffer),
-        this.mergeModeBuffer && writeBufferToFile(this.mergeModeFilename, this.mergeModeBuffer),
-        this.mergeMsgBuffer && writeBufferToFile(this.mergeMsgFilename, this.mergeMsgBuffer)
+        this.mergeHeadBuffer && writeFile(this.mergeHeadFilename, this.mergeHeadBuffer),
+        this.mergeModeBuffer && writeFile(this.mergeModeFilename, this.mergeModeBuffer),
+        this.mergeMsgBuffer && writeFile(this.mergeMsgFilename, this.mergeMsgBuffer)
       ])
       debug('Done restoring merge state!')
     } catch (error) {
@@ -123,6 +107,18 @@ class GitWorkflow {
     }
   }
 
+  /**
+   * List and delete untracked files
+   */
+  async cleanUntrackedFiles() {
+    const lsFiles = await this.execGit(['ls-files', '--others', '--exclude-standard'])
+    const untrackedFiles = lsFiles
+      .split('\n')
+      .filter(Boolean)
+      .map(file => path.resolve(this.gitDir, file))
+    await Promise.all(untrackedFiles.map(file => unlink(file)))
+  }
+
   /**
    * Create backup stashes, one of everything and one of only staged changes
    * Staged files are left in the index for running tasks
@@ -135,6 +131,14 @@ class GitWorkflow {
       // Manually check and backup if necessary
       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 `--keep-index` flag resurrects deleted files
+      // - git stash can't infer RD or MD states correctly, and will lose the deletion
+      this.deletedFiles = (await this.execGit(['ls-files', '--deleted']))
+        .split('\n')
+        .filter(Boolean)
+        .map(file => path.resolve(this.gitDir, file))
+
       // Save stash of entire original state, including unstaged and untracked changes.
       // `--keep-index leaves only staged files on disk, for tasks.`
       await this.execGit(['stash', 'save', '--include-untracked', '--keep-index', STASH])
@@ -144,7 +148,7 @@ class GitWorkflow {
 
       // There is a bug in git =< 2.13.0 where `--keep-index` resurrects deleted files.
       // These files should be listed and deleted before proceeding.
-      await cleanUntrackedFiles(this.execGit)
+      await this.cleanUntrackedFiles()
 
       // Get a diff of unstaged changes by diffing the saved stash against what's left on disk.
       await this.execGit([
@@ -238,6 +242,9 @@ class GitWorkflow {
       ctx.gitRestoreUntrackedError = true
       handleError(error, ctx)
     }
+
+    // If stashing resurrected deleted files, clean them out
+    await Promise.all(this.deletedFiles.map(file => unlink(file)))
   }
 
   /**
@@ -251,6 +258,9 @@ class GitWorkflow {
       await this.execGit(['stash', 'apply', '--quiet', '--index', backupStash])
       debug('Done restoring original state!')
 
+      // If stashing resurrected deleted files, clean them out
+      await Promise.all(this.deletedFiles.map(file => unlink(file)))
+
       // Restore meta information about ongoing git merge
       await this.restoreMergeStatus()
     } catch (error) {
@@ -278,4 +288,3 @@ class GitWorkflow {
 }
 
 module.exports = GitWorkflow
-module.exports.cleanUntrackedFiles = cleanUntrackedFiles

package/lib/index.js

@@ -14,7 +14,7 @@ const errConfigNotFound = new Error('Config could not be found')
 function resolveConfig(configPath) {
   try {
     return require.resolve(configPath)
-  } catch (ignore) {
+  } catch {
     return configPath
   }
 }

package/lib/resolveGitRepo.js

@@ -1,48 +1,52 @@
 'use strict'
 
 const normalize = require('normalize-path')
+const debugLog = require('debug')('lint-staged:resolveGitRepo')
+const fs = require('fs')
 const path = require('path')
+const { promisify } = require('util')
 
 const execGit = require('./execGit')
-const { readBufferFromFile } = require('./file')
+const { readFile } = require('./file')
+
+const fsLstat = promisify(fs.lstat)
 
 /**
  * Resolve path to the .git directory, with special handling for
- * submodules
+ * submodules and worktrees
  */
-const resolveGitConfigDir = async ({ gitDir, isSubmodule }) => {
+const resolveGitConfigDir = async gitDir => {
   const defaultDir = path.resolve(gitDir, '.git')
-  if (!isSubmodule) return normalize(defaultDir)
-
-  const buffer = await readBufferFromFile(defaultDir)
-  const dotGit = buffer.toString()
-  const gitConfigDir = path.resolve(gitDir, dotGit.replace(/^gitdir: /, '').trim())
-  return normalize(gitConfigDir)
+  const stats = await fsLstat(defaultDir)
+  // If .git is a directory, use it
+  if (stats.isDirectory()) return defaultDir
+  // Otherwise .git is a file containing path to real location
+  const file = (await readFile(defaultDir)).toString()
+  return path.resolve(gitDir, file.replace(/^gitdir: /, '')).trim()
 }
 
 /**
  * Resolve git directory and possible submodule paths
  */
-module.exports = async function resolveGitRepo(options = {}) {
+const resolveGitRepo = async cwd => {
   try {
+    debugLog('Resolving git repo from `%s`', cwd)
     // git cli uses GIT_DIR to fast track its response however it might be set to a different path
     // depending on where the caller initiated this from, hence clear GIT_DIR
+    debugLog('Deleting GIT_DIR from env with value `%s`', process.env.GIT_DIR)
     delete process.env.GIT_DIR
 
-    // The git repo root directory; this points to the root of a submodule instead of the parent
-    const gitDir = await execGit(['rev-parse', '--show-toplevel'], options)
+    const gitDir = normalize(await execGit(['rev-parse', '--show-toplevel'], { cwd }))
+    const gitConfigDir = normalize(await resolveGitConfigDir(gitDir))
 
-    // A super-project working tree exists only in submodules; poinst to the parent root
-    const superprojectWorkingTree = await execGit(
-      ['rev-parse', '--show-superproject-working-tree'],
-      options
-    )
+    debugLog('Resolved git directory to be `%s`', gitDir)
+    debugLog('Resolved git config directory to be `%s`', gitConfigDir)
 
-    const isSubmodule = !!superprojectWorkingTree
-    const gitConfigDir = await resolveGitConfigDir({ gitDir, isSubmodule })
-
-    return { gitDir: normalize(gitDir), gitConfigDir, isSubmodule }
+    return { gitDir, gitConfigDir }
   } catch (error) {
-    return { error, gitDir: null }
+    debugLog('Failed to resolve git repo with error:', error)
+    return { error, gitDir: null, gitConfigDir: null }
   }
 }
+
+module.exports = resolveGitRepo

package/lib/runAll.js

@@ -15,6 +15,14 @@ const resolveGitRepo = require('./resolveGitRepo')
 
 const debugLog = require('debug')('lint-staged:run')
 
+const getRenderer = ({ debug, quiet }) => {
+  if (quiet) return 'silent'
+  // Better support for dumb terminals: https://en.wikipedia.org/wiki/Computer_terminal#Dumb_terminals
+  const isDumbTerminal = process.env.TERM === 'dumb'
+  if (debug || isDumbTerminal) return 'verbose'
+  return 'update'
+}
+
 /**
  * Executes all tasks and either resolves or rejects the promise
  *
@@ -47,11 +55,8 @@ module.exports = async function runAll(
 ) {
   debugLog('Running all linter scripts')
 
-  const { gitDir, gitConfigDir, isSubmodule } = await resolveGitRepo({ cwd })
+  const { gitDir, gitConfigDir } = await resolveGitRepo(cwd)
   if (!gitDir) throw new Error('Current directory is not a git directory!')
-  debugLog('Resolved git directory to be `%s`', gitDir)
-  debugLog('Resolved git config directory to be `%s`', gitConfigDir)
-  if (isSubmodule) debugLog('Current git directory is a submodule')
 
   const files = await getStagedFiles({ cwd: gitDir })
   if (!files) throw new Error('Unable to get staged files!')
@@ -74,7 +79,7 @@ module.exports = async function runAll(
   const listrOptions = {
     dateFormat: false,
     exitOnError: false,
-    renderer: (quiet && 'silent') || (debug && 'verbose') || 'update'
+    renderer: getRenderer({ debug, quiet })
   }
 
   const listrTasks = []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "10.0.3",
+  "version": "10.0.7",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -13,7 +13,7 @@
   "funding": {
     "url": "https://opencollective.com/lint-staged"
   },
-  "bin": "./bin/lint-staged",
+  "bin": "./bin/lint-staged.js",
   "main": "./lib/index.js",
   "files": [
     "bin",
@@ -30,7 +30,7 @@
   },
   "husky": {
     "hooks": {
-      "pre-commit": "./bin/lint-staged"
+      "pre-commit": "./bin/lint-staged.js"
     }
   },
   "dependencies": {