filter-scan-dir 1.4.1 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# v1.5.0
+
+- add `fullStat` option to allow enable using the `withFileTypes` option of readdir for huge performance boost (requires node.js 10.10+) [node.js docs](https://nodejs.org/api/fs.html#fsreaddirpath-options-callback).
+- add `concurrency` option to allow using concurrent mode in async version for massive performance boost.
+- convert to typescript
+
+# v1.4.1
+
+- use fs.lstat instead of fs.stat
+
+# v1.4.0
+
+- process files before directories
+
 # v1.3.0
 
 - `sortFiles` option

package/README.md

@@ -12,6 +12,11 @@
 
 Recursively scan and filter directory for a flat array of files.
 
+- Supports super fast concurrent mode in async version.
+
+- **[API Docs](https://jchip.github.io/filter-scan-dir/modules.html#filterScanDir)**
+- **[Github](https://github.com/jchip/filter-scan-dir)**
+
 # Install
 
 ```bash
@@ -20,105 +25,16 @@ npm install --save filter-scan-dir
 
 # Usage
 
-```js
-const filterScanDir = require("filter-scan-dir");
+```ts
+import { filterScanDir, filterScanDirSync } from "filter-scan-dir";
 
 // sync
-const files = filterScanDir.sync({ cwd: "test" });
-console.log(files);
+console.log(filterScanDirSync({ cwd: "test" }));
 
 // async
-filterScanDir({ cwd: "test" }).then((files) => {
-  console.log(files);
-});
-
 console.log(await filterScanDir({ cwd: "test" }));
 ```
 
-## API
-
-`filterScanDir(options)` or `filterScanDir(dir)`
-
-Sync version: `filterScanDir.sync`
-
-`options`:
-
-| name           | description                                                                | default         |
-| -------------- | -------------------------------------------------------------------------- | --------------- |
-| `cwd`          | current working directory to start scanning                                | `process.cwd()` |
-| `prefix`       | prefix to add to the paths to scan                                         |                 |
-| `prependCwd`   | prepend CWD to paths returned                                              | `false`         |
-| `sortFiles`    | sort files from each dir if `true`.                                        | `false`         |
-| `filter`       | callback to filter files. it should return filter result.                  |                 |
-| `ignoreExt`    | array or string of extensions to ignore. ext must include `.`, ie: `".js"` |                 |
-| `filterExt`    | array or string of extensions to include only, apply after `ignoreExt`.    |                 |
-| `filterDir`    | callback to filter directories. it should return filter result             |                 |
-| `includeDir`   | include directories in result if `true`                                    |                 |
-| `grouping`     | enable [grouping](#grouping) if `true`                                     |                 |
-| `maxLevel`     | zero base max level of directories to recurse into                         | `Infinity`      |
-| `rethrowError` | set to `true` to throw errors instead of ignoring them                     | `false`         |
-
-`filterDir` and `filter` callback signature:
-
-```js
-function filter(file, path, extras) {}
-```
-
-params:
-
-| name              | description                                    |
-| ----------------- | ---------------------------------------------- |
-| `file`            | name of the file being considered              |
-| `path`            | path to directory being processed              |
-| `extras.stat`     | result of `fs.stat` on the file                |
-| `extras.dirFile`  | `Path.join(path, file)`                        |
-| `extras.ext`      | extension of the file including `.`, ie: `.js` |
-| `extras.noExt`    | file name without the extension                |
-| `extras.fullFile` | `Path.join(cwd, path, file)`                   |
-
-should return filter result:
-
-- `false` - skip the file or directory
-- _string_ - name of the group to add the file or directory (need to enable [grouping](#grouping))
-- _object_ - `{ group, skip, stop, formatName }` where:
-  - `group` - name of the group to add the file or directory (need to enable [grouping](#grouping))
-  - `skip` - if `true` then skip the file or directory, else add it.
-  - `stop` - stop the scanning and return the result immediately.
-  - `formatName` - if not `undefined`, then use this as the value to add to the output.
-
-## grouping
-
-If `grouping` is true, then the results will be grouped in an object.
-
-The `filter` and `filterDir` callback can return a non-empty string as the label of a group.
-
-Assuming `filter` returns `"group1"` and `"group2"` for some files, the return value will be an object:
-
-```js
-{
-  // default group, when filter callback returns non-string truthy value
-  files: [ "foo" ],
-  // other groups
-  group1: [ "file1" ],
-  group2: [ "file2" ]
-}
-```
-
-## Path Separator
-
-By default all paths generated always use forward slash `/` as separator, even on Windows.
-
-If you really want to force using Windows `\`, then you can pass in `options._path`:
-
-```js
-const path = require("path");
-scanDir({ cwd: "test", _path: path });
-```
-
-> Internally this is default to `require("path").posix`.
-
-If you only want to keep `\` in the dir you passed in, then you can just set `_path` to `path.posix`.
-
 # License
 
 Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)

package/dist/filter-scan-dir.d.ts

@@ -0,0 +1,126 @@
+/// <reference types="node" />
+import { Dirent, Stats } from "fs";
+/**
+ * type of the 3rd argument for the filter callback
+ */
+export declare type ExtrasData = {
+    /** name of the file being considered */
+    file: string;
+    /** path to the directory being processed that contains the file  */
+    path: string;
+    /** result from fs.lstat or readdir */
+    stat: Dirent | Stats;
+    /** full path with cwd + path + file  */
+    fullFile: string;
+    /** path to file without cwd: path + file */
+    dirFile: string;
+    /** extsion of the file, ie: `.js` */
+    ext: string;
+    /** file name without the extension */
+    noExt: string;
+};
+/**
+ * Info from the filter callback to indicate what to do next
+ */
+export declare type FilterInfo = {
+    /** name of the group to add the file or directory (if grouping is enabled) */
+    group?: string;
+    /** if `true` then skip the file or directory, else add it */
+    skip?: boolean;
+    /** stop the scanning and return the result immediately. */
+    stop?: boolean;
+    /** if not `undefined`, then use this as the value to add to the output */
+    formatName?: string;
+};
+/**
+ * result from the filter callback
+ * - `false` or `undefined` - skip the file or directory
+ * - `true` - include the file in the default result
+ * - _string_ - name of the group to add the file or directory (if grouping is enabled)
+ * - _FilterInfo_ - see type {@link FilterInfo} for details
+ */
+export declare type FilterResult = boolean | string | FilterInfo;
+/**
+ * filter callback for file or directory entry
+ * @param file - name of the file/dir being considered
+ * @param path - path to the directory containing the file. Not the full path,
+ *    just the relative path from CWD.  It's empty string for the files in the
+ *    first level directory.
+ * @param extras - extras data
+ */
+export declare type FilterCallback = (file: string, path: string, extras: ExtrasData) => FilterResult;
+/**
+ * Options for filterScanDir
+ */
+export declare type Options = {
+    /** current working directory to start scanning */
+    cwd?: string;
+    /**
+     * prefix to add to the paths to scan.  It's applied after `cwd`.
+     * - The `prefix` will be in the resulting paths.  Useful if you want
+     *   to scan a dir further down from `cwd` but you don't want to prepend
+     *   CWD to the resulting paths.
+     */
+    prefix?: string;
+    /** prepend CWD to paths returned */
+    prependCwd?: boolean;
+    /** sort files from each dir */
+    sortFiles?: boolean;
+    /** include directories in result */
+    includeDir?: boolean;
+    /** enable grouping of files */
+    grouping?: boolean;
+    /** zero base max level of directories to recurse into. Default: `Infinity`  */
+    maxLevel?: number;
+    /**
+     * use `fs.lstat` to get stat of each file, instead of `readir`'s `withFileTypes` option.
+     *
+     * - *Default*: `true` - for significant performance improvement, set this to `false`
+     *
+     */
+    fullStat?: boolean;
+    /**
+     * for async version only - numer of directories to process concurrently. *Default*: `50`
+     *
+     * - Set this to `0` or `1` to disable concurrent mode
+     *
+     * NOTE: setting this to a very large number, or `Infinity`, could potentially
+     * increase performance very significantly, however, there is a dimishing return
+     * and more memory usage, so the default is already fairly good.
+     */
+    concurrency?: number;
+    /** set to `true` to throw errors instead of ignoring them */
+    rethrowError?: boolean;
+    /** callback to filter files. */
+    filter?: FilterCallback;
+    /** callback to filter directories. */
+    filterDir?: FilterCallback;
+    /** array or string of extensions to ignore. ext must include `.`, ie: `".js"` */
+    ignoreExt?: string | string[];
+    /** array or string of extensions to include only, apply after `ignoreExt` */
+    filterExt?: string | string[];
+    /**
+     * path separator to use to join entries
+     *
+     * - *Default*: `path.posix.sep`
+     * - If you didn't specify this, then `cwd` is automatically converted to use `/`.
+     */
+    pathSep?: string;
+};
+/**
+ * The scanned result if grouping is enabled.
+ *
+ * - The default `files` group will contain all files not assigned a group
+ * - All other files with a group will be assigned to that field
+ */
+export declare type GroupingResult = {
+    files: string[];
+} & Record<string, string[]>;
+/**
+ * async version of filter scan dir
+ * @param options
+ * @returns
+ */
+export declare function filterScanDir(options?: string | Options): Promise<string[] | GroupingResult>;
+/** sync version of filter scan dir */
+export declare function filterScanDirSync(options?: string | Options): string[] | GroupingResult;

package/dist/filter-scan-dir.js

@@ -0,0 +1,357 @@
+"use strict";
+/* eslint-disable max-statements, complexity, comma-dangle, max-params, max-depth */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterScanDirSync = exports.filterScanDir = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const util_1 = __importDefault(require("util"));
+function makeExtrasData(file, fullFile, path, stat, options) {
+    const dirFile = options._join2(path, file);
+    const ix = file.lastIndexOf(".");
+    if (ix > 0) {
+        return {
+            file,
+            path,
+            stat,
+            fullFile,
+            dirFile,
+            ext: file.substring(ix),
+            noExt: file.substring(0, ix),
+        };
+    }
+    else {
+        return {
+            file,
+            path,
+            stat,
+            fullFile,
+            dirFile,
+            ext: "",
+            noExt: file,
+        };
+    }
+}
+/**
+ * Add a file entry to the result
+ *
+ * @param result
+ * @param options
+ * @param extras
+ */
+function addResult(result, options, extras) {
+    const group = (options.grouping && typeof result === "string" ? result : result && result.group) || "files";
+    if (!options.result[group]) {
+        options.result[group] = [];
+    }
+    if (result.formatName !== undefined) {
+        options.result[group].push(result.formatName);
+    }
+    else {
+        options.result[group].push(options.prependCwd ? extras.fullFile : extras.dirFile);
+    }
+}
+/**
+ * Process a directory entry
+ *
+ * @param options
+ * @param extras
+ * @returns
+ */
+function processDir(options, extras) {
+    const filterResult = options.filterDir
+        ? options.filterDir(extras.file, extras.path, extras)
+        : true;
+    if (filterResult) {
+        if (filterResult.skip !== true && options.includeDir) {
+            addResult(filterResult, options, extras);
+        }
+        return { stop: filterResult.stop, skip: filterResult.skip };
+    }
+    return { stop: false, skip: true };
+}
+/**
+ * process a file entry
+ *
+ * @param options
+ * @param extras
+ * @returns
+ */
+function processFile(options, extras) {
+    if (options.ignoreExt.length > 0 && options.ignoreExt.indexOf(extras.ext) >= 0) {
+        return false;
+    }
+    if (options.filterExt.length > 0 && options.filterExt.indexOf(extras.ext) < 0) {
+        return false;
+    }
+    const filterResult = options.filter ? options.filter(extras.file, extras.path, extras) : true; // default to include
+    if (filterResult) {
+        if (filterResult.skip !== true) {
+            addResult(filterResult, options, extras);
+        }
+        return filterResult.stop;
+    }
+    return false;
+}
+/**
+ * get the result base on grouping enable flag
+ *
+ * @param options
+ * @returns
+ */
+function getResult(options) {
+    return options.grouping
+        ? Object.assign({ files: [] }, options.result)
+        : options.result.files || [];
+}
+/**
+ * compare Dirent for sorting
+ *
+ * @param a
+ * @param b
+ * @returns
+ */
+const direntCmp = (a, b) => {
+    /* istanbul ignore next */
+    if (a.name === b.name) {
+        /* istanbul ignore next */
+        return 0;
+        /* istanbul ignore next */
+    }
+    else if (a.name > b.name) {
+        /* istanbul ignore next */
+        return 1;
+    }
+    else {
+        /* istanbul ignore next */
+        return -1;
+    }
+};
+/**
+ * sync version of directory walk
+ *
+ * @param path
+ * @param options
+ * @param level
+ * @returns
+ */
+function walkSync(path, options, level = 0) {
+    try {
+        const dir = options._join2(options.dir, path);
+        let files = fs_1.default.readdirSync(dir, options.readdirOpts);
+        if (options.sortFiles) {
+            if (options.fullStat) {
+                files = files.sort();
+            }
+            else {
+                files = files.sort(direntCmp);
+            }
+        }
+        const dirs = [];
+        let stop = false;
+        // process files first
+        for (let ix = 0; !stop && ix < files.length; ix++) {
+            const file = files[ix];
+            let extras;
+            if (options.fullStat) {
+                const fullFile = options._join2(dir, file);
+                const stat = fs_1.default.lstatSync(fullFile);
+                extras = makeExtrasData(file, fullFile, path, stat, options);
+            }
+            else {
+                const fullFile = options._join2(dir, file.name);
+                extras = makeExtrasData(file.name, fullFile, path, file, options);
+            }
+            if (extras.stat.isDirectory()) {
+                dirs.push(extras);
+            }
+            else {
+                stop = processFile(options, extras);
+            }
+        }
+        // now process dirs
+        if (!stop && dirs.length > 0) {
+            for (let ix = 0; ix < dirs.length; ix++) {
+                const extras = dirs[ix];
+                const flags = processDir(options, extras);
+                if (flags.stop) {
+                    break;
+                }
+                if (!flags.skip && level < options.maxLevel) {
+                    walkSync(extras.dirFile, options, level + 1);
+                }
+            }
+        }
+    }
+    catch (err) {
+        if (options.rethrowError) {
+            throw err;
+        }
+    }
+    return getResult(options);
+}
+const asyncReaddir = util_1.default.promisify(fs_1.default.readdir);
+const asyncLStat = util_1.default.promisify(fs_1.default.lstat);
+/**
+ * async version of dir walk
+ *
+ * @param path
+ * @param options
+ * @param level
+ * @returns
+ */
+async function walk(path, options, level = 0) {
+    try {
+        const dir = options._join2(options.dir, path);
+        let files = await asyncReaddir(dir, options.readdirOpts);
+        if (options.sortFiles) {
+            if (options.fullStat) {
+                files = files.sort();
+            }
+            else {
+                files = files.sort(direntCmp);
+            }
+        }
+        const dirs = [];
+        let stop = false;
+        // process files first
+        for (let ix = 0; !stop && ix < files.length; ix++) {
+            const file = files[ix];
+            let extras;
+            if (options.fullStat) {
+                const fullFile = options._join2(dir, file);
+                const stat = await asyncLStat(fullFile);
+                extras = makeExtrasData(file, fullFile, path, stat, options);
+            }
+            else {
+                const fullFile = options._join2(dir, file.name);
+                extras = makeExtrasData(file.name, fullFile, path, file, options);
+            }
+            if (extras.stat.isDirectory()) {
+                dirs.push(extras);
+            }
+            else {
+                stop = processFile(options, extras);
+            }
+        }
+        // now process dirs
+        if (!stop && dirs.length > 0) {
+            let promises = [];
+            for (let ix = 0; ix < dirs.length; ix++) {
+                const extras = dirs[ix];
+                const flags = processDir(options, extras);
+                if (flags.stop) {
+                    break;
+                }
+                if (!flags.skip && level < options.maxLevel) {
+                    const walkP = walk(extras.dirFile, options, level + 1);
+                    if (options.concurrency > 1) {
+                        if (options._concurrentCount < options.concurrency) {
+                            options._concurrentCount++;
+                            promises.push(walkP);
+                        }
+                        else if (promises.length) {
+                            await Promise.all(promises);
+                            options._concurrentCount -= promises.length;
+                            promises = [walkP];
+                            options._concurrentCount++;
+                        }
+                        else {
+                            await walkP;
+                        }
+                    }
+                    else {
+                        await walkP;
+                    }
+                }
+            }
+            if (promises.length) {
+                await Promise.all(promises);
+                options._concurrentCount -= promises.length;
+                promises = [];
+            }
+        }
+    }
+    catch (err) {
+        if (options.rethrowError) {
+            throw err;
+        }
+    }
+    return getResult(options);
+}
+/**
+ * make a copy of the user's options with proper defaults
+ *
+ * @param opts
+ * @returns
+ */
+function makeOptions(opts) {
+    const options = typeof opts === "string" ? { cwd: opts } : opts;
+    const sep = options.pathSep || path_1.default.posix.sep;
+    let cwd = options.cwd || options.dir || process.cwd();
+    if (!options.hasOwnProperty("pathSep") && cwd.includes("\\")) {
+        cwd = cwd.replace(/\\/g, "/");
+    }
+    const cleanExt = (ext) => {
+        if (!ext) {
+            return ext;
+        }
+        if (ext.startsWith("*.")) {
+            return ext.substring(1);
+        }
+        if (!ext.startsWith(".")) {
+            return `.${ext}`;
+        }
+        return ext;
+    };
+    // `includeRoot` was renamed to `prependCwd`, this avoid breaking code still using that
+    const prependCwd = (options.hasOwnProperty("includeRoot") ? options.includeRoot : options.prependCwd) ||
+        false;
+    // a simple and faster version of path.join that handles just 2
+    // arguments using posix separator
+    const _join2 = (a, b) => (a && b ? a + sep + b : a ? a : b); // eslint-disable-line
+    const opts2 = Object.assign({
+        _join2,
+        maxLevel: Infinity,
+        prefix: "",
+        prependCwd,
+        fullStat: true,
+        concurrency: 50,
+        readdirOpts: undefined,
+    }, options, {
+        dir: cwd,
+        result: {},
+        ignoreExt: []
+            .concat(options.ignoreExt)
+            .map(cleanExt)
+            .filter((x) => x),
+        filterExt: []
+            .concat(options.filterExt)
+            .map(cleanExt)
+            .filter((x) => x),
+        _concurrentCount: 0,
+    });
+    if (!opts2.fullStat) {
+        opts2.readdirOpts = { withFileTypes: true };
+    }
+    return opts2;
+}
+/**
+ * async version of filter scan dir
+ * @param options
+ * @returns
+ */
+function filterScanDir(options = {}) {
+    const options2 = makeOptions(options);
+    return walk(options2.prefix, options2);
+}
+exports.filterScanDir = filterScanDir;
+/** sync version of filter scan dir */
+function filterScanDirSync(options = {}) {
+    const options2 = makeOptions(options);
+    return walkSync(options2.prefix, options2);
+}
+exports.filterScanDirSync = filterScanDirSync;
+//# sourceMappingURL=filter-scan-dir.js.map

package/dist/filter-scan-dir.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-scan-dir.js","sourceRoot":"","sources":["../src/filter-scan-dir.ts"],"names":[],"mappings":";AAAA,oFAAoF;;;;;;AAEpF,4CAAuC;AACvC,gDAAwB;AACxB,gDAAwB;AA2HxB,SAAS,cAAc,CACrB,IAAY,EACZ,QAAgB,EAChB,IAAY,EACZ,IAAoB,EACpB,OAAqB;IAErB,MAAM,OAAO,GAAW,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAEjC,IAAI,EAAE,GAAG,CAAC,EAAE;QACV,OAAO;YACL,IAAI;YACJ,IAAI;YACJ,IAAI;YACJ,QAAQ;YACR,OAAO;YACP,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACvB,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;SAC7B,CAAC;KACH;SAAM;QACL,OAAO;YACL,IAAI;YACJ,IAAI;YACJ,IAAI;YACJ,QAAQ;YACR,OAAO;YACP,GAAG,EAAE,EAAE;YACP,KAAK,EAAE,IAAI;SACZ,CAAC;KACH;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,SAAS,CAAC,MAAM,EAAE,OAAqB,EAAE,MAAkB;IAClE,MAAM,KAAK,GACT,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC;IAEhG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;QAC1B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;KAC5B;IAED,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE;QACnC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;KAC/C;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;KACnF;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,OAAO,EAAE,MAAM;IACjC,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS;QACpC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC;QACrD,CAAC,CAAC,IAAI,CAAC;IAET,IAAI,YAAY,EAAE;QAChB,IAAI,YAAY,CAAC,IAAI,KAAK,IAAI,IAAI,OAAO,CAAC,UAAU,EAAE;YACpD,SAAS,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;SAC1C;QACD,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,CAAC;KAC7D;IAED,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,OAAO,EAAE,MAAM;IAClC,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;QAC9E,OAAO,KAAK,CAAC;KACd;IAED,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QAC7E,OAAO,KAAK,CAAC;KACd;IAED,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,qBAAqB;IAEpH,IAAI,YAAY,EAAE;QAChB,IAAI,YAAY,CAAC,IAAI,KAAK,IAAI,EAAE;YAC9B,SAAS,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;SAC1C;QACD,OAAO,YAAY,CAAC,IAAI,CAAC;KAC1B;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAUD;;;;;GAKG;AACH,SAAS,SAAS,CAAC,OAAqB;IACtC,OAAO,OAAO,CAAC,QAAQ;QACrB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC;QAC9C,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;AACjC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,SAAS,GAAG,CAAC,CAAS,EAAE,CAAS,EAAU,EAAE;IACjD,0BAA0B;IAC1B,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,EAAE;QACrB,0BAA0B;QAC1B,OAAO,CAAC,CAAC;QACT,0BAA0B;KAC3B;SAAM,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE;QAC1B,0BAA0B;QAC1B,OAAO,CAAC,CAAC;KACV;SAAM;QACL,0BAA0B;QAC1B,OAAO,CAAC,CAAC,CAAC;KACX;AACH,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,SAAS,QAAQ,CAAC,IAAY,EAAE,OAAqB,EAAE,KAAK,GAAG,CAAC;IAC9D,IAAI;QACF,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC9C,IAAI,KAAK,GAAwB,YAAE,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAE1E,IAAI,OAAO,CAAC,SAAS,EAAE;YACrB,IAAI,OAAO,CAAC,QAAQ,EAAE;gBACpB,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;aACtB;iBAAM;gBACL,KAAK,GAAI,KAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC7C;SACF;QAED,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAI,IAAI,GAAG,KAAK,CAAC;QAEjB,sBAAsB;QACtB,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE;YACjD,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;YACvB,IAAI,MAAkB,CAAC;YAEvB,IAAI,OAAO,CAAC,QAAQ,EAAE;gBACpB,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBAC3C,MAAM,IAAI,GAAG,YAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACpC,MAAM,GAAG,cAAc,CAAC,IAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;aACxE;iBAAM;gBACL,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,EAAG,IAAe,CAAC,IAAI,CAAC,CAAC;gBAC5D,MAAM,GAAG,cAAc,CAAE,IAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAc,EAAE,OAAO,CAAC,CAAC;aACzF;YAED,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE;gBAC7B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACnB;iBAAM;gBACL,IAAI,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;aACrC;SACF;QAED,mBAAmB;QACnB,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5B,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE;gBACvC,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;gBACxB,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBAC1C,IAAI,KAAK,CAAC,IAAI,EAAE;oBACd,MAAM;iBACP;gBACD,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE;oBAC3C,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;iBAC9C;aACF;SACF;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,OAAO,CAAC,YAAY,EAAE;YACxB,MAAM,GAAG,CAAC;SACX;KACF;IAED,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED,MAAM,YAAY,GAAG,cAAI,CAAC,SAAS,CAAC,YAAE,CAAC,OAAO,CAAC,CAAC;AAChD,MAAM,UAAU,GAAG,cAAI,CAAC,SAAS,CAAC,YAAE,CAAC,KAAK,CAAC,CAAC;AAE5C;;;;;;;GAOG;AACH,KAAK,UAAU,IAAI,CAAC,IAAY,EAAE,OAAqB,EAAE,KAAK,GAAG,CAAC;IAChE,IAAI;QACF,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC9C,IAAI,KAAK,GAAwB,MAAM,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAE9E,IAAI,OAAO,CAAC,SAAS,EAAE;YACrB,IAAI,OAAO,CAAC,QAAQ,EAAE;gBACpB,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;aACtB;iBAAM;gBACL,KAAK,GAAI,KAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC7C;SACF;QAED,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAI,IAAI,GAAG,KAAK,CAAC;QAEjB,sBAAsB;QACtB,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE;YACjD,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;YACvB,IAAI,MAAM,CAAC;YAEX,IAAI,OAAO,CAAC,QAAQ,EAAE;gBACpB,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBAC3C,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACxC,MAAM,GAAG,cAAc,CAAC,IAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;aACxE;iBAAM;gBACL,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,EAAG,IAAe,CAAC,IAAI,CAAC,CAAC;gBAC5D,MAAM,GAAG,cAAc,CAAE,IAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAc,EAAE,OAAO,CAAC,CAAC;aACzF;YAED,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE;gBAC7B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACnB;iBAAM;gBACL,IAAI,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;aACrC;SACF;QAED,mBAAmB;QACnB,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5B,IAAI,QAAQ,GAAG,EAAE,CAAC;YAElB,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE;gBACvC,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;gBACxB,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBAC1C,IAAI,KAAK,CAAC,IAAI,EAAE;oBACd,MAAM;iBACP;gBACD,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE;oBAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;oBACvD,IAAI,OAAO,CAAC,WAAW,GAAG,CAAC,EAAE;wBAC3B,IAAI,OAAO,CAAC,gBAAgB,GAAG,OAAO,CAAC,WAAW,EAAE;4BAClD,OAAO,CAAC,gBAAgB,EAAE,CAAC;4BAC3B,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;yBACtB;6BAAM,IAAI,QAAQ,CAAC,MAAM,EAAE;4BAC1B,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;4BAC5B,OAAO,CAAC,gBAAgB,IAAI,QAAQ,CAAC,MAAM,CAAC;4BAC5C,QAAQ,GAAG,CAAC,KAAK,CAAC,CAAC;4BACnB,OAAO,CAAC,gBAAgB,EAAE,CAAC;yBAC5B;6BAAM;4BACL,MAAM,KAAK,CAAC;yBACb;qBACF;yBAAM;wBACL,MAAM,KAAK,CAAC;qBACb;iBACF;aACF;YAED,IAAI,QAAQ,CAAC,MAAM,EAAE;gBACnB,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAC5B,OAAO,CAAC,gBAAgB,IAAI,QAAQ,CAAC,MAAM,CAAC;gBAC5C,QAAQ,GAAG,EAAE,CAAC;aACf;SACF;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,OAAO,CAAC,YAAY,EAAE;YACxB,MAAM,GAAG,CAAC;SACX;KACF;IAED,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,IAAsB;IACzC,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAEhE,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,IAAI,cAAI,CAAC,KAAK,CAAC,GAAG,CAAC;IAE9C,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,IAAK,OAAe,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAC/D,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QAC5D,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;KAC/B;IAED,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,EAAE;QAC/B,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,GAAG,CAAC;SACZ;QACD,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACxB,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;SACzB;QACD,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACxB,OAAO,IAAI,GAAG,EAAE,CAAC;SAClB;QACD,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IAEF,uFAAuF;IACvF,MAAM,UAAU,GACd,CAAC,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,CAAE,OAAe,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAC3F,KAAK,CAAC;IAER,+DAA+D;IAC/D,kCAAkC;IAClC,MAAM,MAAM,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,sBAAsB;IAEnG,MAAM,KAAK,GAAiB,MAAM,CAAC,MAAM,CACvC;QACE,MAAM;QACN,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,EAAE;QACV,UAAU;QACV,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,EAAE;QACf,WAAW,EAAE,SAAS;KACvB,EACD,OAAO,EACP;QACE,GAAG,EAAE,GAAG;QACR,MAAM,EAAE,EAAE;QACV,SAAS,EAAE,EAAE;aACV,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;aACzB,GAAG,CAAC,QAAQ,CAAC;aACb,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QACnB,SAAS,EAAE,EAAE;aACV,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;aACzB,GAAG,CAAC,QAAQ,CAAC;aACb,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QACnB,gBAAgB,EAAE,CAAC;KACpB,CACF,CAAC;IAEF,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;QACnB,KAAK,CAAC,WAAW,GAAG,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;KAC7C;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,UAA4B,EAAE;IAC1D,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACzC,CAAC;AAHD,sCAGC;AAED,sCAAsC;AACtC,SAAgB,iBAAiB,CAAC,UAA4B,EAAE;IAC9D,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IACtC,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAHD,8CAGC"}

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+export * from "../dist/filter-scan-dir.d";
+import { filterScanDir } from "../dist/filter-scan-dir.d";
+
+// @ts-ignore
+export = filterScanDir;

package/lib/index.js

@@ -1,260 +1,9 @@
-"use strict";
-
-/* eslint-disable max-statements, complexity, comma-dangle, max-params */
-
-const Fs = require("fs");
-const Path = require("path");
-const Util = require("util");
-
-function makeExtrasData(file, fullFile, path, stat, options) {
-  const dirFile = options._path.join(path, file);
-  const ix = file.lastIndexOf(".");
-
-  if (ix > 0) {
-    return {
-      file,
-      path,
-      stat,
-      fullFile,
-      dirFile,
-      ext: file.substr(ix),
-      noExt: file.substring(0, ix),
-    };
-  } else {
-    return {
-      file,
-      path,
-      stat,
-      fullFile,
-      dirFile,
-      ext: "",
-      noExt: file,
-    };
-  }
-}
-
-function addResult(result, options, extras) {
-  const group =
-    (options.grouping && typeof result === "string"
-      ? result
-      : result && result.group) || "files";
-
-  if (!options.result[group]) {
-    options.result[group] = [];
-  }
-
-  if (result.formatName !== undefined) {
-    options.result[group].push(result.formatName);
-  } else {
-    options.result[group].push(
-      options.prependCwd ? extras.fullFile : extras.dirFile
-    );
-  }
-}
-
-function processDir(options, extras) {
-  const filterResult = options.filterDir
-    ? options.filterDir(extras.file, extras.path, extras)
-    : true;
-
-  if (filterResult) {
-    if (filterResult.skip !== true && options.includeDir) {
-      addResult(filterResult, options, extras);
-    }
-    return { stop: filterResult.stop, skip: filterResult.skip };
-  }
-
-  return { stop: false, skip: true };
-}
-
-function processFile(options, extras) {
-  if (
-    options.ignoreExt.length > 0 &&
-    options.ignoreExt.indexOf(extras.ext) >= 0
-  ) {
-    return false;
-  }
-
-  if (
-    options.filterExt.length > 0 &&
-    options.filterExt.indexOf(extras.ext) < 0
-  ) {
-    return false;
-  }
-
-  const filterResult = options.filter
-    ? options.filter(extras.file, extras.path, extras)
-    : true; // default to include
-
-  if (filterResult) {
-    if (filterResult.skip !== true) {
-      addResult(filterResult, options, extras);
-    }
-    return filterResult.stop;
-  }
-
-  return false;
-}
-
-function getResult(options) {
-  return options.grouping
-    ? Object.assign({ files: [] }, options.result)
-    : options.result.files || [];
-}
-
-function walkSync(path, options, level = 0) {
-  try {
-    const dir = options._path.join(options.dir, path);
-    let files = Fs.readdirSync(dir);
-
-    if (options.sortFiles) {
-      files = files.sort();
-    }
-
-    const dirs = [];
-    let stop = false;
-
-    // process files first
-    for (let ix = 0; !stop && ix < files.length; ix++) {
-      const file = files[ix];
-      const fullFile = options._path.join(dir, file);
-      const stat = Fs.lstatSync(fullFile);
-
-      const extras = makeExtrasData(file, fullFile, path, stat, options);
-
-      if (stat.isDirectory()) {
-        dirs.push(extras);
-      } else {
-        stop = processFile(options, extras);
-      }
-    }
-
-    // now process dirs
-    if (!stop && dirs.length > 0) {
-      for (let ix = 0; ix < dirs.length; ix++) {
-        const extras = dirs[ix];
-        const flags = processDir(options, extras);
-        if (flags.stop) {
-          break;
-        }
-        if (!flags.skip && level < options.maxLevel) {
-          walkSync(extras.dirFile, options, level + 1);
-        }
-      }
-    }
-  } catch (err) {
-    if (options.rethrowError) {
-      throw err;
-    }
-  }
-
-  return getResult(options);
-}
-
-const asyncReaddir = Util.promisify(Fs.readdir);
-const asyncLStat = Util.promisify(Fs.lstat);
-
-async function walk(path, options, level = 0) {
-  try {
-    const dir = options._path.join(options.dir, path);
-    let files = await asyncReaddir(dir);
-
-    if (options.sortFiles) {
-      files = files.sort();
-    }
-
-    const dirs = [];
-    let stop = false;
-
-    // process files first
-    for (let ix = 0; !stop && ix < files.length; ix++) {
-      const file = files[ix];
-      const fullFile = options._path.join(dir, file);
-
-      const stat = await asyncLStat(fullFile);
-      const extras = makeExtrasData(file, fullFile, path, stat, options);
-      if (stat.isDirectory()) {
-        dirs.push(extras);
-      } else {
-        stop = processFile(options, extras);
-      }
-    }
-
-    // now process dirs
-    if (!stop && dirs.length > 0) {
-      for (let ix = 0; ix < dirs.length; ix++) {
-        const extras = dirs[ix];
-        const flags = processDir(options, extras);
-        if (flags.stop) {
-          break;
-        }
-        if (!flags.skip && level < options.maxLevel) {
-          await walk(extras.dirFile, options, level + 1);
-        }
-      }
-    }
-  } catch (err) {
-    if (options.rethrowError) {
-      throw err;
-    }
-  }
-
-  return getResult(options);
-}
-
-function makeOptions(options) {
-  let cwd =
-    (typeof options === "string" ? options : options.cwd || options.dir) ||
-    process.cwd();
-
-  if (!options._path && cwd.indexOf("\\") >= 0) {
-    cwd = cwd.replace(/\\/g, "/");
-  }
-
-  const cleanExt = (ext) => {
-    if (!ext) {
-      return ext;
-    }
-    if (ext.startsWith("*.")) {
-      return ext.substring(1);
-    }
-    if (!ext.startsWith(".")) {
-      return `.${ext}`;
-    }
-    return ext;
-  };
-
-  const prependCwd =
-    (options.hasOwnProperty("includeRoot")
-      ? options.includeRoot
-      : options.prependCwd) || false;
-
-  return Object.assign(
-    { _path: Path.posix, maxLevel: Infinity, prefix: "", prependCwd },
-    options,
-    {
-      dir: cwd,
-      result: {},
-      ignoreExt: []
-        .concat(options.ignoreExt)
-        .map(cleanExt)
-        .filter((x) => x),
-      filterExt: []
-        .concat(options.filterExt)
-        .map(cleanExt)
-        .filter((x) => x),
-    }
-  );
-}
-
-function filterScanDir(options) {
-  const options2 = makeOptions(options);
-  return walk(options2.prefix, options2);
-}
-
-filterScanDir.sync = function filterScanDirSync(options) {
-  const options2 = makeOptions(options);
-  return walkSync(options2.prefix, options2);
-};
-
-module.exports = filterScanDir;
+const fsd = require("../dist/filter-scan-dir");
+
+const asyncApi = (options) => fsd.filterScanDir(options);
+Object.defineProperties(asyncApi, {
+  sync: { value: fsd.filterScanDirSync },
+  filterScanDir: { value: fsd.filterScanDir },
+  filterScanDirSync: { value: fsd.filterScanDirSync },
+});
+module.exports = asyncApi;

package/package.json

@@ -1,16 +1,20 @@
 {
   "name": "filter-scan-dir",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Recursively scan and filter directory for a flat array of files",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
-    "test": "clap test-only",
+    "build": "rm -rf dist && tsc",
+    "test": "xrun -x build xarc/test-only",
     "lint": "clap lint",
     "coveralls": "cat coverage/lcov.info | coveralls",
-    "coverage": "clap check",
-    "ci:check": "clap -n --serial check coveralls",
+    "coverage": "xrun -x build xarc/test-cov",
+    "ci:check": "xrun --serial build check coveralls",
     "prepack": "publish-util-prepack",
-    "postpack": "publish-util-postpack"
+    "postpack": "publish-util-postpack",
+    "prepublishOnly": "xrun --serial [[build, docs], xarc/check]",
+    "docs": "xrun xarc/docs && touch docs/.nojekyll"
   },
   "repository": {
     "type": "git",
@@ -20,6 +24,7 @@
     "registry": "https://registry.npmjs.com/"
   },
   "files": [
+    "dist",
     "lib"
   ],
   "keywords": [
@@ -31,7 +36,9 @@
     "dir",
     "directory",
     "readdir",
-    "fs"
+    "fs",
+    "fast",
+    "glob"
   ],
   "author": "Joel Chen <joel123@gmail.com>",
   "license": "Apache-2.0",