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

npm-plugin-fetcher

v2.0.0

Published

Fetch data about packages on npm that match a keyword

Downloads

8

Readme

This is a quick and dirty utility to fetch data about npm packages.

Usage:
  npm-plugin-fetcher [OPTIONS] keyword

Options:
  -r, --registry [STRING]Registry to use (Default is https://registry.npmjs.com)
  -b, --blacklist STRING A blacklist JSON file to use
  -o, --out [STRING]     The output directory to put files into (must exist!)  (Default is ./)
  -k, --no-color         Omit color from output
      --debug            Show debug information
  -v, --version          Display the current version
  -h, --help             Display help and usage details

Typically you'd use it if you're building a static site's plugin-listing, for example Grunt's plugin page, Gulp's plugin page or Chai's plugin page.

It fetches a list of npm plugin names by a keyword present in all JSON files, and then downloads their package.json files.

For example:

$ npm-plugin-fetcher chai-plugins -o ./plugins/
INFO: Fetching data on these plugins:
    chai-change
    chai-checkmark
    chai-fireproof
    ...
INFO: Written: ./plugins/chai-change.json (2ms)
INFO: Written: ./plugins/chai-fireproof.json (2ms)
INFO: Written: ./plugins/chai-checkmark.json (1ms)
...

These can then either be picked up by an API, or by a static site generator (perhaps Jekyll).

Under the hood

The script first fetches a URL like:

https://registry.npmjs.com/-/_view/byKeyword?startkey=%5B%22chai-plugin%22%5D&endkey=%5B%22chai-plugin%22,%7B%7D%5D&group_level=2

Then iterates over the plugin names, and fetches the npm registry entries for each one, for example:

https://registry.npmjs.com/chai-change
https://registry.npmjs.com/chai-fireproof
https://registry.npmjs.com/chai-checkmark
...

The contents of the latter requests are just written out to JSON. They look like the package.json files that are published - but have loads of extra goodies, such as the README file, and a list of all versions, etc.

Blacklists

If you dont want packages to be downloaded, but that appear in searches, just make a blacklist.json, that looks like this:

['nasty-plugin', 'security-breach', 'not-really-a-plugin']

And those package names will not be downloaded.