# base-fs-rename

> Plugin for 'base' applications that adds a `rename` method that, when called, can be passed to `app.dest()` as the rename function (this is an instance plugin, not pipeline plugin)

Latest version **0.1.4** (published 2016-06-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install base-fs-rename
pnpm add base-fs-rename
yarn add base-fs-rename
bun add base-fs-rename
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2016-06-20 |
| First published | 2016-02-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | base, baseplugin, fs, plugin, rename |

## Links

- npm: https://www.npmjs.com/package/base-fs-rename
- Repository: https://github.com/node-base/base-fs-rename
- Issues: https://github.com/node-base/base-fs-rename/issues
- npm.io page: https://npm.io/package/base-fs-rename

## Dependencies (7)

- [kind-of](https://npm.io/package/kind-of.md) ^3.0.3
- [base-cwd](https://npm.io/package/base-cwd.md) ^0.2.1
- [through2](https://npm.io/package/through2.md) ^2.0.1
- [lazy-cache](https://npm.io/package/lazy-cache.md) ^2.0.1
- [mixin-deep](https://npm.io/package/mixin-deep.md) ^1.1.3
- [is-absolute](https://npm.io/package/is-absolute.md) ^0.2.5
- [is-valid-app](https://npm.io/package/is-valid-app.md) ^0.1.1

## 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

- 0.1.4 (latest) — 2016-06-20
- 0.1.3 — 2016-05-28
- 0.1.2 — 2016-04-05
- 0.1.1 — 2016-02-06
- 0.1.0 — 2016-02-04

## README

# base-fs-rename [![NPM version](https://img.shields.io/npm/v/base-fs-rename.svg?style=flat)](https://www.npmjs.com/package/base-fs-rename) [![NPM downloads](https://img.shields.io/npm/dm/base-fs-rename.svg?style=flat)](https://npmjs.org/package/base-fs-rename) [![Build Status](https://img.shields.io/travis/node-base/base-fs-rename.svg?style=flat)](https://travis-ci.org/node-base/base-fs-rename)

Plugin for 'base' applications that adds a `rename` method that, when called, can be passed to `app.dest()` as the rename function (this is an instance plugin, not pipeline plugin)

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save base-fs-rename
```

## Usage

Requires either the [base-fs](https://github.com/node-base/base-fs) or the [assemble-fs](https://github.com/assemble/assemble-fs) plugin to work.

```js
var fs = require('base-fs');
var rename = require('base-fs-rename');
var Base = require('base');
var app = new Base();

app.use(rename());
app.use(fs());

app.src('fixtures/a.txt')
  // pass `app.rename()` to `app.dest()`
  .pipe(app.dest(app.rename('actual')));
```

## Related projects

You might also be interested in these projects:

* [assemble-fs](https://www.npmjs.com/package/assemble-fs): Assemble plugin to add methods to assemble for working with the file system, like src… [more](https://github.com/assemble/assemble-fs) | [homepage](https://github.com/assemble/assemble-fs "Assemble plugin to add methods to assemble for working with the file system, like src, dest, copy and symlink.")
* [base](https://www.npmjs.com/package/base): base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… [more](https://github.com/node-base/base) | [homepage](https://github.com/node-base/base "base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting with a handful of common methods, like `set`, `get`, `del` and `use`.")
* [base-fs](https://www.npmjs.com/package/base-fs): base-methods plugin that adds vinyl-fs methods to your 'base' application for working with the file… [more](https://github.com/node-base/base-fs) | [homepage](https://github.com/node-base/base-fs "base-methods plugin that adds vinyl-fs methods to your 'base' application for working with the file system, like src, dest, copy and symlink.")
* [base-fs-conflicts](https://www.npmjs.com/package/base-fs-conflicts): Detect potential file system conflicts and if necessary prompt the user before overwriting files. | [homepage](https://github.com/node-base/base-fs-conflicts "Detect potential file system conflicts and if necessary prompt the user before overwriting files.")
* [base-task](https://www.npmjs.com/package/base-task): base plugin that provides a very thin wrapper around [https://github.com/doowb/composer](https://github.com/doowb/composer) for adding task methods to… [more](https://github.com/node-base/base-task) | [homepage](https://github.com/node-base/base-task "base plugin that provides a very thin wrapper around <https://github.com/doowb/composer> for adding task methods to your application.")

## Contributing

This document was generated by [verb-readme-generator](https://github.com/verbose/verb-readme-generator) (a [verb](https://github.com/verbose/verb) generator), please don't edit directly. Any changes to the readme must be made in [.verb.md](.verb.md). See [Building Docs](#building-docs).

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). Or visit the [verb-readme-generator](https://github.com/verbose/verb-readme-generator) project to submit bug reports or pull requests for the readme layout template.

## Building docs

Generate readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install -g verb verb-readme-generator && verb
```

## Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

## Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/node-base/base-fs-rename/blob/master/LICENSE).

***

_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on June 20, 2016._

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