lint-staged 11.3.0-beta.2 → 12.0.3

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!
 
@@ -42,6 +42,10 @@ See [Releases](https://github.com/okonet/lint-staged/releases).
 
 ### Migration
 
+#### v12
+
+- Since `v12.0.0` _lint-staged_ is a pure ESM module, so make sure your Node.js version is at least `12.20.0`, `14.13.1`, or `16.0.0`. Read more about ESM modules from the official [Node.js Documentation site here](https://nodejs.org/api/esm.html#introduction).
+
 #### v10
 
 - From `v10.0.0` onwards any new modifications to originally staged files will be automatically added to the commit.
@@ -65,7 +69,8 @@ Options:
                                      (default: false)
   -c, --config [path]                path to configuration file, or - to read from stdin
   -d, --debug                        print additional debug information (default: false)
-  --no-reset                         do not reset changes in case of errors
+  --no-stash                         disable the backup stash, and do not revert in case of
+                                     errors
   -p, --concurrent <parallel tasks>  the number of tasks to run concurrently, or false to run
                                      tasks serially (default: true)
   -q, --quiet                        disable lint-staged’s own console output (default: false)
@@ -86,7 +91,7 @@ Options:
   - `false`: Run all tasks serially
   - `true` (default) : _Infinite_ concurrency. Runs as many tasks in parallel as possible.
   - `{number}`: Run the specified number of tasks in parallel, where `1` is equivalent to `false`.
-- **`--no-reset`**: 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.
+- **`--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`.
 - **`--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"`.
@@ -564,8 +569,8 @@ const success = await lintStaged({
   maxArgLength: null,
   quiet: false,
   relative: false,
-  reset: true,
   shell: false
+  stash: true,
   verbose: false
 })
 ```
@@ -582,8 +587,8 @@ const success = await lintStaged({
   maxArgLength: null,
   quiet: false,
   relative: false,
-  reset: true,
   shell: false,
+  stash: true,
   verbose: false,
 })
 ```

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,31 +19,16 @@ 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 { Command, Option } = require('commander')
-const debugLib = require('debug')
-const lintStaged = require('../lib')
-const { CONFIG_STDIN_ERROR } = require('../lib/messages')
-
-const debug = debugLib('lint-staged:bin')
-
-const program = new Command('lint-staged')
+const packageJsonPath = path.join(fileURLToPath(import.meta.url), '../../package.json')
+const packageJson = JSON.parse(fs.readFileSync(packageJsonPath))
+const version = packageJson.version
 
-program.version(pkg.version)
-
-program
+cmdline
+  .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)
-  .option('--no-reset', 'do not reset changes in case of errors', false)
+  .option('--no-stash', 'disable the backup stash, and do not revert in case of errors', false)
   .option(
     '-p, --concurrent <parallel tasks>',
     'the number of tasks to run concurrently, or false to run tasks serially',
@@ -51,17 +42,13 @@ program
     'show task output even when tasks succeed; by default only failed output is shown',
     false
   )
+  .parse(process.argv)
 
-// Added for backwards-compatibility
-program.addOption(new Option('--no-stash').hideHelp())
-
-program.parse(process.argv)
-
-if (program.debug) {
-  debugLib.enable('lint-staged*')
+const debugLog = debug('lint-staged:bin')
+if (cmdline.debug) {
+  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
@@ -81,23 +68,22 @@ const getMaxArgLength = () => {
   }
 }
 
-const programOpts = program.opts()
+const cmdlineOptions = cmdline.opts()
 
 const options = {
-  allowEmpty: !!programOpts.allowEmpty,
-  concurrent: JSON.parse(programOpts.concurrent),
-  configPath: programOpts.config,
-  debug: !!programOpts.debug,
+  allowEmpty: !!cmdlineOptions.allowEmpty,
+  concurrent: JSON.parse(cmdlineOptions.concurrent),
+  configPath: cmdlineOptions.config,
+  debug: !!cmdlineOptions.debug,
   maxArgLength: getMaxArgLength() / 2,
-  quiet: !!programOpts.quiet,
-  relative: !!programOpts.relative,
-  reset: !!programOpts.reset, // commander inverts `no-<x>` flags to `!x`
-  shell: programOpts.shell /* Either a boolean or a string pointing to the shell */,
-  stash: programOpts.stash /** kept for backwards-compatibility */,
-  verbose: !!programOpts.verbose,
+  stash: !!cmdlineOptions.stash, // commander inverts `no-<x>` flags to `!x`
+  quiet: !!cmdlineOptions.quiet,
+  relative: !!cmdlineOptions.relative,
+  shell: cmdlineOptions.shell /* Either a boolean or a string pointing to the shell */,
+  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

@@ -0,0 +1,53 @@
+import { promises as fs } from 'fs'
+
+import debug from 'debug'
+
+const debugLog = debug('lint-staged:file')
+
+/**
+ * Read contents of a file to buffer
+ * @param {String} filename
+ * @param {Boolean} [ignoreENOENT=true] — Whether to throw if the file doesn't exist
+ * @returns {Promise<Buffer>}
+ */
+export const readFile = async (filename, ignoreENOENT = true) => {
+  debugLog('Reading file `%s`', filename)
+  try {
+    return await fs.readFile(filename)
+  } catch (error) {
+    if (ignoreENOENT && error.code === 'ENOENT') {
+      debugLog("File `%s` doesn't exist, ignoring...", filename)
+      return null // no-op file doesn't exist
+    } else {
+      throw error
+    }
+  }
+}
+
+/**
+ * Remove a file
+ * @param {String} filename
+ * @param {Boolean} [ignoreENOENT=true] — Whether to throw if the file doesn't exist
+ */
+export const unlink = async (filename, ignoreENOENT = true) => {
+  debugLog('Removing file `%s`', filename)
+  try {
+    await fs.unlink(filename)
+  } catch (error) {
+    if (ignoreENOENT && error.code === 'ENOENT') {
+      debugLog("File `%s` doesn't exist, ignoring...", filename)
+    } else {
+      throw error
+    }
+  }
+}
+
+/**
+ * Write buffer to file
+ * @param {String} filename
+ * @param {Buffer} buffer
+ */
+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