lint-staged 12.4.1 → 12.5.0

package/README.md

@@ -92,6 +92,10 @@ 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
+  --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
   -q, --quiet                        disable lint-staged’s own console output (default: false)
   -r, --relative                     pass relative filepaths to tasks (default: false)
@@ -111,6 +115,9 @@ Options:
 - **`--debug`**: Run in debug mode. When set, it does the following:
   - uses [debug](https://github.com/visionmedia/debug) internally to log additional information about staged files, commands being executed, location of binaries, etc. Debug logs, which are automatically enabled by passing the flag, can also be enabled by setting the environment variable `$DEBUG` to `lint-staged*`.
   - uses [`verbose` renderer](https://github.com/SamVerschueren/listr-verbose-renderer) for `listr`; this causes serial, uncoloured output to the terminal, instead of the default (beautified, dynamic) output.
+- **`--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).
+- **`--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.
 - **`--quiet`**: Supress all CLI output, except from tasks.
 - **`--relative`**: Pass filepaths relative to `process.cwd()` (where `lint-staged` runs) to tasks. Default is `false`.
@@ -594,9 +601,9 @@ const success = await lintStaged({
   maxArgLength: null,
   quiet: false,
   relative: false,
-  shell: false
+  shell: false,
   stash: true,
-  verbose: false
+  verbose: false,
 })
 ```
 
@@ -713,6 +720,30 @@ Example repo: [sudo-suhas/lint-staged-django-react-demo](https://github.com/sudo
 
 </details>
 
+### Can I run `lint-staged` in CI, or when there are no staged files?
+
+<details>
+  <summary>Click to expand</summary>
+
+Lint-staged will by default run against files staged in git, and should be run during the git pre-commit hook, for example. It's also possible to override this default behaviour and run against files in a specific diff, for example
+all changed files between two different branches. If you want to run _lint-staged_ in the CI, maybe you can set it up to compare the branch in a _Pull Request_/_Merge Request_ to the target branch.
+
+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
+```
+
+This will print a list of _added_, _changed_, _modified_, and _renamed_ files between `master` and `my-branch`.
+
+You can then run lint-staged against the same files with:
+
+```
+npx lint-staged --diff="master...my-branch"
+```
+
+</details>
+
 ### Can I use `lint-staged` with `ng lint`
 
 <details>

package/bin/lint-staged.js

@@ -4,7 +4,7 @@ import fs from 'fs'
 import path from 'path'
 import { fileURLToPath } from 'url'
 
-import cmdline from 'commander'
+import { Option, program } from 'commander'
 import debug from 'debug'
 import supportsColor from 'supports-color'
 
@@ -23,50 +23,87 @@ const packageJsonPath = path.join(fileURLToPath(import.meta.url), '../../package
 const packageJson = JSON.parse(fs.readFileSync(packageJsonPath))
 const version = packageJson.version
 
-cmdline
-  .version(version)
-  .option('--allow-empty', 'allow empty commits when tasks revert all staged changes', false)
-  .option(
-    '-p, --concurrent <number|boolean>',
-    'the number of tasks to run concurrently, or false for serial',
-    true
+const debugLog = debug('lint-staged:bin')
+debugLog('Running `lint-staged@%s`', version)
+
+const cli = program.version(version)
+
+cli.option('--allow-empty', 'allow empty commits when tasks revert all staged changes', false)
+
+cli.option(
+  '-p, --concurrent <number|boolean>',
+  'the number of tasks to run concurrently, or false for serial',
+  true
+)
+
+cli.option('-c, --config [path]', 'path to configuration file, or - to read from stdin')
+
+cli.option('--cwd [path]', 'run all tasks in specific directory, instead of the current')
+
+cli.option('-d, --debug', 'print additional debug information', false)
+
+cli.option(
+  '--diff [string]',
+  'override the default "--staged" flag of "git diff" to get list of files. Implies "--no-stash".'
+)
+
+cli.option(
+  '--diff-filter [string]',
+  'override the default "--diff-filter=ACMR" flag of "git diff" to get list of files'
+)
+
+cli.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
+ * configuring only the latter won't actually set the default value.
+ */
+cli
+  .addOption(
+    new Option('--stash', 'enable the backup stash, and revert in case of errors')
+      .default(true)
+      .hideHelp()
   )
-  .option('-c, --config [path]', 'path to configuration file, or - to read from stdin')
-  .option('--cwd [path]', 'run all tasks in specific directory, instead of the current')
-  .option('-d, --debug', 'print additional debug information', false)
-  .option('--max-arg-length', 'maximum length of the command-line argument string')
-  .option('--no-stash', 'disable the backup stash, and do not revert in case of errors', false)
-  .option('-q, --quiet', 'disable lint-staged’s own console output', false)
-  .option('-r, --relative', 'pass relative filepaths to tasks', false)
-  .option('-x, --shell [path]', 'skip parsing of tasks for better shell support', false)
-  .option(
-    '-v, --verbose',
-    'show task output even when tasks succeed; by default only failed output is shown',
-    false
+  .addOption(
+    new Option(
+      '--no-stash',
+      'disable the backup stash, and do not revert in case of errors'
+    ).default(false)
   )
-  .parse(process.argv)
 
-const cmdlineOptions = cmdline.opts()
+cli.option('-q, --quiet', 'disable lint-staged’s own console output', false)
+
+cli.option('-r, --relative', 'pass relative filepaths to tasks', false)
+
+cli.option('-x, --shell [path]', 'skip parsing of tasks for better shell support', false)
+
+cli.option(
+  '-v, --verbose',
+  'show task output even when tasks succeed; by default only failed output is shown',
+  false
+)
 
-if (cmdlineOptions.debug) {
+const cliOptions = cli.parse(process.argv).opts()
+
+if (cliOptions.debug) {
   debug.enable('lint-staged*')
 }
 
-const debugLog = debug('lint-staged:bin')
-debugLog('Running `lint-staged@%s`', version)
-
 const options = {
-  allowEmpty: !!cmdlineOptions.allowEmpty,
-  concurrent: JSON.parse(cmdlineOptions.concurrent),
-  configPath: cmdlineOptions.config,
-  cwd: cmdlineOptions.cwd,
-  debug: !!cmdlineOptions.debug,
-  maxArgLength: JSON.parse(cmdlineOptions.maxArgLength || null),
-  quiet: !!cmdlineOptions.quiet,
-  relative: !!cmdlineOptions.relative,
-  shell: cmdlineOptions.shell /* Either a boolean or a string pointing to the shell */,
-  stash: !!cmdlineOptions.stash, // commander inverts `no-<x>` flags to `!x`
-  verbose: !!cmdlineOptions.verbose,
+  allowEmpty: !!cliOptions.allowEmpty,
+  concurrent: JSON.parse(cliOptions.concurrent),
+  configPath: cliOptions.config,
+  cwd: cliOptions.cwd,
+  debug: !!cliOptions.debug,
+  diff: cliOptions.diff,
+  diffFilter: cliOptions.diffFilter,
+  maxArgLength: cliOptions.maxArgLength || undefined,
+  quiet: !!cliOptions.quiet,
+  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`
+  verbose: !!cliOptions.verbose,
 }
 
 debugLog('Options parsed from command-line:', options)

package/lib/getStagedFiles.js

@@ -5,14 +5,25 @@ import normalize from 'normalize-path'
 import { execGit } from './execGit.js'
 import { parseGitZOutput } from './parseGitZOutput.js'
 
-export const getStagedFiles = async ({ cwd = process.cwd() } = {}) => {
+export const getStagedFiles = async ({ cwd = process.cwd(), diff, diffFilter } = {}) => {
   try {
-    // Docs for --diff-filter option: https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203
-    // Docs for -z option: https://git-scm.com/docs/git-diff#Documentation/git-diff.txt--z
-    const lines = await execGit(['diff', '--staged', '--diff-filter=ACMR', '--name-only', '-z'], {
-      cwd,
-    })
+    /**
+     *  Docs for --diff-filter option:
+     * @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203
+     */
+    const diffFilterArg = diffFilter !== undefined ? diffFilter.trim() : 'ACMR'
 
+    /** Use `--diff branch1...branch2` or `--diff="branch1 branch2", or fall back to default staged files */
+    const diffArgs = diff !== undefined ? diff.trim().split(' ') : ['--staged']
+
+    /**
+     * Docs for -z option:
+     * @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt--z
+     */
+    const lines = await execGit(
+      ['diff', '--name-only', '-z', `--diff-filter=${diffFilterArg}`, ...diffArgs],
+      { cwd }
+    )
     if (!lines) return []
 
     return parseGitZOutput(lines).map((file) => normalize(path.resolve(cwd, file)))

package/lib/groupFilesByConfig.js

@@ -2,22 +2,18 @@ import path from 'path'
 
 import debug from 'debug'
 
-import { ConfigObjectSymbol } from './searchConfigs.js'
-
 const debugLog = debug('lint-staged:groupFilesByConfig')
 
-export const groupFilesByConfig = async ({ configs, files }) => {
+export const groupFilesByConfig = async ({ configs, files, singleConfigMode }) => {
   debugLog('Grouping %d files by %d configurations', files.length, Object.keys(configs).length)
 
   const filesSet = new Set(files)
   const filesByConfig = {}
 
   /** Configs are sorted deepest first by `searchConfigs` */
-  for (const filepath of Reflect.ownKeys(configs)) {
-    const config = configs[filepath]
-
-    /** When passed an explicit config object via the Node.js API, skip logic */
-    if (filepath === ConfigObjectSymbol) {
+  for (const [filepath, config] of Object.entries(configs)) {
+    /** When passed an explicit config object via the Node.js API‚ or an explicit path, skip logic */
+    if (singleConfigMode) {
       filesByConfig[filepath] = { config, files }
       break
     }

package/lib/index.js

@@ -49,6 +49,8 @@ const getMaxArgLength = () => {
  * @param {string} [options.configPath] - Path to configuration file
  * @param {Object} [options.cwd] - Current working directory
  * @param {boolean} [options.debug] - Enable debug mode
+ * @param {string} [options.diff] - Override the default "--staged" flag of "git diff" to get list of files
+ * @param {string} [options.diffFilter] - Override the default "--diff-filter=ACMR" flag of "git diff" to get list of files
  * @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
@@ -67,6 +69,8 @@ const lintStaged = async (
     configPath,
     cwd,
     debug = false,
+    diff,
+    diffFilter,
     maxArgLength = getMaxArgLength() / 2,
     quiet = false,
     relative = false,
@@ -82,24 +86,25 @@ const lintStaged = async (
   debugLog('Unset GIT_LITERAL_PATHSPECS (was `%s`)', process.env.GIT_LITERAL_PATHSPECS)
   delete process.env.GIT_LITERAL_PATHSPECS
 
+  const options = {
+    allowEmpty,
+    concurrent,
+    configObject,
+    configPath,
+    cwd,
+    debug,
+    diff,
+    diffFilter,
+    maxArgLength,
+    quiet,
+    relative,
+    shell,
+    stash,
+    verbose,
+  }
+
   try {
-    const ctx = await runAll(
-      {
-        allowEmpty,
-        concurrent,
-        configObject,
-        configPath,
-        cwd,
-        debug,
-        maxArgLength,
-        quiet,
-        relative,
-        shell,
-        stash,
-        verbose,
-      },
-      logger
-    )
+    const ctx = await runAll(options, logger)
     debugLog('Tasks were executed successfully!')
     printTaskOutput(ctx, logger)
     return true

package/lib/messages.js

@@ -28,8 +28,14 @@ export const NO_STAGED_FILES = `${info} No staged files found.`
 
 export const NO_TASKS = `${info} No staged files match any configured task.`
 
-export const skippingBackup = (hasInitialCommit) => {
-  const reason = hasInitialCommit ? '`--no-stash` was used' : 'there’s no initial commit yet'
+export const skippingBackup = (hasInitialCommit, diff) => {
+  const reason =
+    diff !== undefined
+      ? '`--diff` was used'
+      : hasInitialCommit
+      ? '`--no-stash` was used'
+      : 'there’s no initial commit yet'
+
   return yellow(`${warning} Skipping backup because ${reason}.\n`)
 }
 

package/lib/runAll.js

@@ -36,7 +36,7 @@ import {
   restoreUnstagedChangesSkipped,
 } from './state.js'
 import { GitRepoError, GetStagedFilesError, GitError, ConfigNotFoundError } from './symbols.js'
-import { ConfigObjectSymbol, searchConfigs } from './searchConfigs.js'
+import { searchConfigs } from './searchConfigs.js'
 
 const debugLog = debug('lint-staged:runAll')
 
@@ -52,6 +52,8 @@ const createError = (ctx) => Object.assign(new Error('lint-staged failed'), { ct
  * @param {string} [options.configPath] - Explicit path to a config file
  * @param {string} [options.cwd] - Current working directory
  * @param {boolean} [options.debug] - Enable debug mode
+ * @param {string} [options.diff] - Override the default "--staged" flag of "git diff" to get list of files
+ * @param {string} [options.diffFilter] - Override the default "--diff-filter=ACMR" flag of "git diff" to get list of files
  * @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
@@ -69,6 +71,8 @@ export const runAll = async (
     configPath,
     cwd,
     debug = false,
+    diff,
+    diffFilter,
     maxArgLength,
     quiet = false,
     relative = false,
@@ -100,13 +104,14 @@ export const runAll = async (
     .then(() => true)
     .catch(() => false)
 
-  // Lint-staged should create a backup stash only when there's an initial commit
-  ctx.shouldBackup = hasInitialCommit && stash
+  // Lint-staged should create a backup stash only when there's an initial commit,
+  // and when using the default list of staged files
+  ctx.shouldBackup = hasInitialCommit && stash && diff === undefined
   if (!ctx.shouldBackup) {
-    logger.warn(skippingBackup(hasInitialCommit))
+    logger.warn(skippingBackup(hasInitialCommit, diff))
   }
 
-  const files = await getStagedFiles({ cwd: gitDir })
+  const files = await getStagedFiles({ cwd: gitDir, diff, diffFilter })
   if (!files) {
     if (!quiet) ctx.output.push(FAILED_GET_STAGED_FILES)
     ctx.errors.add(GetStagedFilesError)
@@ -121,7 +126,7 @@ export const runAll = async (
   }
 
   const foundConfigs = await searchConfigs({ configObject, configPath, cwd, gitDir }, logger)
-  const numberOfConfigs = Reflect.ownKeys(foundConfigs).length
+  const numberOfConfigs = Object.keys(foundConfigs).length
 
   // Throw if no configurations were found
   if (numberOfConfigs === 0) {
@@ -129,7 +134,11 @@ export const runAll = async (
     throw createError(ctx, ConfigNotFoundError)
   }
 
-  const filesByConfig = await groupFilesByConfig({ configs: foundConfigs, files })
+  const filesByConfig = await groupFilesByConfig({
+    configs: foundConfigs,
+    files,
+    singleConfigMode: configObject || configPath !== undefined,
+  })
 
   const hasMultipleConfigs = numberOfConfigs > 1
 
@@ -149,13 +158,8 @@ export const runAll = async (
   // Set of all staged files that matched a task glob. Values in a set are unique.
   const matchedFiles = new Set()
 
-  for (const configPath of Reflect.ownKeys(filesByConfig)) {
-    const { config, files } = filesByConfig[configPath]
-
-    const configName =
-      configPath === ConfigObjectSymbol
-        ? 'Config object'
-        : normalize(path.relative(cwd, configPath))
+  for (const [configPath, { config, files }] of Object.entries(filesByConfig)) {
+    const configName = configPath ? normalize(path.relative(cwd, configPath)) : 'Config object'
 
     const stagedFileChunks = chunkFiles({ baseDir: gitDir, files, maxArgLength, relative })
 

package/lib/searchConfigs.js

@@ -23,8 +23,6 @@ const sortDeepestParth = (a, b) => (numberOfLevels(a) > numberOfLevels(b) ? -1 :
 
 const isInsideDirectory = (dir) => (file) => file.startsWith(normalize(dir))
 
-export const ConfigObjectSymbol = Symbol()
-
 /**
  * Search all config files from the git repository, preferring those inside `cwd`.
  *
@@ -46,7 +44,7 @@ export const searchConfigs = async (
   if (configObject) {
     debugLog('Using single direct configuration object...')
 
-    return { [ConfigObjectSymbol]: validateConfig(configObject, 'config object', logger) }
+    return { '': validateConfig(configObject, 'config object', logger) }
   }
 
   // Use only explicit config path instead of discovering multiple

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "12.4.1",
+  "version": "12.5.0",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -34,35 +34,36 @@
   "dependencies": {
     "cli-truncate": "^3.1.0",
     "colorette": "^2.0.16",
-    "commander": "^8.3.0",
-    "debug": "^4.3.3",
+    "commander": "^9.3.0",
+    "debug": "^4.3.4",
     "execa": "^5.1.1",
-    "lilconfig": "2.0.4",
-    "listr2": "^4.0.1",
-    "micromatch": "^4.0.4",
+    "lilconfig": "2.0.5",
+    "listr2": "^4.0.5",
+    "micromatch": "^4.0.5",
     "normalize-path": "^3.0.0",
-    "object-inspect": "^1.12.0",
+    "object-inspect": "^1.12.2",
     "pidtree": "^0.5.0",
     "string-argv": "^0.3.1",
-    "supports-color": "^9.2.1",
+    "supports-color": "^9.2.2",
     "yaml": "^1.10.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.16.12",
-    "@babel/eslint-parser": "^7.16.5",
-    "@babel/preset-env": "^7.16.11",
-    "babel-jest": "^27.4.6",
+    "@babel/core": "^7.18.2",
+    "@babel/eslint-parser": "^7.18.2",
+    "@babel/preset-env": "^7.18.2",
+    "babel-jest": "^28.1.0",
+    "babel-plugin-transform-imports": "2.0.0",
     "consolemock": "^1.1.0",
-    "eslint": "^8.7.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.4",
+    "eslint": "^8.16.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "fs-extra": "^10.0.0",
-    "husky": "^7.0.4",
-    "jest": "^27.4.7",
+    "fs-extra": "^10.1.0",
+    "husky": "^8.0.1",
+    "jest": "^28.1.0",
     "jest-snapshot-serializer-ansi": "^1.0.0",
-    "prettier": "^2.5.1"
+    "prettier": "^2.6.2"
   },
   "keywords": [
     "lint",