clear-folder

Clears the contents of a directory synchronously, for instance the build directory of your node package module.

Since version 4, clear-folder is an es-module. To use commonjs modules, use clear-folder version 3.x.x.

Safe deleting

Clear-folder is a cli app, intended to use safely in the scripts section of a package.json. It just uses the synchronous methods of the node.js fs module. The directory to clear must be inside the current directory. For brevity you may call this app with 'cf' instead of 'clear-folder'.

Usage

Add a number of names of folders to empty:

"scripts": {
    "...": "...",
    "prebuild": "cf folder1 folder2",
    "...": "..."
}

On the command line:

npx cf folder

In a script:

import cf from 'clear-folder'
...
cf(['folder1', 'folder2'])

Return codes

Clear-folder returns the number of emptied folders. When no folders are specified, clear-folder prints an helpful message and returns -1. When one of folders points at or outside the current working directory, clear-folder aborts and returns -1.