lint-staged 8.1.5 → 8.2.1

package/README.md

@@ -25,7 +25,7 @@ The fastest way to start using lint-staged is to run following command in your t
 
 ```bash
 npx mrm lint-staged
-``` 
+```
 
 It will install and configure [husky](https://github.com/typicode/husky) and lint-staged depending on code quality tools from `package.json` dependencies so please make sure you install (`npm install --save-dev`) and configure all code quality tools like [Prettier](https://prettier.io), [ESlint](https://eslint.org) prior that.
 
@@ -140,7 +140,7 @@ It is possible to run linters for certain paths only by using glob patterns. [mi
 
 ```js
 {
-  // .js files anywhere in the project
+  // .js files anywhere in the root directory of the project
   "*.js": "eslint",
   // .js files anywhere in the project
   "**/*.js": "eslint",
@@ -345,7 +345,22 @@ When using the IDE's GUI to commit changes with the `precommit` hook, you might
 
 Until the issue is resolved in the IDE, you can use the following config to work around it:
 
-```js
+husky v1.x
+
+```json
+{
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "post-commit": "git update-index --again"
+    }
+  }
+}
+```
+
+husky v0.x
+
+```json
 {
   "scripts": {
     "precommit": "lint-staged",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "8.1.5",
+  "version": "8.2.1",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -18,7 +18,7 @@
     "cz": "git-cz",
     "lint:base": "eslint --rule \"prettier/prettier: 2\"",
     "lint": "npm run lint:base -- .",
-    "lint:fix": "npm run lint --fix",
+    "lint:fix": "npm run lint -- --fix",
     "pretest": "npm run lint",
     "test": "jest --coverage",
     "test:watch": "jest --watch"
@@ -31,12 +31,11 @@
   "dependencies": {
     "chalk": "^2.3.1",
     "commander": "^2.14.1",
-    "cosmiconfig": "^5.0.2",
+    "cosmiconfig": "^5.2.0",
     "debug": "^3.1.0",
     "dedent": "^0.7.0",
     "del": "^3.0.0",
     "execa": "^1.0.0",
-    "find-parent-dir": "^0.3.0",
     "g-status": "^2.0.2",
     "is-glob": "^4.0.0",
     "is-windows": "^1.0.2",
@@ -53,7 +52,7 @@
     "staged-git-files": "1.1.2",
     "string-argv": "^0.0.2",
     "stringify-object": "^3.2.2",
-    "yup": "^0.26.10"
+    "yup": "^0.27.0"
   },
   "devDependencies": {
     "babel-core": "^6.26.3",

package/src/execGit.js

@@ -0,0 +1,23 @@
+'use strict'
+
+const debug = require('debug')('lint-staged:git')
+const execa = require('execa')
+const path = require('path')
+
+function getAbsolutePath(dir) {
+  return path.isAbsolute(dir) ? dir : path.resolve(dir)
+}
+
+module.exports = async function execGit(cmd, options = {}) {
+  const cwd = options.cwd || process.cwd()
+  debug('Running git command', cmd)
+  try {
+    const { stdout } = await execa('git', [].concat(cmd), {
+      ...options,
+      cwd: getAbsolutePath(cwd)
+    })
+    return stdout
+  } catch (err) {
+    throw new Error(err)
+  }
+}

package/src/generateTasks.js

@@ -4,17 +4,15 @@ const path = require('path')
 const micromatch = require('micromatch')
 const pathIsInside = require('path-is-inside')
 const { getConfig } = require('./getConfig')
-const resolveGitDir = require('./resolveGitDir')
 
 const debug = require('debug')('lint-staged:gen-tasks')
 
-module.exports = function generateTasks(config, stagedRelFiles) {
+module.exports = async function generateTasks(config, gitDir, stagedRelFiles) {
   debug('Generating linter tasks')
 
   const normalizedConfig = getConfig(config) // Ensure we have a normalized config
   const { linters, globOptions, ignore } = normalizedConfig
 
-  const gitDir = resolveGitDir()
   const cwd = process.cwd()
   const stagedFiles = stagedRelFiles.map(file => path.resolve(gitDir, file))
 

package/src/gitWorkflow.js

@@ -1,34 +1,15 @@
 'use strict'
 
-const path = require('path')
-const execa = require('execa')
 const gStatus = require('g-status')
 const del = require('del')
 const debug = require('debug')('lint-staged:git')
-const resolveGitDir = require('./resolveGitDir')
+
+const execGit = require('./execGit')
 
 let workingCopyTree = null
 let indexTree = null
 let formattedIndexTree = null
 
-function getAbsolutePath(dir) {
-  return path.isAbsolute(dir) ? dir : path.resolve(dir)
-}
-
-async function execGit(cmd, options) {
-  const cwd = options && options.cwd ? options.cwd : resolveGitDir()
-  debug('Running git command', cmd)
-  try {
-    const { stdout } = await execa('git', [].concat(cmd), {
-      ...options,
-      cwd: getAbsolutePath(cwd)
-    })
-    return stdout
-  } catch (err) {
-    throw new Error(err)
-  }
-}
-
 async function writeTree(options) {
   return execGit(['write-tree'], options)
 }
@@ -51,7 +32,7 @@ async function getDiffForTrees(tree1, tree2, options) {
 }
 
 async function hasPartiallyStagedFiles(options) {
-  const cwd = options && options.cwd ? options.cwd : resolveGitDir()
+  const { cwd } = options
   const files = await gStatus({ cwd })
   const partiallyStaged = files.filter(
     file =>

package/src/makeCmdTasks.js

@@ -1,7 +1,6 @@
 'use strict'
 
 const resolveTaskFn = require('./resolveTaskFn')
-const resolveGitDir = require('./resolveGitDir')
 
 const debug = require('debug')('lint-staged:make-cmd-tasks')
 
@@ -14,14 +13,14 @@ const debug = require('debug')('lint-staged:make-cmd-tasks')
  * @param {number} options.chunkSize
  * @param {number} options.subTaskConcurrency
  */
-module.exports = function makeCmdTasks(
+module.exports = async function makeCmdTasks(
   commands,
+  gitDir,
   pathsToLint,
   { chunkSize = Number.MAX_SAFE_INTEGER, subTaskConcurrency = 1 } = {}
 ) {
   debug('Creating listr tasks for commands %o', commands)
 
-  const gitDir = resolveGitDir()
   const lintersArray = Array.isArray(commands) ? commands : [commands]
 
   return lintersArray.map(linter => ({

package/src/resolveGitDir.js

@@ -1,7 +1,16 @@
 'use strict'
 
-const findParentDir = require('find-parent-dir')
+const execGit = require('./execGit')
+const path = require('path')
 
-module.exports = function resolveGitDir() {
-  return findParentDir.sync(process.cwd(), '.git')
+module.exports = async function resolveGitDir(options) {
+  try {
+    // 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
+    delete process.env.GIT_DIR
+    const gitDir = await execGit(['rev-parse', '--show-toplevel'], options)
+    return path.normalize(gitDir)
+  } catch (error) {
+    return null
+  }
 }

package/src/runAll.js

@@ -16,7 +16,7 @@ const debug = require('debug')('lint-staged:run')
  * @param config {Object}
  * @returns {Promise}
  */
-module.exports = function runAll(config) {
+module.exports = async function runAll(config) {
   debug('Running all linter scripts')
   // Config validation
   if (!config || !has(config, 'concurrent') || !has(config, 'renderer')) {
@@ -24,92 +24,97 @@ module.exports = function runAll(config) {
   }
 
   const { concurrent, renderer, chunkSize, subTaskConcurrency } = config
-  const gitDir = resolveGitDir()
+  const gitDir = await resolveGitDir(config)
+
+  if (!gitDir) {
+    throw new Error('Current directory is not a git directory!')
+  }
+
   debug('Resolved git directory to be `%s`', gitDir)
 
   sgf.cwd = gitDir
-  return pify(sgf)('ACM').then(files => {
-    /* files is an Object{ filename: String, status: String } */
-    const filenames = files.map(file => file.filename)
-    debug('Loaded list of staged files in git:\n%O', filenames)
 
-    const tasks = generateTasks(config, filenames).map(task => ({
-      title: `Running tasks for ${task.pattern}`,
-      task: () =>
-        new Listr(
-          makeCmdTasks(task.commands, task.fileList, {
-            chunkSize,
-            subTaskConcurrency
-          }),
-          {
-            // In sub-tasks we don't want to run concurrently
-            // and we want to abort on errors
-            dateFormat: false,
-            concurrent: false,
-            exitOnError: true
-          }
-        ),
-      skip: () => {
-        if (task.fileList.length === 0) {
-          return `No staged files match ${task.pattern}`
+  /* files is an Object{ filename: String, status: String } */
+  const files = await pify(sgf)('ACM')
+  const filenames = files.map(file => file.filename)
+  debug('Loaded list of staged files in git:\n%O', filenames)
+
+  const tasks = (await generateTasks(config, gitDir, filenames)).map(task => ({
+    title: `Running tasks for ${task.pattern}`,
+    task: async () =>
+      new Listr(
+        await makeCmdTasks(task.commands, gitDir, task.fileList, {
+          chunkSize,
+          subTaskConcurrency
+        }),
+        {
+          // In sub-tasks we don't want to run concurrently
+          // and we want to abort on errors
+          dateFormat: false,
+          concurrent: false,
+          exitOnError: true
         }
-        return false
+      ),
+    skip: () => {
+      if (task.fileList.length === 0) {
+        return `No staged files match ${task.pattern}`
       }
-    }))
-
-    const listrBaseOptions = {
-      dateFormat: false,
-      renderer
+      return false
     }
+  }))
 
-    // If all of the configured "linters" should be skipped
-    // avoid executing any lint-staged logic
-    if (tasks.every(task => task.skip())) {
-      console.log('No staged files match any of provided globs.')
-      return 'No tasks to run.'
-    }
+  const listrBaseOptions = {
+    dateFormat: false,
+    renderer
+  }
 
-    // Do not terminate main Listr process on SIGINT
-    process.on('SIGINT', () => {})
+  // If all of the configured "linters" should be skipped
+  // avoid executing any lint-staged logic
+  if (tasks.every(task => task.skip())) {
+    console.log('No staged files match any of provided globs.')
+    return 'No tasks to run.'
+  }
 
-    return new Listr(
-      [
-        {
-          title: 'Stashing changes...',
-          skip: async () => {
-            const hasPSF = await git.hasPartiallyStagedFiles()
-            if (!hasPSF) {
-              return 'No partially staged files found...'
-            }
-            return false
-          },
-          task: ctx => {
-            ctx.hasStash = true
-            return git.gitStashSave()
+  // Do not terminate main Listr process on SIGINT
+  process.on('SIGINT', () => {})
+
+  return new Listr(
+    [
+      {
+        title: 'Stashing changes...',
+        skip: async () => {
+          const hasPSF = await git.hasPartiallyStagedFiles({ cwd: gitDir })
+          if (!hasPSF) {
+            return 'No partially staged files found...'
           }
+          return false
         },
-        {
-          title: 'Running linters...',
-          task: () =>
-            new Listr(tasks, {
-              ...listrBaseOptions,
-              concurrent,
-              exitOnError: !concurrent // Wait for all errors when running concurrently
-            })
-        },
-        {
-          title: 'Updating stash...',
-          enabled: ctx => ctx.hasStash,
-          skip: ctx => ctx.hasErrors && 'Skipping stash update since some tasks exited with errors',
-          task: () => git.updateStash()
-        },
-        {
-          title: 'Restoring local changes...',
-          enabled: ctx => ctx.hasStash,
-          task: () => git.gitStashPop()
+        task: ctx => {
+          ctx.hasStash = true
+          return git.gitStashSave({ cwd: gitDir })
         }
-      ],
-      listrBaseOptions
-    ).run()
-  })
+      },
+      {
+        title: 'Running linters...',
+        task: () =>
+          new Listr(tasks, {
+            ...listrBaseOptions,
+            concurrent,
+            exitOnError: !concurrent // Wait for all errors when running concurrently
+          })
+      },
+      {
+        title: 'Updating stash...',
+        enabled: ctx => ctx.hasStash,
+        skip: ctx => ctx.hasErrors && 'Skipping stash update since some tasks exited with errors',
+        task: () => git.updateStash({ cwd: gitDir })
+      },
+      {
+        title: 'Restoring local changes...',
+        enabled: ctx => ctx.hasStash,
+        task: () => git.gitStashPop({ cwd: gitDir })
+      }
+    ],
+    listrBaseOptions
+  ).run()
 }