jonschlinkert/delete-empty


Recursively delete all empty folders in a directory and child directories.

License: MIT

Language: JavaScript

Keywords: delete, directories, directory, empty, files, glob, nodejs


delete-empty NPM version NPM monthly downloads NPM total downloads Linux Build Status

Recursively delete all empty folders in a directory and child directories.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save delete-empty

Usage

const deleteEmpty = require('delete-empty');

CLI

To use the delete-empty command from any directory you must first install the package globally with the following command:

$ npm install --global delete-empty

Usage

$ delete-empty [<cwd>] [--dry-run|-d]
  • <cwd> (optional) - initial directory to begin the search for empty directories. By default, the current working directory (process.cwd()) is used (note that process.cwd() is only used as the default by the CLI).
  • -d, --dry-run (optional) - output empty directories to the terminal, does not delete anything

API

Given the following directory structure, the highlighted directories would be deleted.

foo/
└─┬ a/
-  ├── aa/
  ├── bb/
  │ └─┬ bbb/
  │ │ ├── one.txt
  │ │ └── two.txt
-  ├── cc/
-  ├ b/
-  └ c/

async promise

If no callback is passed, a promise is returned. Returns the array of deleted directories.

deleteEmpty('foo/')
  .then(deleted => console.log(deleted)) //=> ['foo/aa/', 'foo/a/cc/', 'foo/b/', 'foo/c/']
  .catch(console.error);

async callback

Returns the array of deleted directories in the callback.

deleteEmpty('foo/', function(err, deleted) {
  console.log(deleted); //=> ['foo/aa/', 'foo/a/cc/', 'foo/b/', 'foo/c/']
});

sync

Returns the array of deleted directories.

console.log(deleteEmpty.sync('foo/')); //=> ['foo/aa/', 'foo/a/cc/', 'foo/b/', 'foo/c/']

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

  • copy: Copy files or directories using globs. | homepage
  • delete: Delete files and folders and any intermediate directories if they exist (sync and async). | homepage
  • fs-utils: fs extras and utilities to extend the node.js file system module. Used in Assemble and… more | homepage
  • matched: Adds array support to node-glob, sync and async. Also supports tilde expansion (user home) and… more | homepage

Contributors

Commits Contributor
27 jonschlinkert
2 treble-snake
1 doowb
1 svenschoenung
1 vpalmisano

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on February 16, 2018.

Project Statistics

Sourcerank 10
Repository Size 32.2 KB
Stars 15
Forks 7
Watchers 2
Open issues 0
Dependencies 7
Contributors 5
Tags 5
Created
Last updated
Last pushed

Top Contributors See all

Jon Schlinkert treble-snake Brian Woodward Vittorio Palmisano Sven Schoenung

Packages Referencing this Repo

delete-empty
Recursively delete all empty folders in a directory and child directories.
Latest release 2.0.0 - Updated - 15 stars

Recent Tags See all

2.0.0 February 16, 2018
1.0.1 April 07, 2017
1.0.0 February 24, 2017
0.1.3 May 14, 2016
0.1.1 December 03, 2015

Something wrong with this page? Make a suggestion

Last synced: 2018-02-23 16:29:17 UTC

Login to resync this repository