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

bogart-handlebars

v0.10.7

Published

Handlebars tools for Bogart

Downloads

13

Readme

Bogart Handlebars

Bogart Middleware to load a directory hierarchy of views.

npm install bogart-handlebars --save

In your app:

var bogartHandlebars = require('bogart-handlebars');

var app = bogart.app();
app.use(bogartHandlebars(Path.join(__dirname, 'views')));

Middleware executed after bogartHandlebars will have views and respond services available. The views service is an object whose property hierarchy matches the directory hierarchy of the views.

Directory contents starting with underscore e.g. _layout.html are registered as partials with their full path name.

Example:

Figure A, Directory Hierarchy

views
  |-layouts
    |-_main.hbt
  |-public
    |-index.hbt

_main.hbt will be registered as the partial 'layouts/main'.

index.hbt will be available from views.public.index.

respond service

Middleware executed after bogart-handlebars will have respond available as a service.

/**
 * Create a Bogart response with a body of a handlebars view.
 * @param {Function} view  The handlebars view from the `view` service.
 * @param {Object} locals  Template variables for the handlebars template.
 * @param {Object} options Overrides for the response. Common values: status, headers.
 * @returns {Object} A Bogart response.
 */
respond(view, locals, options)

Example:

var bogartHandlebars = require('bogart-handlebars');

var router = bogart.router();
router.get('/', function (views, respond) {
  return respond(views.public.index, { title: 'Hello World' });
});

var app = bogart.app();
app.use(bogartHandlebars(path.join(__dirname, 'views')));
app.use(router);

Cross-cutting locals

It is possible to add to the locals passed to the view by respond in a cross-cutting manner with the onCreateLocals event. Register a callback to this event:

bogartHandlebars(path.join(__dirname, 'views'))
  .onCreateLocals(function (session) {
    return { user: session('user') }
  });

This example adds a user parameter from session to the locals of every view that respond renders.

onCreateLocals is chainable.