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

pug-tree

v1.0.4

Published

Compiles pug templates into an object representation based on the pug template directory structure

Downloads

88

Readme

pug-tree
Credit: flickr/dapuglet

pug-tree

NPM version Dependency status CI status

pug-tree is a tiny library design to build nested objects of templating functions from a given directory of pug template files.

Installation and Usage

  • npm install --save pug-tree
  • require('pug-tree')(directory, defaults)
    • directory should be the top level of your templates folder, usually something like path.join(__dirname, 'templates')
    • defaults is properties object that is pre-bound to template - this is a good place to include information that doesn't usually change like title
    • See test/test.js for usage example

Given a folder structure:

<project-name>
↳ templates
  ↳ index.pug
  ↳ nested
    ↳ page.pug

You will be able to do the following:

var templates = require('pug-tree')(path.join(__dirname, 'templates'), { title: title })
var indexHtml = templates.index({ body: indexBody })
var nestedPageHtml = templates.nested.page({ body: nestedPageBody })

Where title and body are both available to each of the templates.