@ryaninvents/plugin-bundle-dependencies
v2.0.0
Published
Plugin for @pika/pack to zip dependencies for Node.js
Downloads
4
Readme
@ryaninvents/plugin-bundle-dependencies
Plugin for @pika/pack to zip your package's dependencies
Why would I want this?
This package creates a zip file containing your node_modules
. After the build step runs, the zip file will be available in ./pkg/dist-dependencies.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-dependencies
.
npm install --save-dev @ryaninvents/plugin-bundle-dependencies
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-dependencies"]
]
}
}
For more details on setting up Pack, refer to the @pika/pack repository. For details on configuring plugin-bundle-dependencies
, keep reading.
Options
prefix
Add a fixed prefix to every file in the ZIP archive. By default, the zip contains exactly what would be installed into the node_modules
directory -- phrased another way, if you unzipped an archive generated with the default settings, you would create one folder in your working directory for each of your package's dependencies.
Listing your archive would look something like this:
$ unzip -Z1 pkg/dist-dependencies.zip express/package.json express/index.js express/README.md lodash/package.json lodash/index.js # ... etc.
Use the prefix
option to package all dependencies into a set of nested folders. For example, when deploying to an AWS Lambda layer, dependencies should be extracted to the nodejs/node_modules
subdirectory of the extraction location. To set it up this way, modify your pipeline:
{
"@pika/pack": {
"pipeline": [
["@pika/plugin-standard-pkg"],
["@pika/plugin-build-node"],
[
"@ryaninvents/plugin-bundle-dependencies",
{
"prefix": "nodejs/node_modules"
}
]
]
}
}
Listing your archive would look something like this:
$ unzip -Z1 pkg/dist-dependencies.zip nodejs/node_modules/express/package.json nodejs/node_modules/express/index.js nodejs/node_modules/express/README.md nodejs/node_modules/lodash/package.json nodejs/node_modules/lodash/index.js # ... etc.
packageOverrides
Override versions for some packages during the install step.
This plugin requires file:
version specifications for any local packages, conflicting with Yarn's expectation of version numbers for local packages. Using packageOverrides
allows this plugin to handle this situation correctly without trying to re-implement any of Yarn's functionality.
Expects an object where the keys are package names and the values are override versions. The same lookup is used for both dependencies
and devDependencies
.
{
"dependencies": {
"my-local-package": "0.0.0-semantically-released"
},
"@pika/pack": {
"pipeline": [
["@pika/plugin-standard-pkg"],
["@pika/plugin-build-node"],
[
"@ryaninvents/plugin-bundle-dependencies",
{
"packageOverrides": {
"my-local-package": "file:../my-local-package"
}
}
]
]
}
}
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.