lint-staged 10.4.1 → 10.5.2

package/README.md

@@ -12,10 +12,10 @@ This project contains a script that will run arbitrary shell tasks with a list o
 
 ## Related blogs posts and talks
 
-- [Make Linting Great Again](https://medium.com/@okonetchnikov/make-linting-great-again-f3890e1ad6b8#.8qepn2b5l)
-- [Running Jest Tests Before Each Git Commit](https://benmccormick.org/2017/02/26/running-jest-tests-before-each-git-commit/)
-- [AgentConf: Make Linting Great Again](https://www.youtube.com/watch?v=-mhY7e-EsC4)
-- [SurviveJS Interview](https://survivejs.com/blog/lint-staged-interview/)
+- [Introductory Medium post - Andrey Okonetchnikov, 2016](https://medium.com/@okonetchnikov/make-linting-great-again-f3890e1ad6b8#.8qepn2b5l)
+- [Running Jest Tests Before Each Git Commit - Ben McCormick, 2017](https://benmccormick.org/2017/02/26/running-jest-tests-before-each-git-commit/)
+- [AgentConf presentation - Andrey Okonetchnikov, 2018](https://www.youtube.com/watch?v=-mhY7e-EsC4)
+- [SurviveJS interview - Juho Vepsäläinen and Andrey Okonetchnikov, 2018](https://survivejs.com/blog/lint-staged-interview/)
 
 > If you've written one, please submit a PR with the link to it!
 
@@ -62,7 +62,7 @@ Options:
   -V, --version                      output the version number
   --allow-empty                      allow empty commits when tasks revert all staged changes
                                      (default: false)
-  -c, --config [path]                path to configuration file
+  -c, --config [path]                path to configuration file, or - to read from stdin
   -d, --debug                        print additional debug information (default: false)
   --no-stash                         disable the backup stash, and do not revert in case of
                                      errors
@@ -78,7 +78,7 @@ Options:
 ```
 
 - **`--allow-empty`**: By default, when linter tasks undo all staged changes, lint-staged will exit with an error and abort the commit. Use this flag to allow creating empty git commits.
-- **`--config [path]`**: Manually specify a path to a config file or npm package name. Note: when used, lint-staged won't perform the config file search and print an error if the specified file cannot be found.
+- **`--config [path]`**: Manually specify a path to a config file or npm package name. Note: when used, lint-staged won't perform the config file search and print an error if the specified file cannot be found. If '-' is provided as the filename then the config will be read from stdin, allowing piping in the config like `cat my-config.json | npx lint-staged --config -`.
 - **`--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.
@@ -97,8 +97,11 @@ Options:
 Starting with v3.1 you can now use different ways of configuring it:
 
 - `lint-staged` object in your `package.json`
-- `.lintstagedrc` file in JSON or YML format
-- `lint-staged.config.js` file in JS format
+- `.lintstagedrc` file in JSON or YML format, or you can be explicit with the file extension:
+  - `.lintstagedrc.json`
+  - `.lintstagedrc.yaml`
+  - `.lintstagedrc.yml`
+- `lint-staged.config.js`, `.lintstagedrc.js`, or `.lintstagedrc.cjs` file in JS format
 - 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.

package/bin/lint-staged.js

@@ -2,6 +2,8 @@
 
 'use strict'
 
+const fs = require('fs')
+
 // Force colors for packages that depend on https://www.npmjs.com/package/supports-color
 const { supportsColor } = require('chalk')
 if (supportsColor && supportsColor.level) {
@@ -23,13 +25,14 @@ require('please-upgrade-node')(
 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')
 
 cmdline
   .version(pkg.version)
   .option('--allow-empty', 'allow empty commits when tasks revert all staged changes', false)
-  .option('-c, --config [path]', 'path to configuration file')
+  .option('-c, --config [path]', 'path to configuration file, or - to read from stdin')
   .option('-d, --debug', 'print additional debug information', false)
   .option('--no-stash', 'disable the backup stash, and do not revert in case of errors', false)
   .option(
@@ -86,6 +89,22 @@ const options = {
 
 debug('Options parsed from command-line:', options)
 
+if (options.configPath === '-') {
+  delete options.configPath
+  try {
+    options.config = fs.readFileSync(process.stdin.fd, 'utf8').toString().trim()
+  } catch {
+    console.error(CONFIG_STDIN_ERROR)
+    process.exit(1)
+  }
+
+  try {
+    options.config = JSON.parse(options.config)
+  } catch {
+    // Let config parsing complain if it's not JSON
+  }
+}
+
 lintStaged(options)
   .then((passed) => {
     process.exitCode = passed ? 0 : 1

package/lib/messages.js

@@ -39,6 +39,8 @@ const RESTORE_STASH_EXAMPLE = `  Any lost modifications can be restored from a g
     > git stash apply --index stash@{0}
 `
 
+const CONFIG_STDIN_ERROR = 'Error: Could not read config from stdin.'
+
 module.exports = {
   NOT_GIT_REPO,
   FAILED_GET_STAGED_FILES,
@@ -51,4 +53,5 @@ module.exports = {
   GIT_ERROR,
   PREVENTED_EMPTY_COMMIT,
   RESTORE_STASH_EXAMPLE,
+  CONFIG_STDIN_ERROR,
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "10.4.1",
+  "version": "10.5.2",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -34,13 +34,13 @@
   "dependencies": {
     "chalk": "^4.1.0",
     "cli-truncate": "^2.1.0",
-    "commander": "^6.0.0",
+    "commander": "^6.2.0",
     "cosmiconfig": "^7.0.0",
-    "debug": "^4.1.1",
+    "debug": "^4.2.0",
     "dedent": "^0.7.0",
     "enquirer": "^2.3.6",
-    "execa": "^4.0.3",
-    "listr2": "^2.6.0",
+    "execa": "^4.1.0",
+    "listr2": "^3.2.2",
     "log-symbols": "^4.0.0",
     "micromatch": "^4.0.2",
     "normalize-path": "^3.0.0",
@@ -49,22 +49,22 @@
     "stringify-object": "^3.3.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.11.4",
-    "@babel/plugin-proposal-object-rest-spread": "^7.11.0",
-    "@babel/preset-env": "^7.11.0",
+    "@babel/core": "^7.12.3",
+    "@babel/plugin-proposal-object-rest-spread": "^7.12.1",
+    "@babel/preset-env": "^7.12.1",
     "babel-eslint": "10.1.0",
-    "babel-jest": "^26.3.0",
+    "babel-jest": "^26.6.1",
     "consolemock": "^1.1.0",
-    "eslint": "^7.7.0",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-import": "^2.22.0",
+    "eslint": "^7.12.1",
+    "eslint-config-prettier": "^6.15.0",
+    "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.1.4",
     "fs-extra": "^9.0.1",
-    "husky": "^4.2.5",
-    "jest": "^26.4.2",
+    "husky": "^4.3.0",
+    "jest": "^26.6.1",
     "jest-snapshot-serializer-ansi": "^1.0.0",
-    "prettier": "^2.1.0"
+    "prettier": "^2.1.2"
   },
   "config": {
     "commitizen": {