@bevry/fs-remove
Version:
Remove a file or directory.
175 lines (174 loc) • 10.2 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
// builtin
var fs_1 = require("fs");
var os_1 = require("os");
var isWindows = (0, os_1.platform)() === 'win32';
var child_process_1 = require("child_process");
var process_1 = require("process");
var nodeVersion = String(process_1.versions.node || '0');
// external
var fs_accessible_1 = __importStar(require("@bevry/fs-accessible"));
var errlop_1 = __importDefault(require("errlop"));
var version_compare_1 = __importDefault(require("version-compare"));
/** Remove a file or directory. */
function remove(path) {
return __awaiter(this, void 0, void 0, function () {
var err_1, err_2;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (Array.isArray(path)) {
return [2 /*return*/, Promise.all(path.map(function (i) { return remove(i); })).then(function () { })];
}
// sanity check
if (path === '' || path === '/') {
throw new Error('will not remove root directory');
}
_a.label = 1;
case 1:
_a.trys.push([1, 3, , 4]);
return [4 /*yield*/, (0, fs_accessible_1.default)(path)];
case 2:
_a.sent();
return [3 /*break*/, 4];
case 3:
err_1 = _a.sent();
// if it doesn't exist, then we don't care
return [2 /*return*/];
case 4:
_a.trys.push([4, 6, , 7]);
return [4 /*yield*/, (0, fs_accessible_1.default)(path, fs_accessible_1.W_OK)];
case 5:
_a.sent();
return [3 /*break*/, 7];
case 6:
err_2 = _a.sent();
if (err_2.code === 'ENOENT') {
// if it doesn't exist, then we don't care (this may not seem necessary due to the earlier accessible check, however it is necessary, testen would fail on @bevry/json otherwise)
return [2 /*return*/];
}
throw new errlop_1.default("unable to remove the non-writable path: ".concat(path), err_2);
case 7:
// attempt removal
return [2 /*return*/, new Promise(function (resolve, reject) {
function next(err) {
if (err && err.code === 'ENOENT')
return resolve();
if (err) {
return reject(new errlop_1.default("failed to remove the accessible and writable path: ".concat(path), err));
}
return resolve();
}
// modern versions have a command that works on files and directories
if ((0, version_compare_1.default)(nodeVersion, '14.14.0') >= 0) {
// use rm builtin via dynamic import (necessary as older versions will fail as you can't import something that doesn't exist
Promise.resolve().then(function () { return __importStar(require('fs')); }).then(function (_a) {
var _rm = _a.rm;
_rm(path, { recursive: true, force: true, maxRetries: 10 }, next);
});
return;
}
// older versions require a different command for files and directories, so determine which it is
(0, fs_1.stat)(path, function (err, stat) {
if (err)
return next(err);
var isDirectory = stat.isDirectory();
// is file
if (!isDirectory) {
(0, fs_1.unlink)(path, next);
return;
}
// is directory
// NOTE: if you are wondering why this now differs from @bevry/fs-rmdir, it is because the 14.14.0 option is earlier in this file
if ((0, version_compare_1.default)(nodeVersion, '12.16.0') >= 0 &&
(0, version_compare_1.default)(nodeVersion, '16') < 0) {
// use rmdir builtin via dynamic import (necessary as older versions will fail as you can't import something that doesn't exist
Promise.resolve().then(function () { return __importStar(require('fs')); }).then(function (_a) {
var _rmdir = _a.rmdir;
_rmdir(path, { recursive: true, maxRetries: 10 }, next);
});
}
else if ((0, version_compare_1.default)(nodeVersion, '12.10.0') >= 0 &&
(0, version_compare_1.default)(nodeVersion, '12.16.0') < 0) {
// use rmdir builtin via dynamic import (necessary as older versions will fail as you can't import something that doesn't exist
Promise.resolve().then(function () { return __importStar(require('fs')); }).then(function (_a) {
var _rmdir = _a.rmdir;
// as any is to workaround that type definition is only for the latest version
_rmdir(path, { recursive: true, maxBusyTries: 10 }, next);
});
}
else {
// no builtin option exists, so use platform-specific workarounds
// rmdir: https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-xp/bb490990(v=technet.10)?redirectedfrom=MSDN
(0, child_process_1.exec)("".concat(isWindows ? "rmdir /s /q" : "rm -rf", " ").concat(JSON.stringify(path)), next);
}
});
})];
}
});
});
}
exports.default = remove;