Fix ignore option disabling the gitignore option

The `ignore` option was forwarded to the search that looks for the ignore files, so a pattern like `**/.gi*` hid `.gitignore` from it and nothing was ignored at all. It is still forwarded, since that is what keeps the search out of unreadable directories, but the patterns that could name one of the searched ignore files are now dropped.

Fixes #281

Author: sindresorhus

index.d.ts

@@ -46,7 +46,9 @@ export type Options = {
 
 	Gitignore patterns take priority over user patterns, matching Git's behavior. To include gitignored files, set this to `false`.
 
-	Performance: Globby reads `.gitignore` files before globbing. When there are no negation patterns (like `!important.log`) and no parent `.gitignore` files are found, it passes ignore patterns to fast-glob to skip traversing ignored directories entirely, which significantly improves performance for large `node_modules` or build directories. When negation patterns or parent `.gitignore` files are present, all filtering is done after traversal to ensure correct Git-compatible behavior. For optimal performance, prefer specific `.gitignore` patterns without negations, or use `ignoreFiles: '.gitignore'` to target only the root ignore file.
+	The `ignore` option applies to the results only. A pattern that could name an ignore file, such as `'**\/.gitignore'`, is not used when searching for the ignore files, so it hides them from the results without disabling this option.
+
+	Performance: Globby reads `.gitignore` files before globbing and hands fast-glob patterns for the directories it can prove are ignored, so whole ignored directories (like large `node_modules` or build outputs) are skipped during traversal instead of being enumerated and filtered afterwards. This holds even when negation patterns (like `!important.log`) or parent `.gitignore` files are present: only the rules that provably cannot be re-included by a negation are used to skip directories, while the final filtering always matches Git's behavior. To read fewer ignore files, use `ignoreFiles: '.gitignore'` to target only the root ignore file.
 
 	@default false
 	*/
@@ -57,6 +59,8 @@ export type Options = {
 
 	This is a more generic form of the `gitignore` option, allowing you to find ignore files with a [compatible syntax](http://git-scm.com/docs/gitignore). For instance, this works with Babel's `.babelignore`, Prettier's `.prettierignore`, or ESLint's `.eslintignore` files.
 
+	The `ignore` option applies to the results only, as with the `gitignore` option.
+
 	Performance tip: Using a specific path like `'.gitignore'` is much faster than recursive patterns.
 
 	@default undefined
@@ -137,6 +141,8 @@ export type GitignoreOptions = {
 	/**
 	Glob patterns to exclude from ignore file search.
 
+	Unlike the `ignore` option of `globby()`, which applies to the results only, this one excludes files from the search itself, so a pattern that names an ignore file stops that file from being read.
+
 	@default []
 	*/
 	readonly ignore?: string | readonly string[];

index.js

@@ -21,6 +21,7 @@ import {
 	normalizeNegativePattern,
 	adjustIgnorePatternsForParentDirectories,
 	convertPatternsForFastGlob,
+	convertIgnorePatternsForIgnoreFileSearch,
 	findGitRoot,
 	findGitRootSync,
 } from './utilities.js';
@@ -245,6 +246,12 @@ const buildIgnoreFilterResult = ({options, cwd, ignoreResult: {rules, matcher},
 	};
 };
 
+// The ignore files are searched for with the same options as the glob itself, except for `ignore`, which excludes paths from the results and must not decide which ignore files are read. The patterns that cannot hide one are still passed on, so the search keeps skipping the directories they name.
+const getIgnoreFileSearchOptions = (options, searchPatterns) => ({
+	...options,
+	ignore: convertIgnorePatternsForIgnoreFileSearch(options.ignore, searchPatterns),
+});
+
 /**
 Apply ignore files to options and return the filter predicate.
 
@@ -272,7 +279,7 @@ const applyIgnoreFilesAndGetFilter = async options => {
 	// Enable parent .gitignore search when using gitignore option
 	const includeParentIgnoreFiles = options.gitignore === true;
 	const ignoreResult = ignoreFilesPatterns.length > 0
-		? await getIgnorePatternsAndPredicate(ignoreFilesPatterns, options, includeParentIgnoreFiles)
+		? await getIgnorePatternsAndPredicate(ignoreFilesPatterns, getIgnoreFileSearchOptions(options, ignoreFilesPatterns), includeParentIgnoreFiles)
 		: {rules: [], matcher: false};
 
 	const globalGitRoot = globalIgnoreFile ? await findGitRoot(cwd, options.fs) : undefined;
@@ -309,7 +316,7 @@ const applyIgnoreFilesAndGetFilterSync = options => {
 	// Enable parent .gitignore search when using gitignore option
 	const includeParentIgnoreFiles = options.gitignore === true;
 	const ignoreResult = ignoreFilesPatterns.length > 0
-		? getIgnorePatternsAndPredicateSync(ignoreFilesPatterns, options, includeParentIgnoreFiles)
+		? getIgnorePatternsAndPredicateSync(ignoreFilesPatterns, getIgnoreFileSearchOptions(options, ignoreFilesPatterns), includeParentIgnoreFiles)
 		: {rules: [], matcher: false};
 
 	const globalGitRoot = globalIgnoreFile ? findGitRootSync(cwd, options.fs) : undefined;

package.json

@@ -67,6 +67,7 @@
 		"fast-glob": "^3.3.3",
 		"ignore": "^7.0.5",
 		"is-path-inside": "^4.0.0",
+		"micromatch": "^4.0.8",
 		"slash": "^5.1.0",
 		"unicorn-magic": "^0.4.0"
 	},

readme.md

@@ -93,6 +93,8 @@ When enabled, globby searches for `.gitignore` files from the current working di
 
 Gitignore patterns take priority over user patterns, matching Git's behavior. To include gitignored files, set this to `false`.
 
+The `ignore` option applies to the results only. A pattern that could name an ignore file, such as `'**/.gitignore'`, is not used when searching for the ignore files, so it hides them from the results without disabling this option.
+
 **Performance:** Globby reads `.gitignore` files before globbing and hands fast-glob patterns for the directories it can prove are ignored, so whole ignored directories (like large `node_modules` or build outputs) are skipped during traversal instead of being enumerated and filtered afterwards. This holds even when negation patterns (like `!important.log`) or parent `.gitignore` files are present: only the rules that provably cannot be re-included by a negation are used to skip directories, while the final filtering always matches Git's behavior. To read fewer ignore files, use `ignoreFiles: '.gitignore'` to target only the root ignore file.
 
 ##### globalGitignore
@@ -117,6 +119,8 @@ Glob patterns to look for ignore files, which are then used to ignore globbed fi
 
 This is a more generic form of the `gitignore` option, allowing you to find ignore files with a [compatible syntax](http://git-scm.com/docs/gitignore). For instance, this works with Babel's `.babelignore`, Prettier's `.prettierignore`, or ESLint's `.eslintignore` files.
 
+The `ignore` option applies to the results only, as with the [`gitignore`](#gitignore) option.
+
 **Performance tip:** Using a specific path like `'.gitignore'` is much faster than recursive patterns.
 
 ##### expandNegationOnlyPatterns
@@ -248,6 +252,8 @@ Default: `[]`
 
 Glob patterns to exclude from `.gitignore` file search.
 
+Unlike the `ignore` option of [`globby()`](#options), which applies to the results only, this one excludes files from the search itself, so a pattern that names an ignore file stops that file from being read.
+
 ##### followSymbolicLinks
 
 Type: `boolean`\

tests/globby.js

@@ -24,6 +24,7 @@ import {
 	getPathValues,
 	invalidPatterns,
 	isUnique,
+	runGlobby,
 } from './utilities.js';
 
 const cwd = process.cwd();
@@ -39,39 +40,6 @@ const fixture = [
 	'e.tmp',
 ];
 
-const stabilizeResult = result => result
-	.map(fastGlobResult => {
-		// In `objectMode`, `fastGlobResult.dirent` contains a function that makes `t.deepEqual` assertion fail.
-		// `fastGlobResult.stats` contains different `atime`.
-		if (typeof fastGlobResult === 'object') {
-			const {dirent, stats, ...rest} = fastGlobResult;
-			return rest;
-		}
-
-		return fastGlobResult;
-	})
-	.sort((a, b) => (a.path ?? a).localeCompare(b.path ?? b));
-
-const runGlobby = async (t, patterns, options) => {
-	const syncResult = globbySync(patterns, options);
-	const promiseResult = await globby(patterns, options);
-	const streamResult = await globbyStream(patterns, options).toArray();
-
-	const result = stabilizeResult(promiseResult);
-	t.deepEqual(
-		stabilizeResult(syncResult),
-		result,
-		'globbySync() result is different than globby()',
-	);
-	t.deepEqual(
-		stabilizeResult(streamResult),
-		result,
-		'globbyStream() result is different than globby()',
-	);
-
-	return promiseResult;
-};
-
 const blockNodeModulesTraversal = directory => {
 	const normalizedDirectory = path.normalize(directory);
 	const directoryPrefix = `${normalizedDirectory}${path.sep}`;