https://github.com/brodycj/easy-rm-rf

https://github.com/brodycj/easy-rm-rf

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/brodycj/easy-rm-rf
• Owner: brodycj
• Created: 2018-07-19T03:35:54.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-04-02T19:38:37.000Z (almost 5 years ago)
• Last Synced: 2024-07-31T00:17:28.146Z (5 months ago)
• Language: JavaScript
• Size: 1.95 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Easy rm-rf CLI

**Author:** [@brodybits (Christopher J. Brody)](github.com/brodybits)

**License:** ISC OR MIT

Status: initial proof-of-concept for testing

Quick and easy rm -rf CLI tool for Node.js

## Usage

```sh

easy-rm-rf [-v] path [another-path ...]

```

or simply:

```sh

rm-rf [-v] path [another-path ...]

```

## Design

Conceptually based on: 

CLI part is extremely easy due to `meow` package.

Wrapper around `rimraf.sync` call

In the future this CLI may be reworked to use something like `fs-extra`

instead of `rimraf`.

## Use case

npm cli project has a number of dependencies included (committed) in git,

including `rimraf`, with `rimraf` but no `rimraf.cmd` in its

`node_modules/.bin` directory

This causes `npm run prepare` in npm cli project to fail on Windows cmd shell.

This CLI is the quick and easy solution.

## TODO items

- automatic testing

- rm -rf options

- AppVeyor CI & Travis CI

- rework to use asynchronous API calls

- improve documentation