# fuf

> fuf - Find Unused Files in a directory

Latest version **1.0.0** (published 2018-09-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install fuf
pnpm add fuf
yarn add fuf
bun add fuf
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-09-17 |
| First published | 2018-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Rubens Mariuzzo |
| Maintainers | rmariuzzo |
| Keywords | find, unused, files, grep |

## Links

- npm: https://www.npmjs.com/package/fuf
- Repository: https://github.com/rmariuzzo/fuf
- Homepage: https://github.com/rmariuzzo/fuf#readme
- Issues: https://github.com/rmariuzzo/fuf/issues
- npm.io page: https://npm.io/package/fuf

## Dependencies (2)

- [glob](https://npm.io/package/glob.md) ^7.1.3
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.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

- 1.0.0 (latest) — 2018-09-17
- 0.0.1 — 2018-09-15

## README

![fuf – Find Unused Files in a directory](.github/banner.svg)

## Usage

```js
import fuf from 'fuf'

fuf('target/directory', 'files/directory/**.*')
  .then(results => {
    console.log(results.unused)
    console.log(results.used)
  })
```

## How it works?

 1. **`fuf`** find filenames that will be test for usage.
 2. **`fuf`** find usage of those filenames in files from a target directory.
 3. **`fuf`** output a list of unused files and a list of used files.

## Development

  1. Clone and fork this repo.
  2. Install dependencies: `npm install`.
  3. Do your stuff.
  4. [Run tests](#test).
  5. Prepare a pull request.

## Releases

  1. `npm install --global np`
  2. `np`

<div align=center>

Made with :heart: by [Rubens Mariuzzo](https://github.com/rmariuzzo).

[MIT license](LICENSE)

</div>

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