lint-staged 15.2.9 → 15.2.11

package/README.md

@@ -293,6 +293,8 @@ Supported are any executables installed locally or globally via `npm` as well as
 }
 ```
 
+This will result in _lint-staged_ running `eslint --fix file-1.js file-2.js`, when you have staged files `file-1.js`, `file-2.js` and `README.md`.
+
 Pass arguments to your commands separated by space as you would do in the shell. See [examples](#examples) below.
 
 ## Running multiple commands in a sequence
@@ -309,6 +311,8 @@ For example:
 
 going to execute `eslint` and if it exits with `0` code, it will execute `prettier --write` on all staged `*.js` files.
 
+This will result in _lint-staged_ running `eslint file-1.js file-2.js`, when you have staged files `file-1.js`, `file-2.js` and `README.md`, and if it passes, `prettier --write file-1.js file-2.js`.
+
 ## Using JS configuration files
 
 Writing the configuration file in JavaScript is the most powerful way to configure lint-staged (`lint-staged.config.js`, [similar](https://github.com/okonet/lint-staged#configuration), or passed via `--config`). From the configuration file, you can export either a single function or an object.
@@ -317,6 +321,16 @@ If the `exports` value is a function, it will receive an array of all staged fil
 
 If the `exports` value is an object, its keys should be glob matches (like in the normal non-js config format). The values can either be like in the normal config or individual functions like described above. Instead of receiving all matched files, the functions in the exported object will only receive the staged files matching the corresponding glob key.
 
+To summarize, by default _lint-staged_ automatically adds the list of matched staged files to your command, but when building the command using JS functions it is expected to do this manually. For example:
+
+```js
+export default {
+  '*.js': (stagedFiles) => [`eslint .`, `prettier --write ${stagedFiles.join(' ')}`],
+}
+```
+
+This will result in _lint-staged_ first running `eslint .` (matching _all_ files), and if it passes, `prettier --write file-1.js file-2.js`, when you have staged files `file-1.js`, `file-2.js` and `README.md`.
+
 ### Function signature
 
 The function can also be async:

package/lib/getStagedFiles.js

@@ -5,12 +5,21 @@ import { getDiffCommand } from './getDiffCommand.js'
 import { normalizePath } from './normalizePath.js'
 import { parseGitZOutput } from './parseGitZOutput.js'
 
+const listSubmoduleRoots = async ({ cwd }) => {
+  const lines = await execGit(['submodule', '--quiet', 'foreach', 'echo $displaypath'], { cwd })
+  return lines.split('\n').map((file) => normalizePath(path.resolve(cwd, file)))
+}
+
 export const getStagedFiles = async ({ cwd = process.cwd(), diff, diffFilter } = {}) => {
   try {
     const lines = await execGit(getDiffCommand(diff, diffFilter), { cwd })
     if (!lines) return []
 
-    return parseGitZOutput(lines).map((file) => normalizePath(path.resolve(cwd, file)))
+    const submodules = await listSubmoduleRoots({ cwd })
+
+    return parseGitZOutput(lines)
+      .map((file) => normalizePath(path.resolve(cwd, file)))
+      .filter((file) => !submodules.includes(file))
   } catch {
     return null
   }

package/lib/gitWorkflow.js

@@ -6,12 +6,12 @@ import { execGit } from './execGit.js'
 import { readFile, unlink, writeFile } from './file.js'
 import { getDiffCommand } from './getDiffCommand.js'
 import {
-  GitError,
-  RestoreOriginalStateError,
   ApplyEmptyCommitError,
   GetBackupStashError,
+  GitError,
   HideUnstagedChangesError,
   RestoreMergeStatusError,
+  RestoreOriginalStateError,
   RestoreUnstagedChangesError,
 } from './symbols.js'
 

package/lib/index.js

@@ -2,10 +2,10 @@ import debug from 'debug'
 
 import { execGit } from './execGit.js'
 import {
-  PREVENTED_EMPTY_COMMIT,
   GIT_ERROR,
-  RESTORE_STASH_EXAMPLE,
   NO_CONFIGURATION,
+  PREVENTED_EMPTY_COMMIT,
+  RESTORE_STASH_EXAMPLE,
 } from './messages.js'
 import { printTaskOutput } from './printTaskOutput.js'
 import { runAll } from './runAll.js'

package/lib/loadConfig.js

@@ -6,15 +6,15 @@ import path from 'node:path'
 import debug from 'debug'
 import YAML from 'yaml'
 
-import { dynamicImport } from './dynamicImport.js'
-import { failedToLoadConfig } from './messages.js'
-import { resolveConfig } from './resolveConfig.js'
 import {
   CONFIG_FILE_NAMES,
   CONFIG_NAME,
   PACKAGE_JSON_FILE,
   PACKAGE_YAML_FILES,
 } from './configFiles.js'
+import { dynamicImport } from './dynamicImport.js'
+import { failedToLoadConfig } from './messages.js'
+import { resolveConfig } from './resolveConfig.js'
 
 const debugLog = debug('lint-staged:loadConfig')
 

package/lib/resolveGitRepo.js

@@ -12,7 +12,7 @@ const debugLog = debug('lint-staged:resolveGitRepo')
  *
  * @example ".git"
  */
-const resolveRelativeGitDir = async (cwd = process.cwd()) => {
+const resolveRelativeGitDir = async (cwd) => {
   /**
    * Absolute repo top-level directory
    *

package/lib/resolveTaskFn.js

@@ -1,13 +1,18 @@
 import chalk from 'chalk'
-import { execa, execaCommand } from 'execa'
 import debug from 'debug'
-import { parseArgsStringToArgv } from 'string-argv'
+import { execa, execaCommand } from 'execa'
 import pidTree from 'pidtree'
+import { parseArgsStringToArgv } from 'string-argv'
 
 import { error, info } from './figures.js'
 import { getInitialState } from './state.js'
 import { TaskError } from './symbols.js'
 
+/**
+ * @see https://github.com/sindresorhus/execa/blob/f4b8b3ab601c94d1503f1010822952758dcc6350/lib/command.js#L32-L37
+ */
+const escapeSpaces = (input) => input.replaceAll(' ', '\\ ')
+
 const TASK_ERROR = 'lint-staged:taskError'
 
 const debugLog = debug('lint-staged:resolveTaskFn')
@@ -159,7 +164,10 @@ export const resolveTaskFn = ({
 
   return async (ctx = getInitialState()) => {
     const execaChildProcess = shell
-      ? execaCommand(isFn ? command : `${command} ${files.join(' ')}`, execaOptions)
+      ? execaCommand(
+          isFn ? command : `${command} ${files.map(escapeSpaces).join(' ')}`,
+          execaOptions
+        )
       : execa(cmd, isFn ? args : args.concat(files), execaOptions)
 
     const quitInterruptCheck = interruptExecutionOnError(ctx, execaChildProcess)

package/lib/runAll.js

@@ -17,27 +17,27 @@ import { makeCmdTasks } from './makeCmdTasks.js'
 import {
   DEPRECATED_GIT_ADD,
   FAILED_GET_STAGED_FILES,
-  NOT_GIT_REPO,
   NO_STAGED_FILES,
   NO_TASKS,
+  NOT_GIT_REPO,
   SKIPPED_GIT_ERROR,
   skippingBackup,
   skippingHidePartiallyStaged,
 } from './messages.js'
 import { normalizePath } from './normalizePath.js'
 import { resolveGitRepo } from './resolveGitRepo.js'
+import { searchConfigs } from './searchConfigs.js'
 import {
   applyModificationsSkipped,
   cleanupEnabled,
   cleanupSkipped,
   getInitialState,
-  shouldHidePartiallyStagedFiles,
   restoreOriginalStateEnabled,
   restoreOriginalStateSkipped,
   restoreUnstagedChangesSkipped,
+  shouldHidePartiallyStagedFiles,
 } from './state.js'
-import { GitRepoError, GetStagedFilesError, GitError, ConfigNotFoundError } from './symbols.js'
-import { searchConfigs } from './searchConfigs.js'
+import { ConfigNotFoundError, GetStagedFilesError, GitError, GitRepoError } from './symbols.js'
 
 const debugLog = debug('lint-staged:runAll')
 

package/lib/searchConfigs.js

@@ -4,12 +4,12 @@ import path from 'node:path'
 
 import debug from 'debug'
 
+import { CONFIG_FILE_NAMES } from './configFiles.js'
 import { execGit } from './execGit.js'
 import { loadConfig } from './loadConfig.js'
 import { normalizePath } from './normalizePath.js'
 import { parseGitZOutput } from './parseGitZOutput.js'
 import { validateConfig } from './validateConfig.js'
-import { CONFIG_FILE_NAMES } from './configFiles.js'
 
 const debugLog = debug('lint-staged:searchConfigs')
 

package/lib/state.js

@@ -3,10 +3,10 @@ import EventEmitter from 'events'
 import { GIT_ERROR, TASK_ERROR } from './messages.js'
 import {
   ApplyEmptyCommitError,
-  TaskError,
-  RestoreOriginalStateError,
   GitError,
+  RestoreOriginalStateError,
   RestoreUnstagedChangesError,
+  TaskError,
 } from './symbols.js'
 
 export const getInitialState = ({ quiet = false } = {}) => ({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "15.2.9",
+  "version": "15.2.11",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/lint-staged/lint-staged",
@@ -38,32 +38,35 @@
   "dependencies": {
     "chalk": "~5.3.0",
     "commander": "~12.1.0",
-    "debug": "~4.3.6",
+    "debug": "~4.4.0",
     "execa": "~8.0.1",
-    "lilconfig": "~3.1.2",
-    "listr2": "~8.2.4",
-    "micromatch": "~4.0.7",
+    "lilconfig": "~3.1.3",
+    "listr2": "~8.2.5",
+    "micromatch": "~4.0.8",
     "pidtree": "~0.6.0",
     "string-argv": "~0.3.2",
-    "yaml": "~2.5.0"
+    "yaml": "~2.6.1"
   },
   "devDependencies": {
     "@changesets/changelog-github": "0.5.0",
-    "@changesets/cli": "2.27.7",
-    "@commitlint/cli": "19.3.0",
-    "@commitlint/config-conventional": "19.2.2",
+    "@changesets/cli": "2.27.10",
+    "@commitlint/cli": "19.6.0",
+    "@commitlint/config-conventional": "19.6.0",
+    "@eslint/js": "9.16.0",
     "consolemock": "1.1.0",
     "cross-env": "7.0.3",
-    "eslint": "8.57.0",
+    "eslint": "9.16.0",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-jest": "28.9.0",
+    "eslint-plugin-n": "17.15.0",
     "eslint-plugin-prettier": "5.2.1",
-    "husky": "9.1.4",
+    "eslint-plugin-simple-import-sort": "12.1.1",
+    "husky": "9.1.7",
     "jest": "29.7.0",
     "jest-snapshot-serializer-ansi": "2.1.0",
     "mock-stdin": "1.0.0",
-    "prettier": "3.3.3"
+    "prettier": "3.4.2",
+    "semver": "7.6.3"
   },
   "keywords": [
     "lint",