Many errors in standard output when using git sparse-checkout

[tpluscode]

Description

I'm trying to set up lint-stage on https://github.com/DefinitelyTyped/DefinitelyTyped. Since that repo moved to pnpm as a monorepo, the recommended workflow is to use sparse checkout and only check out those types/* dirs which one is working on.

This apparently causes a ton of errors like this, for every single types/* directory which is not currently checked out.

[Error: ENOENT: no such file or directory, open '/Volumes/Home/projects/github/DefinitelyTyped/types/zxcvbn/package.json'] {
  errno: -2,
  code: 'ENOENT',
  syscall: 'open',
  path: '/Volumes/Home/projects/github/DefinitelyTyped/types/zxcvbn/package.json'
}

Otherwise, linting succeeds

Steps to reproduce

1. git clone --sparse --filter=blob:none --depth=1 git@github.com:tpluscode/DefinitelyTyped.git
2. git switch lint-staged
3. git sparse-checkout add types/node
4. pnpm i
5. Modify types/node/index.d.ts
6. git add --sparse types/node/index.d.ts
7. pnpm lint-staged
8. Observe errors rolling in

Debug Logs

That repo produces a log so big that I just upload the whole thing:
log.log

Environment

• OS: macOS Catalina
• Node.js: 18.19.0
• lint-staged: 15.2.0

[iiroj]

Hey, looks like this might be related to the automatic monorepo features. Since all the type definition packages include a package.json in version control, lint-staged tries to read configuration from them.

It would probably be a lot faster to use a single explicit config file, if that's all you need:

npx lint-staged --config .lintstagedrc.js

This should hopefully make lint-staged skip trying to read every single possible config file.

[iiroj]

We use git ls-files to list possible config files in the repo. I wonder if adding the --sparse flag here would help:

lint-staged/lib/searchConfigs.js

Line 16 in adf50b0

const EXEC_GIT = ['ls-files', '-z', '--full-name']

[tpluscode]

This should hopefully make lint-staged skip trying to read every single possible config file.

Thank you, that did it! Now lint-staged succeeds without trying to access all those package.json which have not been checked out

We use git ls-files to list possible config files in the repo

Thanks for pointing this out. I found this SO answer, which suggests adding verbose flag to ls-files and filtering by the H flag.

tl;dr;, the above in shell

git ls-files -v | grep -e '^H' | grep 'package.json$'

[iiroj]

Glad to hear it! For now I won't add this extra filtering, but if this issue surfaces again I will look at it again.