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

hbs-utils

v0.0.4

Published

A set of helpers and utility functions useful when using hbs in an express app.

Downloads

6,235

Readme

hbs-utils

Helpers that are useful when using hbs and handlebars.js.

Install

npm install hbs-utils

Use

You must initialize hbs-utils with a reference to the hbs module, like so:

var hbs = require('hbs');
var hbsutils = require('hbs-utils')(hbs);

API

hbs-utils exposes some methods that are useful when dealing with partials in your app.

Partials

Registration

hbsutils.registerPartials(directory[, opts, done]);
hbsutils.registerWatchedPartials(directory[, opts, done]);

These convenience methods will register all partials (that have a *.html or *.hbs extension) in the given directory. registerPartials will perform a one-time registration, while registerWatchedPartials will watch the filesystem to changes to the directory, and automatically re-register any changed or added partials directly with handlebars.

opts is an optional parameter that can safely be omitted. It is an object that can contain the following settings:

  • precompile: (default: false) If true, the partials will be pre-compiled when they are registered.
  • onchange: A callback of the form function(template) {} that will be called everytime a partial has been changed (added or updated). The name of the partial is passed as the sole parameter.
  • match: (default: /\.(html|hbs)$/) A regular expression that each partial's filename is tested against to determine whether it is a valid partial.
  • name: A function in the form function(template) {} that will be called for each partial. The name of the partial is passed as the sole parameter. This function gives you the opportunity to rename the partial before it is registered -- for example, to remove a leading _ from the filename -- by returning the new name.

done is an optional parameter that will be called when the initial registration of partials is complete.

Partials that are loaded from a directory are named based on their filename, where spaces and hyphens are replaced with an underscore character:

template.html      -> {{> template}}
template 2.html    -> {{> template_2}}
login view.hbs     -> {{> login_view}}
template-file.html -> {{> template_file}}

See the handlebars.js README and docs for more information.

Compilation

hbsutils.precompilePartials();

precompilePartials is a helper to automatically pre-compile any partials which have been registered but not yet compiled.

History

v0.0.4

  • Fixed issue with slashes in template names (thanks @fengcen!)
  • Updated dependency version specifications

v0.0.3

  • Fixed declaration of Instance object (#2)

v0.0.2

  • Added match and name options (thanks @jas!)

v0.0.1

  • Initial release

License (MIT)