<commit_before># Remy [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]

Remove files with emitter.

## Global

`remy` could be installed global with

```
npm i remy -g
```
And used this way:

```
Usage: remy [path]
Options:
  -h, --help      display this help and exit
  -v, --version   output version information and exit
```

## Local

`Remy` could be used localy. It will emit event on every copied file.
Good for making progress bars.

### Install

```
npm i rummy --save
```

### How to use?
`Remy` could be called with one or two arguments: `remy(path[, files])`.

```js
var remy            = require('remy'),
    cwd             = process.cwd(),
    abortOnError    = false;
    
rm = remy(cwd, [
    'LICENSE',
    'README.md',
    'package.json'
]);

rm.on('file', function(name) {
    console.log(name);
});

rm.on('progress', function(percent) {
    console.log(percent);
    
    if (percent >= 50) {
        rm.pause();
        rm.continue();
    }
});

rm.on('error', function(error, name, i, percent) {
    console.error(percent, ' -> ', name, ':', error.message);
    
    if (abortOnError)
        rm.abort();
    else
        rm.continue();
});

rm.on('end', function() {
    console.log('Removing ended up');
});
```

In case of starting example output should be similar to:

```
33%
67%
100%
Removing ended up
```

## License

MIT

[NPMIMGURL]:                https://img.shields.io/npm/v/remy.svg?style=flat
[BuildStatusIMGURL]:        https://img.shields.io/travis/coderaiser/node-remy/master.svg?style=flat
[DependencyStatusIMGURL]:   https://img.shields.io/gemnasium/coderaiser/node-remy.svg?style=flat
[LicenseIMGURL]:            https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[CoverageIMGURL]:           https://coveralls.io/repos/coderaiser/node-remy/badge.svg?branch=master&service=github
[NPMURL]:                   https://npmjs.org/package/remy "npm"
[BuildStatusURL]:           https://travis-ci.org/coderaiser/node-remy  "Build Status"
[DependencyStatusURL]:      https://gemnasium.com/coderaiser/node-remy "Dependency Status"
[LicenseURL]:               https://tldrlegal.com/license/mit-license "MIT License"
[CoverageURL]:              https://coveralls.io/github/coderaiser/node-remy?branch=master
<commit_msg>docs(readme) Related<commit_after># Remy [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]

Remove files with emitter.

## Global

`remy` could be installed global with

```
npm i remy -g
```
And used this way:

```
Usage: remy [path]
Options:
  -h, --help      display this help and exit
  -v, --version   output version information and exit
```

## Local

`Remy` could be used localy. It will emit event on every copied file.
Good for making progress bars.

### Install

```
npm i rummy --save
```

### How to use?
`Remy` could be called with one or two arguments: `remy(path[, files])`.

```js
var remy            = require('remy'),
    cwd             = process.cwd(),
    abortOnError    = false;
    
rm = remy(cwd, [
    'LICENSE',
    'README.md',
    'package.json'
]);

rm.on('file', function(name) {
    console.log(name);
});

rm.on('progress', function(percent) {
    console.log(percent);
    
    if (percent >= 50) {
        rm.pause();
        rm.continue();
    }
});

rm.on('error', function(error, name, i, percent) {
    console.error(percent, ' -> ', name, ':', error.message);
    
    if (abortOnError)
        rm.abort();
    else
        rm.continue();
});

rm.on('end', function() {
    console.log('Removing ended up');
});
```

In case of starting example output should be similar to:

```
33%
67%
100%
Removing ended up
```
## Related

- [Copymitter](https://github.com/coderaiser/node-copymitter "Copymitter") - Copy files with emitter.
- [OneZip](https://github.com/coderaiser/node-onezip "OneZip") - Pack and extract zip archives with emitter.
- [Tar-to-zip](https://github.com/coderaiser/node-tar-to-zip "tar-to-zip") - Convert tar and tar.gz archives to zip.

## License

MIT

[NPMIMGURL]:                https://img.shields.io/npm/v/remy.svg?style=flat
[BuildStatusIMGURL]:        https://img.shields.io/travis/coderaiser/node-remy/master.svg?style=flat
[DependencyStatusIMGURL]:   https://img.shields.io/gemnasium/coderaiser/node-remy.svg?style=flat
[LicenseIMGURL]:            https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[CoverageIMGURL]:           https://coveralls.io/repos/coderaiser/node-remy/badge.svg?branch=master&service=github
[NPMURL]:                   https://npmjs.org/package/remy "npm"
[BuildStatusURL]:           https://travis-ci.org/coderaiser/node-remy  "Build Status"
[DependencyStatusURL]:      https://gemnasium.com/coderaiser/node-remy "Dependency Status"
[LicenseURL]:               https://tldrlegal.com/license/mit-license "MIT License"
[CoverageURL]:              https://coveralls.io/github/coderaiser/node-remy?branch=master

{'fraction_non_alphanumeric': 0.16302903776807742, 'fraction_numerical': 0.004934522679825394, 'mean_word_length': 3.3090760425183974, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 23, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2287036', 'n_tokens_mistral': 1857, 'n_tokens_neox': 1786, 'n_words': 372}