lint-staged 12.3.3 → 12.3.6

package/README.md

@@ -713,6 +713,17 @@ Example repo: [sudo-suhas/lint-staged-django-react-demo](https://github.com/sudo
 
 </details>
 
+### Can I use `lint-staged` with `ng lint`
+
+<details>
+  <summary>Click to expand</summary>
+
+You should not use `ng lint` through _lint-staged_, because it's designed to lint an entire project. Instead, you can add `ng lint` to your git pre-commit hook the same way as you would run lint-staged.
+
+See issue [!951](https://github.com/okonet/lint-staged/issues/951) for more details and possible workarounds.
+
+</details>
+
 ### How can I ignore files from `.eslintignore`?
 
 <details>

package/lib/getConfigGroups.js

@@ -99,13 +99,6 @@ export const getConfigGroups = async (
   // Discover configs from the base directory of each file
   await Promise.all(Object.entries(filesByDir).map(([dir, files]) => searchConfig(dir, files)))
 
-  // Throw if no configurations were found
-  if (Object.keys(configGroups).length === 0) {
-    debugLog('Found no config groups!')
-    logger.error(`${ConfigNotFoundError.message}.`)
-    throw ConfigNotFoundError
-  }
-
   debugLog('Grouped staged files into %d groups!', Object.keys(configGroups).length)
 
   return configGroups

package/lib/getStagedFiles.js

@@ -3,6 +3,7 @@ import path from 'path'
 import normalize from 'normalize-path'
 
 import { execGit } from './execGit.js'
+import { parseGitZOutput } from './parseGitZOutput.js'
 
 export const getStagedFiles = async ({ cwd = process.cwd() } = {}) => {
   try {
@@ -14,15 +15,7 @@ export const getStagedFiles = async ({ cwd = process.cwd() } = {}) => {
 
     if (!lines) return []
 
-    // With `-z`, git prints `fileA\u0000fileB\u0000fileC\u0000` so we need to
-    // remove the last occurrence of `\u0000` before splitting
-    return (
-      lines
-        // eslint-disable-next-line no-control-regex
-        .replace(/\u0000$/, '')
-        .split('\u0000')
-        .map((file) => normalize(path.resolve(cwd, file)))
-    )
+    return parseGitZOutput(lines).map((file) => normalize(path.resolve(cwd, file)))
   } catch {
     return null
   }

package/lib/loadConfig.js

@@ -13,7 +13,7 @@ const debugLog = debug('lint-staged:loadConfig')
  * The list of files `lint-staged` will read configuration
  * from, in the declared order.
  */
-const searchPlaces = [
+export const searchPlaces = [
   'package.json',
   '.lintstagedrc',
   '.lintstagedrc.json',

package/lib/parseGitZOutput.js

@@ -0,0 +1,9 @@
+/**
+ * Return array of strings split from the output of `git <something> -z`.
+ * With `-z`, git prints `fileA\u0000fileB\u0000fileC\u0000` so we need to
+ * remove the last occurrence of `\u0000` before splitting
+ */
+export const parseGitZOutput = (input) =>
+  input
+    .replace(/\u0000$/, '') // eslint-disable-line no-control-regex
+    .split('\u0000')

package/lib/resolveTaskFn.js

@@ -2,14 +2,17 @@ import { redBright, dim } from 'colorette'
 import execa from 'execa'
 import debug from 'debug'
 import { parseArgsStringToArgv } from 'string-argv'
+import pidTree from 'pidtree'
 
 import { error, info } from './figures.js'
 import { getInitialState } from './state.js'
 import { TaskError } from './symbols.js'
 
+const ERROR_CHECK_INTERVAL = 200
+
 const debugLog = debug('lint-staged:resolveTaskFn')
 
-const getTag = ({ code, killed, signal }) => signal || (killed && 'KILLED') || code || 'FAILED'
+const getTag = ({ code, killed, signal }) => (killed && 'KILLED') || signal || code || 'FAILED'
 
 /**
  * Handle task console output.
@@ -43,6 +46,34 @@ const handleOutput = (command, result, ctx, isError = false) => {
   }
 }
 
+/**
+ * Interrupts the execution of the execa process that we spawned if
+ * another task adds an error to the context.
+ *
+ * @param {Object} ctx
+ * @param {execa.ExecaChildProcess<string>} execaChildProcess
+ * @returns {function(): void} Function that clears the interval that
+ * checks the context.
+ */
+const interruptExecutionOnError = (ctx, execaChildProcess) => {
+  async function loop() {
+    if (ctx.errors.size > 0) {
+      const ids = await pidTree(execaChildProcess.pid)
+      ids.forEach(process.kill)
+
+      // The execa process is killed separately in order
+      // to get the `KILLED` status.
+      execaChildProcess.kill()
+    }
+  }
+
+  const loopIntervalId = setInterval(loop, ERROR_CHECK_INTERVAL)
+
+  return () => {
+    clearInterval(loopIntervalId)
+  }
+}
+
 /**
  * Create a error output dependding on process result.
  *
@@ -101,9 +132,13 @@ export const resolveTaskFn = ({
   debugLog('execaOptions:', execaOptions)
 
   return async (ctx = getInitialState()) => {
-    const result = await (shell
+    const execaChildProcess = shell
       ? execa.command(isFn ? command : `${command} ${files.join(' ')}`, execaOptions)
-      : execa(cmd, isFn ? args : args.concat(files), execaOptions))
+      : execa(cmd, isFn ? args : args.concat(files), execaOptions)
+
+    const quitInterruptCheck = interruptExecutionOnError(ctx, execaChildProcess)
+    const result = await execaChildProcess
+    quitInterruptCheck()
 
     if (result.failed || result.killed || result.signal != null) {
       throw makeErr(command, result, ctx)

package/lib/runAll.js

@@ -35,7 +35,8 @@ import {
   restoreOriginalStateSkipped,
   restoreUnstagedChangesSkipped,
 } from './state.js'
-import { GitRepoError, GetStagedFilesError, GitError } from './symbols.js'
+import { GitRepoError, GetStagedFilesError, GitError, ConfigNotFoundError } from './symbols.js'
+import { searchConfigs } from './searchConfigs.js'
 
 const debugLog = debug('lint-staged:runAll')
 
@@ -121,7 +122,19 @@ export const runAll = async (
 
   const configGroups = await getConfigGroups({ configObject, configPath, cwd, files }, logger)
 
-  const hasMultipleConfigs = Object.keys(configGroups).length > 1
+  const hasExplicitConfig = configObject || configPath
+  const foundConfigs = hasExplicitConfig ? null : await searchConfigs(gitDir, logger)
+  const numberOfConfigs = hasExplicitConfig ? 1 : Object.keys(foundConfigs).length
+
+  // Throw if no configurations were found
+  if (numberOfConfigs === 0) {
+    ctx.errors.add(ConfigNotFoundError)
+    throw createError(ctx, ConfigNotFoundError)
+  }
+
+  debugLog('Found %d configs:\n%O', numberOfConfigs, foundConfigs)
+
+  const hasMultipleConfigs = numberOfConfigs > 1
 
   // lint-staged 10 will automatically add modifications to index
   // Warn user when their command includes `git add`

package/lib/searchConfigs.js

@@ -0,0 +1,69 @@
+/** @typedef {import('./index').Logger} Logger */
+
+import { basename, join } from 'path'
+
+import normalize from 'normalize-path'
+
+import { execGit } from './execGit.js'
+import { loadConfig, searchPlaces } from './loadConfig.js'
+import { parseGitZOutput } from './parseGitZOutput.js'
+import { validateConfig } from './validateConfig.js'
+
+const EXEC_GIT = ['ls-files', '-z', '--full-name']
+
+const filterPossibleConfigFiles = (file) => searchPlaces.includes(basename(file))
+
+const numberOfLevels = (file) => file.split('/').length
+
+const sortDeepestParth = (a, b) => (numberOfLevels(a) > numberOfLevels(b) ? -1 : 1)
+
+/**
+ * Search all config files from the git repository
+ *
+ * @param {string} gitDir
+ * @param {Logger} logger
+ * @returns {Promise<{ [key: string]: * }>} found configs with filepath as key, and config as value
+ */
+export const searchConfigs = async (gitDir = process.cwd(), logger) => {
+  /** Get all possible config files known to git */
+  const cachedFiles = parseGitZOutput(await execGit(EXEC_GIT, { cwd: gitDir })).filter(
+    filterPossibleConfigFiles
+  )
+
+  /** Get all possible config files from uncommitted files */
+  const otherFiles = parseGitZOutput(
+    await execGit([...EXEC_GIT, '--others', '--exclude-standard'], { cwd: gitDir })
+  ).filter(filterPossibleConfigFiles)
+
+  /** Sort possible config files so that deepest is first */
+  const possibleConfigFiles = [...cachedFiles, ...otherFiles]
+    .map((file) => join(gitDir, file))
+    .map((file) => normalize(file))
+    .sort(sortDeepestParth)
+
+  /** Create object with key as config file, and value as null */
+  const configs = possibleConfigFiles.reduce(
+    (acc, configPath) => Object.assign(acc, { [configPath]: null }),
+    {}
+  )
+
+  /** Load and validate all configs to the above object */
+  await Promise.all(
+    possibleConfigFiles
+      .map((configPath) => loadConfig({ configPath }, logger))
+      .map((promise) =>
+        promise.then(({ config, filepath }) => {
+          if (config) {
+            configs[filepath] = validateConfig(config, filepath, logger)
+          }
+        })
+      )
+  )
+
+  /** Get validated configs from the above object, without any `null` values (not found) */
+  const foundConfigs = Object.entries(configs)
+    .filter(([, value]) => !!value)
+    .reduce((acc, [key, value]) => ({ ...acc, [key]: value }), {})
+
+  return foundConfigs
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "12.3.3",
+  "version": "12.3.6",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -18,7 +18,10 @@
   },
   "type": "module",
   "bin": "./bin/lint-staged.js",
-  "exports": "./lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./package.json": "./package.json"
+  },
   "files": [
     "bin",
     "lib"
@@ -39,6 +42,7 @@
     "micromatch": "^4.0.4",
     "normalize-path": "^3.0.0",
     "object-inspect": "^1.12.0",
+    "pidtree": "^0.5.0",
     "string-argv": "^0.3.1",
     "supports-color": "^9.2.1",
     "yaml": "^1.10.2"