lint-staged 15.4.3 → 15.5.1

package/README.md

@@ -876,7 +876,7 @@ export default {
 }
 ```
 
-To support backwards-compatibility, monorepo features require multiple _lint-staged_ configuration files present in the git repo. If you still want to run _lint-staged_ in only one of the packages in a monorepo, you can either add an "empty" _lint-staged_ configuration to the root of the repo (so that there's two configs in total), or alternatively run _lint-staged_ with the `--cwd` option pointing to your package directory (for example, `lint-staged --cwd packages/frontend`).
+To support backwards-compatibility, monorepo features require multiple _lint-staged_ configuration files present in the git repo. If you still want to run _lint-staged_ in only one of the packages in a monorepo, you can use the `--cwd` option (for example, `lint-staged --cwd packages/frontend`).
 
 </details>
 
@@ -909,15 +909,15 @@ all changed files between two different branches. If you want to run _lint-stage
 Try out the `git diff` command until you are satisfied with the result, for example:
 
 ```
-git diff --diff-filter=ACMR --name-only master...my-branch
+git diff --diff-filter=ACMR --name-only main...my-branch
 ```
 
-This will print a list of _added_, _changed_, _modified_, and _renamed_ files between `master` and `my-branch`.
+This will print a list of _added_, _changed_, _modified_, and _renamed_ files between `main` and `my-branch`.
 
 You can then run lint-staged against the same files with:
 
 ```
-npx lint-staged --diff="master...my-branch"
+npx lint-staged --diff="main...my-branch"
 ```
 
 </details>
@@ -1013,3 +1013,98 @@ ESLint v8.51.0 introduced [`--no-warn-ignored` CLI flag](https://eslint.org/docs
 </details>
 
 </details>
+
+### How can I resolve TypeScript (`tsc`) ignoring `tsconfig.json` when `lint-staged` runs via Husky hooks?
+
+<details>
+  <summary>Click to expand</summary>
+
+When running `lint-staged` via Husky hooks, TypeScript may ignore `tsconfig.json`, leading to errors like:
+
+> **TS17004:** Cannot use JSX unless the '--jsx' flag is provided.  
+> **TS1056:** Accessors are only available when targeting ECMAScript 5 and higher.  
+
+See issue [#825](https://github.com/okonet/lint-staged/issues/825) for more details.  
+
+#### Root Cause  
+
+<details>
+  <summary>Click to expand</summary>
+
+1. `lint-staged` automatically passes matched staged files as arguments to commands.  
+2. Certain input files can cause TypeScript to ignore `tsconfig.json`. For more details, see this TypeScript issue: [Allow tsconfig.json when input files are specified](https://github.com/microsoft/TypeScript/issues/27379).  
+
+</details>  
+
+#### Workaround 1: Use a [function signature](https://github.com/lint-staged/lint-staged?tab=readme-ov-file#example-run-tsc-on-changes-to-typescript-files-but-do-not-pass-any-filename-arguments) for the `tsc` command
+
+<details>
+  <summary>Click to expand</summary>
+
+As suggested by @antoinerousseau in [#825 (comment)](https://github.com/lint-staged/lint-staged/issues/825#issuecomment-620018284), using a function prevents `lint-staged` from appending file arguments:  
+
+**Before:**
+
+```js
+// package.json
+
+"lint-staged": {
+    "*.{ts,tsx}":[
+      "tsc --noEmit",
+      "prettier --write"
+    ]
+  }
+```
+
+**After:**
+
+```js
+// lint-staged.config.js
+module.exports = {
+  "*.{ts,tsx}": [
+    () => "tsc --noEmit", 
+    "prettier --write"
+  ],
+}
+```
+
+</details>
+
+#### Workaround 2: Take the `sh` or `bash` to wrap the `tsc` command
+
+<details>
+  <summary>Click to expand</summary>
+
+As suggested by @sombreroEnPuntas in [#825 (comment)](https://github.com/lint-staged/lint-staged/issues/825#issuecomment-674575655), wrapping `tsc` in a shell command prevents `lint-staged` from modifying its arguments:
+
+**Before:**
+
+```js
+// package.json
+
+"lint-staged": {
+  "*.{ts,tsx}":[
+    "tsc --noEmit",
+    "prettier --write"
+  ]
+}
+```
+
+**After:**
+
+```js
+// package.json
+
+"lint-staged": {
+  "*.{ts,tsx}":[
+    "bash -c 'tsc --noEmit'"
+    "prettier --write"
+  ]
+}
+```
+
+**Note:** This approach may have cross-platform compatibility issues.
+
+</details>
+
+</details>

package/lib/getDiffCommand.js

@@ -1,4 +1,5 @@
-export function getDiffCommand(diff, diffFilter) {
+/** @type {(diff?: string, diffFilter?: string) => string[]} */
+export const getDiffCommand = (diff, diffFilter) => {
   /**
    *  Docs for --diff-filter option:
    * @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203
@@ -12,7 +13,7 @@ export function getDiffCommand(diff, diffFilter) {
    * Docs for -z option:
    * @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt--z
    */
-  const diffCommand = ['diff', '--name-only', '-z', `--diff-filter=${diffFilterArg}`, ...diffArgs]
+  const diffCommand = ['diff', `--diff-filter=${diffFilterArg}`, ...diffArgs]
 
   return diffCommand
 }

package/lib/getStagedFiles.js

@@ -5,21 +5,51 @@ 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 []
+    /**
+     * With the raw output lines look like:
+     *
+     * :000000 100644 0000000 780ccd3\u0000A\u0000.gitmodules\u0000
+     * :000000 160000 0000000 1bb568e\u0000A\u0000submodule\u0000
+     *
+     * @see https://git-scm.com/docs/git-diff#_raw_output_format
+     */
+    const output = await execGit([...getDiffCommand(diff, diffFilter), '--raw', '-z'], { cwd })
+
+    if (!output) return []
+
+    /**
+     * Split from all colons and remove the first one, after which lines will look like:
+     *
+     * 000000 100644 0000000 780ccd3 A\u0000.gitmodules\u0000
+     * 000000 160000 0000000 47e5cff A\u0000submodule\u0000
+     *
+     * where '\u0000' is the NUL character from '-z' option. After that we
+     * parse the lines by splitting from NUL, and then split the first
+     * part from space. This yields us enough info both filter out submodule
+     * roots and get the filename.
+     */
+    return output
+      .split(':')
+      .slice(1)
+      .map(parseGitZOutput)
+      .flatMap(([info, src, dst]) => {
+        const [, dstMode, , , ,] = info.split(' ')
+
+        /**
+         * Filter out submodule root directory. "160000" is the object mode for submodules.
+         * @see https://github.com/git/git/blob/485f5f863615e670fd97ae40af744e14072cfe18/object.h#L114-L120
+         */
+        if (dstMode === '160000') {
+          return []
+        }
 
-    const submodules = await listSubmoduleRoots({ cwd })
+        /** "dst" exists when moving files, otherwise it's undefined and only "src" exists */
+        const filename = dst ?? src
 
-    return parseGitZOutput(lines)
-      .map((file) => normalizePath(path.resolve(cwd, file)))
-      .filter((file) => !submodules.includes(file))
+        return [normalizePath(path.resolve(cwd, filename))]
+      })
   } catch {
     return null
   }

package/lib/gitWorkflow.js

@@ -278,7 +278,12 @@ export class GitWorkflow {
 
     debugLog('Done adding task modifications to index!')
 
-    const stagedFilesAfterAdd = await this.execGit(getDiffCommand(this.diff, this.diffFilter))
+    const stagedFilesAfterAdd = await this.execGit([
+      ...getDiffCommand(this.diff, this.diffFilter),
+      '--name-only',
+      '-z',
+    ])
+
     if (!stagedFilesAfterAdd && !this.allowEmpty) {
       // Tasks reverted all staged changes and the commit would be empty
       // Throw error to stop commit unless `--allow-empty` was used

package/lib/state.js

@@ -2,7 +2,6 @@ import EventEmitter from 'events'
 
 import { GIT_ERROR, TASK_ERROR } from './messages.js'
 import {
-  ApplyEmptyCommitError,
   GitError,
   RestoreOriginalStateError,
   RestoreUnstagedChangesError,
@@ -49,18 +48,11 @@ export const restoreUnstagedChangesSkipped = (ctx) => {
 }
 
 export const restoreOriginalStateEnabled = (ctx) =>
-  ctx.shouldBackup &&
-  (ctx.errors.has(TaskError) ||
-    ctx.errors.has(ApplyEmptyCommitError) ||
-    ctx.errors.has(RestoreUnstagedChangesError))
+  ctx.shouldBackup && (ctx.errors.has(TaskError) || ctx.errors.has(RestoreUnstagedChangesError))
 
 export const restoreOriginalStateSkipped = (ctx) => {
   // Should be skipped in case of unknown git errors
-  if (
-    ctx.errors.has(GitError) &&
-    !ctx.errors.has(ApplyEmptyCommitError) &&
-    !ctx.errors.has(RestoreUnstagedChangesError)
-  ) {
+  if (ctx.errors.has(GitError) && !ctx.errors.has(RestoreUnstagedChangesError)) {
     return GIT_ERROR
   }
 }

package/package.json

@@ -1,9 +1,16 @@
 {
   "name": "lint-staged",
-  "version": "15.4.3",
+  "version": "15.5.1",
   "description": "Lint files staged by git",
   "license": "MIT",
-  "repository": "https://github.com/lint-staged/lint-staged",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lint-staged/lint-staged.git"
+  },
+  "homepage": "https://github.com/lint-staged/lint-staged#readme",
+  "bugs": {
+    "url": "https://github.com/lint-staged/lint-staged/issues"
+  },
   "author": "Andrey Okonetchnikov <andrey@okonet.ru>",
   "maintainers": [
     "Lufty Wiranda <lufty.wiranda@gmail.com>",
@@ -17,16 +24,14 @@
     "node": ">=18.12.0"
   },
   "type": "module",
-  "bin": "./bin/lint-staged.js",
+  "bin": {
+    "lint-staged": "bin/lint-staged.js"
+  },
   "exports": {
-    ".": {
-      "default": "./lib/index.js",
-      "types": "./lib/types.d.ts"
-    },
+    ".": "./lib/index.js",
     "./bin": "./bin/lint-staged.js",
     "./package.json": "./package.json"
   },
-  "types": "lib/types.d.ts",
   "files": [
     "bin",
     "lib"
@@ -35,7 +40,7 @@
     "lint": "eslint .",
     "test": "cross-env NODE_OPTIONS=--experimental-vm-modules npx jest --coverage",
     "test:watch": "npm run test -- --watch",
-    "typecheck": "tsc --noEmit --strict test/unit/types.ts",
+    "typecheck": "tsc --noEmit --strict test/types/index.ts",
     "version": "npx changeset version",
     "postversion": "npm i --package-lock-only && git commit -am \"chore(changeset): release\"",
     "tag": "npx changeset tag"
@@ -53,26 +58,26 @@
     "yaml": "^2.7.0"
   },
   "devDependencies": {
-    "@changesets/changelog-github": "0.5.0",
-    "@changesets/cli": "2.27.11",
-    "@commitlint/cli": "19.6.1",
-    "@commitlint/config-conventional": "19.6.0",
-    "@eslint/js": "9.18.0",
+    "@changesets/changelog-github": "0.5.1",
+    "@changesets/cli": "2.28.1",
+    "@commitlint/cli": "19.8.0",
+    "@commitlint/config-conventional": "19.8.0",
+    "@eslint/js": "9.22.0",
     "consolemock": "1.1.0",
     "cross-env": "7.0.3",
-    "eslint": "9.18.0",
-    "eslint-config-prettier": "10.0.1",
+    "eslint": "9.22.0",
+    "eslint-config-prettier": "10.1.1",
     "eslint-plugin-jest": "28.11.0",
-    "eslint-plugin-n": "17.15.1",
+    "eslint-plugin-n": "17.16.2",
     "eslint-plugin-prettier": "5.2.3",
     "eslint-plugin-simple-import-sort": "12.1.1",
     "husky": "9.1.7",
     "jest": "29.7.0",
-    "jest-snapshot-serializer-ansi": "2.1.0",
+    "jest-snapshot-serializer-ansi": "2.2.1",
     "mock-stdin": "1.0.0",
-    "prettier": "3.4.2",
-    "semver": "7.6.3",
-    "typescript": "5.7.3"
+    "prettier": "3.5.3",
+    "semver": "7.7.1",
+    "typescript": "5.8.2"
   },
   "keywords": [
     "lint",