@depup/webpack 5.106.1-depup.0 → 5.109.2-depup.0

package/lib/NodeStuffPlugin.js

@@ -10,13 +10,13 @@ const {
 	JAVASCRIPT_MODULE_TYPE_DYNAMIC,
 	JAVASCRIPT_MODULE_TYPE_ESM
 } = require("./ModuleTypeConstants");
-const NodeStuffInWebError = require("./NodeStuffInWebError");
 const RuntimeGlobals = require("./RuntimeGlobals");
 const CachedConstDependency = require("./dependencies/CachedConstDependency");
 const ConstDependency = require("./dependencies/ConstDependency");
 const ExternalModuleDependency = require("./dependencies/ExternalModuleDependency");
 const ExternalModuleInitFragmentDependency = require("./dependencies/ExternalModuleInitFragmentDependency");
 const ImportMetaPlugin = require("./dependencies/ImportMetaPlugin");
+const NodeStuffInWebError = require("./errors/NodeStuffInWebError");
 const { evaluateToString } = require("./javascript/JavascriptParserHelpers");
 const { relative } = require("./util/fs");
 const { parseResource } = require("./util/identifier");
@@ -34,16 +34,21 @@ const { parseResource } = require("./util/identifier");
 const PLUGIN_NAME = "NodeStuffPlugin";
 const URL_MODULE_CONSTANT_FUNCTION_NAME = "__webpack_fileURLToPath__";
 
+const { IMPORT_META_DIRNAME, IMPORT_META_FILENAME, isImportMetaFieldEnabled } =
+	ImportMetaPlugin;
+
 class NodeStuffPlugin {
 	/**
+	 * Creates an instance of NodeStuffPlugin.
 	 * @param {NodeOptions} options options
 	 */
 	constructor(options) {
+		/** @type {NodeOptions} */
 		this.options = options;
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -63,12 +68,14 @@ class NodeStuffPlugin {
 				);
 
 				/**
+				 * Processes the provided parser.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {NodeOptions} nodeOptions options
 				 * @returns {void}
 				 */
 				const globalHandler = (parser, nodeOptions) => {
 					/**
+					 * Returns const dependency.
 					 * @param {Expression} expr expression
 					 * @returns {ConstDependency} const dependency
 					 */
@@ -91,7 +98,7 @@ class NodeStuffPlugin {
 
 					parser.hooks.expression.for("global").tap(PLUGIN_NAME, (expr) => {
 						const dep = getGlobalDep(expr);
-						dep.loc = /** @type {DependencyLocation} */ (expr.loc);
+						dep.loc = parser.getLocation(expr);
 						parser.state.module.addPresentationalDependency(dep);
 
 						if (withWarning) {
@@ -107,7 +114,7 @@ class NodeStuffPlugin {
 
 					parser.hooks.rename.for("global").tap(PLUGIN_NAME, (expr) => {
 						const dep = getGlobalDep(expr);
-						dep.loc = /** @type {DependencyLocation} */ (expr.loc);
+						dep.loc = parser.getLocation(expr);
 						parser.state.module.addPresentationalDependency(dep);
 						return false;
 					});
@@ -116,6 +123,7 @@ class NodeStuffPlugin {
 				const hooks = ImportMetaPlugin.getCompilationHooks(compilation);
 
 				/**
+				 * Sets module constant.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {"__filename" | "__dirname" | "import.meta.filename" | "import.meta.dirname"} expressionName expression name
 				 * @param {(module: NormalModule) => string} fn function
@@ -131,14 +139,14 @@ class NodeStuffPlugin {
 								/** @type {Range} */
 								(expr.range)
 							);
-							dep.loc = /** @type {DependencyLocation} */ (expr.loc);
+							dep.loc = parser.getLocation(expr);
 							parser.state.module.addPresentationalDependency(dep);
 							return true;
 						});
 
 					if (
-						expressionName === "import.meta.filename" ||
-						expressionName === "import.meta.dirname"
+						expressionName === IMPORT_META_FILENAME ||
+						expressionName === IMPORT_META_DIRNAME
 					) {
 						hooks.propertyInDestructuring.tap(PLUGIN_NAME, (usingProperty) => {
 							if (usingProperty.id === property) {
@@ -149,6 +157,7 @@ class NodeStuffPlugin {
 				};
 
 				/**
+				 * Sets cached module constant.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {"__filename" | "__dirname" | "import.meta.filename" | "import.meta.dirname"} expressionName expression name
 				 * @param {(module: NormalModule) => string} fn function
@@ -172,7 +181,7 @@ class NodeStuffPlugin {
 								(expr.range),
 								`__webpack_${property}__`
 							);
-							dep.loc = /** @type {DependencyLocation} */ (expr.loc);
+							dep.loc = parser.getLocation(expr);
 							parser.state.module.addPresentationalDependency(dep);
 
 							if (warning) {
@@ -185,28 +194,31 @@ class NodeStuffPlugin {
 						});
 
 					if (
-						expressionName === "import.meta.filename" ||
-						expressionName === "import.meta.dirname"
+						expressionName === IMPORT_META_FILENAME ||
+						expressionName === IMPORT_META_DIRNAME
 					) {
 						hooks.propertyInDestructuring.tap(PLUGIN_NAME, (usingProperty) => {
 							if (property === usingProperty.id) {
 								if (warning) {
 									parser.state.module.addWarning(
 										new NodeStuffInWebError(
-											usingProperty.loc,
+											parser.getLocation(usingProperty),
 											expressionName,
 											warning
 										)
 									);
 								}
 
-								return `${property}: ${JSON.stringify(fn(parser.state.module))},`;
+								return `${property}: ${JSON.stringify(
+									fn(parser.state.module)
+								)},`;
 							}
 						});
 					}
 				};
 
 				/**
+				 * Updates constant using the provided parser.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {"__filename" | "__dirname" | "import.meta.filename" | "import.meta.dirname"} expressionName expression name
 				 * @param {string} value value
@@ -230,6 +242,7 @@ class NodeStuffPlugin {
 					);
 
 				/**
+				 * Sets url module constant.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {"__filename" | "__dirname" | "import.meta.filename" | "import.meta.dirname"} expressionName expression name
 				 * @param {"dirname" | "filename"} property property
@@ -266,7 +279,7 @@ class NodeStuffPlugin {
 									CachedConstDependency.PLACE_CHUNK
 								);
 
-								dep.loc = /** @type {DependencyLocation} */ (expr.loc);
+								dep.loc = parser.getLocation(expr);
 								parser.state.module.addPresentationalDependency(dep);
 								return;
 							}
@@ -285,15 +298,15 @@ class NodeStuffPlugin {
 								`__webpack_${property}__`,
 								ExternalModuleDependency.PLACE_CHUNK
 							);
-							dep.loc = /** @type {DependencyLocation} */ (expr.loc);
+							dep.loc = parser.getLocation(expr);
 							parser.state.module.addPresentationalDependency(dep);
 
 							return true;
 						});
 
 					if (
-						expressionName === "import.meta.filename" ||
-						expressionName === "import.meta.dirname"
+						expressionName === IMPORT_META_FILENAME ||
+						expressionName === IMPORT_META_DIRNAME
 					) {
 						hooks.propertyInDestructuring.tap(PLUGIN_NAME, (usingProperty) => {
 							if (property === usingProperty.id) {
@@ -312,9 +325,7 @@ class NodeStuffPlugin {
 										`__webpack_${property}__`,
 										CachedConstDependency.PLACE_CHUNK
 									);
-									dep.loc = /** @type {DependencyLocation} */ (
-										usingProperty.loc
-									);
+									dep.loc = parser.getLocation(usingProperty);
 									parser.state.module.addPresentationalDependency(dep);
 									return `${property}: __webpack_${property}__,`;
 								}
@@ -334,7 +345,7 @@ class NodeStuffPlugin {
 									ExternalModuleDependency.PLACE_CHUNK
 								);
 
-								dep.loc = /** @type {DependencyLocation} */ (usingProperty.loc);
+								dep.loc = parser.getLocation(usingProperty);
 								parser.state.module.addPresentationalDependency(dep);
 
 								return `${property}: __webpack_${property}__,`;
@@ -344,25 +355,27 @@ class NodeStuffPlugin {
 				};
 
 				/**
+				 * Dirname and filename handler.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {NodeOptions} nodeOptions options
-				 * @param {{ dirname: "__dirname" | "import.meta.dirname", filename: "__filename" | "import.meta.filename" }} identifiers options
+				 * @param {{ dirname: "__dirname" | "import.meta.dirname", filename: "__filename" | "import.meta.filename", dirnameEnabled?: boolean, filenameEnabled?: boolean }} identifiers options
 				 * @returns {void}
 				 */
 				const dirnameAndFilenameHandler = (
 					parser,
 					nodeOptions,
-					{ dirname, filename }
+					{ dirname, filename, dirnameEnabled = true, filenameEnabled = true }
 				) => {
-					// Keep `import.meta.filename` in code
+					// Keep `import.meta.filename` in code.
 					if (
+						filenameEnabled &&
 						nodeOptions.__filename === false &&
-						filename === "import.meta.filename"
+						filename === IMPORT_META_FILENAME
 					) {
 						setModuleConstant(parser, filename, () => filename, "filename");
 					}
 
-					if (nodeOptions.__filename) {
+					if (filenameEnabled && nodeOptions.__filename) {
 						switch (nodeOptions.__filename) {
 							case "mock":
 								setConstant(parser, filename, "/index.js", "filename");
@@ -400,7 +413,7 @@ class NodeStuffPlugin {
 									);
 								}
 								// Replace `import.meta.filename` with `__filename` for the non-ES module output
-								else if (filename === "import.meta.filename") {
+								else if (filename === IMPORT_META_FILENAME) {
 									setModuleConstant(
 										parser,
 										filename,
@@ -433,15 +446,16 @@ class NodeStuffPlugin {
 							});
 					}
 
-					// Keep `import.meta.dirname` in code
+					// Keep `import.meta.dirname` in code.
 					if (
+						dirnameEnabled &&
 						nodeOptions.__dirname === false &&
-						dirname === "import.meta.dirname"
+						dirname === IMPORT_META_DIRNAME
 					) {
 						setModuleConstant(parser, dirname, () => dirname, "dirname");
 					}
 
-					if (nodeOptions.__dirname) {
+					if (dirnameEnabled && nodeOptions.__dirname) {
 						switch (nodeOptions.__dirname) {
 							case "mock":
 								setConstant(parser, dirname, "/", "dirname");
@@ -479,7 +493,7 @@ class NodeStuffPlugin {
 									);
 								}
 								// Replace `import.meta.dirname` with `__dirname` for the non-ES module output
-								else if (dirname === "import.meta.dirname") {
+								else if (dirname === IMPORT_META_DIRNAME) {
 									setModuleConstant(
 										parser,
 										dirname,
@@ -516,6 +530,7 @@ class NodeStuffPlugin {
 				};
 
 				/**
+				 * Handles the hook callback for this code path.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {JavascriptParserOptions} parserOptions the javascript parser options
 				 * @param {boolean} a true when we need to handle `__filename` and `__dirname`, otherwise false
@@ -523,19 +538,24 @@ class NodeStuffPlugin {
 				 */
 				const handler = (parser, parserOptions, a, b) => {
 					if (b && parserOptions.node === false) {
-						// Keep `import.meta.dirname` and `import.meta.filename` in code
-						setModuleConstant(
-							parser,
-							"import.meta.dirname",
-							() => "import.meta.dirname",
-							"dirname"
-						);
-						setModuleConstant(
-							parser,
-							"import.meta.filename",
-							() => "import.meta.filename",
-							"filename"
-						);
+						if (isImportMetaFieldEnabled(parserOptions.importMeta, "dirname")) {
+							setModuleConstant(
+								parser,
+								IMPORT_META_DIRNAME,
+								() => IMPORT_META_DIRNAME,
+								"dirname"
+							);
+						}
+						if (
+							isImportMetaFieldEnabled(parserOptions.importMeta, "filename")
+						) {
+							setModuleConstant(
+								parser,
+								IMPORT_META_FILENAME,
+								() => IMPORT_META_FILENAME,
+								"filename"
+							);
+						}
 						return;
 					}
 
@@ -556,10 +576,22 @@ class NodeStuffPlugin {
 						});
 					}
 
-					if (b && parserOptions.importMeta !== false) {
+					if (
+						b &&
+						(isImportMetaFieldEnabled(parserOptions.importMeta, "dirname") ||
+							isImportMetaFieldEnabled(parserOptions.importMeta, "filename"))
+					) {
 						dirnameAndFilenameHandler(parser, localOptions, {
-							dirname: "import.meta.dirname",
-							filename: "import.meta.filename"
+							dirname: IMPORT_META_DIRNAME,
+							filename: IMPORT_META_FILENAME,
+							dirnameEnabled: isImportMetaFieldEnabled(
+								parserOptions.importMeta,
+								"dirname"
+							),
+							filenameEnabled: isImportMetaFieldEnabled(
+								parserOptions.importMeta,
+								"filename"
+							)
 						});
 					}
 				};