lint-staged 11.2.6 → 12.0.1

package/README.md

@@ -1,4 +1,4 @@
-# 🚫💩 lint-staged ![GitHub Actions](https://github.com/okonet/lint-staged/workflows/CI/badge.svg) [![Build Status for Windows](https://ci.appveyor.com/api/projects/status/github/okonet/lint-staged?branch=master&svg=true)](https://ci.appveyor.com/project/okonet/lint-staged) [![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 ![GitHub Actions](https://github.com/okonet/lint-staged/workflows/CI/badge.svg) [![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)
 
 Run linters against staged git files and don't let :poop: slip into your code base!
 

package/bin/lint-staged.js

@@ -1,11 +1,17 @@
 #!/usr/bin/env node
 
-'use strict'
+import fs from 'fs'
+import path from 'path'
+import { fileURLToPath } from 'url'
 
-const fs = require('fs')
+import cmdline from 'commander'
+import debug from 'debug'
+import supportsColor from 'supports-color'
+
+import lintStaged from '../lib/index.js'
+import { CONFIG_STDIN_ERROR } from '../lib/messages.js'
 
 // Force colors for packages that depend on https://www.npmjs.com/package/supports-color
-const supportsColor = require('supports-color')
 if (supportsColor.stdout) {
   process.env.FORCE_COLOR = supportsColor.stdout.level.toString()
 }
@@ -13,24 +19,12 @@ if (supportsColor.stdout) {
 // Do not terminate main Listr process on SIGINT
 process.on('SIGINT', () => {})
 
-const pkg = require('../package.json')
-require('please-upgrade-node')(
-  Object.assign({}, pkg, {
-    engines: {
-      node: '>=12.13.0', // First LTS release of 'Erbium'
-    },
-  })
-)
-
-const cmdline = require('commander')
-const debugLib = require('debug')
-const lintStaged = require('../lib')
-const { CONFIG_STDIN_ERROR } = require('../lib/messages')
-
-const debug = debugLib('lint-staged:bin')
+const packageJsonPath = path.join(fileURLToPath(import.meta.url), '../../package.json')
+const packageJson = JSON.parse(fs.readFileSync(packageJsonPath))
+const version = packageJson.version
 
 cmdline
-  .version(pkg.version)
+  .version(version)
   .option('--allow-empty', 'allow empty commits when tasks revert all staged changes', false)
   .option('-c, --config [path]', 'path to configuration file, or - to read from stdin')
   .option('-d, --debug', 'print additional debug information', false)
@@ -50,11 +44,11 @@ cmdline
   )
   .parse(process.argv)
 
+const debugLog = debug('lint-staged:bin')
 if (cmdline.debug) {
-  debugLib.enable('lint-staged*')
+  debug.enable('lint-staged*')
 }
-
-debug('Running `lint-staged@%s`', pkg.version)
+debugLog('Running `lint-staged@%s`', version)
 
 /**
  * Get the maximum length of a command-line argument string based on current platform
@@ -89,7 +83,7 @@ const options = {
   verbose: !!cmdlineOptions.verbose,
 }
 
-debug('Options parsed from command-line:', options)
+debugLog('Options parsed from command-line:', options)
 
 if (options.configPath === '-') {
   delete options.configPath

package/lib/chunkFiles.js

@@ -1,8 +1,9 @@
-'use strict'
+import path from 'path'
 
-const debug = require('debug')('lint-staged:chunkFiles')
-const normalize = require('normalize-path')
-const path = require('path')
+import debug from 'debug'
+import normalize from 'normalize-path'
+
+const debugLog = debug('lint-staged:chunkFiles')
 
 /**
  * Chunk array into sub-arrays
@@ -10,7 +11,7 @@ const path = require('path')
  * @param {Number} chunkCount
  * @retuns {Array<Array>}
  */
-function chunkArray(arr, chunkCount) {
+const chunkArray = (arr, chunkCount) => {
   if (chunkCount === 1) return [arr]
   const chunked = []
   let position = 0
@@ -32,21 +33,21 @@ function chunkArray(arr, chunkCount) {
  * @param {Boolean} [opts.relative] whether files are relative to `gitDir` or should be resolved as absolute
  * @returns {Array<Array<String>>}
  */
-module.exports = function chunkFiles({ files, baseDir, maxArgLength = null, relative = false }) {
+export const chunkFiles = ({ files, baseDir, maxArgLength = null, relative = false }) => {
   const normalizedFiles = files.map((file) =>
     normalize(relative || !baseDir ? file : path.resolve(baseDir, file))
   )
 
   if (!maxArgLength) {
-    debug('Skip chunking files because of undefined maxArgLength')
+    debugLog('Skip chunking files because of undefined maxArgLength')
     return [normalizedFiles] // wrap in an array to return a single chunk
   }
 
   const fileListLength = normalizedFiles.join(' ').length
-  debug(
+  debugLog(
     `Resolved an argument string length of ${fileListLength} characters from ${normalizedFiles.length} files`
   )
   const chunkCount = Math.min(Math.ceil(fileListLength / maxArgLength), normalizedFiles.length)
-  debug(`Creating ${chunkCount} chunks for maxArgLength of ${maxArgLength}`)
+  debugLog(`Creating ${chunkCount} chunks for maxArgLength of ${maxArgLength}`)
   return chunkArray(normalizedFiles, chunkCount)
 }

package/lib/execGit.js

@@ -1,7 +1,7 @@
-'use strict'
+import debug from 'debug'
+import execa from 'execa'
 
-const debug = require('debug')('lint-staged:git')
-const execa = require('execa')
+const debugLog = debug('lint-staged:execGit')
 
 /**
  * Explicitly never recurse commands into submodules, overriding local/global configuration.
@@ -9,10 +9,11 @@ const execa = require('execa')
  */
 const NO_SUBMODULE_RECURSE = ['-c', 'submodule.recurse=false']
 
-const GIT_GLOBAL_OPTIONS = [...NO_SUBMODULE_RECURSE]
+// exported for tests
+export const GIT_GLOBAL_OPTIONS = [...NO_SUBMODULE_RECURSE]
 
-module.exports = async function execGit(cmd, options = {}) {
-  debug('Running git command', cmd)
+export const execGit = async (cmd, options = {}) => {
+  debugLog('Running git command', cmd)
   try {
     const { stdout } = await execa('git', GIT_GLOBAL_OPTIONS.concat(cmd), {
       ...options,
@@ -24,6 +25,3 @@ module.exports = async function execGit(cmd, options = {}) {
     throw new Error(all)
   }
 }
-
-// exported for tests
-module.exports.GIT_GLOBAL_OPTIONS = GIT_GLOBAL_OPTIONS

package/lib/figures.js

@@ -1,10 +1,8 @@
-const { blue, redBright, yellow } = require('colorette')
-const { figures } = require('listr2')
+import { blue, redBright, yellow } from 'colorette'
+import { figures } from 'listr2'
 
-const { arrowRight, cross, warning } = figures
+export const info = blue(figures.arrowRight)
 
-module.exports = {
-  info: blue(arrowRight),
-  error: redBright(cross),
-  warning: yellow(warning),
-}
+export const error = redBright(figures.cross)
+
+export const warning = yellow(figures.warning)

package/lib/file.js

@@ -1,12 +1,8 @@
-'use strict'
+import { promises as fs } from 'fs'
 
-const debug = require('debug')('lint-staged:file')
-const fs = require('fs')
-const { promisify } = require('util')
+import debug from 'debug'
 
-const fsReadFile = promisify(fs.readFile)
-const fsUnlink = promisify(fs.unlink)
-const fsWriteFile = promisify(fs.writeFile)
+const debugLog = debug('lint-staged:file')
 
 /**
  * Read contents of a file to buffer
@@ -14,13 +10,13 @@ const fsWriteFile = promisify(fs.writeFile)
  * @param {Boolean} [ignoreENOENT=true] — Whether to throw if the file doesn't exist
  * @returns {Promise<Buffer>}
  */
-const readFile = async (filename, ignoreENOENT = true) => {
-  debug('Reading file `%s`', filename)
+export const readFile = async (filename, ignoreENOENT = true) => {
+  debugLog('Reading file `%s`', filename)
   try {
-    return await fsReadFile(filename)
+    return await fs.readFile(filename)
   } catch (error) {
     if (ignoreENOENT && error.code === 'ENOENT') {
-      debug("File `%s` doesn't exist, ignoring...", filename)
+      debugLog("File `%s` doesn't exist, ignoring...", filename)
       return null // no-op file doesn't exist
     } else {
       throw error
@@ -33,13 +29,13 @@ const readFile = async (filename, ignoreENOENT = true) => {
  * @param {String} filename
  * @param {Boolean} [ignoreENOENT=true] — Whether to throw if the file doesn't exist
  */
-const unlink = async (filename, ignoreENOENT = true) => {
-  debug('Removing file `%s`', filename)
+export const unlink = async (filename, ignoreENOENT = true) => {
+  debugLog('Removing file `%s`', filename)
   try {
-    await fsUnlink(filename)
+    await fs.unlink(filename)
   } catch (error) {
     if (ignoreENOENT && error.code === 'ENOENT') {
-      debug("File `%s` doesn't exist, ignoring...", filename)
+      debugLog("File `%s` doesn't exist, ignoring...", filename)
     } else {
       throw error
     }
@@ -51,13 +47,7 @@ const unlink = async (filename, ignoreENOENT = true) => {
  * @param {String} filename
  * @param {Buffer} buffer
  */
-const writeFile = async (filename, buffer) => {
-  debug('Writing file `%s`', filename)
-  await fsWriteFile(filename, buffer)
-}
-
-module.exports = {
-  readFile,
-  unlink,
-  writeFile,
+export const writeFile = async (filename, buffer) => {
+  debugLog('Writing file `%s`', filename)
+  await fs.writeFile(filename, buffer)
 }

package/lib/generateTasks.js

@@ -1,10 +1,10 @@
-'use strict'
+import path from 'path'
 
-const micromatch = require('micromatch')
-const normalize = require('normalize-path')
-const path = require('path')
+import debug from 'debug'
+import micromatch from 'micromatch'
+import normalize from 'normalize-path'
 
-const debug = require('debug')('lint-staged:gen-tasks')
+const debugLog = debug('lint-staged:generateTasks')
 
 /**
  * Generates all task commands, and filelist
@@ -16,8 +16,8 @@ const debug = require('debug')('lint-staged:gen-tasks')
  * @param {boolean} [options.files] - Staged filepaths
  * @param {boolean} [options.relative] - Whether filepaths to should be relative to gitDir
  */
-const generateTasks = ({ config, cwd = process.cwd(), gitDir, files, relative = false }) => {
-  debug('Generating linter tasks')
+export const generateTasks = ({ config, cwd = process.cwd(), gitDir, files, relative = false }) => {
+  debugLog('Generating linter tasks')
 
   const absoluteFiles = files.map((file) => normalize(path.resolve(gitDir, file)))
   const relativeFiles = absoluteFiles.map((file) => normalize(path.relative(cwd, file)))
@@ -47,10 +47,8 @@ const generateTasks = ({ config, cwd = process.cwd(), gitDir, files, relative =
     const fileList = matches.map((file) => normalize(relative ? file : path.resolve(cwd, file)))
 
     const task = { pattern, commands, fileList }
-    debug('Generated task: \n%O', task)
+    debugLog('Generated task: \n%O', task)
 
     return task
   })
 }
-
-module.exports = generateTasks

package/lib/getRenderer.js

@@ -1,11 +1,7 @@
-'use strict'
-
-const getRenderer = ({ debug, quiet }, env = process.env) => {
+export const getRenderer = ({ debug, quiet }, env = process.env) => {
   if (quiet) return { renderer: 'silent' }
   // Better support for dumb terminals: https://en.wikipedia.org/wiki/Computer_terminal#Dumb_terminals
   const isDumbTerminal = env.TERM === 'dumb'
   if (debug || isDumbTerminal || env.NODE_ENV === 'test') return { renderer: 'verbose' }
   return { renderer: 'update', rendererOptions: { dateFormat: false } }
 }
-
-module.exports = getRenderer

package/lib/getStagedFiles.js

@@ -1,8 +1,6 @@
-'use strict'
+import { execGit } from './execGit.js'
 
-const execGit = require('./execGit')
-
-module.exports = async function getStagedFiles(options) {
+export const getStagedFiles = async (options) => {
   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

package/lib/gitWorkflow.js

@@ -1,11 +1,10 @@
-'use strict'
+import path from 'path'
 
-const debug = require('debug')('lint-staged:git')
-const path = require('path')
+import debug from 'debug'
 
-const execGit = require('./execGit')
-const { readFile, unlink, writeFile } = require('./file')
-const {
+import { execGit } from './execGit.js'
+import { readFile, unlink, writeFile } from './file.js'
+import {
   GitError,
   RestoreOriginalStateError,
   ApplyEmptyCommitError,
@@ -13,7 +12,9 @@ const {
   HideUnstagedChangesError,
   RestoreMergeStatusError,
   RestoreUnstagedChangesError,
-} = require('./symbols')
+} from './symbols.js'
+
+const debugLog = debug('lint-staged:GitWorkflow')
 
 const MERGE_HEAD = 'MERGE_HEAD'
 const MERGE_MODE = 'MERGE_MODE'
@@ -63,7 +64,7 @@ const handleError = (error, ctx, symbol) => {
   throw error
 }
 
-class GitWorkflow {
+export class GitWorkflow {
   constructor({ allowEmpty, gitConfigDir, gitDir, matchedFileChunks }) {
     this.execGit = (args, options = {}) => execGit(args, { ...options, cwd: gitDir })
     this.deletedFiles = []
@@ -107,13 +108,13 @@ class GitWorkflow {
    * Get a list of unstaged deleted files
    */
   async getDeletedFiles() {
-    debug('Getting deleted files...')
+    debugLog('Getting deleted files...')
     const lsFiles = await this.execGit(['ls-files', '--deleted'])
     const deletedFiles = lsFiles
       .split('\n')
       .filter(Boolean)
       .map((file) => path.resolve(this.gitDir, file))
-    debug('Found deleted files:', deletedFiles)
+    debugLog('Found deleted files:', deletedFiles)
     return deletedFiles
   }
 
@@ -121,30 +122,30 @@ class GitWorkflow {
    * Save meta information about ongoing git merge
    */
   async backupMergeStatus() {
-    debug('Backing up merge state...')
+    debugLog('Backing up merge state...')
     await Promise.all([
       readFile(this.mergeHeadFilename).then((buffer) => (this.mergeHeadBuffer = buffer)),
       readFile(this.mergeModeFilename).then((buffer) => (this.mergeModeBuffer = buffer)),
       readFile(this.mergeMsgFilename).then((buffer) => (this.mergeMsgBuffer = buffer)),
     ])
-    debug('Done backing up merge state!')
+    debugLog('Done backing up merge state!')
   }
 
   /**
    * Restore meta information about ongoing git merge
    */
   async restoreMergeStatus(ctx) {
-    debug('Restoring merge state...')
+    debugLog('Restoring merge state...')
     try {
       await Promise.all([
         this.mergeHeadBuffer && writeFile(this.mergeHeadFilename, this.mergeHeadBuffer),
         this.mergeModeBuffer && writeFile(this.mergeModeFilename, this.mergeModeBuffer),
         this.mergeMsgBuffer && writeFile(this.mergeMsgFilename, this.mergeMsgBuffer),
       ])
-      debug('Done restoring merge state!')
+      debugLog('Done restoring merge state!')
     } catch (error) {
-      debug('Failed restoring merge state with error:')
-      debug(error)
+      debugLog('Failed restoring merge state with error:')
+      debugLog(error)
       handleError(
         new Error('Merge state could not be restored due to an error!'),
         ctx,
@@ -159,7 +160,7 @@ class GitWorkflow {
    * both the "from" and "to" filenames, where "from" is no longer on disk.
    */
   async getPartiallyStagedFiles() {
-    debug('Getting partially staged files...')
+    debugLog('Getting partially staged files...')
     const status = await this.execGit(['status', '-z'])
     /**
      * See https://git-scm.com/docs/git-status#_short_format
@@ -179,7 +180,7 @@ class GitWorkflow {
       })
       .map((line) => line.substr(3)) // Remove first three letters (index, workingTree, and a whitespace)
       .filter(Boolean) // Filter empty string
-    debug('Found partially staged files:', partiallyStaged)
+    debugLog('Found partially staged files:', partiallyStaged)
     return partiallyStaged.length ? partiallyStaged : null
   }
 
@@ -188,7 +189,7 @@ class GitWorkflow {
    */
   async prepare(ctx) {
     try {
-      debug('Backing up original state...')
+      debugLog('Backing up original state...')
 
       // Get a list of files with bot staged and unstaged changes.
       // Unstaged changes to these files should be hidden before the tasks run.
@@ -222,7 +223,7 @@ class GitWorkflow {
       const hash = await this.execGit(['stash', 'create'])
       await this.execGit(['stash', 'store', '--quiet', '--message', STASH, hash])
 
-      debug('Done backing up original state!')
+      debugLog('Done backing up original state!')
     } catch (error) {
       handleError(error, ctx)
     }
@@ -249,7 +250,7 @@ class GitWorkflow {
    * In case of a merge-conflict retry with 3-way merge.
    */
   async applyModifications(ctx) {
-    debug('Adding task modifications to index...')
+    debugLog('Adding task modifications to index...')
 
     // `matchedFileChunks` includes staged files that lint-staged originally detected and matched against a task.
     // Add only these files so any 3rd-party edits to other files won't be included in the commit.
@@ -259,7 +260,7 @@ class GitWorkflow {
       await this.execGit(['add', '--', ...files])
     }
 
-    debug('Done adding task modifications to index!')
+    debugLog('Done adding task modifications to index!')
 
     const stagedFilesAfterAdd = await this.execGit(['diff', '--name-only', '--cached'])
     if (!stagedFilesAfterAdd && !this.allowEmpty) {
@@ -275,20 +276,20 @@ class GitWorkflow {
    * 3-way merge usually fixes this, and in case it doesn't we should just give up and throw.
    */
   async restoreUnstagedChanges(ctx) {
-    debug('Restoring unstaged changes...')
+    debugLog('Restoring unstaged changes...')
     const unstagedPatch = this.getHiddenFilepath(PATCH_UNSTAGED)
     try {
       await this.execGit(['apply', ...GIT_APPLY_ARGS, unstagedPatch])
     } catch (applyError) {
-      debug('Error while restoring changes:')
-      debug(applyError)
-      debug('Retrying with 3-way merge')
+      debugLog('Error while restoring changes:')
+      debugLog(applyError)
+      debugLog('Retrying with 3-way merge')
       try {
         // Retry with a 3-way merge if normal apply fails
         await this.execGit(['apply', ...GIT_APPLY_ARGS, '--3way', unstagedPatch])
       } catch (threeWayApplyError) {
-        debug('Error while restoring unstaged changes using 3-way merge:')
-        debug(threeWayApplyError)
+        debugLog('Error while restoring unstaged changes using 3-way merge:')
+        debugLog(threeWayApplyError)
         handleError(
           new Error('Unstaged changes could not be restored due to a merge conflict!'),
           ctx,
@@ -303,7 +304,7 @@ class GitWorkflow {
    */
   async restoreOriginalState(ctx) {
     try {
-      debug('Restoring original state...')
+      debugLog('Restoring original state...')
       await this.execGit(['reset', '--hard', 'HEAD'])
       await this.execGit(['stash', 'apply', '--quiet', '--index', await this.getBackupStash(ctx)])
 
@@ -316,7 +317,7 @@ class GitWorkflow {
       // Clean out patch
       await unlink(this.getHiddenFilepath(PATCH_UNSTAGED))
 
-      debug('Done restoring original state!')
+      debugLog('Done restoring original state!')
     } catch (error) {
       handleError(error, ctx, RestoreOriginalStateError)
     }
@@ -327,13 +328,11 @@ class GitWorkflow {
    */
   async cleanup(ctx) {
     try {
-      debug('Dropping backup stash...')
+      debugLog('Dropping backup stash...')
       await this.execGit(['stash', 'drop', '--quiet', await this.getBackupStash(ctx)])
-      debug('Done dropping backup stash!')
+      debugLog('Done dropping backup stash!')
     } catch (error) {
       handleError(error, ctx)
     }
   }
 }
-
-module.exports = GitWorkflow

package/lib/index.js

@@ -1,20 +1,20 @@
-'use strict'
-
-const { cosmiconfig } = require('cosmiconfig')
-const debugLog = require('debug')('lint-staged')
-const stringifyObject = require('stringify-object')
-
-const { PREVENTED_EMPTY_COMMIT, GIT_ERROR, RESTORE_STASH_EXAMPLE } = require('./messages')
-const printTaskOutput = require('./printTaskOutput')
-const runAll = require('./runAll')
-const {
+import { cosmiconfig } from 'cosmiconfig'
+import debug from 'debug'
+import inspect from 'object-inspect'
+
+import { PREVENTED_EMPTY_COMMIT, GIT_ERROR, RESTORE_STASH_EXAMPLE } from './messages.js'
+import { printTaskOutput } from './printTaskOutput.js'
+import { runAll } from './runAll.js'
+import {
   ApplyEmptyCommitError,
   ConfigNotFoundError,
   GetBackupStashError,
   GitError,
-} = require('./symbols')
-const validateConfig = require('./validateConfig')
-const validateOptions = require('./validateOptions')
+} from './symbols.js'
+import { validateConfig } from './validateConfig.js'
+import { validateOptions } from './validateOptions.js'
+
+const debugLog = debug('lint-staged')
 
 const resolveConfig = (configPath) => {
   try {
@@ -104,7 +104,7 @@ const lintStaged = async (
   if (debug) {
     // Log using logger to be able to test through `consolemock`.
     logger.log('Running lint-staged with the following config:')
-    logger.log(stringifyObject(config, { indent: '  ' }))
+    logger.log(inspect(config, { indent: 2 }))
   } else {
     // We might not be in debug mode but `DEBUG=lint-staged*` could have
     // been set.
@@ -157,4 +157,4 @@ const lintStaged = async (
   }
 }
 
-module.exports = lintStaged
+export default lintStaged

package/lib/makeCmdTasks.js

@@ -1,10 +1,10 @@
-'use strict'
+import cliTruncate from 'cli-truncate'
+import debug from 'debug'
 
-const cliTruncate = require('cli-truncate')
-const debug = require('debug')('lint-staged:make-cmd-tasks')
+import { configurationError } from './messages.js'
+import { resolveTaskFn } from './resolveTaskFn.js'
 
-const { configurationError } = require('./messages')
-const resolveTaskFn = require('./resolveTaskFn')
+const debugLog = debug('lint-staged:makeCmdTasks')
 
 const STDOUT_COLUMNS_DEFAULT = 80
 
@@ -34,8 +34,8 @@ const getTitleLength = (renderer, columns = process.stdout.columns) => {
  * @param {Boolean} shell
  * @param {Boolean} verbose
  */
-const makeCmdTasks = async ({ commands, files, gitDir, renderer, shell, verbose }) => {
-  debug('Creating listr tasks for commands %o', commands)
+export const makeCmdTasks = async ({ commands, files, gitDir, renderer, shell, verbose }) => {
+  debugLog('Creating listr tasks for commands %o', commands)
   const commandArray = Array.isArray(commands) ? commands : [commands]
   const cmdTasks = []
 
@@ -68,5 +68,3 @@ const makeCmdTasks = async ({ commands, files, gitDir, renderer, shell, verbose
 
   return cmdTasks
 }
-
-module.exports = makeCmdTasks

package/lib/messages.js

@@ -1,50 +1,48 @@
-'use strict'
+import { redBright, bold, yellow } from 'colorette'
+import inspect from 'object-inspect'
 
-const { redBright, bold, yellow } = require('colorette')
-const format = require('stringify-object')
+import { error, info, warning } from './figures.js'
 
-const { error, info, warning } = require('./figures')
-
-const configurationError = (opt, helpMsg, value) =>
+export const configurationError = (opt, helpMsg, value) =>
   `${redBright(`${error} Validation Error:`)}
 
   Invalid value for '${bold(opt)}': ${bold(
-    format(value, { inlineCharacterLimit: Number.POSITIVE_INFINITY })
+    inspect(value, { inlineCharacterLimit: Number.POSITIVE_INFINITY })
   )}
 
   ${helpMsg}`
 
-const NOT_GIT_REPO = redBright(`${error} Current directory is not a git directory!`)
+export const NOT_GIT_REPO = redBright(`${error} Current directory is not a git directory!`)
 
-const FAILED_GET_STAGED_FILES = redBright(`${error} Failed to get staged files!`)
+export const FAILED_GET_STAGED_FILES = redBright(`${error} Failed to get staged files!`)
 
-const incorrectBraces = (before, after) =>
+export const incorrectBraces = (before, after) =>
   yellow(
     `${warning} Detected incorrect braces with only single value: \`${before}\`. Reformatted as: \`${after}\`
 `
   )
 
-const NO_STAGED_FILES = `${info} No staged files found.`
+export const NO_STAGED_FILES = `${info} No staged files found.`
 
-const NO_TASKS = `${info} No staged files match any configured task.`
+export const NO_TASKS = `${info} No staged files match any configured task.`
 
-const skippingBackup = (hasInitialCommit) => {
+export const skippingBackup = (hasInitialCommit) => {
   const reason = hasInitialCommit ? '`--no-stash` was used' : 'there’s no initial commit yet'
   return yellow(`${warning} Skipping backup because ${reason}.\n`)
 }
 
-const DEPRECATED_GIT_ADD = yellow(
+export const DEPRECATED_GIT_ADD = 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.
 `
 )
 
-const TASK_ERROR = 'Skipped because of errors from tasks.'
+export const TASK_ERROR = 'Skipped because of errors from tasks.'
 
-const SKIPPED_GIT_ERROR = 'Skipped because of previous git error.'
+export const SKIPPED_GIT_ERROR = 'Skipped because of previous git error.'
 
-const GIT_ERROR = `\n  ${redBright(`${error} lint-staged failed due to a git error.`)}`
+export const GIT_ERROR = `\n  ${redBright(`${error} lint-staged failed due to a git error.`)}`
 
-const invalidOption = (name, value, message) => `${redBright(`${error} Validation Error:`)}
+export const invalidOption = (name, value, message) => `${redBright(`${error} Validation Error:`)}
 
   Invalid value for option '${bold(name)}': ${bold(value)}
 
@@ -52,34 +50,16 @@ const invalidOption = (name, value, message) => `${redBright(`${error} Validatio
 
 See https://github.com/okonet/lint-staged#command-line-flags`
 
-const PREVENTED_EMPTY_COMMIT = `
+export const PREVENTED_EMPTY_COMMIT = `
   ${yellow(`${warning} lint-staged prevented an empty git commit.
   Use the --allow-empty option to continue, or check your task configuration`)}
 `
 
-const RESTORE_STASH_EXAMPLE = `  Any lost modifications can be restored from a git stash:
+export const RESTORE_STASH_EXAMPLE = `  Any lost modifications can be restored from a git stash:
 
     > git stash list
     stash@{0}: automatic lint-staged backup
     > git stash apply --index stash@{0}
 `
 
-const CONFIG_STDIN_ERROR = 'Error: Could not read config from stdin.'
-
-module.exports = {
-  CONFIG_STDIN_ERROR,
-  configurationError,
-  DEPRECATED_GIT_ADD,
-  FAILED_GET_STAGED_FILES,
-  GIT_ERROR,
-  incorrectBraces,
-  invalidOption,
-  NO_STAGED_FILES,
-  NO_TASKS,
-  NOT_GIT_REPO,
-  PREVENTED_EMPTY_COMMIT,
-  RESTORE_STASH_EXAMPLE,
-  SKIPPED_GIT_ERROR,
-  skippingBackup,
-  TASK_ERROR,
-}
+export const CONFIG_STDIN_ERROR = 'Error: Could not read config from stdin.'

package/lib/printTaskOutput.js

@@ -1,16 +1,12 @@
-'use strict'
-
 /**
  * Handle logging of listr `ctx.output` to the specified `logger`
  * @param {Object} ctx - The listr initial state
  * @param {Object} logger - The logger
  */
-const printTaskOutput = (ctx = {}, logger) => {
+export const printTaskOutput = (ctx = {}, logger) => {
   if (!Array.isArray(ctx.output)) return
   const log = ctx.errors && ctx.errors.size > 0 ? logger.error : logger.log
   for (const line of ctx.output) {
     log(line)
   }
 }
-
-module.exports = printTaskOutput

package/lib/resolveGitRepo.js

@@ -1,15 +1,13 @@
-'use strict'
+import { promises as fs } from 'fs'
+import path from 'path'
 
-const normalize = require('normalize-path')
-const debugLog = require('debug')('lint-staged:resolveGitRepo')
-const fs = require('fs')
-const path = require('path')
-const { promisify } = require('util')
+import debug from 'debug'
+import normalize from 'normalize-path'
 
-const execGit = require('./execGit')
-const { readFile } = require('./file')
+import { execGit } from './execGit.js'
+import { readFile } from './file.js'
 
-const fsLstat = promisify(fs.lstat)
+const debugLog = debug('lint-staged:resolveGitRepo')
 
 /**
  * Resolve path to the .git directory, with special handling for
@@ -17,7 +15,7 @@ const fsLstat = promisify(fs.lstat)
  */
 const resolveGitConfigDir = async (gitDir) => {
   const defaultDir = normalize(path.join(gitDir, '.git'))
-  const stats = await fsLstat(defaultDir)
+  const stats = await fs.lstat(defaultDir)
   // If .git is a directory, use it
   if (stats.isDirectory()) return defaultDir
   // Otherwise .git is a file containing path to real location
@@ -25,7 +23,8 @@ const resolveGitConfigDir = async (gitDir) => {
   return path.resolve(gitDir, file.replace(/^gitdir: /, '')).trim()
 }
 
-const determineGitDir = (cwd, relativeDir) => {
+// exported for test
+export const determineGitDir = (cwd, relativeDir) => {
   // if relative dir and cwd have different endings normalize it
   // this happens under windows, where normalize is unable to normalize git's output
   if (relativeDir && relativeDir.endsWith(path.sep)) {
@@ -43,7 +42,7 @@ const determineGitDir = (cwd, relativeDir) => {
 /**
  * Resolve git directory and possible submodule paths
  */
-const resolveGitRepo = async (cwd = process.cwd()) => {
+export const resolveGitRepo = async (cwd = process.cwd()) => {
   try {
     debugLog('Resolving git repo from `%s`', cwd)
 
@@ -68,8 +67,3 @@ const resolveGitRepo = async (cwd = process.cwd()) => {
     return { error, gitDir: null, gitConfigDir: null }
   }
 }
-
-module.exports = resolveGitRepo
-
-// exported for test
-module.exports.determineGitDir = determineGitDir

package/lib/resolveTaskFn.js

@@ -1,13 +1,13 @@
-'use strict'
+import { redBright, dim } from 'colorette'
+import execa from 'execa'
+import debug from 'debug'
+import { parseArgsStringToArgv } from 'string-argv'
 
-const { redBright, dim } = require('colorette')
-const execa = require('execa')
-const debug = require('debug')('lint-staged:task')
-const { parseArgsStringToArgv } = require('string-argv')
+import { error, info } from './figures.js'
+import { getInitialState } from './state.js'
+import { TaskError } from './symbols.js'
 
-const { error, info } = require('./figures')
-const { getInitialState } = require('./state')
-const { TaskError } = require('./symbols')
+const debugLog = debug('lint-staged:resolveTaskFn')
 
 const getTag = ({ code, killed, signal }) => signal || (killed && 'KILLED') || code || 'FAILED'
 
@@ -76,7 +76,7 @@ const makeErr = (command, result, ctx) => {
  * @param {Boolean} [options.verbose] — Always show task verbose
  * @returns {function(): Promise<Array<string>>}
  */
-module.exports = function resolveTaskFn({
+export const resolveTaskFn = ({
   command,
   files,
   gitDir,
@@ -84,10 +84,10 @@ module.exports = function resolveTaskFn({
   relative,
   shell = false,
   verbose = false,
-}) {
+}) => {
   const [cmd, ...args] = parseArgsStringToArgv(command)
-  debug('cmd:', cmd)
-  debug('args:', args)
+  debugLog('cmd:', cmd)
+  debugLog('args:', args)
 
   const execaOptions = { preferLocal: true, reject: false, shell }
   if (relative) {
@@ -97,7 +97,7 @@ module.exports = function resolveTaskFn({
     // e.g `npm` should run tasks in the actual CWD
     execaOptions.cwd = gitDir
   }
-  debug('execaOptions:', execaOptions)
+  debugLog('execaOptions:', execaOptions)
 
   return async (ctx = getInitialState()) => {
     const result = await (shell

package/lib/runAll.js

@@ -1,18 +1,16 @@
-'use strict'
-
 /** @typedef {import('./index').Logger} Logger */
 
-const { Listr } = require('listr2')
+import debug from 'debug'
+import { Listr } from 'listr2'
 
-const chunkFiles = require('./chunkFiles')
-const debugLog = require('debug')('lint-staged:run')
-const execGit = require('./execGit')
-const generateTasks = require('./generateTasks')
-const getRenderer = require('./getRenderer')
-const getStagedFiles = require('./getStagedFiles')
-const GitWorkflow = require('./gitWorkflow')
-const makeCmdTasks = require('./makeCmdTasks')
-const {
+import { chunkFiles } from './chunkFiles.js'
+import { execGit } from './execGit.js'
+import { generateTasks } from './generateTasks.js'
+import { getRenderer } from './getRenderer.js'
+import { getStagedFiles } from './getStagedFiles.js'
+import { GitWorkflow } from './gitWorkflow.js'
+import { makeCmdTasks } from './makeCmdTasks.js'
+import {
   DEPRECATED_GIT_ADD,
   FAILED_GET_STAGED_FILES,
   NOT_GIT_REPO,
@@ -20,9 +18,9 @@ const {
   NO_TASKS,
   SKIPPED_GIT_ERROR,
   skippingBackup,
-} = require('./messages')
-const resolveGitRepo = require('./resolveGitRepo')
-const {
+} from './messages.js'
+import { resolveGitRepo } from './resolveGitRepo.js'
+import {
   applyModificationsSkipped,
   cleanupEnabled,
   cleanupSkipped,
@@ -31,8 +29,10 @@ const {
   restoreOriginalStateEnabled,
   restoreOriginalStateSkipped,
   restoreUnstagedChangesSkipped,
-} = require('./state')
-const { GitRepoError, GetStagedFilesError, GitError } = require('./symbols')
+} from './state.js'
+import { GitRepoError, GetStagedFilesError, GitError } from './symbols.js'
+
+const debugLog = debug('lint-staged:runAll')
 
 const createError = (ctx) => Object.assign(new Error('lint-staged failed'), { ctx })
 
@@ -54,7 +54,7 @@ const createError = (ctx) => Object.assign(new Error('lint-staged failed'), { ct
  * @param {Logger} logger
  * @returns {Promise}
  */
-const runAll = async (
+export const runAll = async (
   {
     allowEmpty = false,
     concurrent = true,
@@ -254,5 +254,3 @@ const runAll = async (
 
   return ctx
 }
-
-module.exports = runAll

package/lib/state.js

@@ -1,15 +1,13 @@
-'use strict'
-
-const { GIT_ERROR, TASK_ERROR } = require('./messages')
-const {
+import { GIT_ERROR, TASK_ERROR } from './messages.js'
+import {
   ApplyEmptyCommitError,
   TaskError,
   RestoreOriginalStateError,
   GitError,
   RestoreUnstagedChangesError,
-} = require('./symbols')
+} from './symbols.js'
 
-const getInitialState = ({ quiet = false } = {}) => ({
+export const getInitialState = ({ quiet = false } = {}) => ({
   hasPartiallyStagedFiles: null,
   shouldBackup: null,
   errors: new Set([]),
@@ -17,9 +15,9 @@ const getInitialState = ({ quiet = false } = {}) => ({
   quiet,
 })
 
-const hasPartiallyStagedFiles = (ctx) => ctx.hasPartiallyStagedFiles
+export const hasPartiallyStagedFiles = (ctx) => ctx.hasPartiallyStagedFiles
 
-const applyModificationsSkipped = (ctx) => {
+export const applyModificationsSkipped = (ctx) => {
   // Always apply back unstaged modifications when skipping backup
   if (!ctx.shouldBackup) return false
   // Should be skipped in case of git errors
@@ -32,7 +30,7 @@ const applyModificationsSkipped = (ctx) => {
   }
 }
 
-const restoreUnstagedChangesSkipped = (ctx) => {
+export const restoreUnstagedChangesSkipped = (ctx) => {
   // Should be skipped in case of git errors
   if (ctx.errors.has(GitError)) {
     return GIT_ERROR
@@ -43,13 +41,13 @@ const restoreUnstagedChangesSkipped = (ctx) => {
   }
 }
 
-const restoreOriginalStateEnabled = (ctx) =>
+export const restoreOriginalStateEnabled = (ctx) =>
   ctx.shouldBackup &&
   (ctx.errors.has(TaskError) ||
     ctx.errors.has(ApplyEmptyCommitError) ||
     ctx.errors.has(RestoreUnstagedChangesError))
 
-const restoreOriginalStateSkipped = (ctx) => {
+export const restoreOriginalStateSkipped = (ctx) => {
   // Should be skipped in case of unknown git errors
   if (
     ctx.errors.has(GitError) &&
@@ -60,9 +58,9 @@ const restoreOriginalStateSkipped = (ctx) => {
   }
 }
 
-const cleanupEnabled = (ctx) => ctx.shouldBackup
+export const cleanupEnabled = (ctx) => ctx.shouldBackup
 
-const cleanupSkipped = (ctx) => {
+export const cleanupSkipped = (ctx) => {
   // Should be skipped in case of unknown git errors
   if (
     ctx.errors.has(GitError) &&
@@ -76,14 +74,3 @@ const cleanupSkipped = (ctx) => {
     return GIT_ERROR
   }
 }
-
-module.exports = {
-  getInitialState,
-  hasPartiallyStagedFiles,
-  applyModificationsSkipped,
-  restoreUnstagedChangesSkipped,
-  restoreOriginalStateEnabled,
-  restoreOriginalStateSkipped,
-  cleanupEnabled,
-  cleanupSkipped,
-}

package/lib/symbols.js

@@ -1,29 +1,23 @@
-'use strict'
-
-const ApplyEmptyCommitError = Symbol('ApplyEmptyCommitError')
-const ConfigNotFoundError = new Error('Config could not be found')
-const GetBackupStashError = Symbol('GetBackupStashError')
-const GetStagedFilesError = Symbol('GetStagedFilesError')
-const GitError = Symbol('GitError')
-const GitRepoError = Symbol('GitRepoError')
-const HideUnstagedChangesError = Symbol('HideUnstagedChangesError')
-const InvalidOptionsError = new Error('Invalid Options')
-const RestoreMergeStatusError = Symbol('RestoreMergeStatusError')
-const RestoreOriginalStateError = Symbol('RestoreOriginalStateError')
-const RestoreUnstagedChangesError = Symbol('RestoreUnstagedChangesError')
-const TaskError = Symbol('TaskError')
-
-module.exports = {
-  ApplyEmptyCommitError,
-  ConfigNotFoundError,
-  GetBackupStashError,
-  GetStagedFilesError,
-  GitError,
-  GitRepoError,
-  InvalidOptionsError,
-  HideUnstagedChangesError,
-  RestoreMergeStatusError,
-  RestoreOriginalStateError,
-  RestoreUnstagedChangesError,
-  TaskError,
-}
+export const ApplyEmptyCommitError = Symbol('ApplyEmptyCommitError')
+
+export const ConfigNotFoundError = new Error('Config could not be found')
+
+export const GetBackupStashError = Symbol('GetBackupStashError')
+
+export const GetStagedFilesError = Symbol('GetStagedFilesError')
+
+export const GitError = Symbol('GitError')
+
+export const GitRepoError = Symbol('GitRepoError')
+
+export const HideUnstagedChangesError = Symbol('HideUnstagedChangesError')
+
+export const InvalidOptionsError = new Error('Invalid Options')
+
+export const RestoreMergeStatusError = Symbol('RestoreMergeStatusError')
+
+export const RestoreOriginalStateError = Symbol('RestoreOriginalStateError')
+
+export const RestoreUnstagedChangesError = Symbol('RestoreUnstagedChangesError')
+
+export const TaskError = Symbol('TaskError')

package/lib/validateBraces.js

@@ -1,4 +1,4 @@
-const { incorrectBraces } = require('./messages')
+import { incorrectBraces } from './messages.js'
 
 /**
  * A correctly-formed brace expansion must contain unquoted opening and closing braces,
@@ -28,7 +28,7 @@ const { incorrectBraces } = require('./messages')
  * - *.${js}      // dollar-sign inhibits expansion, so treated literally
  * - *.{js\,ts}   // the comma is escaped, so treated literally
  */
-const BRACES_REGEXP = /(?<![\\$])({)(?:(?!(?<!\\),|\.\.|\{|\}).)*?(?<!\\)(})/g
+export const BRACES_REGEXP = /(?<![\\$])({)(?:(?!(?<!\\),|\.\.|\{|\}).)*?(?<!\\)(})/g
 
 /**
  * @param {string} pattern
@@ -56,7 +56,7 @@ const withoutIncorrectBraces = (pattern) => {
  * @param {*} logger
  * @returns {string}
  */
-const validateBraces = (pattern, logger) => {
+export const validateBraces = (pattern, logger) => {
   const fixedPattern = withoutIncorrectBraces(pattern)
 
   if (fixedPattern !== pattern) {
@@ -65,7 +65,3 @@ const validateBraces = (pattern, logger) => {
 
   return fixedPattern
 }
-
-module.exports = validateBraces
-
-module.exports.BRACES_REGEXP = BRACES_REGEXP

package/lib/validateConfig.js

@@ -1,17 +1,17 @@
-/* eslint no-prototype-builtins: 0 */
+import debug from 'debug'
 
-'use strict'
+import { configurationError } from './messages.js'
+import { validateBraces } from './validateBraces.js'
 
-const debug = require('debug')('lint-staged:cfg')
+const debugLog = debug('lint-staged:validateConfig')
 
-const { configurationError } = require('./messages')
-const validateBraces = require('./validateBraces')
+const isObject = (test) => test && typeof test === 'object' && !Array.isArray(test)
 
 const TEST_DEPRECATED_KEYS = new Map([
   ['concurrent', (key) => typeof key === 'boolean'],
   ['chunkSize', (key) => typeof key === 'number'],
-  ['globOptions', (key) => typeof key === 'object'],
-  ['linters', (key) => typeof key === 'object'],
+  ['globOptions', isObject],
+  ['linters', isObject],
   ['ignore', (key) => Array.isArray(key)],
   ['subTaskConcurrency', (key) => typeof key === 'number'],
   ['renderer', (key) => typeof key === 'string'],
@@ -23,8 +23,8 @@ const TEST_DEPRECATED_KEYS = new Map([
  * @param config {Object}
  * @returns config {Object}
  */
-const validateConfig = (config, logger) => {
-  debug('Validating config')
+export const validateConfig = (config, logger) => {
+  debugLog('Validating config')
 
   if (!config || (typeof config !== 'object' && typeof config !== 'function')) {
     throw new Error('Configuration should be an object or a function!')
@@ -104,5 +104,3 @@ See https://github.com/okonet/lint-staged#configuration.`)
 
   return validatedConfig
 }
-
-module.exports = validateConfig

package/lib/validateOptions.js

@@ -1,9 +1,11 @@
-const { promises: fs, constants } = require('fs')
+import { constants, promises as fs } from 'fs'
 
-const { invalidOption } = require('./messages')
-const { InvalidOptionsError } = require('./symbols')
+import debug from 'debug'
 
-const debug = require('debug')('lint-staged:options')
+import { invalidOption } from './messages.js'
+import { InvalidOptionsError } from './symbols.js'
+
+const debugLog = debug('lint-staged:validateOptions')
 
 /**
  * Validate lint-staged options, either from the Node.js API or the command line flags.
@@ -12,8 +14,8 @@ const debug = require('debug')('lint-staged:options')
  *
  * @throws {InvalidOptionsError}
  */
-const validateOptions = async (options = {}, logger) => {
-  debug('Validating options...')
+export const validateOptions = async (options = {}, logger) => {
+  debugLog('Validating options...')
 
   /** Ensure the passed shell option is executable */
   if (typeof options.shell === 'string') {
@@ -25,7 +27,5 @@ const validateOptions = async (options = {}, logger) => {
     }
   }
 
-  debug('Validated options!')
+  debugLog('Validated options!')
 }
-
-module.exports = validateOptions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "11.2.6",
+  "version": "12.0.1",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -13,8 +13,13 @@
   "funding": {
     "url": "https://opencollective.com/lint-staged"
   },
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0",
+    "npm": ">=8.1.3"
+  },
+  "type": "module",
   "bin": "./bin/lint-staged.js",
-  "main": "./lib/index.js",
+  "exports": "./lib/index.js",
   "files": [
     "bin",
     "lib"
@@ -22,41 +27,38 @@
   "scripts": {
     "cz": "git-cz",
     "lint": "eslint .",
-    "pretest": "npm run lint",
     "test": "jest --coverage",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "cli-truncate": "2.1.0",
-    "colorette": "^1.4.0",
-    "commander": "^8.2.0",
+    "cli-truncate": "3.1.0",
+    "colorette": "^2.0.16",
+    "commander": "^8.3.0",
     "cosmiconfig": "^7.0.1",
     "debug": "^4.3.2",
-    "enquirer": "^2.3.6",
     "execa": "^5.1.1",
-    "listr2": "^3.12.2",
+    "listr2": "^3.13.3",
     "micromatch": "^4.0.4",
     "normalize-path": "^3.0.0",
-    "please-upgrade-node": "^3.2.0",
+    "object-inspect": "1.11.0",
     "string-argv": "0.3.1",
-    "stringify-object": "3.3.0",
-    "supports-color": "8.1.1"
+    "supports-color": "9.0.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.15.5",
-    "@babel/eslint-parser": "^7.15.7",
-    "@babel/plugin-proposal-object-rest-spread": "^7.15.6",
-    "@babel/preset-env": "^7.15.6",
-    "babel-jest": "^27.2.4",
+    "@babel/core": "^7.16.0",
+    "@babel/eslint-parser": "7.16.3",
+    "@babel/preset-env": "^7.16.0",
+    "babel-jest": "27.3.1",
     "consolemock": "^1.1.0",
-    "eslint": "^7.32.0",
+    "eslint": "^8.2.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "fs-extra": "^10.0.0",
-    "husky": "^7.0.2",
-    "jest": "^27.2.4",
+    "husky": "^7.0.4",
+    "jest": "^27.3.1",
+    "jest-mock-console": "1.2.3",
     "jest-snapshot-serializer-ansi": "^1.0.0",
     "prettier": "^2.4.1"
   },
@@ -65,19 +67,6 @@
       "path": "./node_modules/cz-conventional-changelog"
     }
   },
-  "jest": {
-    "collectCoverage": true,
-    "collectCoverageFrom": [
-      "lib/**/*.js"
-    ],
-    "setupFiles": [
-      "./testSetup.js"
-    ],
-    "snapshotSerializers": [
-      "jest-snapshot-serializer-ansi"
-    ],
-    "testEnvironment": "node"
-  },
   "keywords": [
     "lint",
     "git",