/irish-pub

Feel like npm is drunk or maybe you are and want to verify what gets published via `npm publish`? irish-pub has you covered.

Primary LanguageJavaScriptMIT LicenseMIT

irish-pub build status

Feel like npm is drunk or maybe you are and want to verify what gets published via npm publish? irish-pub has you covered.

➝ irish-pub

npm will publish irish-pub@1.0.0 as thlorenz, including the following files:

package.json
.npmignore
README.md
LICENSE
index.js
.travis.yml
bin/irish-pub.js
test/index.js
test/foo/package.json
test/foo/.npmignore
test/foo/index.js
test/foo/example/first.js
test/foo/lib/work.js

Installation

npm install -g irish-pub

API

irishPub(root) → {ReadableStream}

Invokes npm pack to determine what would be included during npm publish.

Parameters:
Name Type Description
root string

path to package to publish, defaults to cwd
Source:
Returns:

stream that emits all files with paths relative to root that will be packed via the data event

Type
ReadableStream

generated with docme

License

MIT