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-package-walker

v7.0.7

Published

Walks down the local npm package dependency tree and calls a visitor function for each package

Downloads

6,243

Readme

Maintainability

npm-package-walker

Walks down the local npm package dependency tree and calls a visitor function for each package.

import { packageWalker } from "npm-package-walker";

async function collectPackageNames() {
  const names = new Set();

  await packageWalker(
    async (pkg, base, modulePath) => {
      names.add(pkg.name);
      return true;
    },
    process.cwd(),
    ["dependencies"]
  );

  return names;
}

collectPackageNames().then(names => console.log(names));

API

Table of Contents

defaultDependencyTypes

Dependency types used by default

  • dependencies
  • devDependencies
  • optionalDependencies
  • peerDependencies

packageVisitor

Type: Function

Parameters

  • package Object package.json content
  • directory string package base dir
  • packagePath Array<string> how deep in the dependency tree are we (starting with 0 for the root package)

Returns Promise<boolean> true to continue traversing dependencies of this package

packageWalker

Walks the local package dependency tree and calls a visitor function. The visitor function recives the decoded package.json, its directory, and the nesting level starting with 0 for the base package. Descending the dependency tree continues until the visitor function returns false or no more dependencies are declared in a package.

Parameters

  • visitor packageVisitor async to be called for each package
  • base string directory where to start crawling package.json (optional, default process.cwd())
  • dependencyTypes Array<string> dig into dependency dev and/or prod (optional, default defaultDependencyTypes)

Returns Promise<boolean> when resolving to true further dig into the dependencies

install

With npm do:

npm install npm-package-walker

license

BSD-2-Clause