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

post-receive

v2.1.1

Published

The scripts we use to get stuff in the right place on the server.

Downloads

6

Readme

Post Receive

NPM Version Build Status Dependency Status

These scripts are run after code is pushed to the server. They compile everything and deploy to the correct location.

github-listener runs this script for each repository after fetching the files from Github.

index.js is run in this directory, processing files as specified in options.json. The files are then transferred to the output directory.

The options.json takes a number of different options for build steps:

  • build_cmd: list, a list of shell commands to be run in repository root at processing stage
  • copy_from: string, copy the contents of this directory to the output directory
  • copy_to: string, the directory files should be copied to after processing
  • start_cmd: list, a list of shell commands to be run in output directory after processing
  • ignore: list, a list of files and directories in the output directory that should not be overwritten/deleted
  • url: string, a link to be displayed after processing on the github listener output
  • email: list, a list of email addresses to send error messages if the build fails

Host specific options

The options.json can have host specific options under the hosts property. This is useful for moving processed files into different output directories on different environments.

Example:

{
    "copy_to": "/home/git/deploy/post-receive",
    "start_cmd": ["npm install"],
    "hosts": {
        "oliverfaircliff": {
            "copy_to": "/opt/ptr"
        }
    }
}

Documentation

See the DOCUMENTATION.md file.

Contributing

  1. Create an issue with your bug or suggestion
  2. Fork the repository
  3. Make your changes in your fork
  4. Create a pull request here, referencing the original issue

License

See the LICENSE file.