⚡ serverless-rspack

Serverless Framework plugin for zero-config JavaScript and TypeScript code bundling using the high performance Rust-based JavaScript bundler rspack

Look for the plugin under the /libs directory.

Example serverless projects are under the /examples directory.

For Developers - DEVELOPER.MD

Features

• From zero to hero: configuration possibilities range from zero-config to fully customizable
• Supports sls package, sls deploy
• Build and runtime performance at its core

Table of Contents

• Install
• Plugin Options
  • Examples
  • Options
    • Default Rspack Options
• Supported Runtimes
• Advanced Configuration
  • External Dependencies

Install

# install `serverless-rspack`
yarn add --dev @kitchenshelf/serverless-rspack
# or
npm install -D @kitchenshelf/serverless-rspack
# or
pnpm install -D @kitchenshelf/serverless-rspack

Add the following plugin to your serverless.yml:

plugins:
  - @kitchenshelf/serverless-rspack

Plugin Options

By default, no plugin options is required, but you can override the reasonable defaults via the custom.rspack section in the serverless.yml file.

custom:
  rspack:
    mode: 'production',
    esm: true

Examples

See example folder for example plugin option configuration.

Plugin Options

| Option | Description | Default | | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | zipConcurrency | The number of concurrent zip operations to run at once. eg. 8. NOTE: This can be memory intensive and could produce slower builds. | Infinity | | keepOutputDirectory | Keeps the .rspack output folder. Useful for debugging. | false | | stats | Generate packaging information that can be used to analyze module dependencies and optimize compilation speed. | false | | config | Relative rspack config path | undefined | | esm | Output format will be ESM (experimental) | false | | mode | Used to set the build mode of Rspack to enable the default optimization strategy (https://www.rspack.dev/config/mode) | production | | tsConfig | Relative path to your tsconfig | undefined | | externals | Provides a way of excluding dependencies from the output bundles | undefined |

Default Rspack Options

The following rspack options are automatically set and cannot be overwritten.

| Option | Notes | | ------------- | ---------------------------------------------------------------------------------------------------------------- | | entry | Handler entries are determined by the plugin | | output.path | The plugin needs to have full control over where bundles are output to, so it can correctly create zip artifacts |

Function Options

| Option | Description | Default | | -------- | --------------------------------------------------------------------------------------------- | ----------- | | rspack | Set this property on a function definition to force the handler to be processed by the plugin | undefined |

Supported Runtimes

This plugin will automatically process any function that has a runtime that starts with node i.e nodejs20.x

Non-Node functions

If you wish to use this plugin alongside non Node functions like Python or functions with images, this plugin will automatically ignore any function which does not match the supported runtimes.

If you wish to force a function to be process set rspack: true on a function definition. This is handy when using custom provided node runtimes i.e runtime: 'provided.al2023'

⚠️ Note: this will only work if your custom runtime and function are written in JavaScript/Typescript. Make sure you know what you are doing when this option is set to true

Advanced Configuration

Config file

Rspack configuration can be defined by a config file.

custom:
  esbuild:
    config: './rspack.config.js'

// rspack.config.js
module.exports = (serverless) => {
  external: ['lodash'],
  // etc
};

External Dependencies

By providing a regex you can mark packages as external and they will be excluded from the output bundles.

custom:
  rspack:
    externals:
      - "^@aws-sdk\/.*$"
      - "^@smithy\/.*$"
      - '^isin-validator$'

Inspired by serverless-plugin-typescript, serverless-webpack and serverless-esbuild