Merge pull request #6 from arpitchakladar/adding-documentation-comments

Adding documentation comments

3 files changed, 35 insertions, 2 deletions

diff --git a/config/webpack/loader/arrange-shared-module-loader.js b/config/webpack/loader/arrange-shared-module-loader.js
index 2265185..63fd62d 100644
--- a/config/webpack/loader/arrange-shared-module-loader.js
+++ b/config/webpack/loader/arrange-shared-module-loader.js
@@ -1,8 +1,18 @@
 import path from "path";
+
 import { ImportManager } from "import-manager";
 
 import sharedModules from "../utils/shared-modules.js";
 
+/**
+ * Webpack loader that arranges shared modules in dependency order.
+ * As each shared module is processed, its own shared-module dependencies
+ * are inserted before it in the global `sortedSharedModules` array so that
+ * the final output respects the import graph.
+ *
+ * @param {string} source - The source code of the current module.
+ * @returns {string} The unmodified source (this loader is side-effect only).
+ */
 export default function(source) {
 	const currentSharedModuleName = path.basename(this.resourcePath.substring(0, this.resourcePath.length - 3));
 
@@ -17,7 +27,11 @@ export default function(source) {
 			if (moduleIndex >= 0) {
 				const currentSharedModuleName = sharedModules[moduleIndex];
 
-				if (!(sortedSharedModules.includes(currentSharedModuleName) || modulesToBeIncluded.includes(currentSharedModuleName))) {
+				const alreadyIncluded = (
+					sortedSharedModules.includes(currentSharedModuleName)
+					|| modulesToBeIncluded.includes(currentSharedModuleName));
+
+				if (!alreadyIncluded) {
 					modulesToBeIncluded.push(currentSharedModuleName);
 				}
 			}
diff --git a/config/webpack/loader/count-imports-loader.js b/config/webpack/loader/count-imports-loader.js
index 2586332..ef832bf 100644
--- a/config/webpack/loader/count-imports-loader.js
+++ b/config/webpack/loader/count-imports-loader.js
@@ -1,6 +1,15 @@
 import { ImportManager } from "import-manager";
+
 import sharedModules from "../utils/shared-modules.js";
 
+/**
+ * Webpack loader that counts how many times each shared module is imported.
+ * This count is used later to determine which shared modules need to be
+ * included in the compiled output.
+ *
+ * @param {string} source - The source code of the current module.
+ * @returns {string} The unmodified source (this loader is side-effect only).
+ */
 export default function(source) {
 	const { sharedModulesImportedCount } = this.getOptions();
 	const manager = new ImportManager(source);
diff --git a/config/webpack/loader/to-string-loader.js b/config/webpack/loader/to-string-loader.js
index 248574a..025ea5e 100644
--- a/config/webpack/loader/to-string-loader.js
+++ b/config/webpack/loader/to-string-loader.js
@@ -1,7 +1,17 @@
+/**
+ * Webpack loader that converts HTML template files into JavaScript modules.
+ * It escapes template literals and replaces `$name$` placeholders with
+ * `${name}` interpolation syntax so the exported function can accept a
+ * replacements object.
+ *
+ * @param {string} source - Raw HTML file content.
+ * @returns {string} A JS module that exports a function accepting
+ *   replacement values and returning the interpolated HTML string.
+ */
 export default function(source) {
 	source = source
 		.replaceAll("\\", "\\\\")
-		.replaceAll("`","\\`")
+		.replaceAll("`", "\\`")
 		.replaceAll("${", "\\${");
 
 	const replacements = {};