pkg-preper

A pacote dirPacker that runs a package's prepare script before packing it.

When a dependency is installed from a git URL rather than the registry, what's in the repo is often source that has to be built first - that's what a prepare script is for. pacote will pack such a directory for you, but it won't build it. pkg-preper supplies the packer that does: it reads the directory's package.json, and if there's a prepare script it hands the directory to your installDependencies callback (which installs deps and runs the script) before packing the result into a tarball with npm-packlist and tar.

Extracted from fyn, which uses it for git dependencies.

Install

npm install pkg-preper
Copy

Usage

import PkgPreper from "pkg-preper";
import pacote from "pacote";

const preper = new PkgPreper({
  tmpDir: "/path/to/tmp",
  installDependencies: async (dir, message) => {
    // install the package's dependencies in `dir` and run its prepare script
  }
});

await pacote.tarball(spec, { dirPacker: preper.getDirPackerCb() });
Copy

API

See the full API reference for every function, option, and type.

new PkgPreper({ tmpDir, installDependencies })

• tmpDir - directory for cacache's scratch space while packing
• installDependencies(dir, message) - called only when the package has a prepare script; return a promise

preper.getDirPackerCb()

Returns the (manifest, dir) => stream callback to hand to pacote as its dirPacker.

preper.depDirPacker(manifest, dir)

The packer itself, if you'd rather call it directly. Returns a stream of the packed tarball; emits prepared once the prepare step is done (right away when there is no prepare script). On failure the stream is destroyed with the error.

preper.packDirectory(manifest, dir, target)

Packs dir into a tarball at target, without the prepare step. Files are chosen by npm-packlist, so the package's files field and ignore rules are honored.

License

The packing code is adapted from the npm CLI, so this package is licensed under the Artistic License 2.0, same as the original.