remove-glob 0.3.6 → 0.4.0

package/README.md

@@ -11,7 +11,7 @@
 
 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.
+Inspired by [rimraf](https://www.npmjs.com/package/rimraf) and [premove](https://www.npmjs.com/package/premove) but also supports glob pattern to remove multiple files or directories.
 
 ### Install
 ```sh
@@ -20,11 +20,11 @@ npm install remove-glob
 
 ### Command Line
 
-A `remove` binary is available, it takes an optional paths argument (zero or multiple file/directory paths) to be removed **or** a `--glob` pattern instead of paths.
+A `remove` binary is available, it takes an optional path argument (zero or multiple file/directory paths) to be removed **or** a `--glob` pattern instead of path(s).
 
 > [!NOTE]
-> The `paths` (argument) and `glob` (option) are both optional, but you **must** provide at least 1 of them.
-> However, providing both of them simultaneously is not supported (choose which option is best suited to your use case).
+> The `paths` and `glob` arguments are both optionals, but you **must** provide at least 1 of them.
+> However, please note that providing both of them simultaneously is not supported and will throw an error (choose the option that is best suited to your use case).
 
 ```
 Usage:
@@ -60,7 +60,7 @@ $ remove --glob \"dist/**/*.{js,map}\"
 ```
 
 > [!NOTE]
-> When using the `--glob` option, it will skips `.git/` and `node_modules/` directories by default.
+> When using the `--glob` option, it will skip `.git/` and `node_modules/` directories by default.
 
 ### Usage
 
@@ -88,18 +88,26 @@ 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.
+The first argument is an object holding any of the options shown below. The last argument is an optional callback function that will be executed after all files were 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
+  cwd: string;              // directory to resolve your `filepath` from, defaults to `process.cwd()`
+  dryRun: boolean;          // 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: boolean;           // show some statistics after execution (time + file count)
+  verbose: boolean;         // print more information to console when executing the removal
 }
 ```
 
 > [!NOTE]
 > The first argument is required and it **must** include either a `paths` or a `glob`, but it cannot include both options simultaneously.
+
+### Used by
+
+I use it in most of my own open source projects as a Dev Dependency (feel free to modify this list and add your project(s) as well)
+
+- [Lerna-Lite](https://github.com/lerna-lite/lerna-lite)
+- [SlickGrid](https://github.com/6pac/SlickGrid)
+- [Slickgrid-Universal](https://github.com/ghiscoding/slickgrid-universal)

package/dist/index.d.ts.map

@@ -1 +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,qBA0ElF"}
+{"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,qBAwElF"}

package/dist/index.js

@@ -1,5 +1,5 @@
-import { existsSync, readdirSync, rmSync, statSync, unlinkSync } from 'node:fs';
-import { join, resolve } from 'node:path';
+import { existsSync, rmSync, statSync, unlinkSync } from 'node:fs';
+import { resolve } from 'node:path';
 import { globSync } from 'tinyglobby';
 /** Helper to throw or callback with error */
 function throwOrCallback(err, cb) {
@@ -23,7 +23,7 @@ export function removeSync(opts = {}, callback) {
         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);
+        throwOrCallback(new Error('Providing both `--paths` and `--glob` pattern at the same time is not supported, you must chose only one.'), cb);
         return;
     }
     let pathExists = false;
@@ -40,35 +40,29 @@ export function removeSync(opts = {}, callback) {
             ignore: ['**/.git/**', '**/node_modules/**'],
         });
     }
-    opts.stat && console.time('Duration');
-    opts.dryRun && console.log('=== dry-run ===');
+    if (opts.stat || opts.verbose) {
+        console.time('Duration');
+    }
+    // start dry-run print
+    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, maxRetries: process.platform === 'win32' ? 10 : 0 });
-                }
+            const isDir = statSync(path).isDirectory();
+            const pathLog = `${isDir ? 'directory' : 'file'}: ${path}`;
+            if (opts.dryRun) {
+                console.log(`would remove ${pathLog}`);
             }
             else {
-                // files
-                if (opts.dryRun) {
-                    console.log(`would remove file: ${path}`);
+                opts.verbose && console.log(`removing ${pathLog}`);
+                if (isDir) {
+                    rmSync(path, { recursive: true, force: true, maxRetries: process.platform === 'win32' ? 10 : 0 }); // delete folder recursively
                 }
                 else {
-                    opts.verbose && console.log(`removing file: ${path}`);
-                    unlinkSync(path);
+                    unlinkSync(path); // delete file
                 }
             }
             pathExists = true;
@@ -78,8 +72,8 @@ export function removeSync(opts = {}, callback) {
         console.log(`Removed:  ${paths.length} items`);
         console.timeEnd('Duration');
     }
-    opts.dryRun && console.log('=== dry-run ===');
-    if (typeof cb === 'function')
-        cb();
+    // end dry-run print & execute callback when defined
+    opts.dryRun && console.log('-- end --');
+    typeof cb === 'function' && cb();
     return pathExists;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remove-glob",
-  "version": "0.3.6",
+  "version": "0.4.0",
   "description": "A tiny utility to remove items or directories recursively, also supports glob",
   "bin": {
     "remove": "dist/cli.js"
@@ -17,7 +17,8 @@
   },
   "module": "./dist/index.js",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   },
   "files": [
     "/dist",
@@ -35,7 +36,7 @@
   },
   "dependencies": {
     "cli-nano": "^1.2.1",
-    "tinyglobby": "^0.2.14"
+    "tinyglobby": "^0.2.15"
   },
   "engines": {
     "node": "^20.0.0 || >=22.0.0"

package/src/index.ts

@@ -1,5 +1,5 @@
-import { existsSync, readdirSync, rmSync, statSync, unlinkSync } from 'node:fs';
-import { join, resolve } from 'node:path';
+import { existsSync, rmSync, statSync, unlinkSync } from 'node:fs';
+import { resolve } from 'node:path';
 import { globSync } from 'tinyglobby';
 
 import type { RemoveOptions } from './interfaces.js';
@@ -32,7 +32,7 @@ export function removeSync(opts: RemoveOptions = {}, callback?: (e?: Error) => v
   }
   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.'),
+      new Error('Providing both `--paths` and `--glob` pattern at the same time is not supported, you must chose only one.'),
       cb,
     );
     return;
@@ -51,8 +51,11 @@ export function removeSync(opts: RemoveOptions = {}, callback?: (e?: Error) => v
       ignore: ['**/.git/**', '**/node_modules/**'],
     });
   }
-  opts.stat && console.time('Duration');
-  opts.dryRun && console.log('=== dry-run ===');
+  if (opts.stat || opts.verbose) {
+    console.time('Duration');
+  }
+  // start dry-run print
+  opts.dryRun && console.log('-- dry-run --');
 
   paths.forEach(path => {
     // do we need to resolve file/dir from a different cwd?
@@ -61,24 +64,17 @@ export function removeSync(opts: RemoveOptions = {}, callback?: (e?: Error) => v
     }
 
     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, maxRetries: process.platform === 'win32' ? 10 : 0 });
-        }
+      const isDir = statSync(path).isDirectory();
+      const pathLog = `${isDir ? 'directory' : 'file'}: ${path}`;
+
+      if (opts.dryRun) {
+        console.log(`would remove ${pathLog}`);
       } else {
-        // files
-        if (opts.dryRun) {
-          console.log(`would remove file: ${path}`);
+        opts.verbose && console.log(`removing ${pathLog}`);
+        if (isDir) {
+          rmSync(path, { recursive: true, force: true, maxRetries: process.platform === 'win32' ? 10 : 0 }); // delete folder recursively
         } else {
-          opts.verbose && console.log(`removing file: ${path}`);
-          unlinkSync(path);
+          unlinkSync(path); // delete file
         }
       }
       pathExists = true;
@@ -89,7 +85,9 @@ export function removeSync(opts: RemoveOptions = {}, callback?: (e?: Error) => v
     console.log(`Removed:  ${paths.length} items`);
     console.timeEnd('Duration');
   }
-  opts.dryRun && console.log('=== dry-run ===');
-  if (typeof cb === 'function') cb();
+
+  // end dry-run print & execute callback when defined
+  opts.dryRun && console.log('-- end --');
+  typeof cb === 'function' && cb();
   return pathExists;
 }