fix: invalid values for route.rewriteIndex option are treated as default value

webdiscus · webdiscus · commit 548efc79a385 · 2025-04-17T19:08:26.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,23 +1,27 @@
 # Changelog
 
+## 4.20.2 (2025-04-17)
+
+- fix: invalid values for `route.rewriteIndex` option are treated as default value
+
 ## 4.20.1 (2025-04-17)
 
 - fix: disallow `undefined` value for optional properties by `route` option
 
-## 4.20.0
+## 4.20.0 (2025-04-11)
 
 - feat: add support for ESM data files
 - chore: remove tests with Node.js version 18
 
-## 4.19.2
+## 4.19.2 (2025-04-01)
 
 - feat: case-insensitive preprocessor patterns, #165
 
-## 4.19.1
+## 4.19.1 (2025-03-29)
 
 - fix: `js.chunkFilename` should default to `js.filename` when `js.filename` is specified as a string, #164
 
-## 4.19.0
+## 4.19.0 (2025-03-16)
 
 ### 🔥 CHANGES by inlining SVG only
 
@@ -46,7 +50,7 @@
   Result:
   ```html
   <svg class="icon" ...>...</svg>
-    ```
+  ```
 - When inlining SVG as a data URL, consider Webpack's `generator.dataUrl()` and `generator.dataUrl.encoding` options.
 - Display a warning when used `?embed` URL query for SVG files in JS or CSS.
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "html-bundler-webpack-plugin",
-  "version": "4.20.1",
+  "version": "4.20.2",
   "description": "Generates complete single-page or multi-page website from source assets. Built-in support for Markdown, Eta, EJS, Handlebars, Nunjucks, Pug. Alternative to html-webpack-plugin.",
   "keywords": [
     "html",
diff --git a/src/Plugin/Option.js b/src/Plugin/Option.js
@@ -372,6 +372,11 @@ class Option {
       if (typeof routerOptions === 'boolean') {
         this.router.enabled = routerOptions;
       } else if (typeof routerOptions === 'object') {
+        // for invalid value, set default value
+        if (routerOptions.rewriteIndex !== false && typeof routerOptions.rewriteIndex !== 'string') {
+          routerOptions.rewriteIndex = this.router.rewriteIndex;
+        }
+
         this.router = { ...this.router, ...routerOptions };
 
         if (typeof routerOptions.resolve !== 'function') {
diff --git a/test/cases/option-router-rewriteIndex-undefined/expected/assets/css/style.7fc9d183.css b/test/cases/option-router-rewriteIndex-undefined/expected/assets/css/style.7fc9d183.css
@@ -0,0 +1 @@
+h1{color:green}
diff --git a/test/cases/option-router-rewriteIndex-undefined/expected/assets/css/style.fd838354.css b/test/cases/option-router-rewriteIndex-undefined/expected/assets/css/style.fd838354.css
@@ -0,0 +1 @@
+h1{color:red}
diff --git a/test/cases/option-router-rewriteIndex-undefined/expected/assets/img/apple.02a7c382.png b/test/cases/option-router-rewriteIndex-undefined/expected/assets/img/apple.02a7c382.png
diff --git a/test/cases/option-router-rewriteIndex-undefined/expected/assets/img/favicon.edda23bf.ico b/test/cases/option-router-rewriteIndex-undefined/expected/assets/img/favicon.edda23bf.ico
diff --git a/test/cases/option-router-rewriteIndex-undefined/expected/index.html b/test/cases/option-router-rewriteIndex-undefined/expected/index.html
@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Home</title>
+  <link href="http://localhost:8080/assets/img/favicon.edda23bf.ico" rel="icon">
+
+  <!-- load page style -->
+  <link href="http://localhost:8080/assets/css/style.fd838354.css" rel="stylesheet">
+</head>
+<body>
+  <h1>Home</h1>
+  <nav>
+  <a href="http://localhost:8080/index.html">Home</a>
+  | <a href="http://localhost:8080/index.html?q=1">Home (query)</a>
+  | <a href="http://localhost:8080/index.html#test">Home (anchor)</a>
+  | <a href="http://localhost:8080/login/signup/index.html">Sign up</a>
+  | <a href="javascript:void 0" data-link="http://localhost:8080/page1.html" onclick="location.href=this.dataset.link">Page 1 (JS)</a>
+  | <button href="http://localhost:8080/sub/page2.html" onclick="location.href=this.getAttribute('href')">Sub Page 2 (JS)</button>
+  | <button data-hyperlink="http://localhost:8080/sub/page3.html" onclick="location.href=this.dataset.hyperlink">Sub Page 3 (JS)</button>
+  | <a href="http://localhost:8080/assets/img/apple.02a7c382.png" target="_blank">Image file</a>
+  | <a href="https://google.com" target="_blank">Google</a>
+  | <a href="/index.html">Home (not resolvable)</a>
+</nav></body>
+</html>
diff --git a/test/cases/option-router-rewriteIndex-undefined/expected/login/signup/index.html b/test/cases/option-router-rewriteIndex-undefined/expected/login/signup/index.html
@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Sign Up</title>
+  <link href="http://localhost:8080/assets/img/favicon.edda23bf.ico" rel="icon">
+
+  <!-- load page style -->
+  <link href="http://localhost:8080/assets/css/style.7fc9d183.css" rel="stylesheet">
+</head>
+<body>
+  <h1>Sign Up</h1>
+  <nav>
+  <a href="http://localhost:8080/index.html">Home</a>
+  | <a href="http://localhost:8080/index.html?q=1">Home (query)</a>
+  | <a href="http://localhost:8080/index.html#test">Home (anchor)</a>
+  | <a href="http://localhost:8080/login/signup/index.html">Sign up</a>
+  | <a href="javascript:void 0" data-link="http://localhost:8080/page1.html" onclick="location.href=this.dataset.link">Page 1 (JS)</a>
+  | <button href="http://localhost:8080/sub/page2.html" onclick="location.href=this.getAttribute('href')">Sub Page 2 (JS)</button>
+  | <button data-hyperlink="http://localhost:8080/sub/page3.html" onclick="location.href=this.dataset.hyperlink">Sub Page 3 (JS)</button>
+  | <a href="http://localhost:8080/assets/img/apple.02a7c382.png" target="_blank">Image file</a>
+  | <a href="https://google.com" target="_blank">Google</a>
+  | <a href="/index.html">Home (not resolvable)</a>
+</nav></body>
+</html>
diff --git a/test/cases/option-router-rewriteIndex-undefined/expected/page1.html b/test/cases/option-router-rewriteIndex-undefined/expected/page1.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Page 1</title>
+  <link href="http://localhost:8080/assets/img/favicon.edda23bf.ico" rel="icon">
+</head>
+<body>
+<h1>Page 1</h1>
+  <nav>
+    <a href="http://localhost:8080/index.html">Home</a>
+  </nav>
+</body>
+</html>
diff --git a/test/cases/option-router-rewriteIndex-undefined/expected/sub/page2.html b/test/cases/option-router-rewriteIndex-undefined/expected/sub/page2.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Page 2</title>
+  <link href="http://localhost:8080/assets/img/favicon.edda23bf.ico" rel="icon">
+</head>
+<body>
+  <h1>Page 2</h1>
+  <nav>
+  <a href="http://localhost:8080/index.html">Home</a>
+  | <a href="http://localhost:8080/index.html?q=1">Home (query)</a>
+  | <a href="http://localhost:8080/index.html#test">Home (anchor)</a>
+  | <a href="http://localhost:8080/login/signup/index.html">Sign up</a>
+  | <a href="javascript:void 0" data-link="http://localhost:8080/page1.html" onclick="location.href=this.dataset.link">Page 1 (JS)</a>
+  | <button href="http://localhost:8080/sub/page2.html" onclick="location.href=this.getAttribute('href')">Sub Page 2 (JS)</button>
+  | <button data-hyperlink="http://localhost:8080/sub/page3.html" onclick="location.href=this.dataset.hyperlink">Sub Page 3 (JS)</button>
+  | <a href="http://localhost:8080/assets/img/apple.02a7c382.png" target="_blank">Image file</a>
+  | <a href="https://google.com" target="_blank">Google</a>
+  | <a href="/index.html">Home (not resolvable)</a>
+</nav></body>
+</html>
diff --git a/test/cases/option-router-rewriteIndex-undefined/expected/sub/page3.html b/test/cases/option-router-rewriteIndex-undefined/expected/sub/page3.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Page 3</title>
+  <link href="http://localhost:8080/assets/img/favicon.edda23bf.ico" rel="icon">
+</head>
+<body>
+<h1>Page 3</h1>
+  <nav>
+    <a href="http://localhost:8080/index.html">Home</a>
+    | <a href="http://localhost:8080/page1.html">Page 1</a>
+    | <a href="http://localhost:8080/page1.html">Page 1 (double link)</a>
+  </nav>
+</body>
+</html>
diff --git a/test/cases/option-router-rewriteIndex-undefined/src/assets/scripts/main.js b/test/cases/option-router-rewriteIndex-undefined/src/assets/scripts/main.js
@@ -0,0 +1 @@
+console.log('>> main');
diff --git a/test/cases/option-router-rewriteIndex-undefined/src/assets/styles/style.scss b/test/cases/option-router-rewriteIndex-undefined/src/assets/styles/style.scss
@@ -0,0 +1,6 @@
+$color: #444;
+body {
+  font-family: sans-serif;
+  font-size: 14px;
+  color: $color;
+}
diff --git a/test/cases/option-router-rewriteIndex-undefined/src/views/pages/home/index.html b/test/cases/option-router-rewriteIndex-undefined/src/views/pages/home/index.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Home</title>
+  <link href="@images/favicons/favicon.ico" rel="icon">
+
+  <!-- load page style -->
+  <link href="./style.scss" rel="stylesheet">
+</head>
+<body>
+  <h1>Home</h1>
+  <%~ include('src/views/partials/nav.html') %>
+</body>
+</html>
diff --git a/test/cases/option-router-rewriteIndex-undefined/src/views/pages/home/style.scss b/test/cases/option-router-rewriteIndex-undefined/src/views/pages/home/style.scss
@@ -0,0 +1,4 @@
+$color: red;
+h1 {
+  color: $color;
+}
diff --git a/test/cases/option-router-rewriteIndex-undefined/src/views/pages/login/signup/index.eta b/test/cases/option-router-rewriteIndex-undefined/src/views/pages/login/signup/index.eta
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Sign Up</title>
+  <link href="@images/favicons/favicon.ico" rel="icon">
+
+  <!-- load page style -->
+  <link href="./style.scss" rel="stylesheet">
+</head>
+<body>
+  <h1>Sign Up</h1>
+  <%~ include('src/views/partials/nav.html') %>
+</body>
+</html>
diff --git a/test/cases/option-router-rewriteIndex-undefined/src/views/pages/login/signup/style.scss b/test/cases/option-router-rewriteIndex-undefined/src/views/pages/login/signup/style.scss
@@ -0,0 +1,4 @@
+$color: green;
+h1 {
+  color: $color;
+}
diff --git a/test/cases/option-router-rewriteIndex-undefined/src/views/pages/page1.html b/test/cases/option-router-rewriteIndex-undefined/src/views/pages/page1.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Page 1</title>
+  <link href="@images/favicons/favicon.ico" rel="icon">
+</head>
+<body>
+<h1>Page 1</h1>
+  <nav>
+    <a href="@views/home/index.html">Home</a>
+  </nav>
+</body>
+</html>
diff --git a/test/cases/option-router-rewriteIndex-undefined/src/views/pages/sub/page2.html b/test/cases/option-router-rewriteIndex-undefined/src/views/pages/sub/page2.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Page 2</title>
+  <link href="@images/favicons/favicon.ico" rel="icon">
+</head>
+<body>
+  <h1>Page 2</h1>
+  <%~ include('src/views/partials/nav.html') %>
+</body>
+</html>
diff --git a/test/cases/option-router-rewriteIndex-undefined/src/views/pages/sub/page3.html b/test/cases/option-router-rewriteIndex-undefined/src/views/pages/sub/page3.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Page 3</title>
+  <link href="@images/favicons/favicon.ico" rel="icon">
+</head>
+<body>
+<h1>Page 3</h1>
+  <nav>
+    <a href="@views/home/index.html">Home</a>
+    | <a href="@views/page1.html">Page 1</a>
+    | <a href="@views/page1.html">Page 1 (double link)</a>
+  </nav>
+</body>
+</html>
diff --git a/test/cases/option-router-rewriteIndex-undefined/src/views/partials/nav.html b/test/cases/option-router-rewriteIndex-undefined/src/views/partials/nav.html
@@ -0,0 +1,12 @@
+<nav>
+  <a href="@views/home/index.html">Home</a>
+  | <a href="@views/home/index.html?q=1">Home (query)</a>
+  | <a href="@views/home/index.html#test">Home (anchor)</a>
+  | <a href="@views/login/signup/index.eta">Sign up</a>
+  | <a href="javascript:void 0" data-link="@views/page1.html" onclick="location.href=this.dataset.link">Page 1 (JS)</a>
+  | <button href="@views/sub/page2.html" onclick="location.href=this.getAttribute('href')">Sub Page 2 (JS)</button>
+  | <button data-hyperlink="@views/sub/page3.html" onclick="location.href=this.dataset.hyperlink">Sub Page 3 (JS)</button>
+  | <a href="@images/apple.png" target="_blank">Image file</a>
+  | <a href="https://google.com" target="_blank">Google</a>
+  | <a href="/index.html">Home (not resolvable)</a>
+</nav>
diff --git a/test/cases/option-router-rewriteIndex-undefined/webpack.config.js b/test/cases/option-router-rewriteIndex-undefined/webpack.config.js
@@ -0,0 +1,67 @@
+const path = require('path');
+const HtmlBundlerPlugin = require('@test/html-bundler-webpack-plugin');
+
+module.exports = {
+  mode: 'production',
+
+  output: {
+    path: path.join(__dirname, 'dist/'),
+    //publicPath: 'auto', // tested: OK
+    //publicPath: () => '/', // tested: OK
+    publicPath: () => 'http://localhost:8080/', // tested: OK
+  },
+
+  resolve: {
+    alias: {
+      '@images': path.join(__dirname, '../../fixtures/images'),
+      '@scripts': path.join(__dirname, 'src/assets/scripts'),
+      '@styles': path.join(__dirname, 'src/assets/styles'),
+      '@views': path.join(__dirname, 'src/views/pages'),
+    },
+  },
+
+  plugins: [
+    new HtmlBundlerPlugin({
+      entry: {
+        index: './src/views/pages/home/index.html',
+        page1: './src/views/pages/page1.html',
+        'sub/page2': './src/views/pages/sub/page2.html',
+        'sub/page3': './src/views/pages/sub/page3.html',
+        'login/signup/index': './src/views/pages/login/signup/index.eta',
+      },
+      css: {
+        filename: 'assets/css/[name].[contenthash:8].css',
+      },
+      sources: [
+        {
+          tag: 'a',
+          attributes: ['href', 'data-link'],
+        },
+        {
+          tag: 'button',
+          attributes: ['href', 'data-hyperlink'],
+        },
+      ],
+      router: {
+        rewriteIndex: undefined, // invalid values: undefined, null, 0, etc. should be treats as default value
+      },
+    }),
+  ],
+
+  module: {
+    rules: [
+      {
+        test: /\.(css|sass|scss)$/,
+        use: ['css-loader', 'sass-loader'],
+      },
+
+      {
+        test: /\.(png|jpe?g|ico|svg)$/,
+        type: 'asset/resource',
+        generator: {
+          filename: 'assets/img/[name].[hash:8][ext]',
+        },
+      },
+    ],
+  },
+};
diff --git a/test/integration.test.js b/test/integration.test.js
@@ -1,4 +1,4 @@
-import { compareFiles, compareFilesRuns, stdoutContain, watchCompareFiles } from './utils/helpers';
+import { isCI, compareFiles, compareFilesRuns, stdoutContain, watchCompareFiles } from './utils/helpers';
 
 //import { removeDirsSync } from './utils/file';
 // Remove all 'dist/' directories from tests, use it only for some local tests.
@@ -56,10 +56,14 @@ describe('resolve files', () => {
   test('use the same js file in many html', () => compareFiles('resolve-js-diff-tmpl'));
 
   test('assets filenames in relative entry', () => compareFiles('resolve-asset-filenames-in-relative-entry'));
+  test('not resolve in template comment', () => compareFiles('comment-not-resolve'));
 
-  test('js, css with same name', () => compareFiles('resolve-js-css-with-same-name'));
+  console.log();
 
-  test('not resolve in template comment', () => compareFiles('comment-not-resolve'));
+  if (!isCI) {
+    // test only locally, as the result in CI environment may be random
+    test('js, css with same name', () => compareFiles('resolve-js-css-with-same-name'));
+  }
 });
 
 describe('resolve styles', () => {
@@ -281,6 +285,7 @@ describe('plugin option router', () => {
   test('resolve source *.eta file in a.href', () => compareFiles('option-router-resolve-a_href-eta'));
   test('resolve pages in custom attributes', () => compareFiles('option-router-resolve-custom-attrs'));
 
+  test('rewriteIndex = undefined', () => compareFiles('option-router-rewriteIndex-undefined'));
   test('rewriteIndex = "."', () => compareFiles('option-router-rewriteIndex-dot'));
   test('rewriteIndex, publicPath as URL', () => compareFiles('option-router-rewriteIndex-publicPath-url'));
   test('resolve function', () => compareFiles('option-router-resolve-fn'));
@@ -601,5 +606,9 @@ describe('resolve assets in entry', () => {
 
 describe('setup examples', () => {
   test('minimal, one page', () => compareFiles('setup-minimal-one-page'));
-  test('base, multi pages', () => compareFiles('setup-base-multi-pages'));
+
+  if (!isCI) {
+    // test only locally, as the result in CI environment may be random
+    test('base, multi pages', () => compareFiles('setup-base-multi-pages'));
+  }
 });
diff --git a/test/utils/helpers.js b/test/utils/helpers.js

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "html-bundler-webpack-plugin",`
`3`		`- "version": "4.20.1",`
	`3`	`+ "version": "4.20.2",`
`4`	`4`	`"description": "Generates complete single-page or multi-page website from source assets. Built-in support for Markdown, Eta, EJS, Handlebars, Nunjucks, Pug. Alternative to html-webpack-plugin.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"html",`