lint-staged 16.0.0 → 16.1.0

package/README.md

@@ -34,13 +34,28 @@ $ git commit
 
 </details>
 
+## Table of Contents
+
+- [Why](#why)
+- [Installation and setup](#installation-and-setup)
+- [Changelog](#changelog)
+- [Command line flags](#command-line-flags)
+- [Configuration](#configuration)
+- [Filtering files](#filtering-files)
+- [What commands are supported?](#what-commands-are-supported)
+- [Running multiple commands in a sequence](#running-multiple-commands-in-a-sequence)
+- [Using JS configuration files](#using-js-configuration-files)
+- [Reformatting the code](#reformatting-the-code)
+- [Examples](#examples)
+- [Frequently Asked Questions](#frequently-asked-questions)
+
 ## Why
 
 Code quality tasks like formatters and linters make more sense when run before committing your code. By doing so you can ensure no errors go into the repository and enforce code style. But running a task on a whole project can be slow, and opinionated tasks such as linting can sometimes produce irrelevant results. Ultimately you only want to check files that will be committed.
 
 This project contains a script that will run arbitrary shell tasks with a list of staged files as an argument, filtered by a specified glob pattern.
 
-## Related blog posts and talks
+### Related blog posts and talks
 
 - [Introductory Medium post - Andrey Okonetchnikov, 2016](https://medium.com/@okonetchnikov/make-linting-great-again-f3890e1ad6b8#.8qepn2b5l)
 - [Running Jest Tests Before Each Git Commit - Ben McCormick, 2017](https://benmccormick.org/2017/02/26/running-jest-tests-before-each-git-commit/)
@@ -70,7 +85,7 @@ Now change a few files, `git add` or `git add --patch` some of them to your comm
 
 See [examples](#examples) and [configuration](#configuration) for more information.
 
-> [!CAUTION]  
+> [!CAUTION]
 > _Lint-staged_ runs `git` operations affecting the files in your repository. By default _lint-staged_ creates a `git stash` as a backup of the original state before running any configured tasks to help prevent data loss.
 
 ## Changelog
@@ -94,13 +109,12 @@ Options:
   -c, --config [path]                path to configuration file, or - to read from stdin
   --cwd [path]                       run all tasks in specific directory, instead of the current
   -d, --debug                        print additional debug information (default: false)
-  --diff [string]                    override the default "--staged" flag of "git diff" to get list of files.
-                                     Implies "--no-stash".
-  --diff-filter [string]             override the default "--diff-filter=ACMR" flag of "git diff" to get list of
-                                     files
+  --diff [string]                    override the default "--staged" flag of "git diff" to get list of files. Implies
+                                     "--no-stash".
+  --diff-filter [string]             override the default "--diff-filter=ACMR" flag of "git diff" to get list of files
   --max-arg-length [number]          maximum length of the command-line argument string (default: 0)
-  --no-stash                         disable the backup stash, and do not revert in case of errors. Implies
-                                     "--no-hide-partially-staged".
+  --no-revert                        do not revert to original state in case of errors.
+  --no-stash                         disable the backup stash. Implies "--no-revert".
   --no-hide-partially-staged         disable hiding unstaged changes from partially staged files
   -q, --quiet                        disable lint-staged’s own console output (default: false)
   -r, --relative                     pass relative filepaths to tasks (default: false)
@@ -129,10 +143,11 @@ Any lost modifications can be restored from a git stash:
 - **`--diff`**: By default tasks are filtered against all files staged in git, generated from `git diff --staged`. This option allows you to override the `--staged` flag with arbitrary revisions. For example to get a list of changed files between two branches, use `--diff="branch1...branch2"`. You can also read more from about [git diff](https://git-scm.com/docs/git-diff) and [gitrevisions](https://git-scm.com/docs/gitrevisions). This option also implies `--no-stash`.
 - **`--diff-filter`**: By default only files that are _added_, _copied_, _modified_, or _renamed_ are included. Use this flag to override the default `ACMR` value with something else: _added_ (`A`), _copied_ (`C`), _deleted_ (`D`), _modified_ (`M`), _renamed_ (`R`), _type changed_ (`T`), _unmerged_ (`U`), _unknown_ (`X`), or _pairing broken_ (`B`). See also the `git diff` docs for [--diff-filter](https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203).
 - **`--max-arg-length`**: long commands (a lot of files) are automatically split into multiple chunks when it detects the current shell cannot handle them. Use this flag to override the maximum length of the generated command string.
-- **`--no-stash`**: By default a backup stash will be created before running the tasks, and all task modifications will be reverted in case of an error. This option will disable creating the stash, and instead leave all modifications in the index when aborting the commit. Can be re-enabled with `--stash`. This option also implies `--no-hide-partially-staged`.
+- **`--no-stash`**: By default a backup stash will be created before running the tasks, and all task modifications will be reverted in case of an error. This option will disable creating the stash, and instead leave all modifications in the index when aborting the commit. This option also implies `--no-hide-partially-staged`.
 - **`--no-hide-partially-staged`**: By default, unstaged changes from partially staged files will be hidden. This option will disable this behavior and include all unstaged changes in partially staged files. Can be re-enabled with `--hide-partially-staged`
 - **`--quiet`**: Supress all CLI output, except from tasks.
 - **`--relative`**: Pass filepaths relative to `process.cwd()` (where `lint-staged` runs) to tasks. Default is `false`.
+- **`--no-revert`**: By default all task modifications will be reverted in case of an error. This option will disable the behavior, and apply task modifications to the index before aborting the commit.
 - **`--verbose`**: Show task output even when tasks succeed. By default only failed output is shown.
 
 ## Configuration
@@ -998,7 +1013,7 @@ ESLint v8.51.0 introduced [`--no-warn-ignored` CLI flag](https://eslint.org/docs
 
 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.  
+> **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.

package/bin/lint-staged.js

@@ -61,30 +61,26 @@ program.option(
 program.option('--max-arg-length [number]', 'maximum length of the command-line argument string', 0)
 
 /**
- * We don't want to show the `--stash` flag because it's on by default, and only show the
- * negatable flag `--no-stash` in stead. There seems to be a bug in Commander.js where
+ * We don't want to show the `--revert` flag because it's on by default, and only show the
+ * negatable flag `--no-rever` instead. There seems to be a bug in Commander.js where
  * configuring only the latter won't actually set the default value.
  */
 program
   .addOption(
-    new Option('--stash', 'enable the backup stash, and revert in case of errors')
-      .default(true)
-      .hideHelp()
+    new Option('--revert', 'revert to original state in case of errors').default(true).hideHelp()
   )
   .addOption(
-    new Option(
-      '--no-stash',
-      'disable the backup stash, and do not revert in case of errors. Implies "--no-hide-partially-staged".'
-    )
+    new Option('--no-revert', 'do not revert to original state in case of errors.').default(false)
+  )
+
+program
+  .addOption(new Option('--stash', 'enable the backup stash').default(true).hideHelp())
+  .addOption(
+    new Option('--no-stash', 'disable the backup stash. Implies "--no-revert".')
       .default(false)
-      .implies({ hidePartiallyStaged: false })
+      .implies({ revert: false, hidePartiallyStaged: false })
   )
 
-/**
- * We don't want to show the `--hide-partially-staged` flag because it's on by default, and only show the
- * negatable flag `--no-hide-partially-staged` in stead. There seems to be a bug in Commander.js where
- * configuring only the latter won't actually set the default value.
- */
 program
   .addOption(
     new Option('--hide-partially-staged', 'hide unstaged changes from partially staged files')
@@ -127,6 +123,7 @@ const options = {
   maxArgLength: cliOptions.maxArgLength || undefined,
   quiet: !!cliOptions.quiet,
   relative: !!cliOptions.relative,
+  revert: !!cliOptions.revert, // commander inverts `no-<x>` flags to `!x`
   stash: !!cliOptions.stash, // commander inverts `no-<x>` flags to `!x`
   hidePartiallyStaged: !!cliOptions.hidePartiallyStaged, // commander inverts `no-<x>` flags to `!x`
   verbose: !!cliOptions.verbose,

package/lib/getStagedFiles.js

@@ -38,10 +38,10 @@ export const getStagedFiles = async ({ cwd = process.cwd(), diff, diffFilter } =
         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
+         * Filter out submodules and symlinks
+         * @see https://github.com/git/git/blob/cb96e1697ad6e54d11fc920c95f82977f8e438f8/Documentation/git-fast-import.adoc?plain=1#L634-L646
          */
-        if (dstMode === '160000') {
+        if (dstMode === '160000' || dstMode === '120000') {
           return []
         }
 

package/lib/index.d.ts

@@ -66,6 +66,11 @@ export type Options = {
    * @default false
    */
   relative?: boolean
+  /**
+   * Revert to original state in case of errors
+   * @default true
+   */
+  revert?: boolean
   /**
    * Enable the backup stash, and revert in case of errors.
    * @warn Disabling this also implies `hidePartiallyStaged: false`.

package/lib/index.js

@@ -57,6 +57,7 @@ const getMaxArgLength = () => {
  * @param {number} [options.maxArgLength] - Maximum argument string length
  * @param {boolean} [options.quiet] - Disable lint-staged’s own console output
  * @param {boolean} [options.relative] - Pass relative filepaths to tasks
+ * @param {boolean} [options.revert] - revert to original state in case of errors
  * @param {boolean} [options.stash] - Enable the backup stash, and revert in case of errors
  * @param {boolean} [options.verbose] - Show task output even when tasks succeed; by default only failed output is shown
  * @param {Logger} [logger]
@@ -78,6 +79,8 @@ const lintStaged = async (
     relative = false,
     // Stashing should be disabled by default when the `diff` option is used
     stash = diff === undefined,
+    // Cannot revert to original state without stash
+    revert = stash,
     hidePartiallyStaged = stash,
     verbose = false,
   } = {},
@@ -110,6 +113,7 @@ const lintStaged = async (
     maxArgLength,
     quiet,
     relative,
+    revert,
     stash,
     hidePartiallyStaged,
     verbose,

package/lib/runAll.js

@@ -59,6 +59,7 @@ const createError = (ctx) => Object.assign(new Error('lint-staged failed'), { ct
  * @param {number} [options.maxArgLength] - Maximum argument string length
  * @param {boolean} [options.quiet] - Disable lint-staged’s own console output
  * @param {boolean} [options.relative] - Pass relative filepaths to tasks
+ * @param {boolean} [options.revert] - revert to original state in case of errors
  * @param {boolean} [options.stash] - Enable the backup stash, and revert in case of errors
  * @param {boolean} [options.verbose] - Show task output even when tasks succeed; by default only failed output is shown
  * @param {Logger} logger
@@ -79,6 +80,8 @@ export const runAll = async (
     relative = false,
     // Stashing should be disabled by default when the `diff` option is used
     stash = diff === undefined,
+    // Cannot revert to original state without stash
+    revert = stash,
     hidePartiallyStaged = stash,
     verbose = false,
   },
@@ -91,7 +94,7 @@ export const runAll = async (
   cwd = hasExplicitCwd ? path.resolve(cwd) : process.cwd()
   debugLog('Using working directory `%s`', cwd)
 
-  const ctx = getInitialState({ quiet })
+  const ctx = getInitialState({ quiet, revert })
 
   const { topLevelDir, gitConfigDir } = await resolveGitRepo(cwd)
   if (!topLevelDir) {

package/lib/state.js

@@ -8,9 +8,10 @@ import {
   TaskError,
 } from './symbols.js'
 
-export const getInitialState = ({ quiet = false } = {}) => ({
+export const getInitialState = ({ quiet = false, revert = true } = {}) => ({
   hasPartiallyStagedFiles: null,
   shouldBackup: null,
+  shouldRevert: revert,
   backupHash: null,
   shouldHidePartiallyStaged: true,
   errors: new Set([]),
@@ -23,8 +24,8 @@ export const shouldHidePartiallyStagedFiles = (ctx) =>
   ctx.hasPartiallyStagedFiles && ctx.shouldHidePartiallyStaged
 
 export const applyModificationsSkipped = (ctx) => {
-  // Always apply back unstaged modifications when skipping backup
-  if (!ctx.shouldBackup) return false
+  // Always apply back unstaged modifications when skipping revert or backup
+  if (!ctx.shouldRevert || !ctx.shouldBackup) return false
   // Should be skipped in case of git errors
   if (ctx.errors.has(GitError)) {
     return GIT_ERROR
@@ -48,7 +49,9 @@ export const restoreUnstagedChangesSkipped = (ctx) => {
 }
 
 export const restoreOriginalStateEnabled = (ctx) =>
-  ctx.shouldBackup && (ctx.errors.has(TaskError) || ctx.errors.has(RestoreUnstagedChangesError))
+  !!ctx.shouldRevert &&
+  !!ctx.shouldBackup &&
+  (ctx.errors.has(TaskError) || ctx.errors.has(RestoreUnstagedChangesError))
 
 export const restoreOriginalStateSkipped = (ctx) => {
   // Should be skipped in case of unknown git errors

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "16.0.0",
+  "version": "16.1.0",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": {
@@ -21,7 +21,7 @@
     "url": "https://opencollective.com/lint-staged"
   },
   "engines": {
-    "node": ">=20.18"
+    "node": ">=20.17"
   },
   "type": "module",
   "bin": {
@@ -48,25 +48,25 @@
   },
   "dependencies": {
     "chalk": "^5.4.1",
-    "commander": "^13.1.0",
-    "debug": "^4.4.0",
+    "commander": "^14.0.0",
+    "debug": "^4.4.1",
     "lilconfig": "^3.1.3",
     "listr2": "^8.3.3",
     "micromatch": "^4.0.8",
-    "nano-spawn": "^1.0.0",
+    "nano-spawn": "^1.0.2",
     "pidtree": "^0.6.0",
     "string-argv": "^0.3.2",
-    "yaml": "^2.7.1"
+    "yaml": "^2.8.0"
   },
   "devDependencies": {
     "@changesets/changelog-github": "0.5.1",
-    "@changesets/cli": "2.29.3",
+    "@changesets/cli": "2.29.4",
     "@commitlint/cli": "19.8.1",
     "@commitlint/config-conventional": "19.8.1",
-    "@eslint/js": "9.26.0",
+    "@eslint/js": "9.27.0",
     "consolemock": "1.1.0",
     "cross-env": "7.0.3",
-    "eslint": "9.26.0",
+    "eslint": "9.27.0",
     "eslint-config-prettier": "10.1.5",
     "eslint-plugin-jest": "28.11.0",
     "eslint-plugin-n": "17.18.0",
@@ -77,7 +77,7 @@
     "jest-snapshot-serializer-ansi": "2.2.1",
     "mock-stdin": "1.0.0",
     "prettier": "3.5.3",
-    "semver": "7.7.1",
+    "semver": "7.7.2",
     "typescript": "5.8.3"
   },
   "keywords": [