lint-staged 4.2.0 → 4.3.0

package/README.md

@@ -57,6 +57,7 @@ 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
+* 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/index.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+'use strict'
+
+const cmdline = require('commander')
+const pkg = require('./package.json')
+
+cmdline
+  .version(pkg.version)
+  .option('-c, --config [path]', 'Path to configuration file')
+  .parse(process.argv)
+
+require('./src')(console, cmdline.config)

package/package.json

@@ -1,90 +1 @@
-{
-  "name": "lint-staged",
-  "version": "4.2.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": [
-    "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",
-    "cosmiconfig": "^1.1.0",
-    "execa": "^0.8.0",
-    "is-glob": "^4.0.0",
-    "jest-validate": "^20.0.3",
-    "listr": "^0.12.0",
-    "lodash": "^4.17.4",
-    "log-symbols": "^2.0.0",
-    "minimatch": "^3.0.0",
-    "npm-which": "^3.0.1",
-    "p-map": "^1.1.1",
-    "staged-git-files": "0.0.4",
-    "stringify-object": "^3.2.0"
-  },
-  "devDependencies": {
-    "babel-jest": "^20.0.0",
-    "babel-preset-env": "^1.6.0",
-    "commitizen": "^2.9.6",
-    "consolemock": "^0.2.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": "^20.0.4",
-    "jest-cli": "^20.0.4",
-    "jsonlint": "^1.6.2",
-    "prettier": "1.5.3",
-    "remove-lockfiles": "^1.1.1",
-    "strip-ansi": "^3.0.1"
-  },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
-  },
-  "jest": {
-    "testEnvironment": "node",
-    "setupFiles": [
-      "./testSetup.js"
-    ]
-  },
-  "greenkeeper": {
-    "ignore": [
-      "cosmiconfig"
-    ]
-  },
-  "keywords": [
-    "lint",
-    "git",
-    "staged",
-    "eslint",
-    "prettier",
-    "stylelint",
-    "code",
-    "quality",
-    "check",
-    "format",
-    "validate"
-  ]
-}
+{"name":"lint-staged","version":"4.3.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":"^1.1.0","execa":"^0.8.0","is-glob":"^4.0.0","jest-validate":"^21.1.0","listr":"^0.12.0","lodash":"^4.17.4","log-symbols":"^2.0.0","minimatch":"^3.0.0","npm-which":"^3.0.1","p-map":"^1.1.1","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.5.3","remove-lockfiles":"^1.1.1"},"config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"jest":{"testEnvironment":"node","setupFiles":["./testSetup.js"]},"greenkeeper":{"ignore":["cosmiconfig"]},"keywords":["lint","git","staged","eslint","prettier","stylelint","code","quality","check","format","validate"]}

package/src/findBin.js

@@ -2,16 +2,52 @@
 
 const npmWhich = require('npm-which')(process.cwd())
 
-module.exports = function findBin(cmd, packageJson, options) {
+module.exports = function findBin(cmd, scripts, options) {
+  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, '--']
+      // args could be undefined but we filter that out.
+      .concat(args)
+      .filter(arg => arg !== undefined)
+
   /*
-    * If package.json has script with cmd defined
-    * we want it to be executed first
-    */
-  if (packageJson.scripts && packageJson.scripts[cmd] !== undefined) {
+   * If package.json has script with cmd defined we want it to be executed
+   * first. For finding the bin from scripts defined in package.json, there
+   * are 2 possibilities. It's a command which does not have any arguments
+   * passed to it in the lint-staged config. Or it could be something like
+   * `kcd-scripts` which has arguments such as `format`, `lint` passed to it.
+   * But we always cannot assume that the cmd, which has a space in it, is of
+   * the format `bin argument` because it is legal to define a package.json
+   * script with space in it's name. So we do 2 types of lookup. First a naive
+   * lookup which just looks for the scripts entry with cmd. Then we split on
+   * space, parse the bin and args, and try again.
+   *
+   * Related:
+   *  - https://github.com/kentcdodds/kcd-scripts/pull/3
+   *  - https://github.com/okonet/lint-staged/issues/294
+   *
+   * Example:
+   *
+   *   "scripts": {
+   *     "my cmd": "echo deal-wth-it",
+   *     "demo-bin": "node index.js"
+   *   },
+   *   "lint-staged": {
+   *     "*.js": ["my cmd", "demo-bin hello"]
+   *   }
+   */
+  if (scripts[cmd] !== undefined) {
     // Support for scripts from package.json
-    const args = ['run', options && options.verbose ? undefined : '--silent', cmd].filter(Boolean)
+    return { bin: 'npm', args: npmArgs(cmd) }
+  }
 
-    return { bin: 'npm', args }
+  const parts = cmd.split(' ')
+  let bin = parts[0]
+  const args = parts.splice(1)
+
+  if (scripts[bin] !== undefined) {
+    return { bin: 'npm', args: npmArgs(bin, args) }
   }
 
   /*
@@ -32,10 +68,6 @@ module.exports = function findBin(cmd, packageJson, options) {
     *  }
     */
 
-  const parts = cmd.split(' ')
-  let bin = parts[0]
-  const args = parts.splice(1)
-
   try {
     /* npm-which tries to resolve the bin in local node_modules/.bin */
     /* and if this fails it look in $PATH */

package/src/getConfig.js

@@ -1,5 +1,7 @@
-/* eslint no-console: 0 */
 /* eslint no-prototype-builtins: 0 */
+
+'use strict'
+
 const chalk = require('chalk')
 const format = require('stringify-object')
 const intersection = require('lodash/intersection')
@@ -60,13 +62,13 @@ function unknownValidationReporter(config, example, option, options) {
     const message = `  Unknown option ${chalk.bold(`"${option}"`)} with value ${chalk.bold(
       format(config[option], { inlineCharacterLimit: Number.POSITIVE_INFINITY })
     )} was found in the config root.
-  
-  You are probably trying to mix simple and advanced config formats. Adding 
-  
+
+  You are probably trying to mix simple and advanced config formats. Adding
+
   ${chalk.bold(`"linters": {
     "${option}": ${JSON.stringify(config[option])}
   }`)}
-   
+
   will fix it and remove this message.`
 
     const comment = options.comment

package/src/index.js

@@ -1,4 +1,3 @@
-/* eslint no-console: 0 */
 /* eslint import/no-dynamic-require: 0 */
 
 'use strict'
@@ -26,8 +25,11 @@ const errConfigNotFound = new Error('Config could not be found')
 /**
  * Root lint-staged function that is called from .bin
  */
-module.exports = function lintStaged() {
+module.exports = function lintStaged(injectedLogger, configPath) {
+  const logger = injectedLogger || console
+
   return cosmiconfig('lint-staged', {
+    configPath,
     rc: '.lintstagedrc',
     rcExtensions: true
   })
@@ -39,13 +41,15 @@ module.exports = function lintStaged() {
       const config = validateConfig(getConfig(result.config))
 
       if (config.verbose) {
-        console.log(`
+        logger.log(`
 Running lint-staged with the following config:
 ${stringifyObject(config)}
 `)
       }
 
-      runAll(packageJson, config)
+      const scripts = packageJson.scripts || {}
+
+      runAll(scripts, config)
         .then(() => {
           // No errors, exiting with 0
           process.exitCode = 0
@@ -58,15 +62,15 @@ ${stringifyObject(config)}
     })
     .catch(err => {
       if (err === errConfigNotFound) {
-        console.error(`${err.message}.`)
+        logger.error(`${err.message}.`)
       } else {
         // It was probably a parsing error
-        console.error(`Could not parse lint-staged config.
+        logger.error(`Could not parse lint-staged config.
 
 ${err}`)
       }
       // Print helpful message for all errors
-      console.error(`
+      logger.error(`
 Please make sure you have created it correctly.
 See https://github.com/okonet/lint-staged#configuration.
 `)

package/src/printErrors.js

@@ -1,5 +1,3 @@
-/* eslint no-console: 0 */
-
 'use strict'
 
 module.exports = function printErrors(errorInstance) {

package/src/resolveGitDir.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const path = require('path')
 
 module.exports = function resolveGitDir(gitDir) {

package/src/runAll.js

@@ -9,11 +9,11 @@ const resolveGitDir = require('./resolveGitDir')
 
 /**
  * Executes all tasks and either resolves or rejects the promise
- * @param packageJson
+ * @param scripts
  * @param config {Object}
  * @returns {Promise}
  */
-module.exports = function runAll(packageJson, config) {
+module.exports = function runAll(scripts, config) {
   // Config validation
   if (!config || !has(config, 'gitDir') || !has(config, 'concurrent') || !has(config, 'renderer')) {
     throw new Error('Invalid config provided to runAll! Use getConfig instead.')
@@ -35,7 +35,7 @@ module.exports = function runAll(packageJson, config) {
       const tasks = generateTasks(config, filenames).map(task => ({
         title: `Running tasks for ${task.pattern}`,
         task: () =>
-          new Listr(runScript(task.commands, task.fileList, packageJson, config), {
+          new Listr(runScript(task.commands, task.fileList, scripts, config), {
             // In sub-tasks we don't want to run concurrently
             // and we want to abort on errors
             concurrent: false,

package/src/runScript.js

@@ -8,7 +8,7 @@ const getConfig = require('./getConfig').getConfig
 const calcChunkSize = require('./calcChunkSize')
 const findBin = require('./findBin')
 
-module.exports = function runScript(commands, pathsToLint, packageJson, config) {
+module.exports = function runScript(commands, pathsToLint, scripts, config) {
   const normalizedConfig = getConfig(config)
   const chunkSize = normalizedConfig.chunkSize
   const concurrency = normalizedConfig.subTaskConcurrency
@@ -22,9 +22,7 @@ module.exports = function runScript(commands, pathsToLint, packageJson, config)
     title: linter,
     task: () => {
       try {
-        const res = findBin(linter, packageJson, config)
-
-        const separatorArgs = /npm(\.exe)?$/i.test(res.bin) ? ['--'] : []
+        const res = findBin(linter, scripts, config)
 
         // Only use gitDir as CWD if we are using the git binary
         // e.g `npm` should run tasks in the actual CWD
@@ -33,7 +31,7 @@ module.exports = function runScript(commands, pathsToLint, packageJson, config)
 
         const errors = []
         const mapper = pathsChunk => {
-          const args = res.args.concat(separatorArgs, pathsChunk)
+          const args = res.args.concat(pathsChunk)
 
           return (
             execa(res.bin, args, Object.assign({}, execaOptions))

package/src/.eslintrc.json

@@ -1,12 +0,0 @@
-{
-  "plugins": ["node"],
-  "extends": [
-    "plugin:node/recommended"
-  ],
-  "rules": {
-    "node/exports-style": [
-      "error",
-      "module.exports"
-    ]
-  }
-}