Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thebenforce/serverless-rollup-plugin
Use rollupjs to package your serverless framework lambdas.
https://github.com/thebenforce/serverless-rollup-plugin
lambda rollup serverless-framework
Last synced: 14 days ago
JSON representation
Use rollupjs to package your serverless framework lambdas.
- Host: GitHub
- URL: https://github.com/thebenforce/serverless-rollup-plugin
- Owner: theBenForce
- Created: 2019-08-29T16:26:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T14:23:07.000Z (about 1 month ago)
- Last Synced: 2024-10-25T04:22:10.644Z (21 days ago)
- Topics: lambda, rollup, serverless-framework
- Language: TypeScript
- Size: 2.97 MB
- Stars: 22
- Watchers: 3
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Welcome to serverless-rollup-plugin 👋
[](https://github.com/theBenForce/serverless-rollup-plugin/actions)
[](https://codeclimate.com/github/theBenForce/serverless-rollup-plugin/maintainability)
[](https://badge.fury.io/js/serverless-rollup-plugin)
[](https://app.fossa.com/projects/git%2Bgithub.com%2FtheBenForce%2Fserverless-rollup-plugin?ref=badge_shield)
[](#contributors)
> A plugin for the serverless framework to bundle lambda code using rollup
## Install
```sh
npm install --save-dev serverless-rollup-plugin
```
Requires Node.js 18 and serverless 3.2.
## Usage
Add the plugin to your serverless config:
```yaml
plugins:
- serverless-rollup-plugin
- ...any other plugins
```
For each function that you would like to use rollup option, just define the handler option as normal. You can
optionally define the `dependencies` property as a list of packages to be installed in the `node_modules` folder
in your lambda.
```yaml
testFunction:
handler: src/functions/testFunction/index.handler
dependencies:
- aws-xray-sdk-core
copyFiles:
- some/glob/**/*.pattern
```
### Config
By default, `serverless-rollup-plugin` will attempt to load `rollup.config.js`.
In order to override this behavior, you can add the following to configuration options:
```yaml
custom:
rollup:
config: ./custom-rollup.config.js
```
### Using Yarn
By default if you specify function dependencies `npm` will be used. You can override this by setting the `installCommand` property, like this:
```yaml
custom:
rollup:
installCommand: yarn add
```
### Add Global Dependency
If you want to add a dependency for every lambda function (for example [adding source map support](#adding-sourcemap-support)), you can add them to the rollup `dependencies` property:
```yaml
custom:
rollup:
dependencies:
- some-package-name
```
### Output Options
If you don't specify `output` settings in your rollup config, the following defaults will be used:
```json
{
"format": "cjs",
"sourcemap": true
}
```
If the `format` is `esm`, the resulting package will use the `mjs` extension to make use of [native lambda esm support](https://aws.amazon.com/blogs/compute/using-node-js-es-modules-and-top-level-await-in-aws-lambda/).
### Concurrency
By default, `serverless-rollup-plugin` will output rollup bundles concurrently.
In systems with low memory, such as small CI instances, it may be necessary to limit the number concurrent outputs so as not to run out of memory.
You can define the number of concurrent outputs by using the `concurrency` option:
```yaml
custom:
rollup:
concurrency: 3
```
Any value other than a number will be treated as `Number.POSITIVE_INFINITY`.
### Adding Sourcemap Support
You can easily get your lambda stack traces to show correct file/line information using the `source-map-support` package.
To use this with the `serverless-rollup-plugin`, first install the package and add it to the universal dependencies:
```yaml
custom:
rollup:
dependencies:
- source-map-support
```
Then in your rollup config, set the output banner to install it:
```typescript
export default {
output: {
format: "cjs",
sourcemap: true,
banner: "require('source-map-support').install();"
}
};
```
If you do specify `output` settings, they will be used and only the `file` property will be overwritten.
### Copying Resource Files
To copy a static file into your function deployment, use the `copyFiles` parameter. This
parameter is an array of glob pattern strings, or objects with the following properties:
| Name | Required | Description |
| ----------- | -------- | --------------------------------------------------------------- |
| glob | Yes | A glob pattern |
| srcBase | No | Part of the path that will be removed from the destination path |
| destination | No | Destination path within the lambda's directory structure |
## 🧑💻 Contributors
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/drg-adaptive/serverless-rollup-plugin/issues).
## Show your support
Give a ⭐️ if this project helped you!
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_