fs: add rm method

This PR introduces a new method fs.rm that provides the behaviour of rimraf when used with the recursive: true and force: true options. PR-URL: #35494 Reviewed-By: Ben Coe <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Ruy Adorno <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

Author: iansu

doc/api/errors.md

@@ -928,6 +928,11 @@ added: v14.0.0
 Used when a feature that is not available
 to the current platform which is running Node.js is used.
 
+<aid="ERR_FS_EISDIR"></a>
+### `ERR_FS_EISDIR`
+
+Path is a directory.
+
 <aid="ERR_FS_FILE_TOO_LARGE"></a>
 ### `ERR_FS_FILE_TOO_LARGE`
 

doc/api/fs.md

@@ -3509,9 +3509,9 @@ changes:
 *`options`{Object}
 *`maxRetries`{integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
 `EPERM` error is encountered, Node.js will retry the operation with a linear
- backoff wait of `retryDelay`ms longer on each try. This option represents
- the number of retries. This option is ignored if the `recursive` option is
- not `true`. **Default:**`0`.
+ backoff wait of `retryDelay`milliseconds longer on each try. This option
+represents the number of retries. This option is ignored if the `recursive`
+option is not `true`. **Default:**`0`.
 *`recursive`{boolean} If `true`, perform a recursive directory removal. In
  recursive mode, errors are not reported if `path` does not exist, and
  operations are retried on failure. **Default:**`false`.
@@ -3560,9 +3560,9 @@ changes:
 *`options`{Object}
 *`maxRetries`{integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
 `EPERM` error is encountered, Node.js will retry the operation with a linear
- backoff wait of `retryDelay`ms longer on each try. This option represents
- the number of retries. This option is ignored if the `recursive` option is
- not `true`. **Default:**`0`.
+ backoff wait of `retryDelay`milliseconds longer on each try. This option
+represents the number of retries. This option is ignored if the `recursive`
+option is not `true`. **Default:**`0`.
 *`recursive`{boolean} If `true`, perform a recursive directory removal. In
  recursive mode, errors are not reported if `path` does not exist, and
  operations are retried on failure. **Default:**`false`.
@@ -3581,6 +3581,53 @@ that represent files will be deleted. The permissive behavior of the
 `recursive` option is deprecated, `ENOTDIR` and `ENOENT` will be thrown in
 the future.
 
+## `fs.rm(path[, options], callback)`
+<!-- YAML
+added: REPLACEME
+-->
+
+*`path`{string|Buffer|URL}
+*`options`{Object}
+*`force` don't error on nonexistent path
+*`maxRetries`{integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
+`EPERM` error is encountered, Node.js will retry the operation with a linear
+ backoff wait of `retryDelay` milliseconds longer on each try. This option
+ represents the number of retries. This option is ignored if the `recursive`
+ option is not `true`. **Default:**`0`.
+*`recursive`{boolean} If `true`, perform a recursive removal. In
+ recursive mode operations are retried on failure. **Default:**`false`.
+*`retryDelay`{integer} The amount of time in milliseconds to wait between
+ retries. This option is ignored if the `recursive` option is not `true`.
+**Default:**`100`.
+*`callback`{Function}
+*`err`{Error}
+
+Asynchronously removes files and directories (modeled on the standard POSIX `rm`
+utility). No arguments other than a possible exception are given to the
+completion callback.
+
+## `fs.rmSync(path[, options])`
+<!-- YAML
+added: REPLACEME
+-->
+
+*`path`{string|Buffer|URL}
+*`options`{Object}
+*`force` Ignore errors
+*`maxRetries`{integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
+`EPERM` error is encountered, Node.js will retry the operation with a linear
+ backoff wait of `retryDelay` milliseconds longer on each try. This option
+ represents the number of retries. This option is ignored if the `recursive`
+ option is not `true`. **Default:**`0`.
+*`recursive`{boolean} If `true`, perform a recursive directory removal. In
+ recursive mode operations are retried on failure. **Default:**`false`.
+*`retryDelay`{integer} The amount of time in milliseconds to wait between
+ retries. This option is ignored if the `recursive` option is not `true`.
+**Default:**`100`.
+
+Synchronously removes files and directories (modeled on the standard POSIX `rm`
+utility). Returns `undefined`.
+
 ## `fs.stat(path[, options], callback)`
 <!-- YAML
 added: v0.0.2
@@ -5447,9 +5494,9 @@ changes:
 *`options`{Object}
 *`maxRetries`{integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
 `EPERM` error is encountered, Node.js will retry the operation with a linear
- backoff wait of `retryDelay`ms longer on each try. This option represents
- the number of retries. This option is ignored if the `recursive` option is
- not `true`. **Default:**`0`.
+ backoff wait of `retryDelay`milliseconds longer on each try. This option
+represents the number of retries. This option is ignored if the `recursive`
+option is not `true`. **Default:**`0`.
 *`recursive`{boolean} If `true`, perform a recursive directory removal. In
  recursive mode, errors are not reported if `path` does not exist, and
  operations are retried on failure. **Default:**`false`.
@@ -5471,6 +5518,28 @@ that represent files will be deleted. The permissive behavior of the
 `recursive` option is deprecated, `ENOTDIR` and `ENOENT` will be thrown in
 the future.
 
+## `fsPromises.rm(path[, options])`
+<!-- YAML
+added: REPLACEME
+-->
+
+*`path`{string|Buffer|URL}
+*`options`{Object}
+*`force` Ignore errors
+*`maxRetries`{integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
+`EPERM` error is encountered, Node.js will retry the operation with a linear
+ backoff wait of `retryDelay` milliseconds longer on each try. This option
+ represents the number of retries. This option is ignored if the `recursive`
+ option is not `true`. **Default:**`0`.
+*`recursive`{boolean} If `true`, perform a recursive directory removal. In
+ recursive mode operations are retried on failure. **Default:**`false`.
+*`retryDelay`{integer} The amount of time in milliseconds to wait between
+ retries. This option is ignored if the `recursive` option is not `true`.
+**Default:**`100`.
+
+Synchronously removes files and directories (modeled on the standard POSIX `rm`
+utility). Resolves the `Promise` with no arguments on success.
+
 ### `fsPromises.stat(path[, options])`
 <!-- YAML
 added: v10.0.0

lib/fs.js

@@ -97,6 +97,8 @@ const{
  validateOffsetLengthRead,
  validateOffsetLengthWrite,
  validatePath,
+ validateRmOptions,
+ validateRmOptionsSync,
  validateRmdirOptions,
  validateStringAfterArrayBufferView,
  warnOnNonPortableTemplate
@@ -855,30 +857,63 @@ function rmdir(path, options, callback){
 
 callback=makeCallback(callback);
 path=pathModule.toNamespacedPath(getValidatedPath(path));
-options=validateRmdirOptions(options);
 
-if(options.recursive){
-lazyLoadRimraf();
-returnrimraf(path,options,callback);
-}
+if(options&&options.recursive){
+options=validateRmOptions(
+path,
+{ ...options,force: true},
+(err,options)=>{
+if(err){
+returncallback(err);
+}
 
-constreq=newFSReqCallback();
-req.oncomplete=callback;
-binding.rmdir(path,req);
+lazyLoadRimraf();
+returnrimraf(path,options,callback);
+});
+
+}else{
+options=validateRmdirOptions(options);
+constreq=newFSReqCallback();
+req.oncomplete=callback;
+returnbinding.rmdir(path,req);
+}
 }
 
 functionrmdirSync(path,options){
 path=getValidatedPath(path);
-options=validateRmdirOptions(options);
 
-if(options.recursive){
+if(options&&options.recursive){
+options=validateRmOptionsSync(path,{ ...options,force: true});
 lazyLoadRimraf();
 returnrimrafSync(pathModule.toNamespacedPath(path),options);
 }
 
+options=validateRmdirOptions(options);
 constctx={ path };
 binding.rmdir(pathModule.toNamespacedPath(path),undefined,ctx);
-handleErrorFromBinding(ctx);
+returnhandleErrorFromBinding(ctx);
+}
+
+functionrm(path,options,callback){
+if(typeofoptions==='function'){
+callback=options;
+options=undefined;
+}
+
+validateRmOptions(path,options,(err,options)=>{
+if(err){
+returncallback(err);
+}
+lazyLoadRimraf();
+returnrimraf(pathModule.toNamespacedPath(path),options,callback);
+});
+}
+
+functionrmSync(path,options){
+options=validateRmOptionsSync(path,options);
+
+lazyLoadRimraf();
+returnrimrafSync(pathModule.toNamespacedPath(path),options);
 }
 
 functionfdatasync(fd,callback){
@@ -2040,6 +2075,8 @@ module.exports = fs ={
  realpathSync,
  rename,
  renameSync,
+ rm,
+ rmSync,
  rmdir,
  rmdirSync,
  stat,

lib/internal/errors.js

@@ -839,6 +839,7 @@ E('ERR_FEATURE_UNAVAILABLE_ON_PLATFORM',
 'The feature %s is unavailable on the current platform'+
 ', which is being used to run Node.js',
 TypeError);
+E('ERR_FS_EISDIR','Path is a directory',SystemError);
 E('ERR_FS_FILE_TOO_LARGE','File size (%s) is greater than 2 GB',RangeError);
 E('ERR_FS_INVALID_SYMLINK_TYPE',
 'Symlink type must be one of "dir", "file", or "junction". Received "%s"',

lib/internal/fs/promises.js

@@ -52,6 +52,7 @@ const{
  validateBufferArray,
  validateOffsetLengthRead,
  validateOffsetLengthWrite,
+ validateRmOptions,
  validateRmdirOptions,
  validateStringAfterArrayBufferView,
  warnOnNonPortableTemplate
@@ -79,6 +80,7 @@ const{
 }=require('internal/worker/js_transferable');
 
 constgetDirectoryEntriesPromise=promisify(getDirents);
+constvalidateRmOptionsPromise=promisify(validateRmOptions);
 
 classFileHandleextendsJSTransferable{
 constructor(filehandle){
@@ -417,6 +419,12 @@ async function ftruncate(handle, len = 0){
 returnbinding.ftruncate(handle.fd,len,kUsePromises);
 }
 
+asyncfunctionrm(path,options){
+path=pathModule.toNamespacedPath(getValidatedPath(path));
+options=awaitvalidateRmOptionsPromise(path,options);
+returnrimrafPromises(path,options);
+}
+
 asyncfunctionrmdir(path,options){
 path=pathModule.toNamespacedPath(getValidatedPath(path));
 options=validateRmdirOptions(options);
@@ -635,6 +643,7 @@ module.exports ={
 opendir: promisify(opendir),
  rename,
  truncate,
+ rm,
  rmdir,
  mkdir,
  readdir,