remove-glob 1.0.0 → 1.1.1

package/README.md

@@ -45,10 +45,14 @@ Options:
   -g, --glob      Glob pattern(s) to find which files/dirs to remove                        [array]
   -s, --stat      Show the stats of the items being removed                                 [boolean]
   -V, --verbose   If true, it will log each file or directory being removed                 [boolean]
+  -e, --exclude   Pattern or glob to exclude (may be passed multiple times)                 [string|string[]]
   -h, --help      Show help                                                                 [boolean]
   -v, --version   Show version number                                                       [boolean]
 ```
 
+> [!NOTE]
+> When `exclude` glob pattern(s) are provided, it will override the default exclude of: [`"**/.git/**", "**/.git", "**/node_modules/**", "**/node_modules"`]
+
 Remove files or directories.  Note: on Windows globs must be **double quoted**, everybody else can quote however they please.
 
 ```sh
@@ -66,7 +70,15 @@ $ remove --glob \"dist/**/*.{js,map}\"
 ```
 
 > [!NOTE]
-> When using the `--glob` option, it will skip `.git/` and `node_modules/` directories by default.
+> When using the `--glob` option, it will skip `.git/` and `node_modules/` directories by default (using the default `--exclude` patterns).
+> If you want to allow deletion of these directories, you can override the default by providing your own `--exclude` option (including an empty array to disable exclusion):
+>
+> ```sh
+> # Remove everything, including .git and node_modules
+> $ npx remove --glob "**/*" --exclude ""
+> # Or exclude only .git, but allow node_modules to be deleted
+> $ npx remove --glob "**/*" --exclude "**/.git/**" --exclude "**/.git"
+> ```
 
 ### Usage
 
@@ -102,6 +114,7 @@ The first argument is an object holding any of the options shown below. The last
   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
+  exclude: string[];        // glob pattern(s) to exclude from deletion
   stats: boolean;           // show some statistics after execution (time + file count)
   verbose: boolean;         // print more information to console when executing the removal
 }
@@ -109,6 +122,7 @@ The first argument is an object holding any of the options shown below. The last
 
 > [!NOTE]
 > The first argument is required and it **must** include either a `paths` or a `glob`, but it cannot include both options simultaneously.
+> Also when `exclude` glob pattern(s) are provided, it will override the default exclude of: [`"**/.git/**", "**/.git", "**/node_modules/**", "**/node_modules"`]
 
 ### Used by
 

package/dist/cli.js

@@ -70,6 +70,11 @@ try {
                 default: false,
                 describe: 'If true, it will log each file or directory being removed',
             },
+            exclude: {
+                alias: 'e',
+                type: 'array',
+                describe: 'Glob pattern(s) to exclude from deletion (overrides the default patterns)',
+            },
         },
         version: readPackage().version,
     };

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -8,24 +8,38 @@ import { throwOrCallback } from './utils.js';
  */
 export function removeSync(opts = {}, callback) {
     const cb = callback || opts.callback;
-    let paths = opts.paths || [];
+    let paths = [];
+    if (typeof opts.paths === 'string' && opts.paths.length > 0) {
+        paths = [opts.paths];
+    }
+    else if (Array.isArray(opts.paths)) {
+        paths = opts.paths.filter(p => typeof p === 'string' && p.length > 0);
+    }
+    let errorMsg = '';
     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;
+        errorMsg =
+            'Please make sure to provide file paths via command arguments or via `--glob` pattern, i.e.: "remove dir" or "remove --glob dir/**/*.js"';
     }
-    if (paths.length && opts.glob) {
-        throwOrCallback(new Error('Providing both `--paths` and `--glob` pattern at the same time is not supported, you must chose only one.'), cb);
+    else if (paths.length > 0 && opts.glob) {
+        errorMsg = 'Providing both `--paths` and `--glob` pattern at the same time is not supported, you must chose only one.';
+    }
+    if (errorMsg) {
+        throwOrCallback(new Error(errorMsg), cb);
         return;
     }
     let pathExists = false;
-    if (!Array.isArray(paths)) {
-        paths = paths.length ? [paths] : [];
-    }
+    // paths is always an array now
     const requiresCwdChange = !!(paths.length && opts.cwd);
     if (!paths.length && opts.glob) {
         // Use fs.globSync to match files. Dotfiles and dot-directories are always included.
-        paths = globSync(opts.glob, { cwd: opts.cwd });
-        // Manually resolve to absolute paths if cwd is set
+        const defaultExclude = ['**/.git/**', '**/.git', '**/node_modules/**', '**/node_modules'];
+        const globOptions = { cwd: opts.cwd, withFileTypes: false };
+        globOptions.exclude = Array.isArray(opts.exclude) ? opts.exclude : defaultExclude;
+        const globResult = globSync(opts.glob, globOptions);
+        // We reassign 'paths' here to hold the final list of files matched by glob,
+        // after filtering for strings and resolving to absolute paths if needed.
+        paths =
+            Array.isArray(globResult) && globResult.length > 0 ? globResult.filter((v) => typeof v === 'string') : [];
         if (opts.cwd) {
             paths = paths.map(p => resolve(opts.cwd, p));
         }

package/dist/interfaces.d.ts

@@ -21,5 +21,10 @@ export interface RemoveOptions {
     stat?: boolean;
     /** Print more information to console */
     verbose?: boolean;
+    /**
+     * Glob pattern(s) to exclude from deletion. If not provided, defaults to `["**\/.git/**", "**\/.git", "**\/node_modules/**", "**\/node_modules"]`
+     * To disable exclusion and allow deleting everything, pass an empty array ([]).
+     */
+    exclude?: string | string[];
 }
 //# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -1 +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,GAAG,MAAM,EAAE,CAAC;IAEzB;;;;;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"}
+{"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,GAAG,MAAM,EAAE,CAAC;IAEzB;;;;;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;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC7B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remove-glob",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "A tiny utility to remove items or directories recursively, also supports glob",
   "bin": {
     "remove": "dist/cli.js"

package/src/cli.ts

@@ -75,6 +75,11 @@ try {
         default: false,
         describe: 'If true, it will log each file or directory being removed',
       },
+      exclude: {
+        alias: 'e',
+        type: 'array',
+        describe: 'Glob pattern(s) to exclude from deletion (overrides the default patterns)',
+      },
     },
     version: readPackage().version,
   } as const;

package/src/index.ts

@@ -1,3 +1,4 @@
+import type { GlobOptions } from 'node:fs';
 import { existsSync, globSync, rmSync, statSync, unlinkSync } from 'node:fs';
 import { resolve } from 'node:path';
 import type { RemoveOptions } from './interfaces.js';
@@ -10,37 +11,45 @@ import { throwOrCallback } from './utils.js';
  */
 export function removeSync(opts: RemoveOptions = {}, callback?: (e?: Error) => void) {
   const cb = callback || opts.callback;
-  let paths = opts.paths || [];
+  let paths: string[] = [];
+  if (typeof opts.paths === 'string' && opts.paths.length > 0) {
+    paths = [opts.paths];
+  } else if (Array.isArray(opts.paths)) {
+    paths = opts.paths.filter(p => typeof p === 'string' && p.length > 0);
+  }
+
+  let errorMsg = '';
   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;
+    errorMsg =
+      'Please make sure to provide file paths via command arguments or via `--glob` pattern, i.e.: "remove dir" or "remove --glob dir/**/*.js"';
+  } else if (paths.length > 0 && opts.glob) {
+    errorMsg = 'Providing both `--paths` and `--glob` pattern at the same time is not supported, you must chose only one.';
   }
-  if (paths.length && opts.glob) {
-    throwOrCallback(
-      new Error('Providing both `--paths` and `--glob` pattern at the same time is not supported, you must chose only one.'),
-      cb,
-    );
+
+  if (errorMsg) {
+    throwOrCallback(new Error(errorMsg), cb);
     return;
   }
+
   let pathExists = false;
-  if (!Array.isArray(paths)) {
-    paths = paths.length ? [paths] : [];
-  }
+  // paths is always an array now
   const requiresCwdChange = !!(paths.length && opts.cwd);
   if (!paths.length && opts.glob) {
     // Use fs.globSync to match files. Dotfiles and dot-directories are always included.
-    paths = globSync(opts.glob, { cwd: opts.cwd });
+    const defaultExclude = ['**/.git/**', '**/.git', '**/node_modules/**', '**/node_modules'];
+    const globOptions: GlobOptions = { cwd: opts.cwd, withFileTypes: false };
+    globOptions.exclude = Array.isArray(opts.exclude) ? opts.exclude : defaultExclude;
 
-    // Manually resolve to absolute paths if cwd is set
+    const globResult = globSync(opts.glob, globOptions);
+    // We reassign 'paths' here to hold the final list of files matched by glob,
+    // after filtering for strings and resolving to absolute paths if needed.
+    paths =
+      Array.isArray(globResult) && globResult.length > 0 ? (globResult as unknown[]).filter((v): v is string => typeof v === 'string') : [];
     if (opts.cwd) {
       paths = paths.map(p => resolve(opts.cwd as string, p));
     }
   }
+
   if (opts.stat || opts.verbose) {
     console.time('Duration');
   }

package/src/interfaces.ts

@@ -27,4 +27,10 @@ export interface RemoveOptions {
 
   /** Print more information to console */
   verbose?: boolean;
+
+  /**
+   * Glob pattern(s) to exclude from deletion. If not provided, defaults to `["**\/.git/**", "**\/.git", "**\/node_modules/**", "**\/node_modules"]`
+   * To disable exclusion and allow deleting everything, pass an empty array ([]).
+   */
+  exclude?: string | string[];
 }