lint-staged 7.1.3 → 7.3.0

package/README.md

@@ -6,7 +6,7 @@ The latest versions of `lint-staged` require Node.js v6 or newer. (Versions of `
 
 ## Why
 
-Linting makes more sense when running before committing your code. By doing that you can ensure no errors are going into repository and enforce code style. But running a lint process on a whole project is slow and linting results can be irrelevant. Ultimately you only want to lint files that will be committed.
+Linting makes more sense when run before committing your code. By doing so you can ensure no errors go into the repository and enforce code style. But running a lint process on a whole project is slow and linting results can be irrelevant. Ultimately you only want to lint files that will be committed.
 
 This project contains a script that will run arbitrary shell tasks with a list of staged files as an argument, filtered by a specified glob pattern.
 
@@ -39,7 +39,7 @@ This project contains a script that will run arbitrary shell tasks with a list o
 
 Now change a few files, `git add` some of them to your commit and try to `git commit` them.
 
-And this is how it looks like in action:
+This is how it looks in action:
 
 <p align="center">
   <img src="./screenshots/lint-staged-prettier.gif" alt="lint-staged with prettier example"
@@ -71,14 +71,14 @@ $ ./node_modules/.bin/lint-staged --help
   Options:
 
     -V, --version        output the version number
-    -c, --config [path]  Path to configuration file
+    -c, --config [path]  Configuration file path or package
     -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.
+* **`--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. You may pass a npm package name for configuration also.
 * **`--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*`.
+  * `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.
 
@@ -125,9 +125,24 @@ So, considering you did `git add file1.ext file2.ext`, lint-staged will run the
 
 ### Advanced config format
 
-To set options and keep lint-staged extensible, advanced format can be used. This should hold linters object in `linters` property.
+To extend and customise lint-staged, advanced options are available. To use these options the format should be as the following:
 
-## Options
+#### `package.json` example with `ignore` option:
+
+```json
+{
+  "lint-staged": {
+    "linters": {
+      "*.{js,scss}": ["some command", "git add"]
+    },
+    "ignore": ["**/dist/*.min.js"]
+  }
+}
+```
+
+Notice that the linting commands now are nested into the `linters` object. The following options are available for advance configuration:
+
+#### Options
 
 * `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 option is only applicable on Windows based systems to avoid command length limitations. See [#147](https://github.com/okonet/lint-staged/issues/147)
@@ -326,3 +341,16 @@ If you wish to use `lint-staged` in a multi package monorepo, it is recommended
 [`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).
+
+### Can I lint files outside of the current project folder?
+
+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).
+So this question is relevant _only_ when the project folder is a child folder inside the git repo.
+In certain project setups, it might be desirable to bypass this restriction. See [#425](https://github.com/okonet/lint-staged/issues/425), [#487](https://github.com/okonet/lint-staged/issues/487) for more context.
+
+`lint-staged` provides an escape hatch for the same(`>= v7.3.0`). For patterns that start with `../`, all the staged files are allowed to match against the pattern.
+Note that patterns like `*.js`, `**/*.js` will still only match the project files and not any of the files in parent or sibling directories.
+
+Example repo: [sudo-suhas/lint-staged-django-react-demo](https://github.com/sudo-suhas/lint-staged-django-react-demo).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lint-staged",
-  "version": "7.1.3",
+  "version": "7.3.0",
   "description": "Lint files staged by git",
   "license": "MIT",
   "repository": "https://github.com/okonet/lint-staged",
@@ -28,7 +28,6 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "app-root-path": "^2.0.1",
     "chalk": "^2.3.1",
     "commander": "^2.14.1",
     "cosmiconfig": "^5.0.2",
@@ -38,7 +37,7 @@
     "find-parent-dir": "^0.3.0",
     "is-glob": "^4.0.0",
     "is-windows": "^1.0.2",
-    "jest-validate": "^23.0.0",
+    "jest-validate": "^23.5.0",
     "listr": "^0.14.1",
     "lodash": "^4.17.5",
     "log-symbols": "^2.2.0",

package/src/findBin.js

@@ -1,14 +1,22 @@
 'use strict'
 
 const parse = require('string-argv')
-const appRoot = require('app-root-path')
 const npmWhich = require('npm-which')(process.cwd())
 const checkPkgScripts = require('./checkPkgScripts')
 
-// Find and load the package.json at the root of the project.
-const pkg = require(appRoot.resolve('package.json')) // eslint-disable-line import/no-dynamic-require
 const debug = require('debug')('lint-staged:find-bin')
 
+// Find and load the package.json at the root of the project.
+let pkg
+try {
+  // eslint-disable-next-line import/no-dynamic-require, global-require
+  pkg = require(`${process.cwd()}/package.json`)
+  debug('Loaded package.json using `process.cwd()`')
+} catch (ignore) {
+  debug('Could not load package.json using `process.cwd()`')
+  pkg = {}
+}
+
 const cache = new Map()
 
 module.exports = function findBin(cmd) {

package/src/generateTasks.js

@@ -8,7 +8,7 @@ const resolveGitDir = require('./resolveGitDir')
 
 const debug = require('debug')('lint-staged:gen-tasks')
 
-module.exports = function generateTasks(config, relFiles) {
+module.exports = function generateTasks(config, stagedRelFiles) {
   debug('Generating linter tasks')
 
   const normalizedConfig = getConfig(config) // Ensure we have a normalized config
@@ -17,16 +17,18 @@ module.exports = function generateTasks(config, relFiles) {
 
   const gitDir = resolveGitDir()
   const cwd = process.cwd()
-  const files = relFiles.map(file => path.resolve(gitDir, file))
+  const stagedFiles = stagedRelFiles.map(file => path.resolve(gitDir, file))
 
   return Object.keys(linters).map(pattern => {
+    const isParentDirPattern = pattern.startsWith('../')
     const patterns = [pattern].concat(ignorePatterns)
     const commands = linters[pattern]
 
     const fileList = micromatch(
-      files
-        // Only worry about children of the CWD
-        .filter(file => pathIsInside(file, cwd))
+      stagedFiles
+        // Only worry about children of the CWD unless the pattern explicitly
+        // specifies that it concerns a parent directory.
+        .filter(file => isParentDirPattern || pathIsInside(file, cwd))
         // Make the paths relative to CWD for filtering
         .map(file => path.relative(cwd, file)),
       patterns,

package/src/getConfig.js

@@ -138,6 +138,7 @@ function validateConfig(config) {
     exampleConfig,
     deprecatedConfig,
     unknown: unknownValidationReporter,
+    recursive: false,
     comment:
       'Please refer to https://github.com/okonet/lint-staged#configuration for more information...'
   })

package/src/index.js

@@ -18,20 +18,28 @@ if (process.stdout.isTTY) {
 
 const errConfigNotFound = new Error('Config could not be found')
 
+function resolveConfig(configPath) {
+  try {
+    return require.resolve(configPath)
+  } catch (ignore) {
+    return configPath
+  }
+}
+
 function loadConfig(configPath) {
   const explorer = cosmiconfig('lint-staged', {
     searchPlaces: [
       'package.json',
-      `.lintstagedrc`,
-      `.lintstagedrc.json`,
-      `.lintstagedrc.yaml`,
-      `.lintstagedrc.yml`,
-      `.lintstagedrc.js`,
-      `lint-staged.config.js`
+      '.lintstagedrc',
+      '.lintstagedrc.json',
+      '.lintstagedrc.yaml',
+      '.lintstagedrc.yml',
+      '.lintstagedrc.js',
+      'lint-staged.config.js'
     ]
   })
 
-  return configPath ? explorer.load(configPath) : explorer.search()
+  return configPath ? explorer.load(resolveConfig(configPath)) : explorer.search()
 }
 
 /**