lint-staged 15.1.0 → 15.2.0

package/README.md

@@ -117,7 +117,9 @@ Options:
                                      "--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
+  --no-stash                         disable the backup stash, and do not revert in case of errors. Implies
+                                     "--no-hide-partially-staged".
+  --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)
   -x, --shell [path]                 skip parsing of tasks for better shell support (default: false)
@@ -140,7 +142,8 @@ Options:
 - **`--diff`**: By default linters 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`.
+- **`--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-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`.
 - **`--shell`**: By default linter commands will be parsed for speed and security. This has the side-effect that regular shell scripts might not work as expected. You can skip parsing of commands with this option. To use a specific shell, use a path like `--shell "/bin/bash"`.
@@ -644,7 +647,7 @@ module.exports = {
 
 ## Frequently Asked Questions
 
-### The output of commit hook looks weird (no colors, duplicate lines, …)
+### The output of commit hook looks weird (no colors, duplicate lines, verbose output on Windows, …)
 
 <details>
   <summary>Click to expand</summary>
@@ -660,6 +663,21 @@ https://raw.githubusercontent.com/git/git/master/Documentation/RelNotes/2.37.0.t
 >   hook, which was noticed post release. This is getting corrected.
 >   (merge [a082345372](https://github.com/git/git/commit/a082345372) ab/hooks-regression-fix later to maint).
 
+If updating Git doesn't help, you can try to manually redirect the output in your Git hook; for example:
+
+```shell
+# .husky/pre-commit
+
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+if sh -c ": >/dev/tty" >/dev/null 2>/dev/null; then exec >/dev/tty 2>&1; fi
+
+npx lint-staged
+```
+
+Source: https://github.com/typicode/husky/issues/968#issuecomment-1176848345
+
 </details>
 
 ### Can I use `lint-staged` via node?

package/bin/lint-staged.js

@@ -67,7 +67,27 @@ cli
   .addOption(
     new Option(
       '--no-stash',
-      'disable the backup stash, and do not revert in case of errors'
+      'disable the backup stash, and do not revert in case of errors. Implies "--no-hide-partially-staged".'
+    )
+      .default(false)
+      .implies({ 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.
+ */
+cli
+  .addOption(
+    new Option('--hide-partially-staged', 'hide unstaged changes from partially staged files')
+      .default(true)
+      .hideHelp()
+  )
+  .addOption(
+    new Option(
+      '--no-hide-partially-staged',
+      'disable hiding unstaged changes from partially staged files'
     ).default(false)
   )
 
@@ -104,6 +124,7 @@ const options = {
   relative: !!cliOptions.relative,
   shell: cliOptions.shell /* Either a boolean or a string pointing to the shell */,
   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/configFiles.js

@@ -0,0 +1,24 @@
+export const CONFIG_NAME = 'lint-staged'
+
+export const PACKAGE_JSON_FILE = 'package.json'
+
+export const PACKAGE_YAML_FILES = ['package.yaml', 'package.yml']
+
+/**
+ * The list of files `lint-staged` will read configuration
+ * from, in the declared order.
+ */
+export const CONFIG_FILE_NAMES = [
+  PACKAGE_JSON_FILE,
+  ...PACKAGE_YAML_FILES,
+  '.lintstagedrc',
+  '.lintstagedrc.json',
+  '.lintstagedrc.yaml',
+  '.lintstagedrc.yml',
+  '.lintstagedrc.mjs',
+  '.lintstagedrc.js',
+  '.lintstagedrc.cjs',
+  'lint-staged.config.mjs',
+  'lint-staged.config.js',
+  'lint-staged.config.cjs',
+]

package/lib/index.js

@@ -77,6 +77,7 @@ const lintStaged = async (
     shell = false,
     // Stashing should be disabled by default when the `diff` option is used
     stash = diff === undefined,
+    hidePartiallyStaged = stash,
     verbose = false,
   } = {},
   logger = console
@@ -101,6 +102,7 @@ const lintStaged = async (
     relative,
     shell,
     stash,
+    hidePartiallyStaged,
     verbose,
   }
 

package/lib/loadConfig.js

@@ -1,44 +1,27 @@
 /** @typedef {import('./index').Logger} Logger */
 
+import fs from 'node:fs/promises'
 import path from 'node:path'
 
 import debug from 'debug'
-import { lilconfig } from 'lilconfig'
 import YAML from 'yaml'
 
 import { dynamicImport } from './dynamicImport.js'
 import { resolveConfig } from './resolveConfig.js'
+import {
+  CONFIG_FILE_NAMES,
+  CONFIG_NAME,
+  PACKAGE_JSON_FILE,
+  PACKAGE_YAML_FILES,
+} from './configFiles.js'
 
 const debugLog = debug('lint-staged:loadConfig')
 
-const CONFIG_NAME = 'lint-staged'
-
-const PACKAGE_JSON_FILE = 'package.json'
-
-const PACKAGE_YAML_FILES = ['package.yaml', 'package.yml']
-
-/**
- * The list of files `lint-staged` will read configuration
- * from, in the declared order.
- */
-export const searchPlaces = [
-  PACKAGE_JSON_FILE,
-  ...PACKAGE_YAML_FILES,
-  '.lintstagedrc',
-  '.lintstagedrc.json',
-  '.lintstagedrc.yaml',
-  '.lintstagedrc.yml',
-  '.lintstagedrc.mjs',
-  '.lintstagedrc.js',
-  '.lintstagedrc.cjs',
-  'lint-staged.config.mjs',
-  'lint-staged.config.js',
-  'lint-staged.config.cjs',
-]
-
 const jsonParse = (filePath, content) => {
+  const isPackageFile = PACKAGE_JSON_FILE.includes(path.basename(filePath))
   try {
-    return JSON.parse(content)
+    const json = JSON.parse(content)
+    return isPackageFile ? json[CONFIG_NAME] : json
   } catch (error) {
     if (path.basename(filePath) === PACKAGE_JSON_FILE) {
       debugLog('Ignoring invalid package file `%s` with content:\n%s', filePath, content)
@@ -64,6 +47,8 @@ const yamlParse = (filePath, content) => {
   }
 }
 
+const NO_EXT = 'noExt'
+
 /**
  * `lilconfig` doesn't support yaml files by default,
  * so we add custom loaders for those. Files without
@@ -77,10 +62,31 @@ const loaders = {
   '.cjs': dynamicImport,
   '.yaml': yamlParse,
   '.yml': yamlParse,
-  noExt: yamlParse,
+  [NO_EXT]: yamlParse,
 }
 
-const explorer = lilconfig(CONFIG_NAME, { searchPlaces, loaders })
+const readFile = async (filepath) => {
+  const absolutePath = path.resolve(filepath)
+  const file = await fs.readFile(absolutePath)
+  return await file.toString()
+}
+
+const loadConfigByExt = async (filepath) => {
+  filepath = path.resolve(filepath)
+  const ext = path.extname(filepath) || NO_EXT
+  const loader = loaders[ext]
+
+  /**
+   * No need to read file contents when loader only takes in the filepath argument
+   * and reads itself; this is for `lilconfig` compatibility
+   */
+  const content = loader.length > 1 ? await readFile(filepath) : undefined
+
+  return {
+    config: await loader(filepath, content),
+    filepath,
+  }
+}
 
 /**
  * @param {object} options
@@ -89,20 +95,22 @@ const explorer = lilconfig(CONFIG_NAME, { searchPlaces, loaders })
  */
 export const loadConfig = async ({ configPath, cwd }, logger) => {
   try {
+    let result
+
     if (configPath) {
       debugLog('Loading configuration from `%s`...', configPath)
+      result = await loadConfigByExt(resolveConfig(configPath))
     } else {
       debugLog('Searching for configuration from `%s`...', cwd)
+      const { lilconfig } = await import('lilconfig')
+      const explorer = lilconfig(CONFIG_NAME, { searchPlaces: CONFIG_FILE_NAMES, loaders })
+      result = await explorer.search(cwd)
     }
 
-    const result = await (configPath
-      ? explorer.load(resolveConfig(configPath))
-      : explorer.search(cwd))
-
     if (!result) return {}
 
     // config is a promise when using the `dynamicImport` loader
-    const config = await result.config
+    const config = (await result.config) ?? null
     const filepath = result.filepath
 
     debugLog('Successfully loaded config from `%s`:\n%O', filepath, config)

package/lib/messages.js

@@ -32,12 +32,25 @@ export const skippingBackup = (hasInitialCommit, diff) => {
     diff !== undefined
       ? '`--diff` was used'
       : hasInitialCommit
-      ? '`--no-stash` was used'
-      : 'there’s no initial commit yet'
+        ? '`--no-stash` was used'
+        : 'there’s no initial commit yet'
 
   return chalk.yellow(`${warning} Skipping backup because ${reason}.\n`)
 }
 
+export const skippingHidePartiallyStaged = (stash, diff) => {
+  const reason =
+    diff !== undefined
+      ? '`--diff` was used'
+      : !stash
+        ? '`--no-stash` was used'
+        : '`--no-hide-partially-staged` was used'
+
+  return chalk.yellow(
+    `${warning} Skipping hiding unstaged changes from partially staged files because ${reason}.\n`
+  )
+}
+
 export const DEPRECATED_GIT_ADD = chalk.yellow(
   `${warning} Some of your tasks use \`git add\` command. Please remove it from the config since all modifications made by tasks will be automatically added to the git commit index.
 `

package/lib/resolveGitRepo.js

@@ -15,10 +15,19 @@ const debugLog = debug('lint-staged:resolveGitRepo')
  */
 const resolveGitConfigDir = async (gitDir) => {
   // Get the real path in case it's a symlink
-  const defaultDir = normalizePath(await fs.realpath(path.join(gitDir, '.git')))
+  const defaultDir = path.join(gitDir, '.git')
   const stats = await fs.lstat(defaultDir)
+
   // If .git is a directory, use it
-  if (stats.isDirectory()) return defaultDir
+  if (stats.isDirectory()) {
+    return defaultDir
+  }
+
+  // If .git is a symlink, return the real location
+  if (stats.isSymbolicLink()) {
+    return await fs.realpath(gitDir)
+  }
+
   // Otherwise .git is a file containing path to real location
   const file = (await readFile(defaultDir)).toString()
   return path.resolve(gitDir, file.replace(/^gitdir: /, '')).trim()
@@ -33,10 +42,10 @@ export const determineGitDir = (cwd, relativeDir) => {
   }
   if (relativeDir) {
     // the current working dir is inside the git top-level directory
-    return normalizePath(cwd.substring(0, cwd.lastIndexOf(relativeDir)))
+    return cwd.substring(0, cwd.lastIndexOf(relativeDir))
   } else {
     // the current working dir is the top-level git directory
-    return normalizePath(cwd)
+    return cwd
   }
 }
 
@@ -56,7 +65,7 @@ export const resolveGitRepo = async (cwd = process.cwd()) => {
     // read the path of the current directory relative to the top-level directory
     // don't read the toplevel directly, it will lead to an posix conform path on non posix systems (cygwin)
     const gitRel = normalizePath(await execGit(['rev-parse', '--show-prefix'], { cwd }))
-    const gitDir = determineGitDir(normalizePath(cwd), gitRel)
+    const gitDir = normalizePath(determineGitDir(normalizePath(cwd), gitRel))
     const gitConfigDir = normalizePath(await resolveGitConfigDir(gitDir))
 
     debugLog('Resolved git directory to be `%s`', gitDir)

package/lib/runAll.js

@@ -22,6 +22,7 @@ import {
   NO_TASKS,
   SKIPPED_GIT_ERROR,
   skippingBackup,
+  skippingHidePartiallyStaged,
 } from './messages.js'
 import { normalizePath } from './normalizePath.js'
 import { resolveGitRepo } from './resolveGitRepo.js'
@@ -30,7 +31,7 @@ import {
   cleanupEnabled,
   cleanupSkipped,
   getInitialState,
-  hasPartiallyStagedFiles,
+  shouldHidePartiallyStagedFiles,
   restoreOriginalStateEnabled,
   restoreOriginalStateSkipped,
   restoreUnstagedChangesSkipped,
@@ -79,6 +80,7 @@ export const runAll = async (
     shell = false,
     // Stashing should be disabled by default when the `diff` option is used
     stash = diff === undefined,
+    hidePartiallyStaged = stash,
     verbose = false,
   },
   logger = console
@@ -112,6 +114,11 @@ export const runAll = async (
     logger.warn(skippingBackup(hasInitialCommit, diff))
   }
 
+  ctx.shouldHidePartiallyStaged = hidePartiallyStaged
+  if (!ctx.shouldHidePartiallyStaged && !quiet) {
+    logger.warn(skippingHidePartiallyStaged(hasInitialCommit && stash, diff))
+  }
+
   const files = await getStagedFiles({ cwd: gitDir, diff, diffFilter })
   if (!files) {
     if (!quiet) ctx.output.push(FAILED_GET_STAGED_FILES)
@@ -280,7 +287,7 @@ export const runAll = async (
       {
         title: 'Hiding unstaged changes to partially staged files...',
         task: (ctx) => git.hideUnstagedChanges(ctx),
-        enabled: hasPartiallyStagedFiles,
+        enabled: shouldHidePartiallyStagedFiles,
       },
       {
         title: `Running tasks for ${diff ? 'changed' : 'staged'} files...`,
@@ -295,7 +302,7 @@ export const runAll = async (
       {
         title: 'Restoring unstaged changes to partially staged files...',
         task: (ctx) => git.restoreUnstagedChanges(ctx),
-        enabled: hasPartiallyStagedFiles,
+        enabled: shouldHidePartiallyStagedFiles,
         skip: restoreUnstagedChangesSkipped,
       },
       {

package/lib/searchConfigs.js

@@ -5,17 +5,18 @@ import path from 'node:path'
 import debug from 'debug'
 
 import { execGit } from './execGit.js'
-import { loadConfig, searchPlaces } from './loadConfig.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')
 
 const EXEC_GIT = ['ls-files', '-z', '--full-name']
 
 const filterPossibleConfigFiles = (files) =>
-  files.filter((file) => searchPlaces.includes(path.basename(file)))
+  files.filter((file) => CONFIG_FILE_NAMES.includes(path.basename(file)))
 
 const numberOfLevels = (file) => file.split('/').length
 

package/lib/state.js

@@ -12,13 +12,15 @@ import {
 export const getInitialState = ({ quiet = false } = {}) => ({
   hasPartiallyStagedFiles: null,
   shouldBackup: null,
+  shouldHidePartiallyStaged: true,
   errors: new Set([]),
   events: new EventEmitter(),
   output: [],
   quiet,
 })
 
-export const hasPartiallyStagedFiles = (ctx) => ctx.hasPartiallyStagedFiles
+export const shouldHidePartiallyStagedFiles = (ctx) =>
+  ctx.hasPartiallyStagedFiles && ctx.shouldHidePartiallyStaged
 
 export const applyModificationsSkipped = (ctx) => {
   // Always apply back unstaged modifications when skipping backup

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "15.1.0",
+  "version": "15.2.0",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -29,8 +29,8 @@
   ],
   "scripts": {
     "lint": "eslint .",
-    "test": "jest --coverage",
-    "test:watch": "jest --watch",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules npx jest --coverage",
+    "test:watch": "npm run test -- --watch",
     "version": "npx changeset version",
     "postversion": "npm i --package-lock-only && git commit -am \"chore(changeset): release\"",
     "tag": "npx changeset tag"
@@ -40,25 +40,21 @@
     "commander": "11.1.0",
     "debug": "4.3.4",
     "execa": "8.0.1",
-    "lilconfig": "2.1.0",
-    "listr2": "7.0.2",
+    "lilconfig": "3.0.0",
+    "listr2": "8.0.0",
     "micromatch": "4.0.5",
     "pidtree": "0.6.0",
     "string-argv": "0.3.2",
     "yaml": "2.3.4"
   },
   "devDependencies": {
-    "@babel/core": "7.23.3",
-    "@babel/eslint-parser": "7.23.3",
-    "@babel/preset-env": "7.23.3",
-    "@changesets/changelog-github": "0.4.8",
-    "@changesets/cli": "2.26.2",
-    "@commitlint/cli": "18.4.0",
-    "@commitlint/config-conventional": "18.4.0",
-    "babel-jest": "29.7.0",
-    "babel-plugin-transform-imports": "2.0.0",
+    "@changesets/changelog-github": "0.5.0",
+    "@changesets/cli": "2.27.1",
+    "@commitlint/cli": "18.4.3",
+    "@commitlint/config-conventional": "18.4.3",
     "consolemock": "1.1.0",
-    "eslint": "8.53.0",
+    "cross-env": "7.0.3",
+    "eslint": "8.55.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-import": "2.29.0",
     "eslint-plugin-node": "11.1.0",
@@ -67,7 +63,7 @@
     "jest": "29.7.0",
     "jest-snapshot-serializer-ansi": "2.1.0",
     "mock-stdin": "1.0.0",
-    "prettier": "3.0.3"
+    "prettier": "3.1.0"
   },
   "keywords": [
     "lint",