remove-glob 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2025-present, Ghislain B.
+https://github.com/ghiscoding/remove-glob
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+[![Vitest](https://img.shields.io/badge/tested%20with-vitest-fcc72b.svg?logo=vitest)](https://vitest.dev/)
+[![codecov](https://codecov.io/gh/ghiscoding/remove-glob/branch/main/graph/badge.svg)](https://codecov.io/gh/ghiscoding/remove-glob)
+[![npm](https://img.shields.io/npm/v/remove-glob.svg)](https://www.npmjs.com/package/remove-glob)
+[![npm](https://img.shields.io/npm/dy/remove-glob)](https://www.npmjs.com/package/remove-glob)
+[![npm bundle size](https://img.shields.io/bundlephobia/minzip/remove-glob?color=success&label=gzip)](https://bundlephobia.com/result?p=remove-glob)
+
+## remove-glob
+
+A tiny cross-platform utility to remove items or directories recursively, it also accepts an optional glob pattern. There's also a CLI for easy, cross-platform usage. It uses 2 small dependencies [tinyglobby](https://www.npmjs.com/package/tinyglobby) for glob support and [cli-nano](https://www.npmjs.com/package/cli-nano) for the CLI.
+
+Inspired by [rimraf](https://www.npmjs.com/package/rimraf) and [premove](https://www.npmjs.com/package/premove) but also supports glob pattern to remove files or directories.
+
+### Install
+```sh
+npm install remove-glob
+```
+
+### Command Line
+
+A `remove` binary is available, it takes 1 or more file/directory paths to be removed or any other options shown below (you can use an optional `--glob` pattern instead of paths).
+
+```
+Usage:
+  remove [paths..] [options]  Remove all items recursively
+
+Positionals:
+  paths               directory or file paths to remove                                 [string]
+
+Options:
+      --cwd           Directory to resolve from (default ".")                           [string]
+      --dryRun        Show which files/dirs would be deleted but without actually re... [boolean]
+      --glob          Glob pattern to find which files/dirs to remove                   [string]
+      --stat          Show the stats of the items being removed                         [boolean]
+      --verbose       If true, it will log each file or directory being removed         [boolean]
+
+Default options:
+  -h, --help          Show help                                                         [boolean]
+  -v, --version       Show version number                                               [boolean]
+```
+
+Remove files or directories.  Note: on Windows globs must be **double quoted**, everybody else can quote however they please.
+
+```sh
+# remove "foo" and "bar" via `npx`
+$ npx remove foo bar
+
+# or remove using glob pattern
+$ npx remove --glob \"dist/**/*.js\"
+
+# install globally, use whenever
+$ npm install remove-glob -g
+$ remove foo bar
+$ remove --glob \"dist/**/*.{js,map}\"
+```
+
+### Usage
+
+```ts
+import { resolve } from 'node:path';
+import { removeSync } from 'remove-glob';
+
+try {
+  // remove via paths
+  removeSync({ paths: './foobar' });
+  removeSync({ paths: ['./foo/file1.txt', './foo/file2.txt'] });
+
+  // or remove via glob pattern
+  removeSync({ glob: 'foo/**/*.txt' })
+} catch (err) {
+  //
+}
+
+// Using `cwd` option
+const dir = resolve('./foo/bar');
+await removeSync({ paths: ['hello.txt'], cwd: dir });
+```
+
+### JavaScript API
+
+```js
+import { removeSync } from 'remove-glob';
+
+removeSync(opt, callback);
+```
+
+The first argument is an object holding any of the options shown below. The last argument is an optional callback function which is executed (when defined) after all files are removed.
+
+```js
+{
+  cwd: string,              // directory to resolve your `filepath` from, defaults to `process.cwd()`
+  dryRun: bool,             // show what would be copied, without actually copying anything
+  paths: string | string[], // filepath(s) to remove – may be a file or a directory.
+  glob: string,             // glob pattern to find which files/directories to remove
+  stats: bool               // show some statistics after execution (time + file count)
+  verbose: bool,            // print more information to console when executing the removal
+}
+```
+
+> [!WARNING]
+> The first argument is necessary and it **must** include a `paths` or a `glob` (but it cannot include both options together).

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+import { readFileSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { parseArgs } from 'cli-nano';
+import { removeSync } from './index.js';
+function readPackage() {
+    const __dirname = dirname(fileURLToPath(import.meta.url));
+    const pkgPath = resolve(__dirname, '../package.json');
+    const pkg = readFileSync(pkgPath, 'utf8');
+    return JSON.parse(pkg);
+}
+function handleError(err) {
+    if (err) {
+        console.error(err);
+        process.exit(1);
+    }
+    else {
+        process.exit(0);
+    }
+}
+try {
+    const results = parseArgs({
+        command: {
+            name: 'remove',
+            description: 'Remove all items recursively',
+            positionals: [
+                {
+                    name: 'paths',
+                    description: 'directory or file paths to remove',
+                    type: 'string',
+                    variadic: true,
+                    required: false,
+                },
+            ],
+        },
+        options: {
+            cwd: {
+                type: 'string',
+                description: 'Directory to resolve from (default ".")',
+            },
+            dryRun: {
+                type: 'boolean',
+                default: false,
+                description: 'Show which files/dirs would be deleted but without actually removing them',
+            },
+            glob: {
+                type: 'string',
+                description: 'Glob pattern to find which files/dirs to remove',
+            },
+            stat: {
+                type: 'boolean',
+                default: false,
+                description: 'Show the stats of the items being removed',
+            },
+            verbose: {
+                type: 'boolean',
+                default: false,
+                description: 'If true, it will log each file or directory being removed',
+            },
+        },
+        version: readPackage().version,
+    });
+    // execute remove function
+    removeSync(results, err => handleError(err));
+}
+catch (err) {
+    handleError(err);
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAGxC,SAAS,WAAW;IAClB,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1D,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;IACtD,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,IAAI,GAAG,EAAE,CAAC;QACR,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,IAAI,CAAC;IACH,MAAM,OAAO,GAAG,SAAS,CAAC;QACxB,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,8BAA8B;YAC3C,WAAW,EAAE;gBACX;oBACE,IAAI,EAAE,OAAO;oBACb,WAAW,EAAE,mCAAmC;oBAChD,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,IAAI;oBACd,QAAQ,EAAE,KAAK;iBAChB;aACF;SACF;QACD,OAAO,EAAE;YACP,GAAG,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yCAAyC;aACvD;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,2EAA2E;aACzF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,iDAAiD;aAC/D;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,2CAA2C;aACzD;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,2DAA2D;aACzE;SACF;QACD,OAAO,EAAE,WAAW,EAAE,CAAC,OAAO;KAC/B,CAAC,CAAC;IAEH,0BAA0B;IAC1B,UAAU,CAAC,OAAwB,EAAE,GAAG,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;AAChE,CAAC;AAAC,OAAO,GAAG,EAAE,CAAC;IACb,WAAW,CAAC,GAAY,CAAC,CAAC;AAC5B,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import type { RemoveOptions } from './interfaces.js';
+/**
+ * Remove the files or directories, the item(s) can be provided via positional arguments or via a `--glob` pattern.
+ * @param {RemoveOptions} options - CLI options
+ * @param {(e?: Error) => void} callback - optional callback that will be executed after remove is finished or when an error occurs
+ */
+export declare function removeSync(opts?: RemoveOptions, callback?: (e?: Error) => void): false | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAWrD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,IAAI,GAAE,aAAkB,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,qBAoElF"}

package/dist/index.js

@@ -0,0 +1,80 @@
+import { existsSync, readdirSync, rmSync, statSync, unlinkSync } from 'node:fs';
+import { join, resolve } from 'node:path';
+import { globSync } from 'tinyglobby';
+/** Helper to throw or callback with error */
+function throwOrCallback(err, cb) {
+    if (typeof cb === 'function') {
+        cb(err);
+    }
+    else {
+        throw err;
+    }
+}
+/**
+ * Remove the files or directories, the item(s) can be provided via positional arguments or via a `--glob` pattern.
+ * @param {RemoveOptions} options - CLI options
+ * @param {(e?: Error) => void} callback - optional callback that will be executed after remove is finished or when an error occurs
+ */
+export function removeSync(opts = {}, callback) {
+    const cb = callback || opts.callback;
+    let paths = opts.paths || [];
+    if (!paths.length && !opts.glob) {
+        throwOrCallback(new Error('Please make sure to provide file paths via command arguments or via `--glob` pattern, i.e.: "remove dir" or "remove --glob dir/**/*.js"'), cb);
+        return;
+    }
+    if (paths.length && opts.glob) {
+        throwOrCallback(new Error('Providing both `--paths` and `--glob` pattern are not supported, you must provide only one of these options.'), cb);
+        return;
+    }
+    let pathExists = false;
+    if (!Array.isArray(paths)) {
+        paths = paths.length ? [paths] : [];
+    }
+    const requiresCwdChange = !!(paths.length && opts.cwd);
+    if (!paths.length) {
+        paths = globSync([opts.glob], { cwd: opts.cwd, dot: true, onlyFiles: false, absolute: true });
+    }
+    opts.stat && console.time('Duration');
+    opts.dryRun && console.log('=== dry-run ===');
+    paths.forEach(path => {
+        // do we need to resolve file/dir from a different cwd?
+        if (requiresCwdChange) {
+            path = resolve(opts.cwd || '.', path);
+        }
+        if (existsSync(path)) {
+            if (statSync(path).isDirectory()) {
+                // directories
+                if (opts.dryRun) {
+                    console.log(`would remove directory: ${path}`);
+                }
+                else {
+                    opts.verbose && console.log(`removing directory: ${path}`);
+                    readdirSync(path).forEach(name => {
+                        removeSync({ paths: join(path, name) }); // recursively remove content
+                    });
+                    rmSync(path, { recursive: true, force: true });
+                }
+            }
+            else {
+                // files
+                if (opts.dryRun) {
+                    console.log(`would remove file: ${path}`);
+                }
+                else {
+                    opts.verbose && console.log(`removing file: ${path}`);
+                    unlinkSync(path);
+                }
+            }
+            pathExists = true;
+        }
+    });
+    if (opts.stat || opts.verbose) {
+        console.log(`Removed:  ${paths.length} items`);
+        console.timeEnd('Duration');
+    }
+    opts.dryRun && console.log('=== dry-run ===');
+    if (typeof cb === 'function')
+        cb();
+    return pathExists;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAChF,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC,6CAA6C;AAC7C,SAAS,eAAe,CAAC,GAAW,EAAE,EAAwB;IAC5D,IAAI,OAAO,EAAE,KAAK,UAAU,EAAE,CAAC;QAC7B,EAAE,CAAC,GAAG,CAAC,CAAC;IACV,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,OAAsB,EAAE,EAAE,QAA8B;IACjF,MAAM,EAAE,GAAG,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;IACrC,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;IAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAChC,eAAe,CACb,IAAI,KAAK,CACP,yIAAyI,CAC1I,EACD,EAAE,CACH,CAAC;QACF,OAAO;IACT,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QAC9B,eAAe,CACb,IAAI,KAAK,CAAC,8GAA8G,CAAC,EACzH,EAAE,CACH,CAAC;QACF,OAAO;IACT,CAAC;IACD,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACtC,CAAC;IACD,MAAM,iBAAiB,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC;IACvD,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,KAAK,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAK,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACjG,CAAC;IACD,IAAI,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAE9C,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACnB,uDAAuD;QACvD,IAAI,iBAAiB,EAAE,CAAC;YACtB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,EAAE,IAAI,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACrB,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBACjC,cAAc;gBACd,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;oBAChB,OAAO,CAAC,GAAG,CAAC,2BAA2B,IAAI,EAAE,CAAC,CAAC;gBACjD,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,IAAI,EAAE,CAAC,CAAC;oBAC3D,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;wBAC/B,UAAU,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,6BAA6B;oBACxE,CAAC,CAAC,CAAC;oBACH,MAAM,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;gBACjD,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,QAAQ;gBACR,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;oBAChB,OAAO,CAAC,GAAG,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC;gBAC5C,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC;oBACtD,UAAU,CAAC,IAAI,CAAC,CAAC;gBACnB,CAAC;YACH,CAAC;YACD,UAAU,GAAG,IAAI,CAAC;QACpB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,CAAC,MAAM,QAAQ,CAAC,CAAC;QAC/C,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC;IACD,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC9C,IAAI,OAAO,EAAE,KAAK,UAAU;QAAE,EAAE,EAAE,CAAC;IACnC,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/interfaces.d.ts

@@ -0,0 +1,25 @@
+export interface RemoveOptions {
+    /** Callback to run when the execution finished or an error occured */
+    callback?: (e?: Error) => void;
+    /**
+     * The directory to resolve your `filepath` from.
+     * Defaults to the `process.cwd()` – aka, the directory that your command is run within.
+     */
+    cwd?: string;
+    /** Show which files would be deleted but without actually deleting them */
+    dryRun?: boolean;
+    /** Glob pattern to find which files/directories to remove */
+    glob?: string;
+    /**
+     * The filepath(s) to remove – may be a file or a directory.
+     * An initial existence check is made for this filepath.
+     * Important: This value is resolved to a full path.
+     * Please be aware of how and from where the Node.js file system is resolving your path!
+     */
+    paths?: string | string[];
+    /** Show the stats of the removed items */
+    stat?: boolean;
+    /** Print more information to console */
+    verbose?: boolean;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,sEAAsE;IACtE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;IAE/B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,2EAA2E;IAC3E,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE1B,0CAA0C;IAC1C,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,wCAAwC;IACxC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}

package/dist/interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=interfaces.js.map

package/dist/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "remove-glob",
+  "version": "0.2.0",
+  "description": "A tiny utility to remove items or directories recursively, also supports glob",
+  "bin": {
+    "remove": "dist/cli.js"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "./dist/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "/dist",
+    "/src"
+  ],
+  "license": "MIT",
+  "author": "Ghislain B.",
+  "homepage": "https://github.com/ghiscoding/remove-glob",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ghiscoding/remove-glob.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ghiscoding/remove-glob/issues"
+  },
+  "dependencies": {
+    "cli-nano": "^1.0.2",
+    "tinyglobby": "^0.2.14"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}

package/src/cli.ts

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+
+import { readFileSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { parseArgs } from 'cli-nano';
+
+import { removeSync } from './index.js';
+import type { RemoveOptions } from './interfaces.js';
+
+function readPackage() {
+  const __dirname = dirname(fileURLToPath(import.meta.url));
+  const pkgPath = resolve(__dirname, '../package.json');
+  const pkg = readFileSync(pkgPath, 'utf8');
+  return JSON.parse(pkg);
+}
+
+function handleError(err?: Error) {
+  if (err) {
+    console.error(err);
+    process.exit(1);
+  } else {
+    process.exit(0);
+  }
+}
+
+try {
+  const results = parseArgs({
+    command: {
+      name: 'remove',
+      description: 'Remove all items recursively',
+      positionals: [
+        {
+          name: 'paths',
+          description: 'directory or file paths to remove',
+          type: 'string',
+          variadic: true,
+          required: false,
+        },
+      ],
+    },
+    options: {
+      cwd: {
+        type: 'string',
+        description: 'Directory to resolve from (default ".")',
+      },
+      dryRun: {
+        type: 'boolean',
+        default: false,
+        description: 'Show which files/dirs would be deleted but without actually removing them',
+      },
+      glob: {
+        type: 'string',
+        description: 'Glob pattern to find which files/dirs to remove',
+      },
+      stat: {
+        type: 'boolean',
+        default: false,
+        description: 'Show the stats of the items being removed',
+      },
+      verbose: {
+        type: 'boolean',
+        default: false,
+        description: 'If true, it will log each file or directory being removed',
+      },
+    },
+    version: readPackage().version,
+  });
+
+  // execute remove function
+  removeSync(results as RemoveOptions, err => handleError(err));
+} catch (err) {
+  handleError(err as Error);
+}

package/src/index.ts

@@ -0,0 +1,89 @@
+import { existsSync, readdirSync, rmSync, statSync, unlinkSync } from 'node:fs';
+import { join, resolve } from 'node:path';
+import { globSync } from 'tinyglobby';
+
+import type { RemoveOptions } from './interfaces.js';
+
+/** Helper to throw or callback with error */
+function throwOrCallback(err?: Error, cb?: (e?: Error) => void) {
+  if (typeof cb === 'function') {
+    cb(err);
+  } else {
+    throw err;
+  }
+}
+
+/**
+ * Remove the files or directories, the item(s) can be provided via positional arguments or via a `--glob` pattern.
+ * @param {RemoveOptions} options - CLI options
+ * @param {(e?: Error) => void} callback - optional callback that will be executed after remove is finished or when an error occurs
+ */
+export function removeSync(opts: RemoveOptions = {}, callback?: (e?: Error) => void) {
+  const cb = callback || opts.callback;
+  let paths = opts.paths || [];
+  if (!paths.length && !opts.glob) {
+    throwOrCallback(
+      new Error(
+        'Please make sure to provide file paths via command arguments or via `--glob` pattern, i.e.: "remove dir" or "remove --glob dir/**/*.js"',
+      ),
+      cb,
+    );
+    return;
+  }
+  if (paths.length && opts.glob) {
+    throwOrCallback(
+      new Error('Providing both `--paths` and `--glob` pattern are not supported, you must provide only one of these options.'),
+      cb,
+    );
+    return;
+  }
+  let pathExists = false;
+  if (!Array.isArray(paths)) {
+    paths = paths.length ? [paths] : [];
+  }
+  const requiresCwdChange = !!(paths.length && opts.cwd);
+  if (!paths.length) {
+    paths = globSync([opts.glob!], { cwd: opts.cwd, dot: true, onlyFiles: false, absolute: true });
+  }
+  opts.stat && console.time('Duration');
+  opts.dryRun && console.log('=== dry-run ===');
+
+  paths.forEach(path => {
+    // do we need to resolve file/dir from a different cwd?
+    if (requiresCwdChange) {
+      path = resolve(opts.cwd || '.', path);
+    }
+
+    if (existsSync(path)) {
+      if (statSync(path).isDirectory()) {
+        // directories
+        if (opts.dryRun) {
+          console.log(`would remove directory: ${path}`);
+        } else {
+          opts.verbose && console.log(`removing directory: ${path}`);
+          readdirSync(path).forEach(name => {
+            removeSync({ paths: join(path, name) }); // recursively remove content
+          });
+          rmSync(path, { recursive: true, force: true });
+        }
+      } else {
+        // files
+        if (opts.dryRun) {
+          console.log(`would remove file: ${path}`);
+        } else {
+          opts.verbose && console.log(`removing file: ${path}`);
+          unlinkSync(path);
+        }
+      }
+      pathExists = true;
+    }
+  });
+
+  if (opts.stat || opts.verbose) {
+    console.log(`Removed:  ${paths.length} items`);
+    console.timeEnd('Duration');
+  }
+  opts.dryRun && console.log('=== dry-run ===');
+  if (typeof cb === 'function') cb();
+  return pathExists;
+}

package/src/interfaces.ts

@@ -0,0 +1,30 @@
+export interface RemoveOptions {
+  /** Callback to run when the execution finished or an error occured */
+  callback?: (e?: Error) => void;
+
+  /**
+   * The directory to resolve your `filepath` from.
+   * Defaults to the `process.cwd()` – aka, the directory that your command is run within.
+   */
+  cwd?: string;
+
+  /** Show which files would be deleted but without actually deleting them */
+  dryRun?: boolean;
+
+  /** Glob pattern to find which files/directories to remove */
+  glob?: string;
+
+  /**
+   * The filepath(s) to remove – may be a file or a directory.
+   * An initial existence check is made for this filepath.
+   * Important: This value is resolved to a full path.
+   * Please be aware of how and from where the Node.js file system is resolving your path!
+   */
+  paths?: string | string[];
+
+  /** Show the stats of the removed items */
+  stat?: boolean;
+
+  /** Print more information to console */
+  verbose?: boolean;
+}