lint-staged 10.1.3 → 10.1.7

package/bin/lint-staged.js

@@ -81,7 +81,7 @@ const options = {
 debug('Options parsed from command-line:', options)
 
 lintStaged(options)
-  .then(passed => {
+  .then((passed) => {
     process.exitCode = passed ? 0 : 1
   })
   .catch(() => {

package/lib/chunkFiles.js

@@ -38,7 +38,7 @@ module.exports = function chunkFiles({ files, baseDir, maxArgLength = null, rela
     return [files]
   }
 
-  const normalizedFiles = files.map(file =>
+  const normalizedFiles = files.map((file) =>
     normalize(relative || !baseDir ? file : path.resolve(baseDir, file))
   )
   const fileListLength = normalizedFiles.join(' ').length

package/lib/generateTasks.js

@@ -25,8 +25,8 @@ module.exports = function generateTasks({
 }) {
   debug('Generating linter tasks')
 
-  const absoluteFiles = files.map(file => normalize(path.resolve(gitDir, file)))
-  const relativeFiles = absoluteFiles.map(file => normalize(path.relative(cwd, file)))
+  const absoluteFiles = files.map((file) => normalize(path.resolve(gitDir, file)))
+  const relativeFiles = absoluteFiles.map((file) => normalize(path.relative(cwd, file)))
 
   return Object.entries(config).map(([pattern, commands]) => {
     const isParentDirPattern = pattern.startsWith('../')
@@ -35,7 +35,7 @@ module.exports = function generateTasks({
       relativeFiles
         // Only worry about children of the CWD unless the pattern explicitly
         // specifies that it concerns a parent directory.
-        .filter(file => {
+        .filter((file) => {
           if (isParentDirPattern) return true
           return !file.startsWith('..') && !path.isAbsolute(file)
         }),
@@ -48,7 +48,7 @@ module.exports = function generateTasks({
         // match both `test.js` and `subdirectory/test.js`.
         matchBase: !pattern.includes('/')
       }
-    ).map(file => normalize(relative ? file : path.resolve(cwd, file)))
+    ).map((file) => normalize(relative ? file : path.resolve(cwd, file)))
 
     const task = { pattern, commands, fileList }
     debug('Generated task: \n%O', task)

package/lib/gitWorkflow.js

@@ -85,7 +85,7 @@ class GitWorkflow {
    */
   async getBackupStash(ctx) {
     const stashes = await this.execGit(['stash', 'list'])
-    const index = stashes.split('\n').findIndex(line => line.includes(STASH))
+    const index = stashes.split('\n').findIndex((line) => line.includes(STASH))
     if (index === -1) {
       ctx.gitGetBackupStashError = true
       throw new Error('lint-staged automatic backup is missing!')
@@ -102,7 +102,7 @@ class GitWorkflow {
     const deletedFiles = lsFiles
       .split('\n')
       .filter(Boolean)
-      .map(file => path.resolve(this.gitDir, file))
+      .map((file) => path.resolve(this.gitDir, file))
     debug('Found deleted files:', deletedFiles)
     return deletedFiles
   }
@@ -113,9 +113,9 @@ class GitWorkflow {
   async backupMergeStatus() {
     debug('Backing up merge state...')
     await Promise.all([
-      readFile(this.mergeHeadFilename).then(buffer => (this.mergeHeadBuffer = buffer)),
-      readFile(this.mergeModeFilename).then(buffer => (this.mergeModeBuffer = buffer)),
-      readFile(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!')
   }
@@ -149,7 +149,7 @@ class GitWorkflow {
     const status = await this.execGit(['status', '--porcelain'])
     const partiallyStaged = status
       .split('\n')
-      .filter(line => {
+      .filter((line) => {
         /**
          * See https://git-scm.com/docs/git-status#_short_format
          * The first letter of the line represents current index status,
@@ -158,7 +158,8 @@ class GitWorkflow {
         const [index, workingTree] = line
         return index !== ' ' && workingTree !== ' ' && index !== '?' && workingTree !== '?'
       })
-      .map(line => line.substr(3)) // Remove first three letters (index, workingTree, and a whitespace)
+      .map((line) => line.substr(3)) // Remove first three letters (index, workingTree, and a whitespace)
+      .filter(Boolean) // Filter empty string
     debug('Found partially staged files:', partiallyStaged)
     return partiallyStaged.length ? partiallyStaged : null
   }
@@ -166,7 +167,7 @@ class GitWorkflow {
   /**
    * Create a diff of partially staged files and backup stash if enabled.
    */
-  async prepare(ctx, stash) {
+  async prepare(ctx, shouldBackup) {
     try {
       debug('Backing up original state...')
 
@@ -184,32 +185,24 @@ class GitWorkflow {
       /**
        * If backup stash should be skipped, no need to continue
        */
-      if (!stash) return
+      if (!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 `--keep-index` flag resurrects deleted files
+      // - 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()
 
-      // the `git stash` clears metadata about a possible git merge
-      // Manually check and backup if necessary
-      await this.backupMergeStatus()
-
-      // Save stash of original state
-      await this.execGit(['stash', 'save', STASH])
-      await this.execGit(['stash', 'apply', '--quiet', '--index', await this.getBackupStash()])
-
-      // Restore meta information about ongoing git merge, cleared by `git stash`
-      await this.restoreMergeStatus()
-
-      // If stashing resurrected deleted files, clean them out
-      await Promise.all(this.deletedFiles.map(file => unlink(file)))
+      // 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 hash = await this.execGit(['stash', 'create'])
+      await this.execGit(['stash', 'store', '--quiet', '--message', STASH, hash])
 
       debug('Done backing up original state!')
     } catch (error) {
-      if (error.message && error.message.includes('You do not have the initial commit yet')) {
-        ctx.emptyGitRepo = true
-      }
       handleError(error, ctx)
     }
   }
@@ -306,10 +299,10 @@ class GitWorkflow {
       await this.restoreMergeStatus()
 
       // If stashing resurrected deleted files, clean them out
-      await Promise.all(this.deletedFiles.map(file => unlink(file)))
+      await Promise.all(this.deletedFiles.map((file) => unlink(file)))
 
       // Clean out patch
-      if (this.partiallyStagedFiles) await unlink(PATCH_UNSTAGED)
+      await unlink(this.getHiddenFilepath(PATCH_UNSTAGED))
 
       debug('Done restoring original state!')
     } catch (error) {

package/lib/printErrors.js

@@ -2,11 +2,11 @@
 
 // istanbul ignore next
 // Work-around for duplicated error logs, see #142
-const errMsg = err => (err.privateMsg != null ? err.privateMsg : err.message)
+const errMsg = (err) => (err.privateMsg != null ? err.privateMsg : err.message)
 
 module.exports = function printErrors(errorInstance, logger) {
   if (Array.isArray(errorInstance.errors)) {
-    errorInstance.errors.forEach(lintError => {
+    errorInstance.errors.forEach((lintError) => {
       logger.error(errMsg(lintError))
     })
   } else {

package/lib/resolveGitRepo.js

@@ -15,7 +15,7 @@ const fsLstat = promisify(fs.lstat)
  * Resolve path to the .git directory, with special handling for
  * submodules and worktrees
  */
-const resolveGitConfigDir = async gitDir => {
+const resolveGitConfigDir = async (gitDir) => {
   const defaultDir = normalize(path.join(gitDir, '.git'))
   const stats = await fsLstat(defaultDir)
   // If .git is a directory, use it
@@ -28,7 +28,7 @@ const resolveGitConfigDir = async gitDir => {
 /**
  * Resolve git directory and possible submodule paths
  */
-const resolveGitRepo = async cwd => {
+const resolveGitRepo = async (cwd) => {
   try {
     debugLog('Resolving git repo from `%s`', cwd)
 

package/lib/resolveTaskFn.js

@@ -8,7 +8,7 @@ const symbols = require('log-symbols')
 
 const debug = require('debug')('lint-staged:task')
 
-const successMsg = linter => `${symbols.success} ${linter} passed!`
+const successMsg = (linter) => `${symbols.success} ${linter} passed!`
 
 /**
  * Create and returns an error instance with a given message.
@@ -81,7 +81,7 @@ module.exports = function resolveTaskFn({ command, files, gitDir, isFn, relative
   }
   debug('execaOptions:', execaOptions)
 
-  return async ctx => {
+  return async (ctx) => {
     const promise = shell
       ? execa.command(isFn ? command : `${command} ${files.join(' ')}`, execaOptions)
       : execa(cmd, isFn ? args : args.concat(files), execaOptions)

package/lib/runAll.js

@@ -7,6 +7,7 @@ const Listr = require('listr')
 const symbols = require('log-symbols')
 
 const chunkFiles = require('./chunkFiles')
+const execGit = require('./execGit')
 const generateTasks = require('./generateTasks')
 const getStagedFiles = require('./getStagedFiles')
 const GitWorkflow = require('./gitWorkflow')
@@ -28,7 +29,7 @@ const MESSAGES = {
   GIT_ERROR: 'Skipped because of previous git error.'
 }
 
-const shouldSkipApplyModifications = ctx => {
+const shouldSkipApplyModifications = (ctx) => {
   // Should be skipped in case of git errors
   if (ctx.gitError) {
     return MESSAGES.GIT_ERROR
@@ -39,14 +40,14 @@ const shouldSkipApplyModifications = ctx => {
   }
 }
 
-const shouldSkipRevert = ctx => {
+const shouldSkipRevert = (ctx) => {
   // Should be skipped in case of unknown git errors
   if (ctx.gitError && !ctx.gitApplyEmptyCommitError && !ctx.gitRestoreUnstagedChangesError) {
     return MESSAGES.GIT_ERROR
   }
 }
 
-const shouldSkipCleanup = ctx => {
+const shouldSkipCleanup = (ctx) => {
   // Should be skipped in case of unknown git errors
   if (ctx.gitError && !ctx.gitApplyEmptyCommitError && !ctx.gitRestoreUnstagedChangesError) {
     return MESSAGES.GIT_ERROR
@@ -91,15 +92,22 @@ const runAll = async (
 ) => {
   debugLog('Running all linter scripts')
 
-  if (!stash) {
-    logger.warn(
-      `${symbols.warning} ${chalk.yellow('Skipping backup because `--no-stash` was used.')}`
-    )
-  }
-
   const { gitDir, gitConfigDir } = await resolveGitRepo(cwd)
   if (!gitDir) throw new Error('Current directory is not a git directory!')
 
+  // Test whether we have any commits or not.
+  // Stashing must be disabled with no initial commit.
+  const hasInitialCommit = await execGit(['log', '-1'], { cwd: gitDir })
+    .then(() => true)
+    .catch(() => false)
+
+  // Lint-staged should create a backup stash only when there's an initial commit
+  const shouldBackup = hasInitialCommit && stash
+  if (!shouldBackup) {
+    const reason = hasInitialCommit ? '`--no-stash` was used' : 'there’s no initial commit yet'
+    logger.warn(`${symbols.warning} ${chalk.yellow(`Skipping backup because ${reason}.\n`)}`)
+  }
+
   const files = await getStagedFiles({ cwd: gitDir })
   if (!files) throw new Error('Unable to get staged files!')
   debugLog('Loaded list of staged files in git:\n%O', files)
@@ -141,11 +149,11 @@ const runAll = async (
       })
 
       // Add files from task to match set
-      task.fileList.forEach(file => {
+      task.fileList.forEach((file) => {
         matchedFiles.add(file)
       })
 
-      hasDeprecatedGitAdd = subTasks.some(subTask => subTask.command === 'git add')
+      hasDeprecatedGitAdd = subTasks.some((subTask) => subTask.command === 'git add')
 
       chunkListrTasks.push({
         title: `Running tasks for ${task.pattern}`,
@@ -176,7 +184,7 @@ const runAll = async (
         // Skip if the first step (backup) failed
         if (ctx.gitError) return MESSAGES.GIT_ERROR
         // Skip chunk when no every task is skipped (due to no matches)
-        if (chunkListrTasks.every(task => task.skip())) return 'No tasks to run.'
+        if (chunkListrTasks.every((task) => task.skip())) return 'No tasks to run.'
         return false
       }
     })
@@ -191,7 +199,7 @@ const runAll = async (
 
   // If all of the configured tasks should be skipped
   // avoid executing any lint-staged logic
-  if (listrTasks.every(task => task.skip())) {
+  if (listrTasks.every((task) => task.skip())) {
     logger.log('No staged files match any of provided globs.')
     return 'No tasks to run.'
   }
@@ -202,38 +210,38 @@ const runAll = async (
     [
       {
         title: 'Preparing...',
-        task: ctx => git.prepare(ctx, stash)
+        task: (ctx) => git.prepare(ctx, shouldBackup)
       },
       {
         title: 'Hiding unstaged changes to partially staged files...',
-        task: ctx => git.hideUnstagedChanges(ctx),
-        enabled: ctx => ctx.hasPartiallyStagedFiles
+        task: (ctx) => git.hideUnstagedChanges(ctx),
+        enabled: (ctx) => ctx.hasPartiallyStagedFiles
       },
       ...listrTasks,
       {
         title: 'Applying modifications...',
-        task: ctx => git.applyModifications(ctx),
+        task: (ctx) => git.applyModifications(ctx),
         // Always apply back unstaged modifications when skipping backup
-        skip: ctx => stash && shouldSkipApplyModifications(ctx)
+        skip: (ctx) => shouldBackup && shouldSkipApplyModifications(ctx)
       },
       {
         title: 'Restoring unstaged changes to partially staged files...',
-        task: ctx => git.restoreUnstagedChanges(ctx),
-        enabled: ctx => ctx.hasPartiallyStagedFiles,
+        task: (ctx) => git.restoreUnstagedChanges(ctx),
+        enabled: (ctx) => ctx.hasPartiallyStagedFiles,
         skip: shouldSkipApplyModifications
       },
       {
         title: 'Reverting to original state because of errors...',
-        task: ctx => git.restoreOriginalState(ctx),
-        enabled: ctx =>
-          stash &&
+        task: (ctx) => git.restoreOriginalState(ctx),
+        enabled: (ctx) =>
+          shouldBackup &&
           (ctx.taskError || ctx.gitApplyEmptyCommitError || ctx.gitRestoreUnstagedChangesError),
         skip: shouldSkipRevert
       },
       {
         title: 'Cleaning up...',
-        task: ctx => git.cleanup(ctx),
-        enabled: () => stash,
+        task: (ctx) => git.cleanup(ctx),
+        enabled: () => shouldBackup,
         skip: shouldSkipCleanup
       }
     ],
@@ -251,12 +259,7 @@ const runAll = async (
     } else if (error.context.gitError && !error.context.gitGetBackupStashError) {
       logger.error(`\n  ${symbols.error} ${chalk.red(`lint-staged failed due to a git error.`)}`)
 
-      if (error.context.emptyGitRepo) {
-        logger.error(
-          `\n    The initial commit is needed for lint-staged to work.
-    Please use the --no-verify flag to skip running lint-staged.`
-        )
-      } else if (stash) {
+      if (shouldBackup) {
         // No sense to show this if the backup stash itself is missing.
         logger.error(`  Any lost modifications can be restored from a git stash:
 

package/lib/validateConfig.js

@@ -8,17 +8,17 @@ const format = require('stringify-object')
 const debug = require('debug')('lint-staged:cfg')
 
 const TEST_DEPRECATED_KEYS = new Map([
-  ['concurrent', key => typeof key === 'boolean'],
-  ['chunkSize', key => typeof key === 'number'],
-  ['globOptions', key => typeof key === 'object'],
-  ['linters', key => typeof key === 'object'],
-  ['ignore', key => Array.isArray(key)],
-  ['subTaskConcurrency', key => typeof key === 'number'],
-  ['renderer', key => typeof key === 'string'],
-  ['relative', key => typeof key === 'boolean']
+  ['concurrent', (key) => typeof key === 'boolean'],
+  ['chunkSize', (key) => typeof key === 'number'],
+  ['globOptions', (key) => typeof key === 'object'],
+  ['linters', (key) => typeof key === 'object'],
+  ['ignore', (key) => Array.isArray(key)],
+  ['subTaskConcurrency', (key) => typeof key === 'number'],
+  ['renderer', (key) => typeof key === 'string'],
+  ['relative', (key) => typeof key === 'boolean']
 ])
 
-const formatError = helpMsg => `● Validation Error:
+const formatError = (helpMsg) => `● Validation Error:
 
   ${helpMsg}
 
@@ -68,7 +68,7 @@ module.exports = function validateConfig(config) {
 
       if (
         (!Array.isArray(task) ||
-          task.some(item => typeof item !== 'string' && typeof item !== 'function')) &&
+          task.some((item) => typeof item !== 'string' && typeof item !== 'function')) &&
         typeof task !== 'string' &&
         typeof task !== 'function'
       ) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "10.1.3",
+  "version": "10.1.7",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -34,12 +34,12 @@
     }
   },
   "dependencies": {
-    "chalk": "^3.0.0",
-    "commander": "^4.0.1",
+    "chalk": "^4.0.0",
+    "commander": "^5.0.0",
     "cosmiconfig": "^6.0.0",
     "debug": "^4.1.1",
     "dedent": "^0.7.0",
-    "execa": "^3.4.0",
+    "execa": "^4.0.0",
     "listr": "^0.14.3",
     "log-symbols": "^3.0.0",
     "micromatch": "^4.0.2",
@@ -49,27 +49,27 @@
     "stringify-object": "^3.3.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.7.4",
-    "@babel/plugin-proposal-object-rest-spread": "^7.7.4",
-    "@babel/preset-env": "^7.7.4",
-    "babel-eslint": "^10.0.3",
-    "babel-jest": "^24.9.0",
+    "@babel/core": "^7.9.0",
+    "@babel/plugin-proposal-object-rest-spread": "^7.9.5",
+    "@babel/preset-env": "^7.9.5",
+    "babel-eslint": "^10.1.0",
+    "babel-jest": "^25.3.0",
     "consolemock": "^1.1.0",
-    "eslint": "^6.7.2",
+    "eslint": "^6.8.0",
     "eslint-config-okonet": "^7.0.2",
-    "eslint-config-prettier": "^6.7.0",
-    "eslint-plugin-flowtype": "^4.5.2",
-    "eslint-plugin-import": "^2.18.2",
+    "eslint-config-prettier": "^6.10.1",
+    "eslint-plugin-flowtype": "^4.7.0",
+    "eslint-plugin-import": "^2.20.2",
     "eslint-plugin-jsx-a11y": "^6.2.3",
-    "eslint-plugin-node": "^10.0.0",
-    "eslint-plugin-prettier": "^3.1.1",
-    "eslint-plugin-react": "^7.17.0",
-    "fs-extra": "^8.1.0",
-    "husky": "^3.1.0",
-    "jest": "^24.9.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.1.3",
+    "eslint-plugin-react": "^7.19.0",
+    "fs-extra": "^9.0.0",
+    "husky": "^4.2.5",
+    "jest": "^25.3.0",
     "jest-snapshot-serializer-ansi": "^1.0.0",
-    "nanoid": "^2.1.7",
-    "prettier": "^1.19.1"
+    "nanoid": "^3.1.3",
+    "prettier": "^2.0.4"
   },
   "config": {
     "commitizen": {