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

@upstatement/puppy

v0.13.0

Published

An adorable library for building a static site generator

Downloads

12

Readme

Puppy Library

Version

An adorable library for building static site generators

Looking to build a Puppy-powered prototype? Head over to the main Puppy repo!

Prerequisites

Prerequisite Prerequisite

Install

  1. nvm install
  2. npm install

Usage

const puppy = require('@upstatement/puppy');
const stream = require('stream');
const twig = require('gulp-twig');
const util = require('util');

const html = async function () {
  const pipeline = util.promisify(stream.pipeline);

  const pages = await puppy({
    publicPath: '/',
    pages: 'src/pages/**/*',
    data: 'src/data/**/*',
  });
  const compile = twig({
    namespaces: { puppy: 'src/templates' },
    useFileContents: true,
  });
  const dist = dest('dist');

  return pipeline(pages, compile, dist);
};

🤝Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

🚀 Release

This library is hosted on npmjs.com. To create a new release and publish to NPM:

  1. Make sure you are on the main branch, have pulled the latest changes from GitHub, and have no local changes:

    git checkout main
    git pull
    git status

    The last command should return the following:

    On branch main
    Your branch is up to date with 'origin/main'.
    
    nothing to commit, working tree clean
  2. Bump the version according to semantic versioning rules

    npm version major|minor|patch
  3. Push the commit up to the GitHub repository

  4. Make sure you are logged in as a user that has access to the @upstatement/puppy package

    # Check who you are currently logged in as
    npm whoami
    
    # Login if you're not logged in
    npm login
  5. Publish to NPM

    npm publish

After the release is published, submit a PR to the @upstatement/puppy template repo (example PR) that updates the version constraint to the new release number.

📝License

Copyright © 2022 Upstatement, LLC