pkgfiles

pkgfiles

List all files which would be published in a package.

Useful for double-checking you're not publishing anything unwanted prior to an npm publish.

Note some files may not yet exist (e.g. .npmignore).

Installation

npm install pkgfiles

Example

var pkgfiles = require('pkgfiles')

pkgfiles('./src', function(err, files, packages) {
  // files: Array of absolute paths to files and dirs that would be included
  // packages: Array of package.jsons that would be included
})

CLI

> pkgfiles

package.json
.npmignore
index.js
Readme.md
bin/pkgfiles.js
test/index.js
test/pkg/package.json
test/pkg/index.js
test/pkg/lib/index.js

Total 9 files
>

Description

This is a wrapper around whatever version of fstream-npm is installed in the global npm. It has an async callback interface (instead of a stream), and keeps the original path (instead of nesting paths in 'package').

License

MIT