Remove output errors to console by default

Author: lahmatiy

Diff for: CHANGELOG.md

@@ -21,8 +21,9 @@
   ```
 
 - Added `resolveSymlinks` option to enable symlink resolving, a symlink resolving is disabled by default
-- Rename `NormRule` type into `MatchRule`
+- Renamed `NormRule` type into `MatchRule`
 - Added `ScanResult` type to define returning type of `scanFs()`
+- Removed output errors to console by default
 
 ## 3.0.0 (2022-06-09)
 

Diff for: README.md

@@ -95,9 +95,9 @@ A value of `options` parameter is a string (which equivalent to `{ basedir: <str
 - **onError**
 
   Type: `function(error)` or `null`  
-  Default: `error => console.error('...', error)`
+  Default: `null`
 
-  A handler that is used when an error is occuring during FS scan or file processing. By default errors output in `stderr`, that's can be disabled by passing another function or a falsy value. Errors also can be reached by `errors` field of a result (i.e. `files.errors`).
+  A handler that is used when an error is occuring during FS scan or file processing. By default nothing happens, but adds to errors `array` which can be reached by `errors` field of a result.
 
 A **rule** is an object with following fields (all are optional):
 

Diff for: src/index.ts

@@ -151,12 +151,7 @@ export function normalizeOptions(options: Options | string = {}): NormalizedOpti
     const resolveSymlinks = Boolean(options.resolveSymlinks);
     const generalInclude = new Set(ensureArray(options.include).map(posixNormalize));
     const generalExclude = new Set(ensureArray(options.exclude).map(posixNormalize));
-    const onError =
-        'onError' in options === false
-            ? (err: Error) => console.error('[@discoveryjs/scan-fs]', err)
-            : typeof options.onError === 'function'
-            ? options.onError
-            : () => {};
+    const onError = typeof options.onError === 'function' ? options.onError : () => {};
 
     const rawRules = ensureArray(options.rules).filter(Boolean);
     const onlyRule = rawRules.find((rule) => rule.only);
@@ -325,7 +320,7 @@ export async function scanFs(options?: Options | string): Promise<ScanResult> {
                 if (extract !== null) {
                     tasks.push(
                         fsPromise
-                            .readFile(basedir + relpath, rule.encoding) // TODO: use encoding from rule config
+                            .readFile(basedir + relpath, rule.encoding)
                             .then((content) => extract(file, content, rule))
                             .catch((error) => {
                                 errors.push((error = scanError('extract', relpath, error)));