refactor: optimize code for next version

Author: webdiscus

src/Plugin/Utils.js src/Common/Utils.jssrc/Plugin/Utils.js renamed to src/Common/Utils.js

@@ -0,0 +1,56 @@
+const vm = require('vm');
+const { transformToCommonJS } = require('./Utils');
+const { executeFunctionException } = require('../Plugin/Messages/Exception');
+
+class VMScript {
+  context = null;
+
+  /**
+   *
+   * @param {Object} context The context object.
+   * @param {string} name The function name compiled in the VM context.
+   */
+  constructor(context, name = '') {
+    this.context = vm.createContext(context);
+    this.name = name;
+  }
+
+  /**
+   * Execute the source code.
+   *
+   * @param {Buffer | string} code The source code.
+   * @param {string} filename The filename is used in stack traces produced by this script.
+   * @param {{}?} data The data passed in the compiled function.
+   * @param {boolean?} esModule  Whether the source code is an ES module.
+   * @return {string}
+   */
+  exec(code, { filename, data = {}, esModule = false }) {
+    if (Buffer.isBuffer(code)) {
+      code = code.toString();
+    }
+
+    // transform the code to CommonJS
+    if (esModule === true) {
+      code = transformToCommonJS(code);
+    }
+
+    try {
+      const script = new vm.Script(code, { filename });
+      let result = script.runInContext(this.context);
+
+      // if the code returns nothing but creates a named definition in the context
+      if (!result && this.name && this.name in this.context) {
+        result = this.context[this.name];
+        //console.log('*** VM EXEC 1: ', { code, result });
+      } else {
+        //console.log('*** VM EXEC 2: ', { code, result });
+      }
+
+      return typeof result === 'function' ? result(data) : result || '';
+    } catch (error) {
+      executeFunctionException(error, filename);
+    }
+  }
+}
+
+module.exports = VMScript;

src/Common/VMScript.js

@@ -35,9 +35,9 @@ class Option {
     const queryData = parseQuery(resourceQuery);
     let options = PluginService.getLoaderCache(loaderId);
 
+    this.fileSystem = loaderContext.fs.fileSystem;
     this.#pluginOption = PluginService.getOptions();
     this.#watch = PluginService.isWatchMode();
-    this.fileSystem = loaderContext.fs.fileSystem;
     this.#webpackOptions = loaderContext._compiler.options || {};
     this.#rootContext = rootContext;
     this.#resourcePath = resourcePath;
@@ -59,6 +59,7 @@ class Option {
 
       PluginService.setLoaderCache(loaderId, options);
     }
+
     this.#options = options;
 
     // if the data option is a string, it must be an absolute or relative filename of an existing file that exports the data

src/Loader/Option.js

@@ -32,6 +32,7 @@ class Preprocessor {
       handlebars: 'Handlebars',
       nunjucks: 'Nunjucks',
       twig: 'Twig',
+      pug: 'Pug',
     };
 
     // disabled preprocessor

src/Loader/Preprocessor.js

@@ -22,7 +22,6 @@ const {
 const loader = function (content, map, meta) {
   /** @type {BundlerPluginLoaderContext} */
   const loaderContext = this;
-
   const loaderCallback = loaderContext.async();
   const { rootContext, resource, resourcePath, entryId } = loaderContext;
   const hooks = PluginService.getHooks();

src/Loader/index.js

@@ -30,7 +30,7 @@ const AssetEntry = require('./AssetEntry');
 const AssetResource = require('./AssetResource');
 const AssetInline = require('./AssetInline');
 const AssetTrash = require('./AssetTrash');
-const VMScript = require('./VMScript');
+const VMScript = require('../Common/VMScript');
 const Integrity = require('./Extras/Integrity');
 
 const { compilationName, verbose } = require('./Messages/Info');
@@ -788,10 +788,8 @@ class AssetCompiler {
 
     const entry = AssetEntry.getByChunk(chunk);
 
-    if (!entry) return;
-
     // process only entries supported by this plugin
-    if (!entry.isTemplate && !entry.isStyle) return;
+    if (!entry || (!entry.isTemplate && !entry.isStyle)) return;
 
     Collection.addEntry(entry);
 
@@ -1198,7 +1196,7 @@ class AssetCompiler {
    * Render the module source code generated by a loader.
    *
    * @param {string} type The type of module, one of the values: template, style.
-   * @param {Object} source The Webpack source.
+   * @param {RawSource} source The Webpack source.
    * @param {string} resource The full path of source file, including a query.
    * @param {string} sourceFile The full path of source file w/o a query.
    * @param {string} assetFile
@@ -1223,7 +1221,7 @@ class AssetCompiler {
     // the css-loader defaults generate ESM code, which must be transformed into CommonJS to compile the code
     // the template loader generates CommonJS code, no need to transform
     const esModule = type === 'style';
-    let result = vmScript.compile(source, sourceFile, esModule);
+    let result = vmScript.exec(source.source(), { filename: sourceFile, esModule });
 
     if (type === 'style') {
       result = CssExtractModule.apply(result);

src/Plugin/AssetCompiler.js

@@ -114,7 +114,7 @@ class PluginService {
   /**
    * Returns plugin options instance.
    *
-   * TODO: rename to getOptionInstance()
+   * TODO: rename to getPluginOptionInstance()
    *
    * @return {OptionPluginInterface}
    */