lint-staged 10.3.0 → 10.5.0

package/README.md

@@ -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.
@@ -189,14 +192,40 @@ 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 functions to customize tasks
+## Using JS configuration file
 
-When supplying configuration in JS format it is possible to define the task as a function, which will receive an array of staged filenames/paths and should return the complete command as a string. It is also possible to return an array of complete command strings, for example when the task supports only a single file input. The function can be either sync or async.
+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.
+
+If the `exports` value is a function, it will receive an array of all staged filenames. You can then build your own matchers for the files, and return a command string, or an array or command strings. These strings are considered complete and should include the filename arguments, if wanted.
+
+If the `exports` value is an object, its keys should be glob matches (like in the normal non-js config format). The values can either be like in the normal config, or individual functions like described above. Instead of receiving all matched files, the functions in the exported object will only receive the staged files matching the corresponding glob key.
+
+### Function signature
+
+The function can also be async:
 
 ```ts
-type TaskFn = (filenames: string[]) => string | string[] | Promise<string | string[]>
+(filenames: string[]) => string | string[] | Promise<string | string[]>
 ```
 
+### Example: Export a function to build your own matchers
+
+```js
+// lint-staged.config.js
+const micromatch = require('micromatch')
+
+module.exports = (allStagedFiles) => {
+    const shFiles =  micromatch(allStagedFiles, ['**/src/**/*.sh']);
+    if (shFiles.length) {
+      return `printf '%s\n' "Script files aren't allowed in src directory" >&2`
+    }
+    const codeFiles = micromatch(allStagedFiles, ['**/*.js', '**/*.ts']);
+    const docFiles = micromatch(allStagedFiles, ['**/*.md']);
+    return [`eslint ${codeFiles.join(' ')}`, `mdl ${docFiles.join(' ')}`];
+  }
+```
+
+
 ### Example: Wrap filenames in single quotes and run once per file
 
 ```js
@@ -226,6 +255,7 @@ module.exports = {
 ```
 
 ### Example: Use your own globs
+It's better to use the [function-based configuration (seen above)](https://github.com/okonet/lint-staged/README.md#example-export-a-function-to-build-your-own-matchers), if your use case is this.
 
 ```js
 // lint-staged.config.js
@@ -233,8 +263,9 @@ const micromatch = require('micromatch')
 
 module.exports = {
   '*': (allFiles) => {
-    const match = micromatch(allFiles, ['*.js', '*.ts'])
-    return `eslint ${match.join(' ')}`
+    const codeFiles = micromatch(allFiles, ['**/*.js', '**/*.ts']);
+    const docFiles = micromatch(allFiles, ['**/*.md']);
+    return [`eslint ${codeFiles.join(' ')}`, `mdl ${docFiles.join(' ')}`];
   }
 }
 ```

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/formatConfig.js

@@ -0,0 +1,7 @@
+module.exports = function formatConfig(config) {
+  if (typeof config === 'function') {
+    return { '*': config }
+  }
+
+  return config
+}

package/lib/index.js

@@ -9,6 +9,7 @@ const { PREVENTED_EMPTY_COMMIT, GIT_ERROR, RESTORE_STASH_EXAMPLE } = require('./
 const printTaskOutput = require('./printTaskOutput')
 const runAll = require('./runAll')
 const { ApplyEmptyCommitError, GetBackupStashError, GitError } = require('./symbols')
+const formatConfig = require('./formatConfig')
 const validateConfig = require('./validateConfig')
 
 const errConfigNotFound = new Error('Config could not be found')
@@ -30,7 +31,9 @@ function loadConfig(configPath) {
       '.lintstagedrc.yaml',
       '.lintstagedrc.yml',
       '.lintstagedrc.js',
+      '.lintstagedrc.cjs',
       'lint-staged.config.js',
+      'lint-staged.config.cjs',
     ],
   })
 
@@ -88,7 +91,8 @@ module.exports = async function lintStaged(
     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)
+    const formattedConfig = formatConfig(resolved.config)
+    const config = validateConfig(formattedConfig)
     if (debug) {
       // Log using logger to be able to test through `consolemock`.
       logger.log('Running lint-staged with the following config:')

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.3.0",
+  "version": "10.5.0",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",