lint-staged 10.5.0 → 10.5.4

package/README.md

@@ -12,10 +12,11 @@ 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/)
+- [Prettier your CSharp with `dotnet-format` and `lint-staged`](https://blog.johnnyreilly.com/2020/12/prettier-your-csharp-with-dotnet-format-and-lint-staged.html)
 
 > If you've written one, please submit a PR with the link to it!
 
@@ -210,51 +211,74 @@ The function can also be async:
 
 ### Example: Export a function to build your own matchers
 
+<details>
+  <summary>Click to expand</summary>
+
 ```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(' ')}`];
+  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(' ')}`]
+}
 ```
 
+</details>
 
 ### Example: Wrap filenames in single quotes and run once per file
 
+<details>
+  <summary>Click to expand</summary>
+
 ```js
 // .lintstagedrc.js
 module.exports = {
-  '**/*.js?(x)': (filenames) => filenames.map((filename) => `prettier --write '${filename}'`)
+  '**/*.js?(x)': (filenames) => filenames.map((filename) => `prettier --write '${filename}'`),
 }
 ```
 
+</details>
+
 ### Example: Run `tsc` on changes to TypeScript files, but do not pass any filename arguments
 
+<details>
+  <summary>Click to expand</summary>
+
 ```js
 // lint-staged.config.js
 module.exports = {
-  '**/*.ts?(x)': () => 'tsc -p tsconfig.json --noEmit'
+  '**/*.ts?(x)': () => 'tsc -p tsconfig.json --noEmit',
 }
 ```
 
+</details>
+
 ### Example: Run eslint on entire repo if more than 10 staged files
 
+<details>
+  <summary>Click to expand</summary>
+
 ```js
 // .lintstagedrc.js
 module.exports = {
   '**/*.js?(x)': (filenames) =>
-    filenames.length > 10 ? 'eslint .' : `eslint ${filenames.join(' ')}`
+    filenames.length > 10 ? 'eslint .' : `eslint ${filenames.join(' ')}`,
 }
 ```
 
+</details>
+
 ### Example: Use your own globs
+
+<details>
+  <summary>Click to expand</summary>
+
 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
@@ -263,15 +287,20 @@ const micromatch = require('micromatch')
 
 module.exports = {
   '*': (allFiles) => {
-    const codeFiles = micromatch(allFiles, ['**/*.js', '**/*.ts']);
-    const docFiles = micromatch(allFiles, ['**/*.md']);
-    return [`eslint ${codeFiles.join(' ')}`, `mdl ${docFiles.join(' ')}`];
-  }
+    const codeFiles = micromatch(allFiles, ['**/*.js', '**/*.ts'])
+    const docFiles = micromatch(allFiles, ['**/*.md'])
+    return [`eslint ${codeFiles.join(' ')}`, `mdl ${docFiles.join(' ')}`]
+  },
 }
 ```
 
+</details>
+
 ### Example: Ignore files from match
 
+<details>
+  <summary>Click to expand</summary>
+
 If for some reason you want to ignore files from the glob match, you can use `micromatch.not()`:
 
 ```js
@@ -283,14 +312,19 @@ module.exports = {
     // from `files` filter those _NOT_ matching `*test.js`
     const match = micromatch.not(files, '*test.js')
     return `eslint ${match.join(' ')}`
-  }
+  },
 }
 ```
 
 Please note that for most cases, globs can achieve the same effect. For the above example, a matching glob would be `!(*test).js`.
 
+</details>
+
 ### Example: Use relative paths for commands
 
+<details>
+  <summary>Click to expand</summary>
+
 ```js
 const path = require('path')
 
@@ -299,10 +333,12 @@ module.exports = {
     const cwd = process.cwd()
     const relativePaths = absolutePaths.map((file) => path.relative(cwd, file))
     return `ng lint myProjectName --files ${relativePaths.join(' ')}`
-  }
+  },
 }
 ```
 
+</details>
+
 ## Reformatting the code
 
 Tools like [Prettier](https://prettier.io), ESLint/TSLint, or stylelint can reformat your code according to an appropriate config by running `prettier --write`/`eslint --fix`/`tslint --fix`/`stylelint --fix`. Lint-staged will automatically add any modifications to the commit as long as there are no errors.
@@ -339,14 +375,22 @@ _Note we don’t pass a path as an argument for the runners. This is important s
 
 ### ESLint with default parameters for `*.js` and `*.jsx` running as a pre-commit hook
 
+<details>
+  <summary>Click to expand</summary>
+
 ```json
 {
   "*.{js,jsx}": "eslint"
 }
 ```
 
+</details>
+
 ### Automatically fix code style with `--fix` and add to commit
 
+<details>
+  <summary>Click to expand</summary>
+
 ```json
 {
   "*.js": "eslint --fix"
@@ -355,8 +399,13 @@ _Note we don’t pass a path as an argument for the runners. This is important s
 
 This will run `eslint --fix` and automatically add changes to the commit.
 
+</details>
+
 ### Reuse npm script
 
+<details>
+  <summary>Click to expand</summary>
+
 If you wish to reuse a npm script defined in your package.json:
 
 ```json
@@ -373,8 +422,13 @@ The following is equivalent:
 }
 ```
 
+</details>
+
 ### Use environment variables with linting commands
 
+<details>
+  <summary>Click to expand</summary>
+
 Linting commands _do not_ support the shell convention of expanding environment variables. To enable the convention yourself, use a tool like [`cross-env`](https://github.com/kentcdodds/cross-env).
 
 For example, here is `jest` running on all `.js` files with the `NODE_ENV` variable being set to `"test"`:
@@ -385,16 +439,59 @@ For example, here is `jest` running on all `.js` files with the `NODE_ENV` varia
 }
 ```
 
+</details>
+
+### Automatically fix code style with `prettier` for any format prettier supports
+
+<details>
+  <summary>Click to expand</summary>
+
+You need to add `micromatch` as a dev dependency.
+
+```sh
+$ npm i --save-dev micromatch
+```
+
+```js
+// lint-staged.config.js
+const micromatch = require('micromatch')
+const prettier = require('prettier')
+
+const prettierSupportedExtensions = prettier
+  .getSupportInfo()
+  .languages.map(({ extensions }) => extensions)
+  .flat()
+const addQuotes = (a) => `"${a}"`
+
+module.exports = (allStagedFiles) => {
+  const prettierFiles = micromatch(
+    allStagedFiles,
+    prettierSupportedExtensions.map((extension) => `**/*${extension}`)
+  )
+  return [`prettier --write ${prettierFiles.map(addQuotes).join(' ')}`]
+}
+```
+
+</details>
+
 ### Automatically fix code style with `prettier` for javascript, typescript, markdown, HTML, or CSS
 
+<details>
+  <summary>Click to expand</summary>
+
 ```json
 {
   "*.{js,jsx,ts,tsx,md,html,css}": "prettier --write"
 }
 ```
 
+</details>
+
 ### Stylelint for CSS with defaults and for SCSS with SCSS syntax
 
+<details>
+  <summary>Click to expand</summary>
+
 ```json
 {
   "*.css": "stylelint",
@@ -402,16 +499,26 @@ For example, here is `jest` running on all `.js` files with the `NODE_ENV` varia
 }
 ```
 
+</details>
+
 ### Run PostCSS sorting and Stylelint to check
 
+<details>
+  <summary>Click to expand</summary>
+
 ```json
 {
   "*.scss": ["postcss --config path/to/your/config --replace", "stylelint"]
 }
 ```
 
+</details>
+
 ### Minify the images
 
+<details>
+  <summary>Click to expand</summary>
+
 ```json
 {
   "*.{png,jpeg,jpg,gif,svg}": "imagemin-lint-staged"
@@ -425,20 +532,29 @@ For example, here is `jest` running on all `.js` files with the `NODE_ENV` varia
 
 See more on [this blog post](https://medium.com/@tomchentw/imagemin-lint-staged-in-place-minify-the-images-before-adding-to-the-git-repo-5acda0b4c57e) for benefits of this approach.
 
+</details>
 </details>
 
 ### Typecheck your staged files with flow
 
+<details>
+  <summary>Click to expand</summary>
+
 ```json
 {
   "*.{js,jsx}": "flow focus-check"
 }
 ```
 
+</details>
+
 ## Frequently Asked Questions
 
 ### Can I use `lint-staged` via node?
 
+<details>
+  <summary>Click to expand</summary>
+
 Yes!
 
 ```js
@@ -485,14 +601,19 @@ const success = await lintStaged({
   relative: false,
   shell: false,
   stash: true,
-  verbose: false
+  verbose: false,
 })
 ```
 
 The `maxArgLength` option configures chunking of tasks into multiple parts that are run one after the other. This is to avoid issues on Windows platforms where the maximum length of the command line argument string is limited to 8192 characters. Lint-staged might generate a very long argument string when there are many staged files. This option is set automatically from the cli, but not via the Node.js API by default.
 
+</details>
+
 ### Using with JetBrains IDEs _(WebStorm, PyCharm, IntelliJ IDEA, RubyMine, etc.)_
 
+<details>
+  <summary>Click to expand</summary>
+
 _**Update**_: The latest version of JetBrains IDEs now support running hooks as you would expect.
 
 When using the IDE's GUI to commit changes with the `precommit` hook, you might see inconsistencies in the IDE and command line. This is [known issue](https://youtrack.jetbrains.com/issue/IDEA-135454) at JetBrains so if you want this fixed, please vote for it on YouTrack.
@@ -525,8 +646,13 @@ husky v0.x
 
 _Thanks to [this comment](https://youtrack.jetbrains.com/issue/IDEA-135454#comment=27-2710654) for the fix!_
 
+</details>
+
 ### How to use `lint-staged` in a multi package monorepo?
 
+<details>
+  <summary>Click to expand</summary>
+
 Starting with v5.0, `lint-staged` automatically resolves the git root **without any** additional configuration. You configure `lint-staged` as you normally would if your project root and git root were the same directory.
 
 If you wish to use `lint-staged` in a multi package monorepo, it is recommended to install [`husky`](https://github.com/typicode/husky) in the root package.json.
@@ -534,8 +660,13 @@ If you wish to use `lint-staged` in a multi package monorepo, it is recommended
 
 Example repo: [sudo-suhas/lint-staged-multi-pkg](https://github.com/sudo-suhas/lint-staged-multi-pkg).
 
+</details>
+
 ### Can I lint files outside of the current project folder?
 
+<details>
+  <summary>Click to expand</summary>
+
 tl;dr: Yes, but the pattern should start with `../`.
 
 By default, `lint-staged` executes linters only on the files present inside the project folder(where `lint-staged` is installed and run from).
@@ -547,11 +678,23 @@ Note that patterns like `*.js`, `**/*.js` will still only match the project file
 
 Example repo: [sudo-suhas/lint-staged-django-react-demo](https://github.com/sudo-suhas/lint-staged-django-react-demo).
 
+</details>
+
 ### How can i ignore files from `.eslintignore` ?
 
+<details>
+  <summary>Click to expand</summary>
+
 ESLint throws out `warning File ignored because of a matching ignore pattern. Use "--no-ignore" to override` warnings that breaks the linting process ( if you used `--max-warnings=0` which is recommended ).
 
-Based on the discussion from https://github.com/eslint/eslint/issues/9977 , it was decided that using [the outlined script ](https://github.com/eslint/eslint/issues/9977#issuecomment-406420893)is the best route to fix this.
+</details>
+
+#### ESLint < 7
+
+<details>
+  <summary>Click to expand</summary>
+
+Based on the discussion from [this issue](https://github.com/eslint/eslint/issues/9977), it was decided that using [the outlined script ](https://github.com/eslint/eslint/issues/9977#issuecomment-406420893)is the best route to fix this.
 
 So you can setup a `.lintstagedrc.js` config file to do this:
 
@@ -562,6 +705,43 @@ const cli = new CLIEngine({})
 
 module.exports = {
   '*.js': (files) =>
-    'eslint --max-warnings=0 ' + files.filter((file) => !cli.isPathIgnored(file)).join(' ')
+    'eslint --max-warnings=0 ' + files.filter((file) => !cli.isPathIgnored(file)).join(' '),
 }
 ```
+
+</details>
+
+#### ESlint >= 7
+
+<details>
+  <summary>Click to expand</summary>
+
+In versions of ESlint > 7, [isPathIgnored](https://eslint.org/docs/developer-guide/nodejs-api#-eslintispathignoredfilepath) is an async function and now returns a promise. The code below can be used to reinstate the above functionality.
+
+This particular code uses a tiny package, [node-filter-async](https://www.npmjs.com/package/node-filter-async), to filter the files array with an async function. If you prefer to not have an extra dependency, it is quite simple to write a similar function.
+
+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')
+const filterAsync = require('node-filter-async').default
+
+const eslintCli = new ESLint()
+
+const removeIgnoredFiles = async (files) => {
+  const filteredFiles = await filterAsync(files, async (file) => {
+    const isIgnored = await eslintCli.isPathIgnored(file)
+    return !isIgnored
+  })
+  return filteredFiles.join(' ')
+}
+
+module.exports = {
+  '**/*.{ts,tsx,js,jsx}': async (files) => {
+    const filesToLint = await removeIgnoredFiles(files)
+    return [`eslint --max-warnings=0 ${filesToLint}`]
+  },
+}
+```
+
+</details>

package/bin/lint-staged.js

@@ -76,7 +76,7 @@ const getMaxArgLength = () => {
 
 const options = {
   allowEmpty: !!cmdline.allowEmpty,
-  concurrent: cmdline.concurrent,
+  concurrent: JSON.parse(cmdline.concurrent),
   configPath: cmdline.config,
   debug: !!cmdline.debug,
   maxArgLength: getMaxArgLength() / 2,

package/lib/index.js

@@ -128,19 +128,24 @@ module.exports = async function lintStaged(
       printTaskOutput(ctx, logger)
       return true
     } catch (runAllError) {
-      const { ctx } = runAllError
-      if (ctx.errors.has(ApplyEmptyCommitError)) {
-        logger.warn(PREVENTED_EMPTY_COMMIT)
-      } else if (ctx.errors.has(GitError) && !ctx.errors.has(GetBackupStashError)) {
-        logger.error(GIT_ERROR)
-        if (ctx.shouldBackup) {
-          // No sense to show this if the backup stash itself is missing.
-          logger.error(RESTORE_STASH_EXAMPLE)
+      if (runAllError && runAllError.ctx && runAllError.ctx.errors) {
+        const { ctx } = runAllError
+        if (ctx.errors.has(ApplyEmptyCommitError)) {
+          logger.warn(PREVENTED_EMPTY_COMMIT)
+        } else if (ctx.errors.has(GitError) && !ctx.errors.has(GetBackupStashError)) {
+          logger.error(GIT_ERROR)
+          if (ctx.shouldBackup) {
+            // No sense to show this if the backup stash itself is missing.
+            logger.error(RESTORE_STASH_EXAMPLE)
+          }
         }
+
+        printTaskOutput(ctx, logger)
+        return false
       }
 
-      printTaskOutput(ctx, logger)
-      return false
+      // Probably a compilation error in the config js file. Pass it up to the outer error handler for logging.
+      throw runAllError
     }
   } catch (lintStagedError) {
     if (lintStagedError === errConfigNotFound) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "10.5.0",
+  "version": "10.5.4",
   "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": {