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

package-json-help

v0.0.11

Published

Lists the available scripts in package.json, hiding any prefixed with an underscore

Downloads

324

Readme

package.json help

lists the available scripts in package.json

Installation

npm i -D js-parametrize

Usage

add to your NPM scripts (in package.json) as follows:

"scripts": {
    "help": "package-json-help.js",
    "_cmd1": "echo HELLO",
    "cmd2": "echo GOODBYE",
    ...
}

add a help.json file, with keys corresponding to each "public" script in your package.json and values being the description for that script.

eg. given the above scripts, and the following help.json:

{
  "cmd1": "just says goodbye, in caps"
}

running this:

npm run help

will output something like:

available commands ...
cmd1    just says goodbye, in caps