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

static-engine

v11.0.0

Published

For building static web content.

Downloads

4

Readme

static-engine

Dependency Status devDependency Status js-standard-style

It started out as a really abstract static site generator. While most static site generators are focused around the idea of a file, static-engine doesn't assume where the data is coming from or even what you want to do with it. Everything is done with plugins that take in an array of objects, and return an array of objects.

Call static-engine with one or more arrays of plugins. Each array of plugins is composed such that each plugin is called with the result from the previous or in the case of the first one, an empty array.

Each array of plugins passed to it creates a promise that is resolved when all plugins have finished. Those promises in turn result in a larger promise that is only resolved when all plugins from every array is finished. Static-engine returns that promise.

// examples of use
var engine = require('static-engine')
var pluginA = require('plugin-a')
var pluginB = require('plugin-b')
var pluginC = require('plugin-c')

engine([pluginA, pluginB], [pluginC])
  .then(function (data) {
    console.log(data)
  })
  .catch(function (err) {
    console.error(err)
  })

plugins

Plugins are called with the data returned from the plugin before it (or for the initial one, an empty array) and a done callback. Using the callback is optional; plugins may also return a Promise.

examples

In these examples each plugin is simply pushing a new object to the array.

// a plugin that uses the callback
module.exports = function (data, done) {
  data.push({})

  done(null, data)
}
// a plugin that returns a Promise
module.exports = function (data) {
  return new Promise(function (reject, resolve) {
    data.push({})

    resolve(data)
  })
}

Plugins are just functions obviously. They don't have to be modules.