# gulp-prune

> Delete files that should not be in the destination directory

Latest version **2.0.1** (published 2022-03-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install gulp-prune
pnpm add gulp-prune
yarn add gulp-prune
bun add gulp-prune
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2022-03-16 |
| First published | 2016-07-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM |
| Node | ^12.17.0 \|\| >=14.0.0 |
| Dependencies | 6 |
| Unpacked size | 11.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jordan Mele |
| Maintainers | siliconsoldier, alexweissman |
| Keywords | gulpplugin, prune, delete, files |

## Links

- npm: https://www.npmjs.com/package/gulp-prune
- Repository: https://github.com/userfrosting/gulp-prune
- Homepage: https://github.com/userfrosting/gulp-prune#readme
- Issues: https://github.com/userfrosting/gulp-prune/issues
- npm.io page: https://npm.io/package/gulp-prune

## Dependencies (6)

- [vinyl](https://npm.io/package/vinyl.md) ^2.2.1
- [globby](https://npm.io/package/globby.md) ^13.1.1
- [fancy-log](https://npm.io/package/fancy-log.md) ^2.0.0
- [ansi-colors](https://npm.io/package/ansi-colors.md) ^4.1.1
- [plugin-error](https://npm.io/package/plugin-error.md) ^1.0.1
- [aggregate-error](https://npm.io/package/aggregate-error.md) ^4.0.0

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 2.0.1 (latest) — 2022-03-16
- 2.0.0 — 2021-07-10
- 1.0.0 — 2021-07-10
- 1.0.0-rc.0 — 2021-04-18
- 0.2.0 — 2016-07-19
- 0.1.2 — 2016-07-19

## README

# gulp-prune

A [Gulp](http://gulpjs.com/) plugin to delete files that should not be in the destination directory.

Files that have not been seen will be deleted after the stream is flushed.

## Examples

### Prune with 1:1 mapping

This example will delete all files in the target directory that do not match a source file,
after transpiling changed files.

```js
import gulp from 'gulp';
import { prune } from 'gulp-prune';
import newer from 'gulp-newer';
import babel from 'gulp-babel';

export function build() {
  return gulp.src('src/**/*.js')
    .pipe(prune('build/'))
    .pipe(newer('build/'))
    .pipe(babel({ presets: [ 'es2015' ] }))
    .pipe(gulp.dest('build/'));
}
```

### Prune with custom mapping

The mapping can be customised if the source and destination file names are different.

This example will prune all .js and .js.map files that aren't from the source .ts files.

```js
import gulp from 'gulp';
import { prune } from 'gulp-prune';
import newer from 'gulp-newer';
import sourcemaps from 'gulp-sourcemaps';
import typescript from 'gulp-typescript';

export function build() {
  return gulp.src('src/**/*.ts')
    .pipe(prune({ dest: 'build/', ext: [ '.js', '.js.map' ] }))
    .pipe(newer({ dest: 'build/', ext: '.js' }))
    .pipe(sourcemaps.init())
    .pipe(typescript())
    .pipe(sourcemaps.write('.'))
    .pipe(gulp.dest('build/'));
}
```

## API

### Export

- `prune(dest)`
- `prune(dest, options)`
- `prune(options)`

### Options

- `options.dest` (or `dest` argument)

  The directory to prune files from.

- `options.map`

  A function that maps the source file name to what is expected in the `dest` directory.  The function may return a string
  or array of string file names to keep.  Can't be used with options.ext.

- `options.filter`

  If a string, only files that match this [Minimatch](https://www.npmjs.com/package/minimatch) pattern may be pruned.

  If a function, will be called with the relative path for each file to be pruned.  Return true to delete it.

- `options.ext`

  A convenience option to both map the extension and ensure only those extensions are deleted.
  May be a single string or an array of strings.

  e.g. `{ ext: [ '.js', '.js.map' ] }` is the equivalent of

  ```js
  {
    map: (name) => [
      name.replace(/(\.[^./\\]*)?$/, '.js'),
      name.replace(/(\.[^./\\]*)?$/, '.js.map')
    ],
    filter: '**/*.@(js|js.map)'
  }
  ```

- `options.verbose`

  Set to true to log all deleted files.

---
_Source: https://npm.io/package/gulp-prune · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._