serverless-rollup-plugin

v2.2.1

A plugin for the serverless framework to build lambda code using rollup

NPM

README

GitHub

Website

MIT

Latest version published 29 days ago

    npm install serverless-rollup-plugin

We couldn't find any similar packages Browse all packages

Package Health Score

64 / 100

Popularity
Limited
Maintenance
Healthy
Security
Security review needed
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (116)

Dependents: 0
GitHub Stars: 19
Forks: 9
Contributors: 4

The npm package serverless-rollup-plugin receives a total of 116 downloads a week. As such, we scored serverless-rollup-plugin popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package serverless-rollup-plugin, we found that it has been starred 19 times, and that 0 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

Security review needed

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

1.5.5

1.6.2

1.7.2

2.1.0

2.2.1

Indirect Vulnerabilities

1.5.5

1.6.2

1.7.2

2.1.0

2.2.1

License Risks

1.5.5

1.6.2

1.7.2

2.1.0

2.2.1

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like serverless-rollup-plugin is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like serverless-rollup-plugin is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test serverless-rollup-plugin

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 1
Merged PR: 22
Open PR: 0
Last Commit: 29 days ago

Further analysis of the maintenance status of serverless-rollup-plugin based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that serverless-rollup-plugin demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 4
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like serverless-rollup-plugin is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 1 year
Dependencies: 8 Direct
Versions: 27
Install Size: 23 kB
Dist-tags: 1
# of Files: 6
Maintainers: 2
TS Typings: No

serverless-rollup-plugin has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Welcome to serverless-rollup-plugin 👋

A plugin for the serverless framework to bundle lambda code using rollup

Install

yarn install serverless-rollup-plugin

Usage

Add the plugin to your serverless config:

plugins:
  - serverless-rollup-plugin
  - ...any other plugins

Under the custom property, add a section for rollup. The only required property to run rollup is the config property:

custom:
  rollup:
    config: ./rollup.config.js

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.

testFunction:
  handler: src/functions/testFunction/index.handler
  dependencies:
    - aws-xray-sdk-core
  copyFiles:
    - some/glob/**/*.pattern

Using Yarn

By default if you specify function dependencies npm will be used. You can override this by setting the installCommand property, like this:

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), you can add them to the rollup dependencies property:

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:

{
  "format": "cjs",
  "sourcemap": true
}

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:

custom:
  rollup:
    dependencies:
      - source-map-support

Then in your rollup config, set the output banner to install it:

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

Author

👤 Ben Force

Twitter: @theBenForce
Github: @theBenForce

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

This README was generated with ❤️ by readme-md-generator