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

mcbain

v0.1.2

Published

Find `require()` calls and report the dependencies they refer to.

Downloads

2

Readme

Find require() calls and report the dependencies they refer to.

This is like, and adapted from, detective, but conducts its investigation with extreme prejudice (scope awareness). (Note: the scope awareness makes this significantly slower than detective.) That is, when this hits a scope that defines a require binding (e.g. as a var or a function parameter) it considers require() calls in that scope to no longer be the require() it's looking for and eliminates them from the output. Example:

Input:

require("x");

(function (require) {
  require("y");
})();

Output (detective): ["x", "y"]

Output (mcbain): ["x"]

Why would scope awareness matter or be desirable? See substack/node-browserify#1151 for an example. If you create a standalone bundle with browserify, then require() it into a subsequent browserify bundle without taking special measures to eliminate or ignore require() calls in the standalone bundle, detective will report modules that are already in the first bundle as dependencies that browserify (module-deps) will try to resolve and choke on. mcbain detects that the require() calls are nested in scopes that have defined require and eliminates them. Indeed, browserify has already resolved and packaged the dependencies they refer to and defined its own require to retrieve them.

Aside from that difference, this should mostly be able to function as a drop-in replacement for detective (albeit slower) in the sense that it has the same export profile and mostly the same API as detective. See its README for documentation. This does not use acorn and does not support opts.parse. This passes detective's tests with the exception of those involving opts.parse.