lint-staged 15.2.7 → 15.2.8

package/README.md

@@ -1,4 +1,8 @@
-# 🚫💩 lint-staged [![Test & Release](https://github.com/okonet/lint-staged/actions/workflows/push.yml/badge.svg)](https://github.com/okonet/lint-staged/actions/workflows/push.yml) [![Publish](https://github.com/okonet/lint-staged/actions/workflows/tag.yml/badge.svg)](https://github.com/okonet/lint-staged/actions/workflows/tag.yml) [![npm version](https://badge.fury.io/js/lint-staged.svg)](https://badge.fury.io/js/lint-staged) [![Codecov](https://codecov.io/gh/okonet/lint-staged/branch/master/graph/badge.svg)](https://codecov.io/gh/okonet/lint-staged)
+# 🚫💩 lint-staged
+
+[![npm version](https://badge.fury.io/js/lint-staged.svg)](https://badge.fury.io/js/lint-staged)
+
+---
 
 Run linters against staged git files and don't let :poop: slip into your code base!
 
@@ -236,17 +240,9 @@ Another example in which tasks make edits to files and globs match multiple file
 
 ```json
 {
-  "*.css": [
-    "stylelint --fix",
-    "prettier --write"
-  ],
-  "*.{js,jsx}": [
-    "eslint --fix",
-    "prettier --write"
-  ],
-  "!(*.css|*.js|*.jsx)": [
-    "prettier --write"
-  ]
+  "*.css": ["stylelint --fix", "prettier --write"],
+  "*.{js,jsx}": ["eslint --fix", "prettier --write"],
+  "!(*.css|*.js|*.jsx)": ["prettier --write"]
 }
 ```
 
@@ -489,8 +485,7 @@ All examples assume you've already set up lint-staged in the `package.json` file
 In `.husky/pre-commit`
 
 ```shell
-#!/usr/bin/env sh
-. "$(dirname "$0")/_/husky.sh"
+# .husky/pre-commit
 
 npx lint-staged
 ```
@@ -696,9 +691,6 @@ If updating Git doesn't help, you can try to manually redirect the output in you
 ```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

package/bin/lint-staged.js

@@ -128,7 +128,7 @@ const options = {
   verbose: !!cliOptions.verbose,
 }
 
-debugLog('Options parsed from command-line:', options)
+debugLog('Options parsed from command-line: %o', options)
 
 if (options.configPath === '-') {
   delete options.configPath

package/lib/chunkFiles.js

@@ -31,7 +31,7 @@ const chunkArray = (arr, chunkCount) => {
  * @param {Array<String>} opts.files
  * @param {String} [opts.baseDir] The optional base directory to resolve relative paths.
  * @param {number} [opts.maxArgLength] the maximum argument string length
- * @param {Boolean} [opts.relative] whether files are relative to `gitDir` or should be resolved as absolute
+ * @param {Boolean} [opts.relative] whether files are relative to `topLevelDir` or should be resolved as absolute
  * @returns {Array<Array<String>>}
  */
 export const chunkFiles = ({ files, baseDir, maxArgLength = null, relative = false }) => {

package/lib/generateTasks.js

@@ -13,9 +13,8 @@ const debugLog = debug('lint-staged:generateTasks')
  * @param {object} options
  * @param {Object} [options.config] - Task configuration
  * @param {Object} [options.cwd] - Current working directory
- * @param {boolean} [options.gitDir] - Git root directory
  * @param {boolean} [options.files] - Staged filepaths
- * @param {boolean} [options.relative] - Whether filepaths to should be relative to gitDir
+ * @param {boolean} [options.relative] - Whether filepaths to should be relative to cwd
  */
 export const generateTasks = ({ config, cwd = process.cwd(), files, relative = false }) => {
   debugLog('Generating linter tasks')

package/lib/gitWorkflow.js

@@ -66,11 +66,11 @@ const handleError = (error, ctx, symbol) => {
 }
 
 export class GitWorkflow {
-  constructor({ allowEmpty, gitConfigDir, gitDir, matchedFileChunks, diff, diffFilter }) {
-    this.execGit = (args, options = {}) => execGit(args, { ...options, cwd: gitDir })
+  constructor({ allowEmpty, gitConfigDir, topLevelDir, matchedFileChunks, diff, diffFilter }) {
+    this.execGit = (args, options = {}) => execGit(args, { ...options, cwd: topLevelDir })
     this.deletedFiles = []
     this.gitConfigDir = gitConfigDir
-    this.gitDir = gitDir
+    this.topLevelDir = topLevelDir
     this.diff = diff
     this.diffFilter = diffFilter
     this.allowEmpty = allowEmpty
@@ -116,7 +116,7 @@ export class GitWorkflow {
     const deletedFiles = lsFiles
       .split('\n')
       .filter(Boolean)
-      .map((file) => path.resolve(this.gitDir, file))
+      .map((file) => path.resolve(this.topLevelDir, file))
     debugLog('Found deleted files:', deletedFiles)
     return deletedFiles
   }

package/lib/index.js

@@ -1,5 +1,6 @@
 import debug from 'debug'
 
+import { execGit } from './execGit.js'
 import {
   PREVENTED_EMPTY_COMMIT,
   GIT_ERROR,
@@ -82,11 +83,8 @@ const lintStaged = async (
   } = {},
   logger = console
 ) => {
-  await validateOptions({ cwd, shell }, logger)
-
-  // Unset GIT_LITERAL_PATHSPECS to not mess with path interpretation
-  debugLog('Unset GIT_LITERAL_PATHSPECS (was `%s`)', process.env.GIT_LITERAL_PATHSPECS)
-  delete process.env.GIT_LITERAL_PATHSPECS
+  const gitVersion = await execGit(['version', '--build-options'], { cwd })
+  debugLog('%s', gitVersion)
 
   const options = {
     allowEmpty,
@@ -106,6 +104,12 @@ const lintStaged = async (
     verbose,
   }
 
+  await validateOptions(options, logger)
+
+  // Unset GIT_LITERAL_PATHSPECS to not mess with path interpretation
+  debugLog('Unset GIT_LITERAL_PATHSPECS (was `%s`)', process.env.GIT_LITERAL_PATHSPECS)
+  delete process.env.GIT_LITERAL_PATHSPECS
+
   try {
     const ctx = await runAll(options, logger)
     debugLog('Tasks were executed successfully!')

package/lib/makeCmdTasks.js

@@ -12,11 +12,11 @@ const debugLog = debug('lint-staged:makeCmdTasks')
  * @param {Array<string|Function>|string|Function} options.commands
  * @param {string} options.cwd
  * @param {Array<string>} options.files
- * @param {string} options.gitDir
+ * @param {string} options.topLevelDir
  * @param {Boolean} shell
  * @param {Boolean} verbose
  */
-export const makeCmdTasks = async ({ commands, cwd, files, gitDir, shell, verbose }) => {
+export const makeCmdTasks = async ({ commands, cwd, files, topLevelDir, shell, verbose }) => {
   debugLog('Creating listr tasks for commands %o', commands)
   const commandArray = Array.isArray(commands) ? commands : [commands]
   const cmdTasks = []
@@ -43,7 +43,7 @@ export const makeCmdTasks = async ({ commands, cwd, files, gitDir, shell, verbos
         )
       }
 
-      const task = resolveTaskFn({ command, cwd, files, gitDir, isFn, shell, verbose })
+      const task = resolveTaskFn({ command, cwd, files, topLevelDir, isFn, shell, verbose })
       cmdTasks.push({ title: command, command, task })
     }
   }

package/lib/resolveGitRepo.js

@@ -1,3 +1,5 @@
+import path from 'node:path'
+
 import debug from 'debug'
 
 import { execGit } from './execGit.js'
@@ -6,8 +8,38 @@ import { normalizePath } from './normalizePath.js'
 const debugLog = debug('lint-staged:resolveGitRepo')
 
 /**
- * Resolve git directory and possible submodule paths
+ * Resolve .git directory relative to repo top-level directory
+ *
+ * @example ".git"
  */
+const resolveRelativeGitDir = async (cwd = process.cwd()) => {
+  /**
+   * Absolute repo top-level directory
+   *
+   * @example <caption>Git on macOS</caption>
+   * "/Users/iiro/Documents/git/lint-staged"
+   *
+   * @example <caption>Git for Windows</caption>
+   * "C:\Users\iiro\Documents\git\lint-staged"
+   *
+   * @example <caption>Git installed with MSYS2, this doesn't work when used as CWD with Node.js child_process</caption>
+   * "/c/Users/iiro/Documents/git/lint-staged"
+   */
+  const topLevelPromise = execGit(['rev-parse', '--show-toplevel'], { cwd })
+
+  /**
+   * Absolute .git directory, similar to top-level
+   *
+   * @example "/Users/iiro/Documents/git/lint-staged/.git"
+   */
+  const absoluteGitDirPromise = execGit(['rev-parse', '--absolute-git-dir'], { cwd })
+
+  const [topLevel, absoluteGitDir] = await Promise.all([topLevelPromise, absoluteGitDirPromise])
+
+  return path.relative(topLevel, absoluteGitDir)
+}
+
+/** Resolve git directory and possible submodule paths */
 export const resolveGitRepo = async (cwd = process.cwd()) => {
   try {
     debugLog('Resolving git repo from `%s`', cwd)
@@ -18,15 +50,17 @@ export const resolveGitRepo = async (cwd = process.cwd()) => {
     debugLog('Unset GIT_WORK_TREE (was `%s`)', process.env.GIT_WORK_TREE)
     delete process.env.GIT_WORK_TREE
 
-    const gitDir = normalizePath(await execGit(['rev-parse', '--show-toplevel'], { cwd }))
-    debugLog('Resolved git directory to be `%s`', gitDir)
+    const relativeTopLevelDir = await execGit(['rev-parse', '--show-cdup'], { cwd })
+    const topLevelDir = normalizePath(path.join(cwd, relativeTopLevelDir))
+    debugLog('Resolved git repository top-level directory to be `%s`', topLevelDir)
 
-    const gitConfigDir = normalizePath(await execGit(['rev-parse', '--absolute-git-dir'], { cwd }))
+    const relativeGitConfigDir = await resolveRelativeGitDir(cwd)
+    const gitConfigDir = normalizePath(path.join(topLevelDir, relativeGitConfigDir))
     debugLog('Resolved git config directory to be `%s`', gitConfigDir)
 
-    return { gitDir, gitConfigDir }
+    return { topLevelDir, gitConfigDir }
   } catch (error) {
     debugLog('Failed to resolve git repo with error:', error)
-    return { error, gitDir: null, gitConfigDir: null }
+    return { error, topLevelDir: null, gitConfigDir: null }
   }
 }

package/lib/resolveTaskFn.js

@@ -125,7 +125,7 @@ const makeErr = (command, result, ctx) => {
  * @param {Object} options
  * @param {string} options.command — Linter task
  * @param {string} [options.cwd]
- * @param {String} options.gitDir - Current git repo path
+ * @param {String} options.topLevelDir - Current git repo top-level path
  * @param {Boolean} options.isFn - Whether the linter task is a function
  * @param {Array<string>} options.files — Filepaths to run the linter task against
  * @param {Boolean} [options.shell] — Whether to skip parsing linter task for better shell support
@@ -136,7 +136,7 @@ export const resolveTaskFn = ({
   command,
   cwd = process.cwd(),
   files,
-  gitDir,
+  topLevelDir,
   isFn,
   shell = false,
   verbose = false,
@@ -146,9 +146,9 @@ export const resolveTaskFn = ({
   debugLog('args:', args)
 
   const execaOptions = {
-    // Only use gitDir as CWD if we are using the git binary
+    // Only use topLevelDir as CWD if we are using the git binary
     // e.g `npm` should run tasks in the actual CWD
-    cwd: /^git(\.exe)?/i.test(cmd) ? gitDir : cwd,
+    cwd: /^git(\.exe)?/i.test(cmd) ? topLevelDir : cwd,
     preferLocal: true,
     reject: false,
     shell,

package/lib/runAll.js

@@ -94,8 +94,8 @@ export const runAll = async (
 
   const ctx = getInitialState({ quiet })
 
-  const { gitDir, gitConfigDir } = await resolveGitRepo(cwd)
-  if (!gitDir) {
+  const { topLevelDir, gitConfigDir } = await resolveGitRepo(cwd)
+  if (!topLevelDir) {
     if (!quiet) ctx.output.push(NOT_GIT_REPO)
     ctx.errors.add(GitRepoError)
     throw createError(ctx)
@@ -103,7 +103,7 @@ export const runAll = async (
 
   // Test whether we have any commits or not.
   // Stashing must be disabled with no initial commit.
-  const hasInitialCommit = await execGit(['log', '-1'], { cwd: gitDir })
+  const hasInitialCommit = await execGit(['log', '-1'], { cwd: topLevelDir })
     .then(() => true)
     .catch(() => false)
 
@@ -119,7 +119,7 @@ export const runAll = async (
     logger.warn(skippingHidePartiallyStaged(hasInitialCommit && stash, diff))
   }
 
-  const files = await getStagedFiles({ cwd: gitDir, diff, diffFilter })
+  const files = await getStagedFiles({ cwd: topLevelDir, diff, diffFilter })
   if (!files) {
     if (!quiet) ctx.output.push(FAILED_GET_STAGED_FILES)
     ctx.errors.add(GetStagedFilesError)
@@ -133,7 +133,7 @@ export const runAll = async (
     return ctx
   }
 
-  const foundConfigs = await searchConfigs({ configObject, configPath, cwd, gitDir }, logger)
+  const foundConfigs = await searchConfigs({ configObject, configPath, cwd, topLevelDir }, logger)
   const numberOfConfigs = Object.keys(foundConfigs).length
 
   // Throw if no configurations were found
@@ -169,7 +169,7 @@ export const runAll = async (
   for (const [configPath, { config, files }] of Object.entries(filesByConfig)) {
     const configName = configPath ? normalizePath(path.relative(cwd, configPath)) : 'Config object'
 
-    const stagedFileChunks = chunkFiles({ baseDir: gitDir, files, maxArgLength, relative })
+    const stagedFileChunks = chunkFiles({ baseDir: topLevelDir, files, maxArgLength, relative })
 
     // Use actual cwd if it's specified, or there's only a single config file.
     // Otherwise use the directory of the config file for each config group,
@@ -188,7 +188,7 @@ export const runAll = async (
             commands: task.commands,
             cwd: groupCwd,
             files: task.fileList,
-            gitDir,
+            topLevelDir,
             shell,
             verbose,
           }).then((subTasks) => {
@@ -262,7 +262,7 @@ export const runAll = async (
 
   // Chunk matched files for better Windows compatibility
   const matchedFileChunks = chunkFiles({
-    // matched files are relative to `cwd`, not `gitDir`, when `relative` is used
+    // matched files are relative to `cwd`, not `topLevelDir`, when `relative` is used
     baseDir: cwd,
     files: Array.from(matchedFiles),
     maxArgLength,
@@ -272,7 +272,7 @@ export const runAll = async (
   const git = new GitWorkflow({
     allowEmpty,
     gitConfigDir,
-    gitDir,
+    topLevelDir,
     matchedFileChunks,
     diff,
     diffFilter,

package/lib/searchConfigs.js

@@ -35,7 +35,7 @@ const isInsideDirectory = (dir) => (file) => file.startsWith(normalizePath(dir))
  * @returns {Promise<{ [key: string]: { config: *, files: string[] } }>} found configs with filepath as key, and config as value
  */
 export const searchConfigs = async (
-  { configObject, configPath, cwd = process.cwd(), gitDir = cwd },
+  { configObject, configPath, cwd = process.cwd(), topLevelDir = cwd },
   logger
 ) => {
   debugLog('Searching for configuration files...')
@@ -59,9 +59,11 @@ export const searchConfigs = async (
 
   const [cachedFilesWithStatus, otherFilesWithStatus] = await Promise.all([
     /** Get all possible config files known to git */
-    execGit(EXEC_GIT, { cwd: gitDir }).then(parseGitZOutput),
+    execGit(EXEC_GIT, { cwd: topLevelDir }).then(parseGitZOutput),
     /** Get all possible config files from uncommitted files */
-    execGit([...EXEC_GIT, '--others', '--exclude-standard'], { cwd: gitDir }).then(parseGitZOutput),
+    execGit([...EXEC_GIT, '--others', '--exclude-standard'], { cwd: topLevelDir }).then(
+      parseGitZOutput
+    ),
   ])
 
   /** Sort possible config files so that deepest is first */
@@ -74,7 +76,7 @@ export const searchConfigs = async (
        */ (line) => (line.startsWith('S ') ? [] : [line.replace(/^[HSMRCK?U] /, '')])
     )
     .filter(filterPossibleConfigFiles)
-    .map((file) => normalizePath(path.join(gitDir, file)))
+    .map((file) => normalizePath(path.join(topLevelDir, file)))
     .filter(isInsideDirectory(cwd))
     .sort(sortDeepestParth)
 

package/lib/validateOptions.js

@@ -26,6 +26,7 @@ export const validateOptions = async (options = {}, logger) => {
       const resolved = path.resolve(options.cwd)
       await fs.access(resolved, constants.F_OK)
     } catch (error) {
+      debugLog('Failed to validate options: %o', options)
       logger.error(invalidOption('cwd', options.cwd, error.message))
       throw InvalidOptionsError
     }
@@ -36,10 +37,11 @@ export const validateOptions = async (options = {}, logger) => {
     try {
       await fs.access(options.shell, constants.X_OK)
     } catch (error) {
+      debugLog('Failed to validate options: %o', options)
       logger.error(invalidOption('shell', options.shell, error.message))
       throw InvalidOptionsError
     }
   }
 
-  debugLog('Validated options!')
+  debugLog('Validated options: %o', options)
 }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "lint-staged",
-  "version": "15.2.7",
+  "version": "15.2.8",
   "description": "Lint files staged by git",
   "license": "MIT",
-  "repository": "https://github.com/okonet/lint-staged",
+  "repository": "https://github.com/lint-staged/lint-staged",
   "author": "Andrey Okonetchnikov <andrey@okonet.ru>",
   "maintainers": [
     "Lufty Wiranda <lufty.wiranda@gmail.com>",
@@ -38,18 +38,18 @@
   "dependencies": {
     "chalk": "~5.3.0",
     "commander": "~12.1.0",
-    "debug": "~4.3.4",
+    "debug": "~4.3.6",
     "execa": "~8.0.1",
-    "lilconfig": "~3.1.1",
-    "listr2": "~8.2.1",
+    "lilconfig": "~3.1.2",
+    "listr2": "~8.2.4",
     "micromatch": "~4.0.7",
     "pidtree": "~0.6.0",
     "string-argv": "~0.3.2",
-    "yaml": "~2.4.2"
+    "yaml": "~2.5.0"
   },
   "devDependencies": {
     "@changesets/changelog-github": "0.5.0",
-    "@changesets/cli": "2.27.3",
+    "@changesets/cli": "2.27.7",
     "@commitlint/cli": "19.3.0",
     "@commitlint/config-conventional": "19.2.2",
     "consolemock": "1.1.0",
@@ -58,12 +58,12 @@
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-prettier": "5.1.3",
-    "husky": "9.0.11",
+    "eslint-plugin-prettier": "5.2.1",
+    "husky": "9.1.4",
     "jest": "29.7.0",
     "jest-snapshot-serializer-ansi": "2.1.0",
     "mock-stdin": "1.0.0",
-    "prettier": "3.2.5"
+    "prettier": "3.3.3"
   },
   "keywords": [
     "lint",