Accept URL in function returned by isGitIgnored (#207)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

Author: fisker

gitignore.js

@@ -56,7 +56,7 @@ const ensureAbsolutePathForCwd = (cwd, p) => {
 	return path.join(cwd, p);
 };
 
-const getIsIgnoredPredicate = (ignores, cwd) => p => ignores.ignores(slash(path.relative(cwd, ensureAbsolutePathForCwd(cwd, p.path || p))));
+const getIsIgnoredPredicate = (ignores, cwd) => p => ignores.ignores(slash(path.relative(cwd, ensureAbsolutePathForCwd(cwd, toPath(p.path || p)))));
 
 const getFile = async (file, cwd) => {
 	const filePath = path.join(cwd, file);

gitignore.test.js

@@ -5,10 +5,10 @@ import slash from 'slash';
 import {isGitIgnored, isGitIgnoredSync} from './gitignore.js';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const getCwdValues = cwd => [cwd, pathToFileURL(cwd), pathToFileURL(cwd).href];
+const getPathValues = cwd => [cwd, pathToFileURL(cwd), pathToFileURL(cwd).href];
 
 test('gitignore', async t => {
-	for (const cwd of getCwdValues(path.join(__dirname, 'fixtures/gitignore'))) {
+	for (const cwd of getPathValues(path.join(__dirname, '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));
@@ -19,7 +19,7 @@ test('gitignore', async t => {
 
 test('gitignore - mixed path styles', async t => {
 	const directory = path.join(__dirname, 'fixtures/gitignore');
-	for (const cwd of getCwdValues(directory)) {
+	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'))));
@@ -28,15 +28,15 @@ test('gitignore - mixed path styles', async t => {
 
 test('gitignore - os paths', async t => {
 	const directory = path.join(__dirname, 'fixtures/gitignore');
-	for (const cwd of getCwdValues(directory)) {
+	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')));
 	}
 });
 
 test('gitignore - sync', t => {
-	for (const cwd of getCwdValues(path.join(__dirname, 'fixtures/gitignore'))) {
+	for (const cwd of getPathValues(path.join(__dirname, 'fixtures/gitignore'))) {
 		const isIgnored = isGitIgnoredSync({cwd});
 		const actual = ['foo.js', 'bar.js'].filter(file => !isIgnored(file));
 		const expected = ['bar.js'];
@@ -47,7 +47,7 @@ test('gitignore - sync', t => {
 test('ignore ignored .gitignore', async t => {
 	const ignore = ['**/.gitignore'];
 
-	for (const cwd of getCwdValues(path.join(__dirname, 'fixtures/gitignore'))) {
+	for (const cwd of getPathValues(path.join(__dirname, 'fixtures/gitignore'))) {
 		// eslint-disable-next-line no-await-in-loop
 		const isIgnored = await isGitIgnored({cwd, ignore});
 		const actual = ['foo.js', 'bar.js'].filter(file => !isIgnored(file));
@@ -59,7 +59,7 @@ test('ignore ignored .gitignore', async t => {
 test('ignore ignored .gitignore - sync', t => {
 	const ignore = ['**/.gitignore'];
 
-	for (const cwd of getCwdValues(path.join(__dirname, 'fixtures/gitignore'))) {
+	for (const cwd of getPathValues(path.join(__dirname, 'fixtures/gitignore'))) {
 		const isIgnored = isGitIgnoredSync({cwd, ignore});
 		const actual = ['foo.js', 'bar.js'].filter(file => !isIgnored(file));
 		const expected = ['foo.js', 'bar.js'];
@@ -68,7 +68,7 @@ test('ignore ignored .gitignore - sync', t => {
 });
 
 test('negative gitignore', async t => {
-	for (const cwd of getCwdValues(path.join(__dirname, 'fixtures/negative'))) {
+	for (const cwd of getPathValues(path.join(__dirname, '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));
@@ -78,7 +78,7 @@ test('negative gitignore', async t => {
 });
 
 test('negative gitignore - sync', t => {
-	for (const cwd of getCwdValues(path.join(__dirname, 'fixtures/negative'))) {
+	for (const cwd of getPathValues(path.join(__dirname, 'fixtures/negative'))) {
 		const isIgnored = isGitIgnoredSync({cwd});
 		const actual = ['foo.js', 'bar.js'].filter(file => !isIgnored(file));
 		const expected = ['foo.js'];
@@ -87,7 +87,7 @@ test('negative gitignore - sync', t => {
 });
 
 test('multiple negation', async t => {
-	for (const cwd of getCwdValues(path.join(__dirname, 'fixtures/multiple-negation'))) {
+	for (const cwd of getPathValues(path.join(__dirname, 'fixtures/multiple-negation'))) {
 		// eslint-disable-next-line no-await-in-loop
 		const isIgnored = await isGitIgnored({cwd});
 
@@ -104,7 +104,7 @@ test('multiple negation', async t => {
 });
 
 test('multiple negation - sync', t => {
-	for (const cwd of getCwdValues(path.join(__dirname, 'fixtures/multiple-negation'))) {
+	for (const cwd of getPathValues(path.join(__dirname, 'fixtures/multiple-negation'))) {
 		const isIgnored = isGitIgnoredSync({cwd});
 
 		const actual = [
@@ -118,3 +118,21 @@ test('multiple negation - sync', t => {
 		t.deepEqual(actual, expected);
 	}
 });
+
+test('check file', async t => {
+	const directory = path.join(__dirname, 'fixtures/gitignore');
+	const ignoredFile = path.join(directory, 'foo.js');
+	const isIgnored = await isGitIgnored({cwd: directory});
+	const isIgnoredSync = isGitIgnoredSync({cwd: directory});
+
+	for (const file of getPathValues(ignoredFile)) {
+		t.true(isIgnored(file));
+		t.true(isIgnored({path: file}));
+		t.true(isIgnoredSync(file));
+		t.true(isIgnoredSync({path: file}));
+	}
+
+	for (const file of getPathValues(path.join(directory, 'bar.js'))) {
+		t.false(isIgnored(file));
+	}
+});

index.d.ts

@@ -59,7 +59,7 @@ export interface GitignoreOptions {
 	readonly ignore?: readonly string[];
 }
 
-export type GlobbyFilterFunction = (path: string) => boolean;
+export type GlobbyFilterFunction = (path: URL | string) => boolean;
 
 /**
 Find files and directories using glob patterns.

readme.md

@@ -138,7 +138,7 @@ console.log(isIgnored('some/file'));
 
 ### isGitIgnoredSync(options?)
 
-Returns a `(path: string) => boolean` indicating whether a given path is ignored via a `.gitignore` file.
+Returns a `(path: URL | string) => boolean` indicating whether a given path is ignored via a `.gitignore` file.
 
 Takes the same options as `isGitIgnored`.