feat: suppress eacces option

Author: etnoy

README.md

@@ -33,6 +33,7 @@ This package provides methods for traversing the file system and returning pathn
     * [fs](#fs)
     * [ignore](#ignore)
     * [suppressErrors](#suppresserrors)
+    * [suppressEacces](#suppresseacces)
     * [throwErrorOnBrokenSymbolicLink](#throwerroronbrokensymboliclink)
     * [signal](#signal)
   * [Output control](#output-control)
@@ -397,6 +398,13 @@ By default this package suppress only `ENOENT` errors. Set to `true` to suppress
 
 > :book: Can be useful when the directory has entries with a special level of access.
 
+#### suppressEacces
+
+* Type: `boolean`
+* Default: `false`
+
+By default, the package throws `EACCES` if a path cannot be accessed due to permission erros. Set to `true` to suppress these errors.
+
 #### throwErrorOnBrokenSymbolicLink
 
 * Type: `boolean`

src/providers/filters/error.spec.ts

@@ -52,5 +52,13 @@ describe('Providers → Filters → Error', () => {
 
 			assert.ok(!actual);
 		});
+
+		it('should return false for EACCES error', () => {
+			const filter = getFilter();
+
+			const actual = filter(tests.errno.getEacces());
+
+			assert.ok(!actual);
+		});
 	});
 });

src/providers/filters/error.ts

@@ -15,6 +15,19 @@ export default class ErrorFilter {
 	}
 
 	#isNonFatalError(error: ErrnoException): boolean {
-		return utils.errno.isEnoentCodeError(error) || this.#settings.suppressErrors;
+		if (this.#settings.suppressErrors) {
+			return true;
+		}
+
+		if (this.#settings.errorHandler !== undefined) {
+			this.#settings.errorHandler(error);
+			return true;
+		}
+
+		if (utils.errno.isEnoentCodeError(error)) {
+			return true;
+		}
+
+		return false;
 	}
 }

src/readers/reader.ts

@@ -44,6 +44,14 @@ export abstract class Reader<T> {
 	}
 
 	protected _isFatalError(error: ErrnoException): boolean {
-		return !utils.errno.isEnoentCodeError(error) && !this.#settings.suppressErrors;
+		if (this.#settings.suppressErrors) {
+			return false;
+		}
+
+		if (utils.errno.isEnoentCodeError(error)) {
+			return false;
+		}
+
+		return true;
 	}
 }

src/settings.spec.ts

@@ -18,6 +18,7 @@ describe('Settings', () => {
 		assert.ok(!settings.onlyDirectories);
 		assert.ok(!settings.stats);
 		assert.ok(!settings.suppressErrors);
+		assert.ok(!settings.errorHandler);
 		assert.ok(!settings.throwErrorOnBrokenSymbolicLink);
 		assert.ok(settings.braceExpansion);
 		assert.ok(settings.caseSensitiveMatch);

src/settings.ts

@@ -1,6 +1,6 @@
 import * as fs from 'node:fs';
 
-import type { FileSystemAdapter, Pattern } from './types';
+import type { ErrnoException, FileSystemAdapter, Pattern } from './types';
 
 export const DEFAULT_FILE_SYSTEM_ADAPTER: FileSystemAdapter = {
 	lstat: fs.lstat,
@@ -125,6 +125,12 @@ export interface Options {
 	 * @default false
 	 */
 	suppressErrors?: boolean;
+	/**
+	 * Callback for user-defined error handling. Ignored if `suppressErrors` is `true`.
+	 *
+	 * @default false
+	 */
+	errorHandler?: (error: Error) => void;
 	/**
 	 * Throw an error when symbolic link is broken if `true` or safely
 	 * return `lstat` call if `false`.
@@ -166,6 +172,7 @@ export default class Settings {
 	public readonly onlyFiles: boolean;
 	public readonly stats: boolean;
 	public readonly suppressErrors: boolean;
+	public readonly errorHandler: ((error: ErrnoException) => void) | undefined;
 	public readonly throwErrorOnBrokenSymbolicLink: boolean;
 	public readonly unique: boolean;
 	public readonly signal?: AbortSignal;
@@ -190,7 +197,9 @@ export default class Settings {
 		this.onlyFiles = options.onlyFiles ?? true;
 		this.stats = options.stats ?? false;
 		this.suppressErrors = options.suppressErrors ?? false;
-		this.throwErrorOnBrokenSymbolicLink = options.throwErrorOnBrokenSymbolicLink ?? false;
+		this.errorHandler = options.errorHandler ?? undefined;
+		this.throwErrorOnBrokenSymbolicLink =
+			options.throwErrorOnBrokenSymbolicLink ?? false;
 		this.unique = options.unique ?? true;
 		this.signal = options.signal;
 

src/tests/utils/errno.ts

@@ -14,3 +14,7 @@ export function getEnoent(): ErrnoException {
 export function getEperm(): ErrnoException {
 	return new SystemError('EPERM', 'operation not permitted');
 }
+
+export function getEacces(): ErrnoException {
+	return new SystemError('EACCES', 'permission denied');
+}