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-trospect

v0.0.4-alpha

Published

Introspection for NPM packages in an unknown, but discoverable, location.

Downloads

2

Readme

npm-trospect.js

A utility to wrap: require('/package')

It will also allow you to perform additional operations as well as gracefully autogenerate some info for directly referenced classes (as is common for optional subcomponents). Really, it's just for my own use in protolus-resource and I'd prefer to keep it separate to stay neat.

Usage

First include the module:

require.package = require('npm-trospect');

then, use it... in this case we introspect on ourselves:

require.package('npm-trospect');

and we get back the package info, so far no different than a request through require(/package), but if you require a submodule like the optional file body scanner

require.package('npm-trospect/scanner');

...you get an autogenerated payload with just 'name', 'main' and 'autogenerated'.

Speaking of the scanner, just include it:

require.scan = require('npm-trospect/scanner');

then it will add an entry to the package of 'scanned_dependencies' and combine dependencies as 'combined_dependencies'... for async style:

require.scan(require('npm-trospect/scanner'), function(pkg){
    //do stuff
});

or sync style, because you are a callous, freewheeling bastard:

require.scan(require('npm-trospect/scanner'));

if you want to find all commonjs modules inside a particular package you can get a scanned_subpackages entry by:

require.scan.directory(packageData, function(data){
    //do stuff
});

and you can put it all together with:

require.scan.full('package', function(packageData){
    //do stuff
});

which also accepts the package data itself.

Testing

Run the tests at the project root with:

mocha

Enjoy,

-Abbey Hawk Sparrow