rimraf 3.0.2 → 4.0.0

package/dist/mjs/src/rimraf-windows.js

@@ -0,0 +1,105 @@
+// This is the same as rimrafPosix, with the following changes:
+//
+// 1. EBUSY, ENFILE, EMFILE trigger retries and/or exponential backoff
+// 2. All non-directories are removed first and then all directories are
+//    removed in a second sweep.
+// 3. If we hit ENOTEMPTY in the second sweep, fall back to move-remove on
+//    the that folder.
+//
+// Note: "move then remove" is 2-10 times slower, and just as unreliable.
+import { parse, resolve } from 'path';
+import { ignoreENOENT, ignoreENOENTSync } from './ignore-enoent';
+import { fixEPERM, fixEPERMSync } from './fix-eperm';
+import { readdirOrError, readdirOrErrorSync } from './readdir-or-error';
+import { retryBusy, retryBusySync } from './retry-busy';
+import { rimrafMoveRemove, rimrafMoveRemoveSync } from './rimraf-move-remove';
+import { promises, rmdirSync, unlinkSync } from './fs';
+const { unlink, rmdir } = promises;
+const rimrafWindowsFile = retryBusy(fixEPERM(unlink));
+const rimrafWindowsFileSync = retryBusySync(fixEPERMSync(unlinkSync));
+const rimrafWindowsDir = retryBusy(fixEPERM(rmdir));
+const rimrafWindowsDirSync = retryBusySync(fixEPERMSync(rmdirSync));
+const rimrafWindowsDirMoveRemoveFallback = async (path, opt) => {
+    try {
+        await rimrafWindowsDir(path, opt);
+    }
+    catch (er) {
+        if (er?.code === 'ENOTEMPTY') {
+            return await rimrafMoveRemove(path, opt);
+        }
+        throw er;
+    }
+};
+const rimrafWindowsDirMoveRemoveFallbackSync = (path, opt) => {
+    try {
+        rimrafWindowsDirSync(path, opt);
+    }
+    catch (er) {
+        if (er?.code === 'ENOTEMPTY') {
+            return rimrafMoveRemoveSync(path, opt);
+        }
+        throw er;
+    }
+};
+const START = Symbol('start');
+const CHILD = Symbol('child');
+const FINISH = Symbol('finish');
+const states = new Set([START, CHILD, FINISH]);
+export const rimrafWindows = async (path, opt, state = START) => {
+    if (!states.has(state)) {
+        throw new TypeError('invalid third argument passed to rimraf');
+    }
+    const entries = await readdirOrError(path);
+    if (!Array.isArray(entries)) {
+        if (entries.code === 'ENOENT') {
+            return;
+        }
+        if (entries.code !== 'ENOTDIR') {
+            throw entries;
+        }
+        // is a file
+        return ignoreENOENT(rimrafWindowsFile(path, opt));
+    }
+    await Promise.all(entries.map(entry => rimrafWindows(resolve(path, entry), opt, state === START ? CHILD : state)));
+    if (state === START) {
+        return rimrafWindows(path, opt, FINISH);
+    }
+    else if (state === FINISH) {
+        if (opt.preserveRoot === false && path === parse(path).root) {
+            return;
+        }
+        return ignoreENOENT(rimrafWindowsDirMoveRemoveFallback(path, opt));
+    }
+};
+export const rimrafWindowsSync = (path, opt, state = START) => {
+    if (!states.has(state)) {
+        throw new TypeError('invalid third argument passed to rimraf');
+    }
+    const entries = readdirOrErrorSync(path);
+    if (!Array.isArray(entries)) {
+        if (entries.code === 'ENOENT') {
+            return;
+        }
+        if (entries.code !== 'ENOTDIR') {
+            throw entries;
+        }
+        // is a file
+        return ignoreENOENTSync(() => rimrafWindowsFileSync(path, opt));
+    }
+    for (const entry of entries) {
+        const s = state === START ? CHILD : state;
+        rimrafWindowsSync(resolve(path, entry), opt, s);
+    }
+    if (state === START) {
+        return rimrafWindowsSync(path, opt, FINISH);
+    }
+    else if (state === FINISH) {
+        if (opt.preserveRoot === false && path === parse(path).root) {
+            return;
+        }
+        return ignoreENOENTSync(() => {
+            rimrafWindowsDirMoveRemoveFallbackSync(path, opt);
+        });
+    }
+};
+//# sourceMappingURL=rimraf-windows.js.map

package/dist/mjs/src/rimraf-windows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rimraf-windows.js","sourceRoot":"","sources":["../../../src/rimraf-windows.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,EAAE;AACF,sEAAsE;AACtE,wEAAwE;AACxE,gCAAgC;AAChC,0EAA0E;AAC1E,sBAAsB;AACtB,EAAE;AACF,yEAAyE;AAEzE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAChE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AACvE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAC7E,OAAO,EAAW,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AAE/D,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAA;AAElC,MAAM,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;AACrD,MAAM,qBAAqB,GAAG,aAAa,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAA;AACrE,MAAM,gBAAgB,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;AACnD,MAAM,oBAAoB,GAAG,aAAa,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAA;AAEnE,MAAM,kCAAkC,GAAG,KAAK,EAC9C,IAAY,EACZ,GAAkB,EAClB,EAAE;IACF,IAAI;QACF,MAAM,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAClC;IAAC,OAAO,EAAE,EAAE;QACX,IAAK,EAAc,EAAE,IAAI,KAAK,WAAW,EAAE;YACzC,OAAO,MAAM,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;SACzC;QACD,MAAM,EAAE,CAAA;KACT;AACH,CAAC,CAAA;AAED,MAAM,sCAAsC,GAAG,CAC7C,IAAY,EACZ,GAAkB,EAClB,EAAE;IACF,IAAI;QACF,oBAAoB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAChC;IAAC,OAAO,EAAE,EAAE;QACX,IAAK,EAAc,EAAE,IAAI,KAAK,WAAW,EAAE;YACzC,OAAO,oBAAoB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;SACvC;QACD,MAAM,EAAE,CAAA;KACT;AACH,CAAC,CAAA;AAED,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;AAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;AAC7B,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;AAC/B,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;AAE9C,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAChC,IAAY,EACZ,GAAkB,EAClB,KAAK,GAAG,KAAK,EACE,EAAE;IACjB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QACtB,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAA;KAC/D;IAED,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,CAAA;IAC1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAC3B,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC7B,OAAM;SACP;QACD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;YAC9B,MAAM,OAAO,CAAA;SACd;QACD,YAAY;QACZ,OAAO,YAAY,CAAC,iBAAiB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAA;KAClD;IAED,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAClB,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAC1E,CACF,CAAA;IAED,IAAI,KAAK,KAAK,KAAK,EAAE;QACnB,OAAO,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAA;KACxC;SAAM,IAAI,KAAK,KAAK,MAAM,EAAE;QAC3B,IAAI,GAAG,CAAC,YAAY,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;YAC3D,OAAM;SACP;QACD,OAAO,YAAY,CAAC,kCAAkC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAA;KACnE;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,IAAY,EACZ,GAAkB,EAClB,KAAK,GAAG,KAAK,EACP,EAAE;IACR,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QACtB,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAA;KAC/D;IAED,MAAM,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAA;IACxC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAC3B,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC7B,OAAM;SACP;QACD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;YAC9B,MAAM,OAAO,CAAA;SACd;QACD,YAAY;QACZ,OAAO,gBAAgB,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAA;KAChE;IAED,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;QAC3B,MAAM,CAAC,GAAG,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAA;QACzC,iBAAiB,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;KAChD;IAED,IAAI,KAAK,KAAK,KAAK,EAAE;QACnB,OAAO,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAA;KAC5C;SAAM,IAAI,KAAK,KAAK,MAAM,EAAE;QAC3B,IAAI,GAAG,CAAC,YAAY,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;YAC3D,OAAM;SACP;QACD,OAAO,gBAAgB,CAAC,GAAG,EAAE;YAC3B,sCAAsC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QACnD,CAAC,CAAC,CAAA;KACH;AACH,CAAC,CAAA"}

package/dist/mjs/src/use-native.d.ts

@@ -0,0 +1,2 @@
+export declare const useNative: () => boolean;
+export declare const useNativeSync: () => boolean;

package/dist/mjs/src/use-native.js

@@ -0,0 +1,6 @@
+const version = process.env.__TESTING_RIMRAF_NODE_VERSION__ || process.version;
+const versArr = version.replace(/^v/, '').split('.');
+const hasNative = +versArr[0] > 14 || (+versArr[0] === 14 && +versArr[1] >= 14);
+export const useNative = !hasNative ? () => false : () => true;
+export const useNativeSync = !hasNative ? () => false : () => true;
+//# sourceMappingURL=use-native.js.map

package/dist/mjs/src/use-native.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-native.js","sourceRoot":"","sources":["../../../src/use-native.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,+BAA+B,IAAI,OAAO,CAAC,OAAO,CAAA;AAC9E,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AACpD,MAAM,SAAS,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;AAC/E,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAA;AAC9D,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAA"}

package/package.json

@@ -1,7 +1,18 @@
 {
   "name": "rimraf",
-  "version": "3.0.2",
-  "main": "rimraf.js",
+  "version": "4.0.0",
+  "main": "./dist/cjs/src/index.js",
+  "module": "./dist/mjs/src/index.js",
+  "bin": "./dist/cjs/src/bin.js",
+  "exports": {
+    ".": {
+      "import": "./dist/mjs/src/index.js",
+      "require": "./dist/cjs/src/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
   "description": "A deep deletion module for node (like `rm -rf`)",
   "author": "Isaac Z. Schlueter <i@izs.me> (http://blog.izs.me/)",
   "license": "ISC",
@@ -9,24 +20,55 @@
   "scripts": {
     "preversion": "npm test",
     "postversion": "npm publish",
-    "postpublish": "git push origin --follow-tags",
-    "test": "tap test/*.js"
+    "prepublishOnly": "git push origin --follow-tags",
+    "preprepare": "rm -rf dist",
+    "prepare": "tsc -p tsconfig-cjs.json && tsc -p tsconfig-esm.json",
+    "postprepare": "bash fixup.sh",
+    "pretest": "npm run prepare",
+    "presnap": "npm run prepare",
+    "test": "c8 tap",
+    "snap": "c8 tap",
+    "format": "prettier --write . --loglevel warn",
+    "benchmark": "node benchmark/index.js",
+    "typedoc": "typedoc --tsconfig tsconfig-esm.json ./src/*.ts"
   },
-  "bin": "./bin.js",
-  "dependencies": {
-    "glob": "^7.1.3"
+  "prettier": {
+    "semi": false,
+    "printWidth": 80,
+    "tabWidth": 2,
+    "useTabs": false,
+    "singleQuote": true,
+    "jsxSingleQuote": false,
+    "bracketSameLine": true,
+    "arrowParens": "avoid",
+    "endOfLine": "lf"
   },
-  "files": [
-    "LICENSE",
-    "README.md",
-    "bin.js",
-    "rimraf.js"
-  ],
   "devDependencies": {
-    "mkdirp": "^0.5.1",
-    "tap": "^12.1.1"
+    "@types/node": "^18.11.9",
+    "@types/tap": "^15.0.7",
+    "c8": "^7.12.0",
+    "eslint-config-prettier": "^8.6.0",
+    "mkdirp": "1",
+    "prettier": "^2.8.2",
+    "tap": "^16.3.3",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.23.21",
+    "typescript": "^4.9.3"
+  },
+  "tap": {
+    "coverage": false,
+    "libtap-settings": "libtap-settings.js",
+    "node-arg": [
+      "--no-warnings",
+      "--loader",
+      "ts-node/esm"
+    ],
+    "ts": false
   },
   "funding": {
     "url": "https://github.com/sponsors/isaacs"
+  },
+  "engines": {
+    "node": ">=14"
   }
 }

package/CHANGELOG.md

@@ -1,65 +0,0 @@
-# v3.0
-
-- Add `--preserve-root` option to executable (default true)
-- Drop support for Node.js below version 6
-
-# v2.7
-
-- Make `glob` an optional dependency
-
-# 2.6
-
-- Retry on EBUSY on non-windows platforms as well
-- Make `rimraf.sync` 10000% more reliable on Windows
-
-# 2.5
-
-- Handle Windows EPERM when lstat-ing read-only dirs
-- Add glob option to pass options to glob
-
-# 2.4
-
-- Add EPERM to delay/retry loop
-- Add `disableGlob` option
-
-# 2.3
-
-- Make maxBusyTries and emfileWait configurable
-- Handle weird SunOS unlink-dir issue
-- Glob the CLI arg for better Windows support
-
-# 2.2
-
-- Handle ENOENT properly on Windows
-- Allow overriding fs methods
-- Treat EPERM as indicative of non-empty dir
-- Remove optional graceful-fs dep
-- Consistently return null error instead of undefined on success
-- win32: Treat ENOTEMPTY the same as EBUSY
-- Add `rimraf` binary
-
-# 2.1
-
-- Fix SunOS error code for a non-empty directory
-- Try rmdir before readdir
-- Treat EISDIR like EPERM
-- Remove chmod
-- Remove lstat polyfill, node 0.7 is not supported
-
-# 2.0
-
-- Fix myGid call to check process.getgid
-- Simplify the EBUSY backoff logic.
-- Use fs.lstat in node >= 0.7.9
-- Remove gently option
-- remove fiber implementation
-- Delete files that are marked read-only
-
-# 1.0
-
-- Allow ENOENT in sync method
-- Throw when no callback is provided
-- Make opts.gently an absolute path
-- use 'stat' if 'lstat' is not available
-- Consistent error naming, and rethrow non-ENOENT stat errors
-- add fiber implementation

package/bin.js

@@ -1,68 +0,0 @@
-#!/usr/bin/env node
-
-const rimraf = require('./')
-
-const path = require('path')
-
-const isRoot = arg => /^(\/|[a-zA-Z]:\\)$/.test(path.resolve(arg))
-const filterOutRoot = arg => {
-  const ok = preserveRoot === false || !isRoot(arg)
-  if (!ok) {
-    console.error(`refusing to remove ${arg}`)
-    console.error('Set --no-preserve-root to allow this')
-  }
-  return ok
-}
-
-let help = false
-let dashdash = false
-let noglob = false
-let preserveRoot = true
-const args = process.argv.slice(2).filter(arg => {
-  if (dashdash)
-    return !!arg
-  else if (arg === '--')
-    dashdash = true
-  else if (arg === '--no-glob' || arg === '-G')
-    noglob = true
-  else if (arg === '--glob' || arg === '-g')
-    noglob = false
-  else if (arg.match(/^(-+|\/)(h(elp)?|\?)$/))
-    help = true
-  else if (arg === '--preserve-root')
-    preserveRoot = true
-  else if (arg === '--no-preserve-root')
-    preserveRoot = false
-  else
-    return !!arg
-}).filter(arg => !preserveRoot || filterOutRoot(arg))
-
-const go = n => {
-  if (n >= args.length)
-    return
-  const options = noglob ? { glob: false } : {}
-  rimraf(args[n], options, er => {
-    if (er)
-      throw er
-    go(n+1)
-  })
-}
-
-if (help || args.length === 0) {
-  // If they didn't ask for help, then this is not a "success"
-  const log = help ? console.log : console.error
-  log('Usage: rimraf <path> [<path> ...]')
-  log('')
-  log('  Deletes all files and folders at "path" recursively.')
-  log('')
-  log('Options:')
-  log('')
-  log('  -h, --help          Display this usage info')
-  log('  -G, --no-glob       Do not expand glob patterns in arguments')
-  log('  -g, --glob          Expand glob patterns in arguments (default)')
-  log('  --preserve-root     Do not remove \'/\' (default)')
-  log('  --no-preserve-root  Do not treat \'/\' specially')
-  log('  --                  Stop parsing flags')
-  process.exit(help ? 0 : 1)
-} else
-  go(0)