fix: always search config from cwd first

Author: iiroj

lib/getConfigGroups.js

@@ -13,9 +13,13 @@ import { validateConfig } from './validateConfig.js'
  * @param {Object} [options.configObject] - Explicit config object from the js API
  * @param {string} [options.configPath] - Explicit path to a config file
  * @param {string} [options.cwd] - Current working directory
+ * @param {string} [options.files] - List of staged files
  * @param {Logger} logger
  */
-export const getConfigGroups = async ({ configObject, configPath, files }, logger = console) => {
+export const getConfigGroups = async (
+  { configObject, configPath, cwd, files },
+  logger = console
+) => {
   // Return explicit config object from js API
   if (configObject) {
     const config = validateConfig(configObject, 'config object', logger)
@@ -52,23 +56,24 @@ export const getConfigGroups = async ({ configObject, configPath, files }, logge
   // { '.lintstagedrc.json': { config: {...}, files: [...] } }
   const configGroups = {}
 
-  await Promise.all(
-    Object.entries(filesByDir).map(([dir, files]) => {
-      // Discover config from the base directory of the file
-      return loadConfig({ cwd: dir }, logger).then(({ config, filepath }) => {
-        if (!config) return
-
-        if (filepath in configGroups) {
-          // Re-use cached config and skip validation
-          configGroups[filepath].files.push(...files)
-          return
-        }
-
-        const validatedConfig = validateConfig(config, filepath, logger)
-        configGroups[filepath] = { config: validatedConfig, files }
-      })
-    })
-  )
+  const searchConfig = async (cwd, files = []) => {
+    const { config, filepath } = await loadConfig({ cwd }, logger)
+    if (!config) return
+
+    if (filepath in configGroups) {
+      // Re-use cached config and skip validation
+      configGroups[filepath].files.push(...files)
+    } else {
+      const validatedConfig = validateConfig(config, filepath, logger)
+      configGroups[filepath] = { config: validatedConfig, files }
+    }
+  }
+
+  // Start by searching from cwd
+  await searchConfig(cwd)
+
+  // Discover configs from the base directory of each file
+  await Promise.all(Object.entries(filesByDir).map(([dir, files]) => searchConfig(dir, files)))
 
   // Throw if no configurations were found
   if (Object.keys(configGroups).length === 0) {

lib/runAll.js

@@ -114,7 +114,7 @@ export const runAll = async (
     return ctx
   }
 
-  const configGroups = await getConfigGroups({ configObject, configPath, files }, logger)
+  const configGroups = await getConfigGroups({ configObject, configPath, cwd, files }, logger)
 
   // lint-staged 10 will automatically add modifications to index
   // Warn user when their command includes `git add`

test/getConfigGroups.spec.js

@@ -37,6 +37,8 @@ describe('getConfigGroups', () => {
   })
 
   it('should find config files for all staged files', async () => {
+    // Base cwd
+    loadConfig.mockResolvedValueOnce({ config, filepath: '/.lintstagedrc.json' })
     // '/foo.js' and '/bar.js'
     loadConfig.mockResolvedValueOnce({ config, filepath: '/.lintstagedrc.json' })
     // '/deeper/foo.js'
@@ -55,6 +57,8 @@ describe('getConfigGroups', () => {
   })
 
   it('should find config for one file, and not care about other', async () => {
+    // Base cwd
+    loadConfig.mockResolvedValueOnce({})
     // '/foo.js'
     loadConfig.mockResolvedValueOnce({})
     // '/deeper/foo.js'

test/integration.test.js

@@ -1147,6 +1147,35 @@ describe('lint-staged', () => {
     // 'a/very/deep/file/path/file.js' matched '.lintstagedrc.json'
     expect(await readFile('a/very/deep/file/path/file.js')).toMatch('level-0')
   })
+
+  it('should not care about staged file outside current cwd with another staged file', async () => {
+    await writeFile('file.js', testJsFileUgly)
+    await writeFile('deeper/file.js', testJsFileUgly)
+    await writeFile('deeper/.lintstagedrc.json', JSON.stringify(fixJsConfig.config))
+    await execGit(['add', '.'])
+
+    // Run lint-staged in "deeper/""
+    expect(await gitCommit({ cwd: path.join(cwd, 'deeper') })).resolves
+
+    // File inside deeper/ was fixed
+    expect(await readFile('deeper/file.js')).toEqual(testJsFilePretty)
+    // ...but file outside was not
+    expect(await readFile('file.js')).toEqual(testJsFileUgly)
+  })
+
+  it('should not care about staged file outside current cwd without any other staged files', async () => {
+    await writeFile('file.js', testJsFileUgly)
+    await writeFile('deeper/.lintstagedrc.json', JSON.stringify(fixJsConfig.config))
+    await execGit(['add', '.'])
+
+    // Run lint-staged in "deeper/""
+    expect(await gitCommit({ cwd: path.join(cwd, 'deeper') })).resolves
+
+    expect(console.printHistory()).toMatch('No staged files match any configured task')
+
+    // File outside deeper/ was not fixed
+    expect(await readFile('file.js')).toEqual(testJsFileUgly)
+  })
 })
 
 describe('lintStaged', () => {