feat(esbuild): support esbuild plugins

README.md

@@ -64,6 +64,20 @@ custom:
     packagePath: absolute/path/to/package.json # optional - by default it looks for a package.json in the working directory
 ```
 
+### Usign esbuild plugins
+
+*Note that the plugins API is still experimental : see [the documentation page](https://esbuild.github.io/plugins/)*
+
+You can configure esbuild plugins by passing a plugins' configuration file:
+
+```yml
+custom:
+  esbuild:
+    plugins: plugins.js
+```
+
+The plugins' configuration file must be a javascript file exporting an array of plugins (see `examples/individually/plugins.js` for a dummy plugin example)
+
 ## Usage
 
 ### Automatic compilation

examples/individually/plugins.js

@@ -0,0 +1,12 @@
+let envPlugin = {
+  name: 'log-lodash',
+  setup(build) {
+    // test interception : log all lodash inports
+    build.onResolve({ filter: /^lodash$/ }, args => {
+      console.log(args);
+    });
+  },
+};
+
+// default export should be an array of plugins
+module.exports = [envPlugin];

examples/individually/serverless.yml

@@ -13,6 +13,7 @@ provider:
 
 custom:
   esbuild:
+    plugins : ./plugins.js
     packager: yarn
     bundle: true
     minify: true

src/index.ts

@@ -26,11 +26,12 @@ export interface WatchConfiguration {
   ignore?: string[] | string;
 }
 
-export interface Configuration extends Omit<BuildOptions, 'watch'> {
+export interface Configuration extends Omit<BuildOptions, 'watch' | 'plugins'> {
   packager: 'npm' | 'yarn';
   packagePath: string;
   exclude: string[];
   watch: WatchConfiguration;
+  plugins?: string;
 }
 
 const DEFAULT_BUILD_OPTIONS: Partial<Configuration> = {
@@ -196,13 +197,17 @@ export class EsbuildPlugin implements Plugin {
           outdir: path.join(this.buildDirPath, path.dirname(entry)),
           platform: 'node',
           incremental,
+          plugins:
+            this.buildOptions.plugins &&
+            require(path.join(this.serverless.config.servicePath, this.buildOptions.plugins)),
         };
 
         // esbuild v0.7.0 introduced config options validation, so I have to delete plugin specific options from esbuild config.
         delete config['exclude'];
         delete config['packager'];
         delete config['packagePath'];
         delete config['watch'];
+        delete config['pugins'];
 
         const result = await build(config);