npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ryaninvents/plugin-bundle-zip-node

v1.4.0

Published

Plugin for @pika/pack to zip built files for Node.js

Downloads

6

Readme

@ryaninvents/plugin-bundle-zip-node

Plugin for @pika/pack to zip built files for Node.js

CircleCI build status View on npm GitHub repository License

Why would I want this?

This package creates a zip file containing your compiled source code. After the build step runs, the zip file will be available in ./pkg/dist-node.zip.

I built this package because I wanted to build an AWS Lambda function source zip using Pika Pack.

Installation

Use the package manager npm to install @ryaninvents/plugin-bundle-zip-node.

npm install --save-dev @ryaninvents/plugin-bundle-zip-node

Then, modify your @pika/pack configuration in your package.json to enable:

{
  "@pika/pack": {
    "pipeline": [
      ["@pika/plugin-standard-pkg"],
      ["@pika/plugin-build-node"],
      ["@ryaninvents/plugin-bundle-zip-node"]
    ]
  }
}

For more details on setting up Pack, refer to the @pika/pack repository. For details on configuring plugin-bundle-zip-node, keep reading.

Options

preserve

Default value: false

Preserve the package root -- that is, the zip file will contain everything in the Pika pkg directory. Note: By default, this will not include the package.json.

{
  "@pika/pack": {
    "pipeline": [
      ["@pika/plugin-standard-pkg"],
      ["@pika/plugin-build-node"],
      ["@ryaninvents/plugin-bundle-zip-node", {
        "preserve": true
      }]
    ]
  }
}

bundleName

Default value: "node"

Specify a name for the bundle. The bundle will be stored as dist-${bundleName}.zip.

{
  "@pika/pack": {
    "pipeline": [
      ["@pika/plugin-standard-pkg"],
      ["@pika/plugin-build-node"],
      ["@ryaninvents/plugin-bundle-zip-node", {
        "bundleName": "javascript"
      }]
    ]
  }
}

directory

Default value: "dist-node"

Choose a different directory to bundle. Note that this will have no effect on bundle name. Also if you have set preserve: true, then this option will have no effect.

{
  "@pika/pack": {
    "pipeline": [
      ["@pika/plugin-standard-pkg"],
      ["@pika/plugin-build-node"],
      ["@ryaninvents/plugin-bundle-zip-node", {
        "directory": "dist-web",
        "bundleName": "web"
      }]
    ]
  }
}

manifest

Default value: true when "preserve": true; false otherwise

Include the package.json in the bundle. Note that this will be the package.json as modified by any preceding Pika pipeline steps.

If you set "manifest": true while "preserve": false, you may end up with unexpected results. Proceed with caution.

{
  "@pika/pack": {
    "pipeline": [
      ["@pika/plugin-standard-pkg"],
      ["@pika/plugin-build-node"],
      ["@ryaninvents/plugin-bundle-zip-node", {
        "preserve": true,
        "manifest": true
      }]
    ]
  }
}

sources

Default value: ["**"]

Power-user option. Directly specify a set of files to use. Use negation to exclude files; for example, exclude test files using "!*.test.js".

{
  "@pika/pack": {
    "pipeline": [
      ["@pika/plugin-standard-pkg"],
      ["@pika/plugin-build-node"],
      ["@ryaninvents/plugin-bundle-zip-node", {
        "sources": [
          "*.js",
          "!*.test.js"
        ]
      }]
    ]
  }
}

epoch

Default value: true

When true, the zip file will always be created with the same timestamp. Set to false to generate correct timestamps.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT