Respect gitignore files from parent directories #107

dflupu · 2019-01-24T21:17:54Z

Fixes #86

wavebeem · 2019-04-06T22:34:34Z

I just came here to work on this issue and here's a PR already! This would really help out my jsx-info project.

sindresorhus · 2020-01-06T09:18:24Z

@dflupu Hey, sorry. I totally missed this PR... If you're still interested, would you be able to fix the merge conflict and add some more tests?

dflupu · 2020-01-07T16:30:14Z

Sure, I'll have it fixed up in the next few days.

dflupu · 2020-01-08T15:27:33Z

@sindresorhus I've updated the PR. Let me know what you think.

sindresorhus · 2020-02-22T17:37:23Z

gitignore.js

-const getIsIgnoredPredecate = (ignores, cwd) => {
-	return p => ignores.ignores(slash(path.relative(cwd, ensureAbsolutePathForCwd(cwd, p))));
+const getIsIgnoredPredecate = (ignores, gitRoot, cwd) => {
+	return p => {


Use a descriptive variable name.

sindresorhus · 2020-02-22T17:37:31Z

gitignore.js

-	return getIsIgnoredPredecate(ignores, options.cwd);
+	const {cwd} = options;
+
+	const gitDir = await findUp('.git', {cwd});


Suggested change

const gitDir = await findUp('.git', {cwd});

const gitDirectory = await findUp('.git', {cwd});

sindresorhus · 2020-02-22T17:42:20Z

gitignore.js

+	]);
+
+	const gitIgnoreFileContents = await Promise.all(
+		[].concat(...gitIgnoreFilePaths)


Can you add a TODO comment about using flatMap here when we target Node.js 12?

I assume we do [].concat(...gitIgnoreFilePaths) because it's nested arrays?

sindresorhus · 2020-02-22T17:42:44Z

gitignore.js

+	]);
+
+	const gitIgnoreFileContents = await Promise.all(
+		[].concat(...gitIgnoreFilePaths)


I assume we do [].concat(...gitIgnoreFilePaths) because it's nested arrays?

sindresorhus · 2020-02-22T17:44:00Z

The new behavior needs to be documented in the readme and index.d.ts.

And it would be good with some integrations tests that uses globby() and not gitignore().

sindresorhus · 2020-03-04T01:53:34Z

I'm also concerned that this will further worsen the performance, see: #50 (comment)

dflupu · 2020-03-08T12:37:22Z

I'm also concerned that this will further worsen the performance, see: #50 (comment)

I've done a bit of testing, and that may happen in some circumstances. Globbing small directory trees (eg <5 directories, <100 files) using the sync function may be up to 3x slower. It does however become less measurable when globbing larger directory trees.

The async function is pretty much unaffected when it comes to performance - unless there is a huge gitignore file in a parent directory.

Note that the main reason as to why the gitignore option is slow in the first place seems to be the globbing for gitignore files in subdirectories. Maybe that could be avoided in some way? How about checking for gitignore files only in directories and parent directories of files that were matched by the users' glob expression? Some kind of callback from fast-glob whenever it wants to descend into a directory that tells it whether or not it should do that could also work.

sindresorhus · 2020-03-09T08:36:20Z

Maybe that could be avoided in some way? How about checking for gitignore files only in directories and parent directories of files that were matched by the users' glob expression? Some kind of callback from fast-glob whenever it wants to descend into a directory that tells it whether or not it should do that could also work.

Yes, I think that would be smart.

sindresorhus · 2020-03-09T08:37:26Z

Some kind of callback from fast-glob whenever it wants to descend into a directory that tells it whether or not it should do that could also work.

Could you open an issue on fast-glob about this use-case? Maybe there are other things fast-glob could do to make this easier.

sindresorhus · 2020-09-29T22:36:20Z

@dflupu Bump

dflupu · 2020-10-02T02:38:11Z

@sindresorhus I've opened an issue on fast-glob at some point but nothing came out of that. I've also benchmarked a few different ways of dealing with the gitignore stuff and there was no clear winner. What worked better was tied to a lot of variables such as how many files were in the project, how complex the gitignore files were and also disk/cpu speed.

sindresorhus · 2020-10-12T17:22:06Z

I've opened an issue on fast-glob at some point but nothing came out of that.

Can you share a link to the issue?

sindresorhus · 2020-10-12T17:22:15Z

How do we move forward with this PR?

dflupu · 2020-10-22T18:29:37Z

Here's the fast-glob issue. I'll mention that I've tried using @nodelib/fs.walk as the author suggested, and I've also partially implemented the functionality requested in the issue. Neither was an all-around clear winner in terms of performance (I don't remember the exact details as it's been a while).

I see a few options for this PR:

Include it under an optional flag
Keep it around until the overall performance of the gitignore option is somehow improved
Close it. Maybe someone else will pick up this up in the future if there's no open PR, and they'll also manage to somehow improve the performance of the gitignore option

sindresorhus · 2021-03-07T11:15:10Z

I'm going to close as it doesn't look like something will happen with this anytime soon.

#86 (comment)

dflupu force-pushed the git-repo-up branch 3 times, most recently from 8159ac0 to ac501b6 Compare January 8, 2020 15:12

include gitignore files from parent dirs

90947fe

dflupu force-pushed the git-repo-up branch from ac501b6 to 90947fe Compare January 8, 2020 15:20

dflupu requested a review from sindresorhus January 19, 2020 12:00

sindresorhus requested changes Feb 22, 2020

View reviewed changes

sindresorhus reviewed Feb 22, 2020

View reviewed changes

sindresorhus requested changes Feb 22, 2020

View reviewed changes

sindresorhus changed the title ~~include gitignore files from parent dirs~~ Adhere to gitignore files from parent directories Feb 22, 2020

sindresorhus changed the title ~~Adhere to gitignore files from parent directories~~ Respect gitignore files from parent directories Feb 22, 2020

dflupu added 2 commits March 8, 2020 15:32

add some tests, docs, fix variable names

d4c171b

trigger travis rebuild

7c27c53

Base automatically changed from master to main January 23, 2021 11:37

sindresorhus mentioned this pull request Mar 7, 2021

Respect gitignore from above #86

Open

sindresorhus closed this Mar 7, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Respect gitignore files from parent directories #107

Respect gitignore files from parent directories #107

dflupu commented Jan 24, 2019

wavebeem commented Apr 6, 2019

sindresorhus commented Jan 6, 2020 •

edited

Loading

dflupu commented Jan 7, 2020

dflupu commented Jan 8, 2020

sindresorhus Feb 22, 2020

sindresorhus Feb 22, 2020

sindresorhus Feb 22, 2020

sindresorhus Feb 22, 2020

sindresorhus Feb 22, 2020

sindresorhus commented Feb 22, 2020

sindresorhus commented Mar 4, 2020

dflupu commented Mar 8, 2020 •

edited

Loading

sindresorhus commented Mar 9, 2020

sindresorhus commented Mar 9, 2020

sindresorhus commented Sep 29, 2020

dflupu commented Oct 2, 2020

sindresorhus commented Oct 12, 2020

sindresorhus commented Oct 12, 2020

dflupu commented Oct 22, 2020

sindresorhus commented Mar 7, 2021

	const gitDir = await findUp('.git', {cwd});
	const gitDirectory = await findUp('.git', {cwd});

Respect gitignore files from parent directories #107

Respect gitignore files from parent directories #107

Conversation

dflupu commented Jan 24, 2019

wavebeem commented Apr 6, 2019

sindresorhus commented Jan 6, 2020 • edited Loading

dflupu commented Jan 7, 2020

dflupu commented Jan 8, 2020

sindresorhus Feb 22, 2020

Choose a reason for hiding this comment

sindresorhus Feb 22, 2020

Choose a reason for hiding this comment

sindresorhus Feb 22, 2020

Choose a reason for hiding this comment

sindresorhus Feb 22, 2020

Choose a reason for hiding this comment

sindresorhus Feb 22, 2020

Choose a reason for hiding this comment

sindresorhus commented Feb 22, 2020

sindresorhus commented Mar 4, 2020

dflupu commented Mar 8, 2020 • edited Loading

sindresorhus commented Mar 9, 2020

sindresorhus commented Mar 9, 2020

sindresorhus commented Sep 29, 2020

dflupu commented Oct 2, 2020

sindresorhus commented Oct 12, 2020

sindresorhus commented Oct 12, 2020

dflupu commented Oct 22, 2020

sindresorhus commented Mar 7, 2021

sindresorhus commented Jan 6, 2020 •

edited

Loading

dflupu commented Mar 8, 2020 •

edited

Loading