@cley_faye/boilerplate 3.20.0 → 3.21.0

package/README.md

@@ -166,6 +166,7 @@ The webpack options support a host of properties:
 - mode: The build mode. "development", "production" or "none"
 - defines: a record of value to define using Babel transform-define
 - resolve: a custom "resolve" object for webpack config
+- generateReport: a boolean, set to true to generate a bundle size report HTML file
 
 ### SASS
 All `.sass` and `.scss` files in the `webres` directory will be processed as `.css` files

package/lib/grunt/reactapp/webpack.d.ts

@@ -52,6 +52,7 @@ export interface WebpackOptions extends BaseOptions {
     babelPlugins?: Array<Record<string, unknown>>;
     defines?: Record<string, string>;
     resolve?: ResolveOptions;
+    generateReport?: boolean;
     typescript?: boolean;
 }
 /** Add a webpack task for the reactApp recipe
@@ -106,6 +107,9 @@ export interface WebpackOptions extends BaseOptions {
  * Build mode. "development", "production" or "none".
  * Defaults to "development"
  *
+ * @param [webpackOptions.generateReport]
+ * Generate a bundle report HTML file.
+ *
  * @param [webpackOptions.typescript]
  * Allow loading typescript source for webpack/babel.
  *

package/lib/grunt/reactapp/webpack.js

@@ -33,6 +33,7 @@ exports.handle = exports.webpackLoadersDefault = void 0;
 const path_1 = require("path");
 const node_fs_1 = require("node:fs");
 const eslint_webpack_plugin_1 = __importDefault(require("eslint-webpack-plugin"));
+const webpack_bundle_analyzer_1 = require("webpack-bundle-analyzer");
 const util_js_1 = require("./util.js");
 const defaultCoreJS = 3;
 const eslintPlugin = () => new eslint_webpack_plugin_1.default({ cache: true });
@@ -178,6 +179,20 @@ const computeWebpackResolve = (webpackOptions) => {
     }
     return res;
 };
+const getWebpackPlugins = (webpackOptions) => {
+    const plugins = [
+        eslintPlugin(),
+        ...webpackOptions.plugins ?? [],
+    ];
+    if (webpackOptions.generateReport) {
+        plugins.push(new webpack_bundle_analyzer_1.BundleAnalyzerPlugin({
+            analyzerMode: "static",
+            reportFilename: (0, path_1.join)(process.cwd(), "bundle_report.html"),
+            openAnalyzer: false,
+        }));
+    }
+    return plugins;
+};
 /** Add a webpack task for the reactApp recipe
  *
  * @param gruntConfig
@@ -230,6 +245,9 @@ const computeWebpackResolve = (webpackOptions) => {
  * Build mode. "development", "production" or "none".
  * Defaults to "development"
  *
+ * @param [webpackOptions.generateReport]
+ * Generate a bundle report HTML file.
+ *
  * @param [webpackOptions.typescript]
  * Allow loading typescript source for webpack/babel.
  *
@@ -257,10 +275,7 @@ const handle = (gruntConfig, targetName, webpackOptions) => {
         output: webpackOutput,
         externals: webpackOptions.externals,
         module: { rules: webpackLoaders },
-        plugins: [
-            eslintPlugin(),
-            ...webpackOptions.plugins ?? [],
-        ],
+        plugins: getWebpackPlugins(webpackOptions),
         resolve: webpackResolve,
     };
     // Special case: I'm not sure I can move options in the task-specific part of

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.20.0",
+  "version": "3.21.0",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",
@@ -22,14 +22,15 @@
   "homepage": "https://github.com/CleyFaye/boilerplate#readme",
   "devDependencies": {
     "@keeex/eslint-config": "^1.11.5",
-    "@types/express": "^4.17.18",
+    "@types/express": "^4.17.19",
     "@types/grunt": "^0.4.28",
     "@types/http-errors": "^2.0.2",
     "@types/minimist": "^1.2.3",
-    "@types/node": "^18.18.3",
-    "@typescript-eslint/eslint-plugin": "^6.7.4",
-    "@typescript-eslint/parser": "^6.7.4",
-    "eslint": "^8.50.0",
+    "@types/node": "^18.18.4",
+    "@types/webpack-bundle-analyzer": "^4.6.1",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "@typescript-eslint/parser": "^6.7.5",
+    "eslint": "^8.51.0",
     "eslint-plugin-deprecation": "^2.0.0",
     "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-promise": "^6.1.1",
@@ -43,7 +44,7 @@
     "logform": "^2.5.1",
     "typescript": "^5.2.2",
     "webpack": "^5.88.2",
-    "winston": "^3.10.0"
+    "winston": "^3.11.0"
   },
   "peerDependencies": {
     "@babel/core": "7.x",
@@ -61,10 +62,11 @@
     "grunt-contrib-pug": "3.x",
     "grunt-contrib-watch": "1.x",
     "grunt-sass": "3.x",
-    "grunt-webpack": "5.x",
+    "grunt-webpack": "5.x||6.x",
     "minimist": "^1.2.8",
     "sass": "1.x",
     "ts-loader": "^9.4.1",
+    "webpack-bundle-analyzer": "^4.9.1",
     "winston": "3.x"
   },
   "peerDependenciesMeta": {