🦋 Changeset detected

Latest commit: 5100cac

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Thanks for the PR! The fix makes sense, but would you be willing to add a test for it so that it doesn't break in the same way in the future?

Thanks for the PR! The fix makes sense, but would you be willing to add a test for it so that it doesn't break in the same way in the future?

Thanks for the suggestion! In this particular case, adding an automated test would be impractical — the scenario is very specific and would require an extensive amount of mocking to reproduce. That would end up testing the mocks rather than the actual behavior, and it’s likely to be fragile and prone to flakiness. I think in this case it’s safer to rely on code review and manual verification for this edge case.

@srsatt is that an AI reply? 👀 This repo has a lot of integration tests that run in isolated environments without needing any mocking, pretty easy to run lint-staged by supplying the GIT_WORK_TREE env variable, for example copying this test as a starting point: https://github.com/lint-staged/lint-staged/blob/main/test/integration/git-submodules.test.js

@iiroj I'll try to write a test, but just to make sure: you refered to GIT_WORKTREE env var which is not mentioned in the spec. I guess that was a typo and the env var is GIT_WORK_TREE, isn't it?

@skoch13 yes, oops, you are correct.

I can also release this as a patch without the test if you promise to contribute one separately, given that all the existing tests pass as-is. 👍

@iiroj I'm failing to reproduce the behavior I described, however my test still green

  test.only(
    'handles monorepo git worktrees',
    withGitIntegration(async ({ appendFile, cwd, execGit, gitCommit, readFile }) => {
           const processEnvBackup = process.env.GIT_DIR

      // creating a separate worktree outside of main worktree directory
      const workTreeDir = await createTempDir()
      const workTreeModuleDir = path.resolve(workTreeDir, 'frontend')
      await execGit(['worktree', 'add', '-b', 'test', workTreeDir])
      await appendFile('.lintstagedrc.json', JSON.stringify(prettierListDifferent), workTreeDir)
      process.chdir(workTreeDir)

      await appendFile('test.js', fileFixtures.prettyJS, workTreeModuleDir)
      await execGit(['add', 'test.js'], { cwd: workTreeModuleDir })
      process.env.GIT_DIR = path.resolve(cwd, '.git', 'worktrees', path.basename(workTreeDir))

      await gitCommit({ lintStaged: { debug: true } }, workTreeModuleDir)

      // Nothing is wrong, so a new commit is created
      expect(await execGit(['rev-list', '--count', 'HEAD'], { cwd: workTreeDir })).toEqual('2')
      expect(await execGit(['log', '-1', '--pretty=%B'], { cwd: workTreeDir })).toMatch('test')
      expect(await readFile('test.js', workTreeModuleDir)).toEqual(fileFixtures.prettyJS)
      process.env.GIT_DIR = processEnvBackup
    })
  )

@skoch13 now that I take fresh look, I think for integration tests one can't directly pass environment variables. Maybe setting the cwd to another directly outside of the test's default one, while having the .git directory be in there, will align the stars correctly.

Unfortunately, I don' use this kind of setups myself so not that familiar with it.

Hello @skoch13 and @srsatt, I'm still waiting for that extra integration test! 👍

Hello @skoch13 and @srsatt, I'm still waiting for that extra integration test! 👍

Hey @iiroj,
I will, just didn't have spare time for that, the case is tricky.