NPM Pack can be installed as an npm package itself.

# Install with NPM
npm install @ecrowjs/npmpack --save-dev
# Install with Yarn
yarn add @ecrowjs/npmpack --dev

It can also be installed globally.

# Global install with NPM
npm install -g @ecrowjs/npmpack
# Global install with Yarn
yarn global add @ecrowjs/npmpack

NPM Pack can be interfaced on the command line or through ES2015 imports.

You can add the command to your package.json on the "scripts" property like so:

{
    "scripts": {
        "pkg": "npmpack --copy src/**/*.js"
    }
}

With the addition above, you can then publish your npm package from the created sub-folder.

 $ npm run pkg # Run the script 'pkg' defined in 'package.json'
 $ cd pkg      # Navigate to the created 'pkg' folder
 $ npm publish [...your flags] # Publish your package

• CLI Usage
• Module Usage

• Flag Options
• Configuration File

$ npmpack [...flags]

Example

Select all files under the lib, copy the dist directory, and output them under the pkg folder.

$ npmpack --copy lib/* dist --output pkg

The pkg folder will include all files from lib, the dist folder itself, and your core package files: LICENSE, README, CHANGELOG, and package.json.

The output would look something like this:

dist
   <...>
lib
   <...>
pkg
   dist
      <dist files...>
   <lib files...>
   CHANGLOG
   LICENSE
   README.md
   package.json
CHANGLOG
LICENSE
README.md
package.json

When using the --config option, you can pass the path to a json file that contains the options you want to pass in.

Example:

$ npmpack --config npmpack.json

npmpack.json

{
    "root": ".",
    "copy": ["dist"],
    "include": ["lib/**/*.ts"],
    "exclude": ["lib/**/*.test.ts"],
    "packagejson": {
        "name": "Changed Package Name",
        "version": "<some_other_version>"
    }
}

NPM Pack can also be included as a module for one of your custom build scripts.

// CommonJS
const NPMPack = require('@ecrowjs/npmpack');
// ES6
import * as NPMPack from '@ecrowjs/npmpack');

// Execute NPMPack with some optional configuration.
NPMPack.execute({
    root: ".",
    copy: ["dist"],
    include: ["lib/**/*.ts"],
    exclude: ["lib/**/*.test.ts"],
    packagejson: {
        "name": "Changed Package Name",
        "version": "<some_other_version>"
    }
})