fix: catching of the error when a peer dependency for a Pug filter is not installed

Author: webdiscus

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 3.6.4 (2024-03-17)
+
+- fix: catching of the error when a peer dependency for a Pug filter is not installed
+
 ## 3.6.3 (2024-03-14)
 
 - fix: resolving asset files on windows

README.md

@@ -3591,22 +3591,29 @@ For all available options, see the [Nunjucks API configure](https://mozilla.gith
 
     // available useful embedded filters
     embedFilters: {
-      // enable the :escape filter
+      // enable the `:escape` filter
       escape: true,
       
-      // enable the :code filter
+      // enable the `:code` filter
       code: {
         className: 'language-', // class name of `<code>` tag
       },
       
-      // enable :highlight filter
+      // enable `:highlight` filter
       highlight: {
+        use: 'prismjs', // use the `prismjs` module as highlighter, must be installed
         verbose: true,
-        use: 'prismjs', // use the prismjs as highlighter
       },
       
-      // enable :markdown filter
+      // enable `:markdown` filter for markdown only, w/o code blocks
       markdown: true,
+      // - OR - you can enable highlighter for code blocks used in markdown
+      markdown: {
+        highlight: {
+          use: 'prismjs', // use the `prismjs` module as highlighter, must be installed
+          verbose: true,
+        },
+      },
     }
   },
 },

package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-bundler-webpack-plugin",
-  "version": "3.6.3",
+  "version": "3.6.4",
   "description": "HTML bundler plugin for webpack handles a template as an entry point, extracts CSS and JS from their sources referenced in HTML, supports template engines like Eta, EJS, Handlebars, Nunjucks.",
   "keywords": [
     "html",

src/Loader/Preprocessors/Pug/Filter.js

@@ -33,26 +33,7 @@ class Filter {
         try {
           filter = require(filterPath);
         } catch (error) {
-          const message = error.toString();
-          const posEOL = message.indexOf('\n');
-          const messageFirstLine = message.slice(0, posEOL);
-
-          if (messageFirstLine.indexOf('Cannot find module') >= 0) {
-            if (messageFirstLine.indexOf(filterPath) > 0) {
-              const entries = fs.readdirSync(filtersPath, { withFileTypes: true });
-              const files = entries
-                .filter((file) => !file.isDirectory())
-                .map((file) => path.basename(file.name, '.js'));
-
-              filterNotFoundException(filterName, files.join(', '));
-            } else {
-              const [, module] = /Cannot find module '(.*?)' from/.exec(messageFirstLine);
-
-              loadNodeModuleException(module);
-            }
-          }
-
-          filterLoadException(filterName, filterPath, error);
+          this.loadModuleException({ filterName, filterPath, error });
         }
 
         try {
@@ -67,6 +48,34 @@ class Filter {
       }
     }
   }
+
+  /**
+   * @param {string} filterName
+   * @param {string} filterPath
+   * @param {Error} error
+   */
+  static loadModuleException({ filterName, filterPath, error }) {
+    const message = error.toString();
+    const posEOL = message.indexOf('\n');
+    const messageFirstLine = message.slice(0, posEOL);
+
+    if (messageFirstLine.indexOf('Cannot find module') >= 0) {
+      if (messageFirstLine.indexOf(filterPath) > 0) {
+        const entries = fs.readdirSync(filtersPath, { withFileTypes: true });
+        const files = entries.filter((file) => !file.isDirectory()).map((file) => path.basename(file.name, '.js'));
+
+        filterNotFoundException(filterName, files.join(', '));
+      } else {
+        const [, module] = /Cannot find module '(.*?)'/.exec(messageFirstLine) || [];
+
+        if (module) {
+          loadNodeModuleException(module);
+        }
+      }
+    }
+
+    filterLoadException(filterName, filterPath, error);
+  }
 }
 
 module.exports = Filter;

test/integration-pug.test.js

@@ -3,6 +3,8 @@ import { filterLoadException } from '../src/Loader/Preprocessors/Pug/Exeptions';
 import adapterHighlight from '../src/Loader/Preprocessors/Pug/filters/highlight/adapter';
 import filterHighlight from '../src/Loader/Preprocessors/Pug/filters/highlight';
 
+import FugFilter from '../src/Loader/Preprocessors/Pug/Filter';
+
 // TODO: add in docs
 // BRAKING CHANGE (to compare with pug-loader)
 // The inlined loader in URL is no longer supported because it is an ugly/terrible usage syntax:
@@ -139,6 +141,32 @@ describe('exception tests', () => {
     done();
   });
 
+  test('exception 1: by load peer dependency for a filter', (done) => {
+    const expected = /The required (.+?) module not found/;
+
+    const result = () => {
+      FugFilter.loadModuleException({
+        error: new Error(`Cannot find module 'parse5'\n`),
+        filterName: 'highlight',
+      });
+    };
+    expect(result).toThrow(expected);
+    done();
+  });
+
+  test('exception 2: by load peer dependency for a filter', (done) => {
+    const expected = /Error by load the (.+?) filter/;
+
+    const result = () => {
+      FugFilter.loadModuleException({
+        error: new Error(`Other exception`),
+        filterName: 'highlight',
+      });
+    };
+    expect(result).toThrow(expected);
+    done();
+  });
+
   test('exception: filter :highlight - unsupported module', () => {
     const filterHighlight = require('../src/Loader/Preprocessors/Pug/filters/highlight');
     const adapterHighlight = require('../src/Loader/Preprocessors/Pug/filters/highlight/adapter');