Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yowainwright/build-lambda-layer
Build awesome node lambda layers with control 🕹
https://github.com/yowainwright/build-lambda-layer
aws aws-lambda lambda lambda-layers nodejs
Last synced: about 1 month ago
JSON representation
Build awesome node lambda layers with control 🕹
- Host: GitHub
- URL: https://github.com/yowainwright/build-lambda-layer
- Owner: yowainwright
- License: mit
- Created: 2022-08-21T07:22:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T05:00:54.000Z (8 months ago)
- Last Synced: 2024-05-02T00:01:12.879Z (8 months ago)
- Topics: aws, aws-lambda, lambda, lambda-layers, nodejs
- Language: TypeScript
- Homepage:
- Size: 962 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Build Lambda Layer
[](https://www.npmjs.com/package/build-lambda-layer)
[](https://github.com/yowainwright/build-lambda-layer)
### Builds Awesome Node Lambda Layers with Control! 🕹
_Build Lambda Layer_ is a utility CLI for building AWS Lambda Layers with control for AWS Node Lambda projects.
---
## Why is this written?
_Build Lambda Layer takes complexity out of building lambda layers!_
---
\+ Monorepo support
\+ The ability to ignore and add dependencies at run time
\+ Easy json configuration!
---
## How does it does it work?
By running:
```sh
build-layer
```
_Build Lambda Layer_ will:
- install all `package.json` dependencies to ``, and
- zip it up to be uploaded to AWS 🚀
---
#### Additionally, _Build Lambda Layer_ works with monorepos!
A key additional feature that Build Lambda Layer provides is that it works with monorepos!
By running:
```sh
build-layer my-lambda-layer --files 'packages/**/package.json'
```
_Build Lambda Layer_ will:
- install all `package/**/package.json` dependencies to your lambda layer, and
- zip it up to be uploaded to AWS
---
#### Ignore and include the dependencies you want!
_Build Lambda Layer_ supports specificity with `ignore` and `include` options.
By adding a `"lambdaLayer"` object to a `package.json` file you're building from, you can specify packages to `ignore` and `include`:
```json
{
"buildLambda": {
"ignore": ["@types/aws-lambda"],
"include": {
"aws-lambda": "latest"
}
}
}
```
You can also add a `lambdaLayerrc` file to your project root if you want to preserve your `package.json` file.
```json
{
"ignore": ["@types/aws-lambda"],
"include": {
"aws-lambda": "latest"
}
}
```
---
#### Be _really_ selective with your installs
There is nothing stopping you from creating your own dependency object to install.
Add a `.json` file to your project root:
```json
{
"dependencies": {
"aws-lambda": "latest"
}
}
```
And run:
```sh
build-layer my-lambda-layer --files '.json'
```
---
That's it! 🎉
Save yourself the time and effort of building Lambda Layers and let _Build Lambda Layer_ do it for you!
---
### Install
```sh
pnpm install build-lambda-layer
```
---
### CLI API
```sh
Usage: build-layer [options]
Build Lambda Layer, Build node awesome lambda layers with controls 🕹
Arguments:
dir lambda layer directory to build to
Options:
--architectures [architectures...] architectures for deployment to AWS
--bucket bucket to deploy to using AWS
-c, --config path to a config file
--deploy deploy your lambda layer
-n, --name lambda layer name
--debug enable debugging
-f, --files [files...] file glob pattern
-i, --ignore [ignore...] ignore glob pattern
--isTesting enable running fn tests w/o overwriting
--noZip don't zip lambda layer
-o, --output output path
-r, --rootDir root directory to start search
--runner npm, pnpm, or yarn
--runtimes [runtimes...] runtimes for deployment to AWS
-t, --isTestingCLI enable CLI only testing
-h, --help display help for command
```
---
## Recipes
##### Debugging
Gets you logging in your terminal
```sh
build-layer --debug
```
##### No Zip
Just build you a directory
```sh
build-layer --noZip
```
##### Custom runner
Build everything with a runner besides `npm`. Options are `npm`, `pnpm`, or `yarn`
```sh
build-layer --runner 'pnpm'
```
##### AWS Deploy
Assumes you're authenticated, have the AWS CLI, and have already deployed the layer to S3.
AKA, implemented but not actively guaranteed to work!
```
build-layer --bucket --runtimes [runtimes...] --architectures [architectures...]
```
---
Made by [@yowainwright](https://github.com/yowainwright) for fun with passion! MIT, 2022