Merge branch 'master' of https://github.com/AnomalyInnovations/serverless-bundle

Author: jayair

README.md

@@ -58,6 +58,7 @@ You can [read more about this over on Serverless Stack](https://serverless-stack
   - [Support for pem, txt, and other raw files](#support-for-pem-txt-and-other-raw-files)
   - [Externals](#externals)
   - [Externals vs forceExclude](#externals-vs-forceexclude)
+  - [Generating a stats file](#generating-stats-files)
 - [Support](#support)
 - [Running Locally](#running-locally)
 
@@ -105,6 +106,7 @@ custom:
     concurrency: 5                  # Set desired concurrency, defaults to the number of available cores
     stats: false                    # Don't print out any Webpack output
     linting: true                   # Enable linting as a part of the build process
+    generateStatsFiles: false       # Creates stats files that could be used for bundle analyzing, more below
     esbuild: false                  # Use esbuild-loader instead of babel or ts for faster builds
     disableForkTsChecker: false     # Disable the ForkTsChecker plugin, more below
     tsConfig: "tsconfig.json"       # Path to your 'tsconfig.json', if it's not in the root
@@ -454,6 +456,12 @@ The three options (`externals`, `forceExclude`, and `excludeFiles`) look similar
 
   These are a glob of files that can be excluded from the function resolution. This happens when you have multiple files that are in the same directory and Serverless Framework tries to use them as a function handler. For example, if you have a `index.js` and a `index.test.js` and your function is pointing to `index`, you'll get a warning saying, `WARNING: More than one matching handlers found for index. Using index.js`. To fix this, use `excludeFiles: **/*.test.js`.
 
+### Generating stats files
+
+Use the `generateStatsFiles` option if you want to analyze your bundle size. This option, if set to `true`, will
+enable the generation of a `bundle_stats.json` and a `bundle_stats.html` in the output directory, using the
+[webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer) plugin.
+
 ## Support
 
 - Open a [new issue](https://github.com/AnomalyInnovations/serverless-bundle/issues/new) if you've found a bug or have some suggestions.

index.js

@@ -35,6 +35,8 @@ function applyWebpackOptions(custom, config) {
       ),
     },
     excludeFiles: config.options.excludeFiles,
+    excludeRegex: /bundle_stats\.(html|json)$/,
+    keepOutputDirectory: config.options.generateStatsFiles,
   };
 }
 

package-lock.json

@@ -76,6 +76,7 @@
     "tsconfig-paths-webpack-plugin": "^3.5.1",
     "typescript": "^4.2.4",
     "webpack": "^5.33.2",
+    "webpack-bundle-analyzer": "^4.5.0",
     "webpack-node-externals": "^2.5.2",
     "webpack-permissions-plugin": "^1.0.8"
   },

package.json

@@ -18,6 +18,7 @@ module.exports = {
     excludeFiles: null,
     ignorePackages: [],
     packagerOptions: {},
+    generateStatsFiles: false,
     tsConfig: "tsconfig.json",
     // Exclude aws-sdk since it's available in the Lambda runtime
     forceExclude: ["aws-sdk"],

src/config.js

@@ -10,6 +10,7 @@ const nodeExternals = require("webpack-node-externals");
 const CopyWebpackPlugin = require("copy-webpack-plugin");
 const { ESBuildMinifyPlugin } = require("esbuild-loader");
 const ConcatTextPlugin = require("concat-text-webpack-plugin");
+const { BundleAnalyzerPlugin } = require("webpack-bundle-analyzer");
 const TsconfigPathsPlugin = require("tsconfig-paths-webpack-plugin");
 const PermissionsOutputPlugin = require("webpack-permissions-plugin");
 const ForkTsCheckerWebpackPlugin = require("fork-ts-checker-webpack-plugin");
@@ -46,6 +47,7 @@ const ENABLE_LINTING = config.options.linting;
 const ENABLE_SOURCE_MAPS = config.options.sourcemaps;
 const ENABLE_TYPESCRIPT = fs.existsSync(tsConfigPath);
 const ENABLE_TSCHECKER = !config.options.disableForkTsChecker;
+const GENERATE_STATS_FILES = config.options.generateStatsFiles;
 const ENABLE_CACHING = isLocal ? config.options.caching : false;
 
 // Handle the "all" option in externals
@@ -272,6 +274,18 @@ function loaders() {
 function plugins() {
   const plugins = [];
 
+  if (GENERATE_STATS_FILES) {
+    plugins.push(
+      new BundleAnalyzerPlugin({
+        openAnalyzer: false,
+        analyzerMode: "static",
+        generateStatsFile: true,
+        statsFilename: "bundle_stats.json",
+        reportFilename: "bundle_stats.html",
+      })
+    );
+  }
+
   if (ENABLE_TYPESCRIPT && ENABLE_TSCHECKER) {
     const forkTsCheckerWebpackOptions = {
       typescript: {