@rustraf/core

The UNIX command rm -rf for node written with Rust.

API

import { remove, removeFile, removeDir } from "@rustraf/core";

remove(fileOrFolder)

Remove a folder or a file, the same behaviour as 'rm -rf fileOrFolder' It will remove empty directories that lack read access on Linux, and will remove "read-only" files and directories on Windows.

removeFile(file)

Remove a file.

removeDir(dir)

Remove a folder and all it's underlying content.

CLI

If installed with

npm install @rustraf/core -g

yarn global add @rustraf/core

it can be used as a global command rustraf <path> [<path> ...] which is useful for cross platform support.

Compared with rimraf

Removing node_modules with a size of 597,5 MB

| Package | Speed | |---------|-----------------------------------------------| | rimraf | 1.61s user 11.26s system 218% cpu 5.899 total | | @rustraf/core | 0.28s user 5.79s system 84% cpu 7.218 total | | native(darwin-arm64) | 0.06s user 5.38s system 86% cpu 6.293 total |