https://github.com/kitchenshelf/serverless-rspack
A Serverless framework plugin for zero-config JavaScript and TypeScript code bundling using the high performance Rust-based JavaScript bundler rspack
https://github.com/kitchenshelf/serverless-rspack
Last synced: 3 months ago
JSON representation
A Serverless framework plugin for zero-config JavaScript and TypeScript code bundling using the high performance Rust-based JavaScript bundler rspack
- Host: GitHub
- URL: https://github.com/kitchenshelf/serverless-rspack
- Owner: kitchenshelf
- Created: 2024-05-06T08:39:26.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T21:05:30.000Z (9 months ago)
- Last Synced: 2024-10-26T08:35:58.243Z (9 months ago)
- Language: TypeScript
- Size: 1.29 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-rspack - serverless-rspack - config JavaScript and TypeScript code bundling using the high performance Rust-based JavaScript bundler rspack. (Resources / Ecosystem)
README
# ⚡ serverless-rspack
[Serverless Framework](https://www.serverless.com) plugin for zero-config JavaScript and TypeScript code bundling using the high performance Rust-based JavaScript bundler [`rspack`](https://rspack.dev/guide/start/introduction)
[![Serverless][ico-serverless]][link-serverless]
[![Build Status][ico-build]][link-build]
[![NPM][ico-npm]][link-npm]
Look for the plugin under the [/libs](/libs/serverless-rspack//) directory.
Example serverless projects are under the [/examples](/examples) directory.
For Developers - [DEVELOPER.MD](./docs/DEVELOPER.md)
## Features
- From zero to hero: configuration possibilities range from zero-config to fully customizable
- Build and runtime performance at its core
- Supports `sls package`, `sls deploy`, `sls deploy function`
- Integrates with [`Serverless Invoke Local`](https://www.serverless.com/framework/docs/providers/aws/cli-reference/invoke-local) & [`serverless-offline`](https://github.com/dherault/serverless-offline)
## Table of Contents
- [Install](#install)
- [Serverless V4](#serverless-v4-requirement)
- [Plugin Options](#plugin-options)
- [Examples](#examples)
- [Options](#options)
- [Read-only default Rspack Options](#read-only-default-rspack-options)
- [Supported Runtimes](#supported-runtimes)
- [Advanced Configuration](#advanced-configuration)
- [Config File](#config-file)
- [Config File Merge Strategies](#config-file-merge-strategies)
- [External Dependencies](#external-dependencies)
- [Scripts](#scripts)
- [Function Scripts](#function-scripts)
- [Global Scripts](#global-scripts)
- [Doctor](#doctor)
- [Integrations](#integrations)
- [Serverless Offline](#serverless-offline)
- [Known Issues](#known-issues)
## Install
```sh
# 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`:
```yaml
plugins:
- @kitchenshelf/serverless-rspack
```
### Serverless v4 requirement
If you are using Serverless v4 you must disable the default builtin ESBuild support in your `serverless.yml`
```yml
build:
esbuild: false
```
## 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.
```yml
custom:
rspack:
mode: 'production'
esm: true
```
### Examples
See [example folder](../../examples) for example plugin option configuration.
### 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`](#config-file) | rspack config options. | `undefined` |
| `config.path` | Relative rspack config path. | `undefined` |
| [`config.strategy`](#config-file-merge-strategies) | Strategy to use when a rspack config is provided. | `override` |
| `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` |
| `sourcemap` | Configure rspack [sourcemaps](https://rspack.dev/config/devtool). | `false` |
| [`externals`](#external-dependencies) | Provides a way of excluding dependencies from the output bundles. | `undefined` |
| [`scripts`](#scripts) | Array of scripts to execute after your code has been bundled by rspack. | `undefined` |
| [`doctor`](#doctor) | Enable the `Rsdoctor` plugin. | `undefined` |
#### Read-only 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.
```yml
custom:
esbuild:
config:
path: './rspack.config.js'
```
```js
// rspack.config.js
module.exports = (serverless) => {
external: ['lodash'],
// etc
};
```
You can also return an async function.
```js
module.exports = async (serverless) => {
const getExternals = new Promise((resolve, reject) => {
setTimeout(() => {
resolve(['lodash']);
}, 250);
});
const externals = await getExternals;
return {
external: externals,
// etc
};
};
```
#### Config file merge strategies
You can change how the plugin uses a provided config via the `strategy` option:
```yml
custom:
esbuild:
config:
path: './rspack.config.js'
strategy: combine
```
1. `override`: ***Default*** - Enables power users to provided their own complete Rspack configuration: `rspack.config.js` -> [`PluginReadOnlyDefaults`](#read-only-default-rspack-options)
2. `combine`: Enables providing partial configuration. Merges all configuration together: `PluginDefaults` -> `PluginOptions` -> `rspack.config.js` -> [`PluginReadOnlyDefaults`](#read-only-default-rspack-options).
⚠️ **Note: Pay attention to the order in which configuration is combined. Each time the right take precedence. **
### External Dependencies
By providing a regex you can mark packages as `external` and they will be excluded from the output bundles.
```yml
custom:
rspack:
externals:
- "^@aws-sdk\/.*$"
- "^@smithy\/.*$"
- '^isin-validator$'
```
### Scripts
Run custom shell commands after your code has been bundled by rspack. This is useful for modifying the output of the build before it is packaged.
There are two types of scripts:
1. **Function**: Executed once per defining function after the bundle step.
2. **Global**: Executed once before the package step.
**Order**: `bundle` -> `function scripts` -> `global scripts` -> `package`
⚠️ **Note: Scripts run sequentially and will fail the build if any errors occur in any of the scripts.**
The following environment variables are available to all your scripts:
- `process.env`: All system environment variables.
- `KS_SERVICE_DIR`: The absolute path to the service directory (e.g. `/Users/user/code/my-service`).
- `KS_BUILD_OUTPUT_FOLDER`: The name of the build output folder (e.g. `.rspack`).
- `KS_PACKAGE_OUTPUT_FOLDER`: The name of the package output folder (e.g. `.serverless`).
#### Function Scripts
Scripts are executed from the function directory in the output folder i.e `.rspack/`.
##### Usage
```yml
functions:
app3:
handler: src/App3.handler
runtime: nodejs20.x
rspack:
enable: true
scripts:
- 'echo "First function script"'
- 'npx npm init -y && npm install --force --os=linux --cpu=x64 --include=optional sharp @img/sharp-linux-x64'
- 'cp $KS_SERVICE_DIR/src/my-image.jpeg ./'
- 'echo "Last function script"'
```
The following extra environment variables are available to your function scripts:
- `KS_FUNCTION_NAME`: The name of the function being processed.
#### Global Scripts
Scripts are executed from the root of the service directory.
##### Usage
```yml
custom:
rspack:
externals: ['^@aws-sdk/.*$'],
scripts:
- 'echo "First global script"'
- 'echo "Last global script"'
```
### Doctor
[Rsdoctor](https://rsdoctor.dev/guide/start/intro) is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
The serverless-rspack plugin will automatically enable the `Rsdoctor` plugin when the `doctor` option is provided.
```yml
custom:
rspack:
doctor: true
```
You can also provide an `outputDirectory` to specify where the report should be saved. By default, the report will be saved in the `.rspack` folder.
```yml
custom:
rspack:
doctor:
enable: true
outputDirectory: ./doctor-report
```
⚠️ **Note: Rsdoctor is configured to run in [`brief`](https://rsdoctor.dev/guide/start/cicd#enabling-brief-mode) mode. If you want to use another mode, you can register `RsdoctorRspackPlugin` manually using the [rspack config option](#config-file).**
## Integrations
### Serverless Offline
The plugin has first class support for [serverless-offline](https://github.com/dherault/serverless-offline).
Add the plugins to your `serverless.yml` file and make sure that `serverless-rspack`
precedes `serverless-offline` as the order is important:
```yaml
plugins: ...
- serverless-rspack
...
- serverless-offline
...
```
Run `serverless offline start` to start the Lambda/API simulation.
⚠️ **Note: The plugin will automatically set sourcemap to `source-map` when running in offline mode and change the `devtoolModuleFilenameTemplate` to `[absolute-resource-path]`.**
⚠️ **Note: If you are using a custom rspack config, then the serverless plugin passed to your config function will have `offlineMode` set to true.**
## Known Issues
- Invoke Local does not work with ESM enabled when using serverless V3: [ISSUE-11308](https://github.com/serverless/serverless/issues/11308#issuecomment-1719297694)
---
---
---
Inspired by [serverless-plugin-typescript](https://github.com/prisma-labs/serverless-plugin-typescript), [serverless-webpack](https://github.com/serverless-heaven/serverless-webpack) and [serverless-esbuild](https://github.com/floydspace/serverless-esbuild)
[ico-serverless]: http://public.serverless.com/badges/v3.svg
[ico-npm]: https://img.shields.io/npm/v/@kitchenshelf/serverless-rspack.svg
[ico-build]: https://github.com/kitchenshelf/serverless-rspack/actions/workflows/ci.yml/badge.svg
[link-serverless]: https://www.serverless.com/
[link-npm]: https://www.npmjs.com/package/@kitchenshelf/serverless-rspack
[link-build]: https://github.com/kitchenshelf/serverless-rspack/actions/workflows/ci.yml