feat: if the router option is specified and not disabled then ensure that a.href is present in the sources

Author: webdiscus

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 4.18.0-beta.2 (2025-02-03)
+
+- feat: if the `router` option is specified and not disabled, 
+  then ensure that `a.href` is present in the `sources` option
+- fix: if router is disabled and sources contains attributes matching a route file, then doesn't resolve it
+
 ## 4.18.0-beta.1 (2025-02-03)
 
 - feat: revert improvement of the `sources[].filter()` function introduced in beta.0, it returns a boolean or void only

package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-bundler-webpack-plugin",
-  "version": "4.18.0-beta.1",
+  "version": "4.18.0-beta.2",
   "description": "Generates complete single-page or multi-page website from source assets. Build-in support for Markdown, Eta, EJS, Handlebars, Nunjucks, Pug. Alternative to html-webpack-plugin.",
   "keywords": [
     "html",

src/Loader/Modes/PreprocessorModeAbstract.js

@@ -84,7 +84,7 @@ class PreprocessorModeAbstract {
    * @param {string} file The required file.
    * @param {string} issuer The issuer of required file.
    * @param {string|number|null} entryId The entry id where is loaded the resource.
-   * @return {{requireExpression: string, resolvedFile: string}}
+   * @return {{requireExpression: string, resolvedFile: string} | false}
    */
   requireFile(file, issuer, entryId) {
     let resolvedFile = '';
@@ -100,8 +100,14 @@ class PreprocessorModeAbstract {
       let isRouteFile = this.loaderOption.isRoute(resolvedFile);
       let isRequestUrl = isUrl(resolvedFile);
 
-      if (isRouteFile && !isRequestUrl) {
-        this.collection.saveInnerRoute(resolvedFile, issuer);
+      if (isRouteFile) {
+        if (!this.loaderOption.isRouterEnabled()) {
+          return false;
+        }
+
+        if (!isRequestUrl) {
+          this.collection.saveInnerRoute(resolvedFile, issuer);
+        }
       }
 
       if (isEntryFile || isRouteFile || isRequestUrl) {

src/Loader/Option.js

@@ -346,6 +346,14 @@ class Option {
     return this.#pluginOption.isRoute(resource);
   }
 
+  /**
+   * Whether the router is force disabled.
+   * @return {boolean}
+   */
+  isRouterEnabled() {
+    return this.#pluginOption.isRouterEnabled();
+  }
+
   /**
    * Whether the file matches a template entry file.
    *

src/Plugin/Collection.js

@@ -991,43 +991,42 @@ class Collection {
         promise = promise.then((value) => this.pluginOption.postprocess(value, templateInfo, compilation) || value);
       }
 
-      // 2.1 postprocess of resolved page URL in a.href
-      const routesPages = this.innerRoute.get(resourcePath);
+      // 2.1 postprocess of resolved page URLs matched to router.test from attributes specified in sources, e.g. a.href
+      const routerPages = this.innerRoute.get(resourcePath);
 
-      if (isRouterEnabled && routesPages) {
+      if (isRouterEnabled && routerPages) {
         promise = promise.then((content) => {
           const sourceFile = resourcePath;
           const outputFile = entryFilename;
 
           // sourceRoute is the resolved value of a tag attribute defined in sources option
-          for (let sourceRoute of routesPages) {
+          for (let sourceRoute of routerPages) {
             const [sourceRoutePath, sourceRouteQuery] = splitUrl(sourceRoute);
             const outputValue = entrySourceFiles.get(sourceRoutePath);
             let outputRoute = this.pluginOption.getOutputFilename(outputValue, outputFile);
+            let outputRouteWithQuery = outputRoute + sourceRouteQuery;
             let wasRouteModified = false;
 
             if (resolveRoute) {
               let result = resolveRoute({
                 sourceRoute,
-                outputRoute: outputRoute + sourceRouteQuery,
+                outputRoute: outputRouteWithQuery,
                 sourceFile,
                 outputFile,
               });
 
-              if (typeof result === 'string' && result !== outputRoute) {
+              if (typeof result === 'string' && result !== outputRouteWithQuery) {
                 outputRoute = result;
                 wasRouteModified = true;
               }
             }
 
             if (!wasRouteModified) {
-              if (!sourceRouteQuery) {
-                if (outputValue.includes('index.html') && routerOptions.rewriteIndex !== false) {
-                  let index = outputRoute === 'index.html' ? routerOptions.rewriteIndex : '';
-                  outputRoute = outputRoute.replace('index.html', index);
-                }
-              } else {
-                outputRoute += sourceRouteQuery;
+              if (sourceRouteQuery) {
+                outputRoute = outputRouteWithQuery;
+              } else if (outputValue.includes('index.html') && routerOptions.rewriteIndex !== false) {
+                let index = outputRoute === 'index.html' ? routerOptions.rewriteIndex : '';
+                outputRoute = outputRoute.replace('index.html', index);
               }
             }
 

src/Plugin/Option.js

@@ -114,22 +114,6 @@ class Option {
     this.options.hotUpdate = this.options.hotUpdate === true;
   }
 
-  /**
-   * @return {boolean}
-   */
-  isRouterEnabled() {
-    return this.router.enabled === true;
-  }
-
-  /**
-   * Get router option for resolving a page URL.
-   *
-   * @return {Object|null}
-   */
-  getRouter() {
-    return this.router;
-  }
-
   /**
    * Get custom page url resolver.
    *
@@ -352,6 +336,10 @@ class Option {
           this.router.rewriteIndex = !this.isAutoPublicPath() && this.getPublicPath() ? '' : rewriteIndex;
         }
       }
+
+      if (this.isRouterEnabled()) {
+        this.addDefaultsRouterOptionsToSources();
+      }
     }
 
     if (this.router.test instanceof RegExp) {
@@ -361,6 +349,34 @@ class Option {
     }
   }
 
+  /**
+   * If router option is defined and is not false, then add default options to sources,
+   * to resolve route in attributes.
+   */
+  addDefaultsRouterOptionsToSources() {
+    if (!Array.isArray(this.options.sources)) {
+      this.options.sources = [];
+    }
+
+    const { sources } = this.options;
+    let tagA = sources.find(({ tag }) => tag === 'a');
+    let hasHref = false;
+
+    if (tagA) {
+      if (Array.isArray(tagA.attributes)) {
+        hasHref = tagA.attributes.some((attr) => attr === 'href');
+      } else {
+        tagA.attributes = [];
+      }
+
+      if (!hasHref) {
+        tagA.attributes.push('href');
+      }
+    } else {
+      sources.push({ tag: 'a', attributes: ['href'] });
+    }
+  }
+
   initWatchMode() {
     const { publicPath } = this.webpackOptions.output;
     if (publicPath == null || publicPath === 'auto') {
@@ -499,6 +515,16 @@ class Option {
     return testRegExpArray(resource, this.router.test);
   }
 
+  /**
+   * Whether the router is force disabled.
+   * Defaults, when sources options matches a template, then it will be resolved.
+   *
+   * @return {boolean}
+   */
+  isRouterEnabled() {
+    return this.router.enabled !== false;
+  }
+
   /**
    * @param {string} resource The resource file, including a query.
    * @return {boolean}
@@ -676,6 +702,15 @@ class Option {
     return this.options.css;
   }
 
+  /**
+   * Get router option for resolving a page URL.
+   *
+   * @return {Object|null}
+   */
+  getRouter() {
+    return this.router;
+  }
+
   /**
    * @return {WatchFiles}
    */

test/cases/option-router-false/expected/assets/css/style.7fc9d183.css

@@ -0,0 +1 @@
+h1{color:green}

test/cases/option-router-false/expected/assets/css/style.fd838354.css

@@ -0,0 +1 @@
+h1{color:red}