tufan-io/pkg-ok

👌 Checks paths and scripts defined in package.json before you publish

@tufan-io/pkg-ok

Forked from typicode/pkg-ok to add maintainance updates

pkg-ok checks paths and scripts defined in package.json before you publish 👌

• Ensures paths defined in main, bin, module, types, typings, es2015 and browser exist
• Ensures bin scripts use cross-platform line endings

Usage

npm install @tufan-io/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 

Options

pkg-ok can be configured to check additional package.json fields or bin files

pkgOk --field someField --bin script.sh

API

const pkgDirectory = __dirname

pkgOk(pkgDirectory, {
  fields: ['someAdditonalField'],
  bin: ['someAdditionalScript.sh']
})

License

MIT

Patreon - Supporters ✨