Add ignoreFiles option

gitignore.js → ignore.js

@@ -2,7 +2,7 @@ import process from 'node:process';
 import fs from 'node:fs';
 import path from 'node:path';
 import fastGlob from 'fast-glob';
-import gitIgnore from 'ignore';
+import ignore from 'ignore';
 import slash from 'slash';
 import {toPath} from './utilities.js';
 
@@ -35,7 +35,7 @@ const parseGitIgnore = (content, options) => {
 };
 
 const reduceIgnore = files => {
-	const ignores = gitIgnore();
+	const ignores = ignore();
 	for (const file of files) {
 		ignores.add(parseGitIgnore(file.content, {
 			cwd: file.cwd,
@@ -77,21 +77,21 @@ const normalizeOptions = (options = {}) => ({
 	cwd: toPath(options.cwd) || slash(process.cwd()),
 });
 
-export const isGitIgnored = async options => {
+export const isIgnored = async (pattern, options) => {
 	const {cwd} = normalizeOptions(options);
 
-	const paths = await fastGlob('**/.gitignore', {cwd, ...gitignoreGlobOptions});
+	const paths = await fastGlob(pattern, {cwd, ...gitignoreGlobOptions});
 
 	const files = await Promise.all(paths.map(file => getFile(file, cwd)));
 	const ignores = reduceIgnore(files);
 
 	return getIsIgnoredPredicate(ignores, cwd);
 };
 
-export const isGitIgnoredSync = options => {
+export const isIgnoredSync = (pattern, options) => {
 	const {cwd} = normalizeOptions(options);
 
-	const paths = fastGlob.sync('**/.gitignore', {cwd, ...gitignoreGlobOptions});
+	const paths = fastGlob.sync(pattern, {cwd, ...gitignoreGlobOptions});
 
 	const files = paths.map(file => getFileSync(file, cwd));
 	const ignores = reduceIgnore(files);

index.d.ts

@@ -42,11 +42,20 @@ export interface Options extends FastGlobOptionsWithoutCwd {
 
 	/**
 	Respect ignore patterns in `.gitignore` files that apply to the globbed files.
+	This option merges with `ignoreFiles` is both are specified.
 
 	@default false
 	*/
 	readonly gitignore?: boolean;
 
+	/**
+	A glob pattern to look for ignore files, which are then used to ignore globbed files. 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.
+	This option merges with `.gitignore` if both are specified.
+
+	@default undefined
+	*/
+	readonly ignoreFiles?: string | string[];
+
 	/**
 	The current working directory in which to search.
 

index.js

@@ -2,7 +2,7 @@ import fs from 'node:fs';
 import merge2 from 'merge2';
 import fastGlob from 'fast-glob';
 import dirGlob from 'dir-glob';
-import {isGitIgnored, isGitIgnoredSync} from './gitignore.js';
+import {isIgnored, isIgnoredSync} from './ignore.js';
 import {FilterStream, toPath} from './utilities.js';
 
 const isNegative = pattern => pattern[0] === '!';
@@ -52,13 +52,32 @@ const normalizeOptions = (options = {}) => {
 const normalizeArguments = fn => async (patterns, options) => fn(toPatternsArray(patterns), normalizeOptions(options));
 const normalizeArgumentsSync = fn => (patterns, options) => fn(toPatternsArray(patterns), normalizeOptions(options));
 
-const getFilter = async options => createFilterFunction(
-	options.gitignore && await isGitIgnored({cwd: options.cwd}),
-);
+const getIgnoreFilesPatterns = options => {
+	if (!options) {
+		return [];
+	}
 
-const getFilterSync = options => createFilterFunction(
-	options.gitignore && isGitIgnoredSync({cwd: options.cwd}),
-);
+	const patterns = toPatternsArray(options.ignoreFiles || []);
+	if (options.gitignore) {
+		patterns.push('**/.gitignore');
+	}
+
+	return patterns;
+};
+
+const getFilter = async options => {
+	const filePatterns = getIgnoreFilesPatterns(options);
+	return createFilterFunction(
+		filePatterns.length > 0 && await isIgnored(filePatterns, {cwd: options.cwd}),
+	);
+};
+
+const getFilterSync = options => {
+	const filePatterns = getIgnoreFilesPatterns(options);
+	return createFilterFunction(
+		filePatterns.length > 0 && isIgnoredSync(filePatterns, {cwd: options.cwd}),
+	);
+};
 
 const createFilterFunction = isIgnored => {
 	const seen = new Set();
@@ -200,7 +219,6 @@ export const isDynamicPattern = normalizeArgumentsSync(
 export const generateGlobTasks = normalizeArguments(generateTasks);
 export const generateGlobTasksSync = normalizeArgumentsSync(generateTasksSync);
 
-export {
-	isGitIgnored,
-	isGitIgnoredSync,
-} from './gitignore.js';
+export {isIgnored, isIgnoredSync} from './ignore.js';
+export const isGitIgnored = options => isIgnored('**/.gitignore', options);
+export const isGitIgnoredSync = options => isIgnoredSync('**/.gitignore', options);

package.json

@@ -22,7 +22,7 @@
 	"files": [
 		"index.js",
 		"index.d.ts",
-		"gitignore.js",
+		"ignore.js",
 		"utilities.js"
 	],
 	"keywords": [

readme.md

@@ -10,7 +10,7 @@ Based on [`fast-glob`](https://github.com/mrmlnc/fast-glob) but adds a bunch of
 - Multiple patterns
 - Negated patterns: `['foo*', '!foobar']`
 - Expands directories: `foo` → `foo/**/*`
-- Supports `.gitignore`
+- Supports `.gitignore`, or any similar ignore file configuration.
 - Supports `URL` as `cwd`
 
 ## Install
@@ -88,6 +88,17 @@ Default: `false`
 
 Respect ignore patterns in `.gitignore` files that apply to the globbed files.
 
+This option takes precedence over the `ignoreFiles` option.
+
+##### ignoreFiles
+
+Type: `string`\
+Default: `undefined`
+
+A glob pattern to look for ignore files, which are then used to ignore globbed files. 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.
+
+This value is unused if `{ gitignore: true }`, because `gitignore` takes precedence.
+
 ### globbySync(patterns, options?)
 
 Returns `string[]` of matching paths.

tests/globby.js

@@ -237,6 +237,16 @@ test('gitignore option and objectMode option', async t => {
 	t.truthy(result[0].path);
 });
 
+test('respects ignoreFiles string option', async t => {
+	const actual = await runGlobby(t, '*', {gitignore: false, ignoreFiles: '.gitignore', onlyFiles: false});
+	t.false(actual.includes('node_modules'));
+});
+
+test('respects ignoreFiles array option', async t => {
+	const actual = await runGlobby(t, '*', {gitignore: false, ignoreFiles: ['.gitignore'], onlyFiles: false});
+	t.false(actual.includes('node_modules'));
+});
+
 test('`{extension: false}` and `expandDirectories.extensions` option', async t => {
 	for (const temporaryDirectory of getPathValues(temporary)) {
 		t.deepEqual(

tests/gitignore.js → tests/ignore.js

@@ -1,63 +1,65 @@
 import path from 'node:path';
 import test from 'ava';
 import slash from 'slash';
-import {isGitIgnored, isGitIgnoredSync} from '../gitignore.js';
+import {isIgnored, isIgnoredSync} from '../ignore.js';
 import {
 	PROJECT_ROOT,
 	getPathValues,
 } from './utilities.js';
 
-test('gitignore', async t => {
+const gitignorePattern = '**/.gitignore';
+
+test('ignore', async t => {
 	for (const cwd of getPathValues(path.join(PROJECT_ROOT, 'fixtures/gitignore'))) {
 		// eslint-disable-next-line no-await-in-loop
-		const isIgnored = await isGitIgnored({cwd});
-		const actual = ['foo.js', 'bar.js'].filter(file => !isIgnored(file));
+		const ignored = await isIgnored(gitignorePattern, {cwd});
+		const actual = ['foo.js', 'bar.js'].filter(file => !ignored(file));
 		const expected = ['bar.js'];
 		t.deepEqual(actual, expected);
 	}
 });
 
-test('gitignore - mixed path styles', async t => {
+test('ignore - mixed path styles', async t => {
 	const directory = path.join(PROJECT_ROOT, 'fixtures/gitignore');
 	for (const cwd of getPathValues(directory)) {
 		// eslint-disable-next-line no-await-in-loop
-		const isIgnored = await isGitIgnored({cwd});
-		t.true(isIgnored(slash(path.resolve(directory, 'foo.js'))));
+		const ignored = await isIgnored(gitignorePattern, {cwd});
+		t.true(ignored(slash(path.resolve(directory, 'foo.js'))));
 	}
 });
 
-test('gitignore - os paths', async t => {
+test('ignore - os paths', async t => {
 	const directory = path.join(PROJECT_ROOT, 'fixtures/gitignore');
 	for (const cwd of getPathValues(directory)) {
 		// eslint-disable-next-line no-await-in-loop
-		const isIgnored = await isGitIgnored({cwd});
-		t.true(isIgnored(path.resolve(directory, 'foo.js')));
+		const ignored = await isIgnored(gitignorePattern, {cwd});
+		t.true(ignored(path.resolve(directory, 'foo.js')));
 	}
 });
 
-test('gitignore - sync', t => {
+test('ignore - sync', t => {
 	for (const cwd of getPathValues(path.join(PROJECT_ROOT, 'fixtures/gitignore'))) {
-		const isIgnored = isGitIgnoredSync({cwd});
-		const actual = ['foo.js', 'bar.js'].filter(file => !isIgnored(file));
+		const ignored = isIgnoredSync(gitignorePattern, {cwd});
+		const actual = ['foo.js', 'bar.js'].filter(file => !ignored(file));
 		const expected = ['bar.js'];
 		t.deepEqual(actual, expected);
 	}
 });
 
-test('negative gitignore', async t => {
+test('negative ignore', async t => {
 	for (const cwd of getPathValues(path.join(PROJECT_ROOT, 'fixtures/negative'))) {
 		// eslint-disable-next-line no-await-in-loop
-		const isIgnored = await isGitIgnored({cwd});
-		const actual = ['foo.js', 'bar.js'].filter(file => !isIgnored(file));
+		const ignored = await isIgnored(gitignorePattern, {cwd});
+		const actual = ['foo.js', 'bar.js'].filter(file => !ignored(file));
 		const expected = ['foo.js'];
 		t.deepEqual(actual, expected);
 	}
 });
 
-test('negative gitignore - sync', t => {
+test('negative ignore - sync', t => {
 	for (const cwd of getPathValues(path.join(PROJECT_ROOT, 'fixtures/negative'))) {
-		const isIgnored = isGitIgnoredSync({cwd});
-		const actual = ['foo.js', 'bar.js'].filter(file => !isIgnored(file));
+		const ignored = isIgnoredSync(gitignorePattern, {cwd});
+		const actual = ['foo.js', 'bar.js'].filter(file => !ignored(file));
 		const expected = ['foo.js'];
 		t.deepEqual(actual, expected);
 	}
@@ -66,14 +68,14 @@ test('negative gitignore - sync', t => {
 test('multiple negation', async t => {
 	for (const cwd of getPathValues(path.join(PROJECT_ROOT, 'fixtures/multiple-negation'))) {
 		// eslint-disable-next-line no-await-in-loop
-		const isIgnored = await isGitIgnored({cwd});
+		const ignored = await isIgnored(gitignorePattern, {cwd});
 
 		const actual = [
 			'!!!unicorn.js',
 			'!!unicorn.js',
 			'!unicorn.js',
 			'unicorn.js',
-		].filter(file => !isIgnored(file));
+		].filter(file => !ignored(file));
 
 		const expected = ['!!unicorn.js', '!unicorn.js'];
 		t.deepEqual(actual, expected);
@@ -82,14 +84,14 @@ test('multiple negation', async t => {
 
 test('multiple negation - sync', t => {
 	for (const cwd of getPathValues(path.join(PROJECT_ROOT, 'fixtures/multiple-negation'))) {
-		const isIgnored = isGitIgnoredSync({cwd});
+		const ignored = isIgnoredSync(gitignorePattern, {cwd});
 
 		const actual = [
 			'!!!unicorn.js',
 			'!!unicorn.js',
 			'!unicorn.js',
 			'unicorn.js',
-		].filter(file => !isIgnored(file));
+		].filter(file => !ignored(file));
 
 		const expected = ['!!unicorn.js', '!unicorn.js'];
 		t.deepEqual(actual, expected);
@@ -99,15 +101,15 @@ test('multiple negation - sync', t => {
 test('check file', async t => {
 	const directory = path.join(PROJECT_ROOT, 'fixtures/gitignore');
 	const ignoredFile = path.join(directory, 'foo.js');
-	const isIgnored = await isGitIgnored({cwd: directory});
-	const isIgnoredSync = isGitIgnoredSync({cwd: directory});
+	const ignored = await isIgnored(gitignorePattern, {cwd: directory});
+	const ignoredSync = isIgnoredSync(gitignorePattern, {cwd: directory});
 
 	for (const file of getPathValues(ignoredFile)) {
-		t.true(isIgnored(file));
-		t.true(isIgnoredSync(file));
+		t.true(ignored(file));
+		t.true(ignoredSync(file));
 	}
 
 	for (const file of getPathValues(path.join(directory, 'bar.js'))) {
-		t.false(isIgnored(file));
+		t.false(ignored(file));
 	}
 });