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

@dickeyxxx/list-npm-contents

v0.0.0

Published

List the contents of an npm package

Downloads

2

Readme

list-npm-contents

NPM version build status Test coverage

List the file contents of an npm package

This will list the files that are actually in the tarball of the NPM module, not just what's reported in the files field of package.json.

Install

$ npm install --save list-npm-contents

Usage

var listNpmContents = require('list-npm-contents');

listNpmContents('lpad').then(
	files => console.log(files)
);
//=> [ 'package.json', 'index.js', 'license', 'readme.md' ]

listNpmContents('lpad', '0.1.0').then(
	files => console.log(files)
);
//=> [ 'package.json', 'lpad.js', 'readme.md' ]

CLI

$ npm install --global list-npm-contents
$ list-npm-contents --help

  Usage
$ list-npm-contents package-name

	Options
	-V, --module-version The version of the module you wish to view. Default: latest

	Examples:
	$ list-npm-contents lpad
	package.json
	index.js
	license
	readme.md

	$ list-npm-contents lpad -V 0.1.0
	package.json
	lpad.js
	readme.md

API

listNpmContents(packageName, [version])

packageName

Required Type: string

The name of the package on NPM to look up the files for.

version

Type: string Default: latest

The version of the module to look for.

License

MIT © Nate Cavanaugh