Merge pull request #450 from mrmlnc/ISSUE-438_only_files

ISSUE-438: Exclude only directories with enabled the `onlyFiles` option

Author: mrmlnc

README.md

@@ -472,7 +472,7 @@ fg.globSync('*', { onlyDirectories: true });  // ['src']
 * Type: `boolean`
 * Default: `true`
 
-Return only files.
+Return everything (file, socket, …) except directories.
 
 ```js
 fg.globSync('*', { onlyFiles: false }); // ['index.js', 'src']

src/providers/filters/entry.spec.ts

@@ -17,6 +17,7 @@ interface FilterOptions {
 }
 
 const FILE_ENTRY = tests.entry.builder().path('root/file.txt').file().build();
+const SOCKET_ENTRY = tests.entry.builder().path('/tmp/test.sock').socket().build();
 const DIRECTORY_ENTRY = tests.entry.builder().path('root/directory').directory().build();
 
 function getEntryFilterInstance(options?: Options): EntryFilter {
@@ -137,6 +138,13 @@ describe('Providers → Filters → Entry', () => {
 					options: { onlyFiles: true },
 				});
 			});
+
+			it('should accept a socket entry', () => {
+				accept(SOCKET_ENTRY, {
+					positive: ['**/*'],
+					options: { onlyFiles: true },
+				});
+			});
 		});
 
 		describe('options.onlyDirectories', () => {
@@ -147,6 +155,13 @@ describe('Providers → Filters → Entry', () => {
 				});
 			});
 
+			it('should reject a socket entry', () => {
+				reject(SOCKET_ENTRY, {
+					positive: ['**/*'],
+					options: { onlyDirectories: true },
+				});
+			});
+
 			it('should accept a directory entry', () => {
 				accept(DIRECTORY_ENTRY, {
 					positive: ['**/*'],

src/providers/filters/entry.ts

@@ -47,11 +47,13 @@ export default class EntryFilter {
 			return false;
 		}
 
-		if (this.#onlyFileFilter(entry) || this.#onlyDirectoryFilter(entry)) {
+		const isDirectory = entry.dirent.isDirectory();
+
+		if (this.#onlyFileFilter(isDirectory) || this.#onlyDirectoryFilter(isDirectory)) {
 			return false;
 		}
 
-		const isMatched = this.#isMatchToPatternsSet(filepath, pattens, entry.dirent.isDirectory());
+		const isMatched = this.#isMatchToPatternsSet(filepath, pattens, isDirectory);
 
 		if (this.#settings.unique && isMatched) {
 			this.#createIndexRecord(filepath);
@@ -68,12 +70,12 @@ export default class EntryFilter {
 		this.index.set(filepath, undefined);
 	}
 
-	#onlyFileFilter(entry: Entry): boolean {
-		return this.#settings.onlyFiles && !entry.dirent.isFile();
+	#onlyFileFilter(isDirectory: boolean): boolean {
+		return this.#settings.onlyFiles && isDirectory;
 	}
 
-	#onlyDirectoryFilter(entry: Entry): boolean {
-		return this.#settings.onlyDirectories && !entry.dirent.isDirectory();
+	#onlyDirectoryFilter(isDirectory: boolean): boolean {
+		return this.#settings.onlyDirectories && !isDirectory;
 	}
 
 	#isMatchToPatternsSet(filepath: string, patterns: PatternsRegexSet, isDirectory: boolean): boolean {

src/tests/e2e/patterns/root.e2e.ts

@@ -22,21 +22,22 @@ function getRootEntries(root: string, withBase: boolean = false): string[] {
 function getRootEntriesWithFileTypes(root: string): string[] {
 	return fs.readdirSync(root, { withFileTypes: true })
 		.filter((item) => !item.name.startsWith('.'))
-		.filter((item) => item.isFile())
+		.filter((item) => !item.isDirectory())
 		.map((item) => item.name);
 }
 
 runner.suite('Patterns Root', {
 	tests: [
 		{
 			pattern: '/*',
+			options: { followSymbolicLinks: false },
 			condition: () => !utils.platform.isWindows(),
 			expected: () => getRootEntries(ROOT, /** withBase */ true),
 		},
 		{
-			pattern: '/tmp/*',
+			pattern: '/usr/*',
 			condition: () => !utils.platform.isWindows(),
-			expected: () => getRootEntries('/tmp', /** withBase */ true),
+			expected: () => getRootEntries('/usr', /** withBase */ true),
 		},
 		{
 			pattern: '/*',
@@ -58,6 +59,7 @@ runner.suite('Patterns Root (cwd)', {
 			pattern: '*',
 			options: {
 				cwd: ROOT,
+				followSymbolicLinks: false,
 			},
 			condition: () => !utils.platform.isWindows(),
 			expected: () => getRootEntries(ROOT),

src/tests/utils/entry.ts

@@ -38,6 +38,12 @@ class EntryBuilder {
 		return this;
 	}
 
+	public socket(): this {
+		this.#entryType = DirentType.Socket;
+
+		return this;
+	}
+
 	public stats(): this {
 		this.#entry.stats = new Stats();