npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

middleware-rename-file

v1.0.0

Published

Middleware for renaming views based on front-matter properties.

Downloads

5,980

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

jonschlinkertjonschlinkert

Keywords

assemblefilefront-mattergeneratemiddlewarerenamerewritetemplatetemplatesverbvinyl

Readme

middleware-rename-file NPM version NPM monthly downloads NPM total downloads Linux Build Status

Middleware for renaming views based on front-matter properties.

Install

Install with npm:

$ 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 file should work.

Example

Given the source file, scaffolds/layouts/base.hbs:

---
rename:
  basename: default.hbs
  dirname: templates
---

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>{{title}}</title>
  </head>
  <body>
    {% body %}
  </body>
</html>

The generated destination path would be, templates/default.hbs.

Usage

This can be used with assemble, verb, generate, update or an other library that is based on 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).

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:

app.onLoad(/\.md$/, rename(function(file) {
  return file.stem !== 'index';
}));

About

Related projects

  • assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
  • generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
  • templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage
  • update: Be scalable! Update is a new, open source developer framework and CLI for automating updates… more | homepage
  • verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ 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:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. MIT

This file was generated by verb-generate-readme, v0.4.2, on February 01, 2017.