Nifty Pun Master

    pkg-ok

    3.0.0 • Public • Published

    pkg-ok Build status npm

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

    • Ensures paths defined in main, bin, module, types, typings, es2015, browser, and exports exist
    • Ensures paths defined in main, bin, and browser 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

    Install

    npm i pkg-ok

    DownloadsWeekly Downloads

    991

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    17.5 kB

    Total Files

    22

    Last publish

    Collaborators

    • abraham
    • typicode