lint-staged 5.0.0 → 6.1.1

package/README.md

@@ -50,6 +50,32 @@ See [examples](#examples) and [configuration](#configuration) below.
 >
 > To mitigate this rename your `commit` npm script to something non git hook namespace like, for example `{ cz: git-cz }`
 
+## Changelog
+
+[releases](https://github.com/okonet/lint-staged/releases)
+
+## Command line flags
+
+```
+$ ./node_modules/.bin/lint-staged --help
+
+  Usage: lint-staged [options]
+
+
+  Options:
+
+    -V, --version        output the version number
+    -c, --config [path]  Path to configuration file
+    -d, --debug          Enable debug mode
+    -h, --help           output usage information
+```
+
+* **`--config [path]`**: This can be used to manually specify the `lint-staged` config file location. However, if the specified file cannot be found, it will error out instead of performing the usual search.
+* **`--debug`**: Enabling the debug mode does the following:
+  - `lint-staged` uses the [debug](https://github.com/visionmedia/debug) module internally to log 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*`.
+  - Use the [`verbose` renderer](https://github.com/SamVerschueren/listr-verbose-renderer) for `listr`.
+  - Do not pass `--silent` to npm scripts.
+
 ## Configuration
 
 Starting with v3.1 you can now use different ways of configuring it:
@@ -98,16 +124,19 @@ To set options and keep lint-staged extensible, advanced format can be used. Thi
 
 ## Options
 
-* `linters` — `Object` — keys (`String`) are glob patterns, values (`Array<String> | String`) are commands to execute.
 * `concurrent` — *true* — runs linters for each glob pattern simultaneously. If you don’t want this, you can set `concurrent: false`
 * `chunkSize` — Max allowed chunk size based on number of files for glob pattern. This is important on windows based systems to avoid command length limitations. See [#147](https://github.com/okonet/lint-staged/issues/147)
+* `globOptions` — `{ matchBase: true, dot: true }` — [minimatch options](https://github.com/isaacs/minimatch#options) to 
+customize how glob patterns match files.
+* `ignore` - `['**/docs/**/*.js']` - array of glob patterns to entirely ignore from any task.
+* `linters` — `Object` — keys (`String`) are glob patterns, values (`Array<String> | String`) are commands to execute.
 * `subTaskConcurrency` — `1` — Controls concurrency for processing chunks generated for each linter. Execution is **not** concurrent by default(see [#225](https://github.com/okonet/lint-staged/issues/225))
-* `verbose` — *false* — runs lint-staged in verbose mode. When `true` it will use https://github.com/SamVerschueren/listr-verbose-renderer.
-* `globOptions` — `{ matchBase: true, dot: true }` — [minimatch options](https://github.com/isaacs/minimatch#options) to customize how glob patterns match files.
 
 ## Filtering files
 
-It is possible to run linters for certain paths only by using [minimatch](https://github.com/isaacs/minimatch) patterns. The paths used for filtering via minimatch are relative to the directory that contains the `.git` directory. The paths passed to the linters are absolute to avoid confusion in case they're executed with a different working directory, as would be the case when using the `gitDir` option.
+It is possible to run linters for certain paths only by using glob patterns. [minimatch](https://github.com/isaacs/minimatch) is used to filter the staged files according to these patterns. File patterns should be specified _relative to the `package.json` location_ (i.e. where `lint-staged` is installed).
+
+**NOTE:** If you're using `lint-staged<5` globs have to be _relative to the git root_.
 
 ```js
 {
@@ -122,6 +151,17 @@ It is possible to run linters for certain paths only by using [minimatch](https:
 }
 ```
 
+When matching, `lint-staged` will do the following
+
+* Resolve the git root automatically, no configuration needed.
+* Pick the staged files which are present inside the project directory.
+* Filter them using the specified glob patterns.
+* Pass absolute paths to the linters as arguments.
+
+**NOTE:** `lint-staged` will pass _absolute_ paths to the linters to avoid any confusion in case they're executed in a different working directory (i.e. when your `.git` directory isn't the same as your `package.json` directory).
+
+Also see [How to use `lint-staged` in a multi package monorepo?](#how-to-use-lint-staged-in-a-multi-package-monorepo)
+
 ## What commands are supported?
 
 Supported are both local npm scripts (`npm run-script`), or any executables installed locally or globally via `npm` as well as any executable from your $PATH.
@@ -140,6 +180,15 @@ Pass arguments to your commands separated by space as you would do in the shell.
 
 Starting from [v2.0.0](https://github.com/okonet/lint-staged/releases/tag/2.0.0) sequences of commands are supported. Pass an array of commands instead of a single one and they will run sequentially. This is useful for running autoformatting tools like `eslint --fix` or `stylefmt` but can be used for any arbitrary sequences.
 
+## How to use `lint-staged` in a multi package monorepo?
+
+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.
+[`lerna`](https://github.com/lerna/lerna) can be used to execute the `precommit` script in all sub-packages.
+
+Example repo: [sudo-suhas/lint-staged-multi-pkg](https://github.com/sudo-suhas/lint-staged-multi-pkg).
+
 ## Reformatting the code
 
 Tools like ESLint/TSLint or stylefmt can reformat your code according to an appropriate config  by running `eslint --fix`/`tslint --fix`. After the code is reformatted, we want it to be added to the same commit. This can be done using following config:
@@ -223,3 +272,22 @@ This will run `eslint --fix` and automatically add changes to the commit. Please
   ]
 }
 ```
+
+### Minify the images and add files to commit
+
+```json
+{
+  "*.{png,jpeg,jpg,gif,svg}": [
+    "imagemin-lint-staged",
+    "git add"
+  ]
+}
+```
+
+<details>
+  <summary>More about <code>imagemin-lint-staged</code></summary>
+
+  [imagemin-lint-staged](https://github.com/tomchentw/imagemin-lint-staged) is a CLI tool designed for lint-staged usage with sensible defaults.
+
+  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>

package/index.js

@@ -3,11 +3,21 @@
 'use strict'
 
 const cmdline = require('commander')
+const debugLib = require('debug')
 const pkg = require('./package.json')
 
+const debug = debugLib('lint-staged:bin')
+
 cmdline
   .version(pkg.version)
   .option('-c, --config [path]', 'Path to configuration file')
+  .option('-d, --debug', 'Enable debug mode')
   .parse(process.argv)
 
-require('./src')(console, cmdline.config)
+if (cmdline.debug) {
+  debugLib.enable('lint-staged*')
+}
+
+debug('Running `lint-staged@%s`', pkg.version)
+
+require('./src')(console, cmdline.config, cmdline.debug)

package/package.json

@@ -1 +1,88 @@
-{"name":"lint-staged","version":"5.0.0","description":"Lint files staged by git","license":"MIT","repository":"https://github.com/okonet/lint-staged","author":"Andrey Okonetchnikov <andrey@okonet.ru>","maintainers":["Lufty Wiranda <lufty.wiranda@gmail.com","Suhas Karanth <sudo.suhas@gmail.com"],"engines":{"node":">=4.2.0"},"bin":"index.js","files":["index.js","src"],"scripts":{"precommit":"remove-lockfiles && node index.js","cz":"git-cz","lint":"eslint .","lint:fix":"npm run lint -- --fix","pretest":"npm run lint","test":"jest --coverage","test:watch":"jest --watch"},"dependencies":{"app-root-path":"^2.0.0","chalk":"^2.1.0","commander":"^2.11.0","cosmiconfig":"^3.1.0","dedent":"^0.7.0","execa":"^0.8.0","find-parent-dir":"^0.3.0","is-glob":"^4.0.0","jest-validate":"^21.1.0","listr":"^0.13.0","lodash":"^4.17.4","log-symbols":"^2.0.0","minimatch":"^3.0.0","npm-which":"^3.0.1","p-map":"^1.1.1","path-is-inside":"^1.0.2","pify":"^3.0.0","staged-git-files":"0.0.4","stringify-object":"^3.2.0"},"devDependencies":{"babel-jest":"^21.0.2","babel-preset-env":"^1.6.0","commitizen":"^2.9.6","consolemock":"^0.3.0","cz-conventional-changelog":"^2.0.0","eslint":"^4.5.0","eslint-config-okonet":"^5.0.1","eslint-plugin-node":"^5.1.1","husky":"^0.14.3","jest":"^21.1.0","jest-cli":"^21.1.0","jsonlint":"^1.6.2","prettier":"1.7.4","remove-lockfiles":"^1.1.1"},"config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"jest":{"testEnvironment":"node","setupFiles":["./testSetup.js"]},"keywords":["lint","git","staged","eslint","prettier","stylelint","code","quality","check","format","validate"]}
+{
+  "name": "lint-staged",
+  "version": "6.1.1",
+  "description": "Lint files staged by git",
+  "license": "MIT",
+  "repository": "https://github.com/okonet/lint-staged",
+  "author": "Andrey Okonetchnikov <andrey@okonet.ru>",
+  "maintainers": [
+    "Lufty Wiranda <lufty.wiranda@gmail.com>",
+    "Suhas Karanth <sudo.suhas@gmail.com>"
+  ],
+  "engines": {
+    "node": ">=4.2.0"
+  },
+  "bin": "index.js",
+  "files": [
+    "index.js",
+    "src"
+  ],
+  "scripts": {
+    "precommit": "node index.js",
+    "cz": "git-cz",
+    "lint": "eslint .",
+    "lint:fix": "yarn lint --fix",
+    "pretest": "yarn lint",
+    "test": "jest --coverage",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "app-root-path": "^2.0.0",
+    "chalk": "^2.1.0",
+    "commander": "^2.11.0",
+    "cosmiconfig": "^4.0.0",
+    "debug": "^3.1.0",
+    "dedent": "^0.7.0",
+    "execa": "^0.8.0",
+    "find-parent-dir": "^0.3.0",
+    "is-glob": "^4.0.0",
+    "jest-validate": "^21.1.0",
+    "listr": "^0.13.0",
+    "lodash": "^4.17.4",
+    "log-symbols": "^2.0.0",
+    "minimatch": "^3.0.0",
+    "npm-which": "^3.0.1",
+    "p-map": "^1.1.1",
+    "path-is-inside": "^1.0.2",
+    "pify": "^3.0.0",
+    "staged-git-files": "1.0.0",
+    "stringify-object": "^3.2.0"
+  },
+  "devDependencies": {
+    "babel-preset-env": "^1.6.0",
+    "commitizen": "^2.9.6",
+    "consolemock": "^1.0.2",
+    "cz-conventional-changelog": "^2.0.0",
+    "eslint": "^4.5.0",
+    "eslint-config-okonet": "^5.0.1",
+    "eslint-plugin-node": "^5.1.1",
+    "husky": "^0.14.3",
+    "jest": "^22.0.4",
+    "jsonlint": "^1.6.2",
+    "prettier": "1.9.2"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "jest": {
+    "testEnvironment": "node",
+    "setupFiles": [
+      "./testSetup.js"
+    ]
+  },
+  "keywords": [
+    "lint",
+    "git",
+    "staged",
+    "eslint",
+    "prettier",
+    "stylelint",
+    "code",
+    "quality",
+    "check",
+    "format",
+    "validate"
+  ]
+}

package/src/findBin.js

@@ -2,11 +2,14 @@
 
 const npmWhich = require('npm-which')(process.cwd())
 
-module.exports = function findBin(cmd, scripts, options) {
+const debug = require('debug')('lint-staged:find-bin')
+
+module.exports = function findBin(cmd, scripts, debugMode) {
+  debug('Resolving binary for command `%s`', cmd)
   const npmArgs = (bin, args) =>
     // We always add `--` even if args are not defined. This is required
     // because we pass filenames later.
-    ['run', options && options.verbose ? undefined : '--silent', bin, '--']
+    ['run', debugMode ? undefined : '--silent', bin, '--']
       // args could be undefined but we filter that out.
       .concat(args)
       .filter(arg => arg !== undefined)
@@ -39,6 +42,7 @@ module.exports = function findBin(cmd, scripts, options) {
    */
   if (scripts[cmd] !== undefined) {
     // Support for scripts from package.json
+    debug('`%s` resolved to npm script - `%s`', cmd, scripts[cmd])
     return { bin: 'npm', args: npmArgs(cmd) }
   }
 
@@ -47,6 +51,7 @@ module.exports = function findBin(cmd, scripts, options) {
   const args = parts.splice(1)
 
   if (scripts[bin] !== undefined) {
+    debug('`%s` resolved to npm script - `%s`', bin, scripts[bin])
     return { bin: 'npm', args: npmArgs(bin, args) }
   }
 
@@ -76,5 +81,6 @@ module.exports = function findBin(cmd, scripts, options) {
     throw new Error(`${bin} could not be found. Try \`npm install ${bin}\`.`)
   }
 
+  debug('Binary for `%s` resolved to `%s`', cmd, bin)
   return { bin, args }
 }

package/src/generateTasks.js

@@ -6,10 +6,20 @@ const pathIsInside = require('path-is-inside')
 const getConfig = require('./getConfig').getConfig
 const resolveGitDir = require('./resolveGitDir')
 
+const debug = require('debug')('lint-staged:gen-tasks')
+
 module.exports = function generateTasks(config, relFiles) {
+  debug('Generating linter tasks')
+
   const normalizedConfig = getConfig(config) // Ensure we have a normalized config
   const linters = normalizedConfig.linters
   const globOptions = normalizedConfig.globOptions
+  const ignoreFilters = normalizedConfig.ignore.map(pattern => minimatch.filter(pattern))
+  // if there are filters, then return false if the input matches any
+  // if there are not, then return true for all input
+  const ignoreFilter = ignoreFilters.length
+    ? input => !ignoreFilters.some(filter => filter(input))
+    : () => true
 
   const gitDir = resolveGitDir()
   const cwd = process.cwd()
@@ -26,13 +36,13 @@ module.exports = function generateTasks(config, relFiles) {
       .map(file => path.relative(cwd, file))
       // We want to filter before resolving paths
       .filter(filter)
+      .filter(ignoreFilter)
       // Return absolute path after the filter is run
       .map(file => path.resolve(cwd, file))
 
-    return {
-      pattern,
-      commands,
-      fileList
-    }
+    const task = { pattern, commands, fileList }
+    debug('Generated task: \n%O', task)
+
+    return task
   })
 }

package/src/getConfig.js

@@ -12,10 +12,12 @@ const logValidationWarning = require('jest-validate').logValidationWarning
 const unknownOptionWarning = require('jest-validate/build/warnings').unknownOptionWarning
 const isGlob = require('is-glob')
 
+const debug = require('debug')('lint-staged:cfg')
+
 /**
  * Default config object
  *
- * @type {{concurrent: boolean, chunkSize: number, globOptions: {matchBase: boolean, dot: boolean}, linters: {}, subTaskConcurrency: number, renderer: string, verbose: boolean}}
+ * @type {{concurrent: boolean, chunkSize: number, globOptions: {matchBase: boolean, dot: boolean}, linters: {}, subTaskConcurrency: number, renderer: string}}
  */
 const defaultConfig = {
   concurrent: true,
@@ -25,9 +27,9 @@ const defaultConfig = {
     dot: true
   },
   linters: {},
+  ignore: [],
   subTaskConcurrency: 1,
-  renderer: 'update',
-  verbose: false
+  renderer: 'update'
 }
 
 /**
@@ -72,7 +74,7 @@ function unknownValidationReporter(config, example, option, options) {
   will fix it and remove this message.`
 
     const comment = options.comment
-    const name = (options.title && options.title.warning) || 'WARNING'
+    const name = options.title.warning
     return logValidationWarning(name, message, comment)
   }
   // If it is not glob pattern, use default jest-validate reporter
@@ -88,10 +90,11 @@ function unknownValidationReporter(config, example, option, options) {
  *
  * @param {Object} sourceConfig
  * @returns {{
- *  concurrent: boolean, chunkSize: number, globOptions: {matchBase: boolean, dot: boolean}, linters: {}, subTaskConcurrency: number, renderer: string, verbose: boolean
+ *  concurrent: boolean, chunkSize: number, globOptions: {matchBase: boolean, dot: boolean}, linters: {}, subTaskConcurrency: number, renderer: string
  * }}
  */
-function getConfig(sourceConfig) {
+function getConfig(sourceConfig, debugMode) {
+  debug('Normalizing config')
   const config = defaultsDeep(
     {}, // Do not mutate sourceConfig!!!
     isSimple(sourceConfig) ? { linters: sourceConfig } : sourceConfig,
@@ -100,18 +103,25 @@ function getConfig(sourceConfig) {
 
   // Check if renderer is set in sourceConfig and if not, set accordingly to verbose
   if (isObject(sourceConfig) && !sourceConfig.hasOwnProperty('renderer')) {
-    config.renderer = config.verbose ? 'verbose' : 'update'
+    config.renderer = debugMode ? 'verbose' : 'update'
   }
 
   return config
 }
 
+const optRmMsg = (opt, helpMsg) => `  Option ${chalk.bold(opt)} was removed.
+
+  ${helpMsg}
+
+  Please remove ${chalk.bold(opt)} from your configuration.`
+
 /**
  * Runs config validation. Throws error if the config is not valid.
  * @param config {Object}
  * @returns config {Object}
  */
 function validateConfig(config) {
+  debug('Validating config')
   const exampleConfig = Object.assign({}, defaultConfig, {
     linters: {
       '*.js': ['eslint --fix', 'git add'],
@@ -120,14 +130,12 @@ function validateConfig(config) {
   })
 
   const deprecatedConfig = {
-    gitDir: () => `  Option ${chalk.bold('gitDir')} was removed.
-
-  lint-staged now automatically resolves '.git' directory.
-
-  Please remove ${chalk.bold('gitDir')} from your configuration.`
+    gitDir: () => optRmMsg('gitDir', "lint-staged now automatically resolves '.git' directory."),
+    verbose: () =>
+      optRmMsg('verbose', `Use the command line flag ${chalk.bold('--debug')} instead.`)
   }
 
-  const validation = validate(config, {
+  validate(config, {
     exampleConfig,
     deprecatedConfig,
     unknown: unknownValidationReporter,
@@ -135,10 +143,6 @@ function validateConfig(config) {
       'Please refer to https://github.com/okonet/lint-staged#configuration for more information...'
   })
 
-  if (!validation.isValid) {
-    throw new Error('lint-staged config is invalid... Aborting.')
-  }
-
   return config
 }
 

package/src/index.js

@@ -11,8 +11,9 @@ const validateConfig = require('./getConfig').validateConfig
 const printErrors = require('./printErrors')
 const runAll = require('./runAll')
 
+const debug = require('debug')('lint-staged')
+
 // Find the right package.json at the root of the project
-// TODO: Test if it should be aware of `gitDir`
 const packageJson = require(appRoot.resolve('package.json'))
 
 // Force colors for packages that depend on https://www.npmjs.com/package/supports-color
@@ -26,7 +27,8 @@ const errConfigNotFound = new Error('Config could not be found')
 /**
  * Root lint-staged function that is called from .bin
  */
-module.exports = function lintStaged(injectedLogger, configPath) {
+module.exports = function lintStaged(injectedLogger, configPath, debugMode) {
+  debug('Loading config using `cosmiconfig`')
   const logger = injectedLogger || console
 
   const explorer = cosmiconfig('lint-staged', {
@@ -36,23 +38,30 @@ module.exports = function lintStaged(injectedLogger, configPath) {
   })
 
   return explorer
-    .load(process.cwd())
+    .load()
     .then(result => {
       if (result == null) throw errConfigNotFound
 
+      debug('Successfully loaded config from `%s`:\n%O', result.filepath, result.config)
       // result.config is the parsed configuration object
       // result.filepath is the path to the config file that was found
-      const config = validateConfig(getConfig(result.config))
-
-      if (config.verbose) {
+      const config = validateConfig(getConfig(result.config, debugMode))
+      if (debugMode) {
+        // Log using logger to be able to test through `consolemock`.
         logger.log('Running lint-staged with the following config:')
         logger.log(stringifyObject(config, { indent: '  ' }))
+      } else {
+        // We might not be in debug mode but `DEBUG=lint-staged*` could have
+        // been set.
+        debug('Normalized config:\n%O', config)
       }
 
       const scripts = packageJson.scripts || {}
+      debug('Loaded scripts from package.json:\n%O', scripts)
 
-      runAll(scripts, config)
+      runAll(scripts, config, debugMode)
         .then(() => {
+          debug('linters were executed successfully!')
           // No errors, exiting with 0
           process.exitCode = 0
         })

package/src/runAll.js

@@ -8,30 +8,36 @@ const runScript = require('./runScript')
 const generateTasks = require('./generateTasks')
 const resolveGitDir = require('./resolveGitDir')
 
+const debug = require('debug')('lint-staged:run')
+
 /**
  * Executes all tasks and either resolves or rejects the promise
  * @param scripts
  * @param config {Object}
  * @returns {Promise}
  */
-module.exports = function runAll(scripts, config) {
+module.exports = function runAll(scripts, config, debugMode) {
+  debug('Running all linter scripts')
   // Config validation
   if (!config || !has(config, 'concurrent') || !has(config, 'renderer')) {
     throw new Error('Invalid config provided to runAll! Use getConfig instead.')
   }
 
-  const gitDir = config.gitDir
   const concurrent = config.concurrent
   const renderer = config.renderer
-  sgf.cwd = resolveGitDir(gitDir)
+  const gitDir = resolveGitDir()
+  debug('Resolved git directory to be `%s`', gitDir)
 
+  sgf.cwd = gitDir
   return pify(sgf)('ACM').then(files => {
     /* files is an Object{ filename: String, status: String } */
     const filenames = files.map(file => file.filename)
+    debug('Loaded list of staged files in git:\n%O', filenames)
+
     const tasks = generateTasks(config, filenames).map(task => ({
       title: `Running tasks for ${task.pattern}`,
       task: () =>
-        new Listr(runScript(task.commands, task.fileList, scripts, config), {
+        new Listr(runScript(task.commands, task.fileList, scripts, config, debugMode), {
           // In sub-tasks we don't want to run concurrently
           // and we want to abort on errors
           dateFormat: false,

package/src/runScript.js

@@ -10,7 +10,11 @@ const calcChunkSize = require('./calcChunkSize')
 const findBin = require('./findBin')
 const resolveGitDir = require('./resolveGitDir')
 
-module.exports = function runScript(commands, pathsToLint, scripts, config) {
+const debug = require('debug')('lint-staged:run-script')
+
+module.exports = function runScript(commands, pathsToLint, scripts, config, debugMode) {
+  debug('Running script with commands %o', commands)
+
   const normalizedConfig = getConfig(config)
   const chunkSize = normalizedConfig.chunkSize
   const concurrency = normalizedConfig.subTaskConcurrency
@@ -24,7 +28,7 @@ module.exports = function runScript(commands, pathsToLint, scripts, config) {
     title: linter,
     task: () => {
       try {
-        const res = findBin(linter, scripts, config)
+        const res = findBin(linter, scripts, debugMode)
 
         // Only use gitDir as CWD if we are using the git binary
         // e.g `npm` should run tasks in the actual CWD
@@ -35,6 +39,10 @@ module.exports = function runScript(commands, pathsToLint, scripts, config) {
         const mapper = pathsChunk => {
           const args = res.args.concat(pathsChunk)
 
+          debug('bin:', res.bin)
+          debug('args: %O', args)
+          debug('opts: %o', execaOptions)
+
           return (
             execa(res.bin, args, Object.assign({}, execaOptions))
               /* If we don't catch, pMap will terminate on first rejection */
@@ -59,6 +67,7 @@ module.exports = function runScript(commands, pathsToLint, scripts, config) {
             const errStdout = errors.map(err => err.stdout).join('')
             const errStderr = errors.map(err => err.stderr).join('')
 
+            // prettier-ignore
             throw new Error(dedent`
               ${logSymbols.error} ${linter} found some errors. Please fix them and try committing again.
               ${errStdout}