https://github.com/jonschlinkert/middleware-rename-file
Middleware for templates, assemble, verb, generate or update, for renaming files based on front-matter properties.
https://github.com/jonschlinkert/middleware-rename-file
filepath path rename rewrite
Last synced: about 2 months ago
JSON representation
Middleware for templates, assemble, verb, generate or update, for renaming files based on front-matter properties.
- Host: GitHub
- URL: https://github.com/jonschlinkert/middleware-rename-file
- Owner: jonschlinkert
- License: mit
- Created: 2016-08-02T11:28:06.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-01T18:29:31.000Z (over 8 years ago)
- Last Synced: 2025-08-17T10:32:47.115Z (about 2 months ago)
- Topics: filepath, path, rename, rewrite
- Language: JavaScript
- Size: 10.7 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# middleware-rename-file [](https://www.npmjs.com/package/middleware-rename-file) [](https://npmjs.org/package/middleware-rename-file) [](https://npmjs.org/package/middleware-rename-file) [](https://travis-ci.org/jonschlinkert/middleware-rename-file)
> Middleware for renaming views based on front-matter properties.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save middleware-rename-file
```
## How it works
You can rename the destination path of a file using properties defined in its front-matter. Any of the path properties on a [vinyl](https://github.com/gulpjs/vinyl) file should work.
**Example**
Given the source file, `scaffolds/layouts/base.hbs`:
```html
---
rename:
basename: default.hbs
dirname: templates
---
{{title}}
{% body %}
```
The generated destination path would be, `templates/default.hbs`.
## Usage
This can be used with [assemble](https://github.com/assemble/assemble), [verb](https://github.com/verbose/verb), [generate](https://github.com/generate/generate), [update](https://github.com/update/update) or an other library that is based on [templates](https://github.com/jonschlinkert/templates).
**.onLoad**
The main export is a middleware function that should be passed to `.onLoad` to ensure that files are renamed as early in the render cycle as possible (so that when rendering begins, the actual file names are available on the context).
```js
var rename = require('middleware-rename-file');
var assemble = require('assemble');
var app = assemble();
app.onLoad(/\.md$/, rename());
```
In addition to the regex provided to `.onLoad`, you may also optionally pass a filter function to `rename()`:
**Example**
Don't modify a file with the name (stem) `index`:
```js
app.onLoad(/\.md$/, rename(function(file) {
return file.stem !== 'index';
}));
```
## About
### Related projects
* [assemble](https://www.npmjs.com/package/assemble): Get the rocks out of your socks! Assemble makes you fast at creating web projects… [more](https://github.com/assemble/assemble) | [homepage](https://github.com/assemble/assemble "Get the rocks out of your socks! Assemble makes you fast at creating web projects. Assemble is used by thousands of projects for rapid prototyping, creating themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websit")
* [generate](https://www.npmjs.com/package/generate): Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… [more](https://github.com/generate/generate) | [homepage](https://github.com/generate/generate "Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the robustness and configurability of Yeoman, the expressiveness and simplicity of Slush, and more powerful flow control and composability than either.")
* [templates](https://www.npmjs.com/package/templates): System for creating and managing template collections, and rendering templates with any node.js template engine… [more](https://github.com/jonschlinkert/templates) | [homepage](https://github.com/jonschlinkert/templates "System for creating and managing template collections, and rendering templates with any node.js template engine. Can be used as the basis for creating a static site generator or blog framework.")
* [update](https://www.npmjs.com/package/update): Be scalable! Update is a new, open source developer framework and CLI for automating updates… [more](https://github.com/update/update) | [homepage](https://github.com/update/update "Be scalable! Update is a new, open source developer framework and CLI for automating updates of any kind in code projects.")
* [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://github.com/verbose/verb) | [homepage](https://github.com/verbose/verb "Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
MIT
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 01, 2017._