Giter VIP home page Giter VIP logo

delete-empty's Introduction

delete-empty Donate 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.

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm install --save delete-empty

Usage

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

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-await (promise)

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

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

// or
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/', (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/']

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

Usage: $ delete-empty <directory> [options]

Directory: (optional) Initial directory to begin the search for empty
           directories. Otherwise, cwd is used.

[Options]:
  -c, --cwd           Set the current working directory for folders to search.
  -d, --dryRun        Do a dry run without deleting any files.
  -h, --help          Display this help menu
  -V, --version       Display the current version of rename
  -v, --verbose       Display all verbose logging messages (currently not used)

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
31 jonschlinkert
2 treble-snake
1 doowb
1 svenschoenung
1 vpalmisano

Author

Jon Schlinkert

License

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


This file was generated by verb-generate-readme, v0.8.0, on July 02, 2019.

delete-empty's People

Contributors

doowb avatar jonschlinkert avatar svenschoenung avatar the-baaron avatar treble-snake avatar vpalmisano avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

delete-empty's Issues

you are not zhongyong a

console.log(__dirname + '\dist\');
deleteEmpty(__dirname + '\dist\')
.then(deleted => console.log(deleted)) //=> ['foo/aa/', 'foo/a/cc/', 'foo/b/', 'foo/c/']
.catch(console.error);
gulp remove failde

Node requirement is actually >= 7.6.0

The "package.json" file reports the Node engine requirement as node@>=6. However, your use of async/await functionality actually requires node@>=7.6.0.

Please either eliminate the use of the async functions or else correct the Node engine requirement in your "package.json". My personal preference would be to remove the async functions... although they are awesome, it is more frustrating to not be able to use a good utility library because of it requires such a modern version of Node only due to syntactic sugar.

Thanks!

Calling function fails with cannot find 'matched' module

Running deleteEmpty.sync('/mydir') is resulting in the following error output for me:

Error: Cannot find module 'matched'
    at Function.Module._resolveFilename (module.js:337:15)
    at Function.Module._load (module.js:287:25)
    at Module.require (module.js:366:17)
    at require (module.js:385:17)
    at Function.getter [as glob] (/Users/robertgryzynger/Sites/Meyers8/deploy/docroot/themes/custom/meyers/node_modules/lazy-cache/index.js:34:42)
    at Function.deleteEmpty.sync (/Users/robertgryzynger/Sites/Meyers8/deploy/docroot/themes/custom/meyers/node_modules/delete-empty/index.js:58:19)
    at /Users/robertgryzynger/Sites/Meyers8/deploy/docroot/themes/custom/meyers/gulpfile.js:119:18
    at taskWrapper (/Users/robertgryzynger/Sites/Meyers8/deploy/docroot/themes/custom/meyers/node_modules/undertaker/lib/set-task.js:13:15)
    at bound (domain.js:280:14)
    at runBound (domain.js:293:12)

I'm using what appears to be the latest version: 0.1.3.

Async and sync produce different results

Calling the asynchronous deleteEmpty() produces different results than calling the synchronous deleteEmpty.sync() on the same directory.

Example:

src/file.txt
src/foo/
src/foo/bar/

Synchronous

deleteEmpty.sync('src/') produces the following result:

src/file.txt

In the synchronous case src/foo/bar/ is deleted first. Since src/foo/ is now empty, src/foo/ is deleted as well. This is the behavior I expected.

Asynchronous

However deleteEmpty('src/', cb) produces the following result:

src/file.txt
src/foo/

So in the asynchronous case the empty directory src/foo/ is left behind. I would expect src/foo/ to be deleted as well.

Version 3.0.0 doesnt seem to work.

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

does nothing to the folder if we are in version 3.0.0, outputs undefined

Doesn't work on Mac OS because of .DS_Store files

After some experimenting with your plug-in, I found out why I couldn't get it to work: Mac OS automatically adds a hidden .DS_Store file in each folder. When I manually deleted that file from my (otherwise) empty folders, the recursive deletion worked fine. I think it's safe to delete folders even if it contains a hidden .DS_Store file.

(.DS_Store is a file that stores custom attributes of its containing folder, such as the position of icons or the choice of a background image.)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.