lint-staged 12.0.2 → 12.1.2

package/README.md

@@ -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.
@@ -102,12 +106,15 @@ Starting with v3.1 you can now use different ways of configuring lint-staged:
   - `.lintstagedrc.json`
   - `.lintstagedrc.yaml`
   - `.lintstagedrc.yml`
-- `lint-staged.config.js`, `.lintstagedrc.js`, or `.lintstagedrc.cjs` file in JS format
+- `.lintstagedrc.mjs` or `lint-staged.config.mjs` file in ESM format
+  - the default export value should be a configuration: `export default { ... }`
+- `.lintstagedrc.cjs` or `lint-staged.config.cjs` file in CommonJS format
+  - the exports value should be a configuration: `module.exports = { ... }`
+- `lint-staged.config.js` or `.lintstagedrc.js` in either ESM or CommonJS format, depending on
+  whether your project's _package.json_ contains the `"type": "module"` option or not.
 - Pass a configuration file using the `--config` or `-c` flag
 
-See [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) for more details on what formats are supported.
-
-Configuration should be an object where each value is a command to run and its key is a glob pattern to use for this command. This package uses [micromatch](https://github.com/micromatch/micromatch) for glob patterns.
+Configuration should be an object where each value is a command to run and its key is a glob pattern to use for this command. This package uses [micromatch](https://github.com/micromatch/micromatch) for glob patterns. JavaScript files can also export advanced configuration as a function. See [Using JS configuration files](#using-js-configuration-files) for more info.
 
 #### `package.json` example:
 
@@ -193,7 +200,7 @@ For example:
 
 going to execute `eslint` and if it exits with `0` code, it will execute `prettier --write` on all staged `*.js` files.
 
-## Using JS configuration file
+## Using JS configuration files
 
 Writing the configuration file in JavaScript is the most powerful way to configure lint-staged (`lint-staged.config.js`, [similar](https://github.com/okonet/lint-staged/README.md#configuration), or passed via `--config`). From the configuration file, you can export either a single function or an object.
 
@@ -216,9 +223,9 @@ The function can also be async:
 
 ```js
 // lint-staged.config.js
-const micromatch = require('micromatch')
+import micromatch from 'micromatch'
 
-module.exports = (allStagedFiles) => {
+export default (allStagedFiles) => {
   const shFiles = micromatch(allStagedFiles, ['**/src/**/*.sh'])
   if (shFiles.length) {
     return `printf '%s\n' "Script files aren't allowed in src directory" >&2`
@@ -238,7 +245,7 @@ module.exports = (allStagedFiles) => {
 
 ```js
 // .lintstagedrc.js
-module.exports = {
+export default {
   '**/*.js?(x)': (filenames) => filenames.map((filename) => `prettier --write '${filename}'`),
 }
 ```
@@ -252,7 +259,7 @@ module.exports = {
 
 ```js
 // lint-staged.config.js
-module.exports = {
+export default {
   '**/*.ts?(x)': () => 'tsc -p tsconfig.json --noEmit',
 }
 ```
@@ -266,7 +273,7 @@ module.exports = {
 
 ```js
 // .lintstagedrc.js
-module.exports = {
+export default {
   '**/*.js?(x)': (filenames) =>
     filenames.length > 10 ? 'eslint .' : `eslint ${filenames.join(' ')}`,
 }
@@ -283,9 +290,9 @@ It's better to use the [function-based configuration (seen above)](https://githu
 
 ```js
 // lint-staged.config.js
-const micromatch = require('micromatch')
+import micromatch from 'micromatch'
 
-module.exports = {
+export default {
   '*': (allFiles) => {
     const codeFiles = micromatch(allFiles, ['**/*.js', '**/*.ts'])
     const docFiles = micromatch(allFiles, ['**/*.md'])
@@ -305,9 +312,9 @@ If for some reason you want to ignore files from the glob match, you can use `mi
 
 ```js
 // lint-staged.config.js
-const micromatch = require('micromatch')
+import micromatch from 'micromatch'
 
-module.exports = {
+export default {
   '*.js': (files) => {
     // from `files` filter those _NOT_ matching `*test.js`
     const match = micromatch.not(files, '*test.js')
@@ -326,9 +333,9 @@ Please note that for most cases, globs can achieve the same effect. For the abov
   <summary>Click to expand</summary>
 
 ```js
-const path = require('path')
+import path from 'path'
 
-module.exports = {
+export default {
   '*.ts': (absolutePaths) => {
     const cwd = process.cwd()
     const relativePaths = absolutePaths.map((file) => path.relative(cwd, file))
@@ -542,7 +549,7 @@ See more on [this blog post](https://medium.com/@tomchentw/imagemin-lint-staged-
 Yes!
 
 ```js
-const lintStaged = require('lint-staged')
+import lintStaged from 'lint-staged'
 
 try {
   const success = await lintStaged()
@@ -681,13 +688,13 @@ Based on the discussion from [this issue](https://github.com/eslint/eslint/issue
 So you can setup a `.lintstagedrc.js` config file to do this:
 
 ```js
-const { CLIEngine } = require('eslint')
+import { CLIEngine } from 'eslint'
 
-const cli = new CLIEngine({})
-
-module.exports = {
-  '*.js': (files) =>
-    'eslint --max-warnings=0 ' + files.filter((file) => !cli.isPathIgnored(file)).join(' '),
+export default {
+  '*.js': (files) => {
+    const cli = new CLIEngine({})
+    return 'eslint --max-warnings=0 ' + files.filter((file) => !cli.isPathIgnored(file)).join(' ')
+  },
 }
 ```
 
@@ -703,7 +710,7 @@ In versions of ESLint > 7, [isPathIgnored](https://eslint.org/docs/developer-gui
 Since [10.5.3](https://github.com/okonet/lint-staged/releases), any errors due to a bad ESLint config will come through to the console.
 
 ```js
-const { ESLint } = require('eslint')
+import { ESLint } from 'eslint'
 
 const removeIgnoredFiles = async (files) => {
   const eslint = new ESLint()
@@ -716,7 +723,7 @@ const removeIgnoredFiles = async (files) => {
   return filteredFiles.join(' ')
 }
 
-module.exports = {
+export default {
   '**/*.{ts,tsx,js,jsx}': async (files) => {
     const filesToLint = await removeIgnoredFiles(files)
     return [`eslint --max-warnings=0 ${filesToLint}`]

package/lib/index.js

@@ -1,7 +1,7 @@
-import { cosmiconfig } from 'cosmiconfig'
 import debug from 'debug'
 import inspect from 'object-inspect'
 
+import { loadConfig } from './loadConfig.js'
 import { PREVENTED_EMPTY_COMMIT, GIT_ERROR, RESTORE_STASH_EXAMPLE } from './messages.js'
 import { printTaskOutput } from './printTaskOutput.js'
 import { runAll } from './runAll.js'
@@ -16,32 +16,6 @@ import { validateOptions } from './validateOptions.js'
 
 const debugLog = debug('lint-staged')
 
-const resolveConfig = (configPath) => {
-  try {
-    return require.resolve(configPath)
-  } catch {
-    return configPath
-  }
-}
-
-const loadConfig = (configPath) => {
-  const explorer = cosmiconfig('lint-staged', {
-    searchPlaces: [
-      'package.json',
-      '.lintstagedrc',
-      '.lintstagedrc.json',
-      '.lintstagedrc.yaml',
-      '.lintstagedrc.yml',
-      '.lintstagedrc.js',
-      '.lintstagedrc.cjs',
-      'lint-staged.config.js',
-      'lint-staged.config.cjs',
-    ],
-  })
-
-  return configPath ? explorer.load(resolveConfig(configPath)) : explorer.search()
-}
-
 /**
  * @typedef {(...any) => void} LogFunction
  * @typedef {{ error: LogFunction, log: LogFunction, warn: LogFunction }} Logger
@@ -84,22 +58,14 @@ const lintStaged = async (
 ) => {
   await validateOptions({ shell }, logger)
 
-  debugLog('Loading config using `cosmiconfig`')
+  const inputConfig = configObject || (await loadConfig(configPath, logger))
 
-  const resolved = configObject
-    ? { config: configObject, filepath: '(input)' }
-    : await loadConfig(configPath)
-
-  if (resolved == null) {
+  if (!inputConfig) {
     logger.error(`${ConfigNotFoundError.message}.`)
     throw ConfigNotFoundError
   }
 
-  debugLog('Successfully loaded config from `%s`:\n%O', resolved.filepath, resolved.config)
-
-  // resolved.config is the parsed configuration object
-  // resolved.filepath is the path to the config file that was found
-  const config = validateConfig(resolved.config, logger)
+  const config = validateConfig(inputConfig, logger)
 
   if (debug) {
     // Log using logger to be able to test through `consolemock`.

package/lib/loadConfig.js

@@ -0,0 +1,86 @@
+import { pathToFileURL } from 'url'
+
+import debug from 'debug'
+import { lilconfig } from 'lilconfig'
+import YAML from 'yaml'
+
+const debugLog = debug('lint-staged:loadConfig')
+
+/**
+ * The list of files `lint-staged` will read configuration
+ * from, in the declared order.
+ */
+const searchPlaces = [
+  'package.json',
+  '.lintstagedrc',
+  '.lintstagedrc.json',
+  '.lintstagedrc.yaml',
+  '.lintstagedrc.yml',
+  '.lintstagedrc.mjs',
+  '.lintstagedrc.js',
+  '.lintstagedrc.cjs',
+  'lint-staged.config.mjs',
+  'lint-staged.config.js',
+  'lint-staged.config.cjs',
+]
+
+/** exported for tests */
+export const dynamicImport = (path) => import(pathToFileURL(path)).then((module) => module.default)
+
+const jsonParse = (path, content) => JSON.parse(content)
+
+const yamlParse = (path, content) => YAML.parse(content)
+
+/**
+ * `lilconfig` doesn't support yaml files by default,
+ * so we add custom loaders for those. Files without
+ * an extensions are assumed to be yaml — this
+ * assumption is in `cosmiconfig` as well.
+ */
+const loaders = {
+  '.js': dynamicImport,
+  '.json': jsonParse,
+  '.mjs': dynamicImport,
+  '.cjs': dynamicImport,
+  '.yaml': yamlParse,
+  '.yml': yamlParse,
+  noExt: yamlParse,
+}
+
+const resolveConfig = (configPath) => {
+  try {
+    return require.resolve(configPath)
+  } catch {
+    return configPath
+  }
+}
+
+/**
+ * @param {string} [configPath]
+ * @param {Logger} [logger]
+ */
+export const loadConfig = async (configPath, logger) => {
+  try {
+    if (configPath) {
+      debugLog('Loading configuration from `%s`...', configPath)
+    } else {
+      debugLog('Searching for configuration...')
+    }
+
+    const explorer = lilconfig('lint-staged', { searchPlaces, loaders })
+
+    const result = await (configPath ? explorer.load(resolveConfig(configPath)) : explorer.search())
+    if (!result) return null
+
+    // config is a promise when using the `dynamicImport` loader
+    const config = await result.config
+
+    debugLog('Successfully loaded config from `%s`:\n%O', result.filepath, config)
+
+    return config
+  } catch (error) {
+    debugLog('Failed to load configuration from `%s`', configPath)
+    logger.error(error)
+    return null
+  }
+}

package/lib/symbols.js

@@ -1,6 +1,10 @@
 export const ApplyEmptyCommitError = Symbol('ApplyEmptyCommitError')
 
-export const ConfigNotFoundError = new Error('Config could not be found')
+export const ConfigNotFoundError = new Error('Configuration could not be found')
+
+export const ConfigFormatError = new Error('Configuration should be an object or a function')
+
+export const ConfigEmptyError = new Error('Configuration should not be empty')
 
 export const GetBackupStashError = Symbol('GetBackupStashError')
 

package/lib/validateConfig.js

@@ -1,6 +1,7 @@
 import debug from 'debug'
 
 import { configurationError } from './messages.js'
+import { ConfigEmptyError, ConfigFormatError } from './symbols.js'
 import { validateBraces } from './validateBraces.js'
 
 const debugLog = debug('lint-staged:validateConfig')
@@ -27,7 +28,7 @@ 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!')
+    throw ConfigFormatError
   }
 
   /**
@@ -42,7 +43,7 @@ export const validateConfig = (config, logger) => {
   }
 
   if (Object.entries(config).length === 0) {
-    throw new Error('Configuration should not be empty!')
+    throw ConfigEmptyError
   }
 
   const errors = []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "12.0.2",
+  "version": "12.1.2",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -24,30 +24,31 @@
     "lib"
   ],
   "scripts": {
-    "cz": "git-cz",
     "lint": "eslint .",
     "test": "jest --coverage",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "cli-truncate": "3.1.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",
+    "lilconfig": "2.0.4",
     "listr2": "^3.13.3",
     "micromatch": "^4.0.4",
     "normalize-path": "^3.0.0",
-    "object-inspect": "1.11.0",
-    "string-argv": "0.3.1",
-    "supports-color": "9.0.2"
+    "object-inspect": "^1.11.0",
+    "string-argv": "^0.3.1",
+    "supports-color": "^9.0.2",
+    "yaml": "^1.10.2"
   },
   "devDependencies": {
     "@babel/core": "^7.16.0",
-    "@babel/eslint-parser": "7.16.3",
+    "@babel/eslint-parser": "^7.16.3",
     "@babel/preset-env": "^7.16.0",
-    "babel-jest": "27.3.1",
+    "babel-jest": "^27.3.1",
     "consolemock": "^1.1.0",
     "eslint": "^8.2.0",
     "eslint-config-prettier": "^8.3.0",
@@ -57,15 +58,9 @@
     "fs-extra": "^10.0.0",
     "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"
   },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
-  },
   "keywords": [
     "lint",
     "git",