Awesome
pkg-ok
pkg-ok
checks paths and scripts defined inpackage.json
before you publish 👌
- Ensures paths defined in
main
,bin
,module
,types
,typings
,es2015
,browser
, andexports
exist - Ensures paths defined in
main
,bin
, andbrowser
are relative - Ensures
bin
scripts use cross-platform line endings
Usage
npm install pkg-ok --save-dev
// package.json
{
"main": "oops_this_file_doesnt_exist.js",
"scripts": {
"prepublishOnly": "... && pkg-ok"
}
}
npm publish
# Error!
# Since main file doesn't exist, publish is blocked
CLI
Check the package.json
in the current directory.
pkg-ok
Check the package.json
in a specific directory.
pkg-ok some/directory
Check additional package.json
fields or bin files.
pkg-ok --field someField --bin script.sh
API
const pkgDirectory = __dirname;
pkgOk(pkgDirectory, {
fields: ['someAdditonalField'],
bin: ['someAdditionalScript.sh'],
});
License
MIT