Get rid of gitDir config option and be smart about it

[okonet]

Ideally, users with complex setup should not suffer trying to setup lint-staged right. There are plenty of issues related just to that:

• Clarify gitDir usage? #270
• gitDir ignored while doing a git rebase #144
• Working in a subdirectory #171
• Error with relative paths #143
• jest can't find babel when i'm using gitDir #158
  etc.

I'm wondering if resolving to git root and taking care of execution context automatically would make gitDir option obsolete and solve all those issues and make the DX even better?

⚠︎ This issue is meant to be a discussion before proceeding with the actual implementation.

cc @ai @FezVrasta

[sudo-suhas]

Is it as simple as keep looking in the parent directory until you encounter a git repo?

[okonet]

Well, that's why I created the issue. I don't know yet but it seems like it. I'm probably missing something. For instance there are users with a very unconventional setup #232 so I don't know how it will affect them yet.

[FezVrasta]

If you are going to make this change you'll also want to change the way the glob patterns are matched (changing the root dir to the actual package.json folder and not the .git folder anymore).

[okonet]

@FezVrasta I'm not sure about that... Why do you think so?

Let's keep this discussion inside your original issue.

[frontsideair]

The git dir can be found the same way husky finds it, and the dependencies are already installed too.

[okonet]

@frontsideair yeah, that is what I was thinking about. I'm not concerned about the implementation but about possible side-effects for some users. But it seems to be safe.

[mattfysh]

Anything I can do to help move this along? Looking at using lerna, yarn workspaces, husky and lint-staged together with multiple packages stored in <gitroot>/packages/app-name

[okonet]

@mattfysh do you think the proposed solution will work? You could create a PR by looking at how husky does it. Probably there is an npm package to do that ;)

[mattfysh]

I think I'll try to tackle this over the weekend using:

• https://www.npmjs.com/package/find-parent-dir
• path.relative to get path of package relative to git
• combine glob in linters config with relative path to package, before checking against absolute paths of staged files