# @dickeyxxx/list-npm-contents

> List the contents of an npm package

Latest version **0.0.0** (published 2018-01-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dickeyxxx/list-npm-contents
pnpm add @dickeyxxx/list-npm-contents
yarn add @dickeyxxx/list-npm-contents
bun add @dickeyxxx/list-npm-contents
```

Provides the command `list-npm-contents`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2018-01-17 |
| First published | 2018-01-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Nate Cavanaugh |
| Maintainers | dickeyxxx |
| Keywords | cli-app, cli, bin |

## Links

- npm: https://www.npmjs.com/package/@dickeyxxx/list-npm-contents
- Repository: https://github.com/natecavanaugh/list-npm-contents
- Homepage: https://github.com/natecavanaugh/list-npm-contents#readme
- Issues: https://github.com/natecavanaugh/list-npm-contents/issues
- npm.io page: https://npm.io/package/@dickeyxxx/list-npm-contents

## Dependencies (7)

- [got](https://npm.io/package/got.md) ^6.7.1
- [tmp](https://npm.io/package/tmp.md) 0.0.31
- [meow](https://npm.io/package/meow.md) ^3.3.0
- [is-url](https://npm.io/package/is-url.md) ^1.2.2
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.0
- [ls-archive](https://npm.io/package/ls-archive.md) ^1.2.3
- [get-npm-tarball-url](https://npm.io/package/get-npm-tarball-url.md) ^2.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.0 (latest) — 2018-01-17

## README

# list-npm-contents
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]

> 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

```js
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](http://alterform.com)

[npm-image]: https://img.shields.io/npm/v/list-npm-contents.svg?style=flat-square
[npm-url]: https://npmjs.org/package/list-npm-contents
[travis-image]: https://img.shields.io/travis/natecavanaugh/list-npm-contents/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/natecavanaugh/list-npm-contents
[coveralls-image]: https://img.shields.io/coveralls/natecavanaugh/list-npm-contents/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/natecavanaugh/list-npm-contents?branch=master

---
_Source: https://npm.io/package/@dickeyxxx/list-npm-contents · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._