add docs comments for build.js

build.js

@@ -5,6 +5,8 @@ import SPB from "stash-plugin-builder";
 import { execSync } from "child_process";
 import "dotenv/config";
 
+////////////////////////////// INIT //////////////////////////////
+
 import config from "./build-config.json" assert { type: "json" };
 
 const argv = parseArgs(process.argv.slice(2));
@@ -20,35 +22,43 @@ config.mode.build = getArgv("build");
 config.mode.dist = getArgv("dist");
 
 if (config.mode.build) {
+  // set out path to stash plugins folder
   config.outDir = path.join(
     process.env.STASH_PLUGIN_DIR,
     config.stashPluginSubDir ?? ""
   );
 }
 
+////////////////////////////// FUNCTIONS //////////////////////////////
+
+// functions related to file system
 class GlobModules {
+  // gets all yml files inside a folder
   getYmlFiles(dirPath) {
     return fs
       .readdirSync(dirPath)
       .filter((file) => path.extname(file) === ".yml")
       .map((file) => path.join(dirPath, file));
   }
 
+  // return the plugin yml path
   getPluginYmlPath(_path) {
     const ymls = Glob.getYmlFiles(_path);
     return ymls.length > 1
       ? (() => {
           const id = path.basename(_path);
           const yml = path.join(_path, `${id}.yml`);
+          // check if there is a yml with the folder's name
           if (SPB.Glob.fsExsists(yml)) {
             return yml;
           } else {
             return ymls[0];
           }
         })()
-      : ymls[0];
+      : ymls[0]; // if only 1 yml file is present then return its path
   }
 
+  // get all 1 level down child dirs
   getChildDirs(source, relativePath = false) {
     return fs
       .readdirSync(source, { withFileTypes: true })
@@ -63,6 +73,7 @@ class GlobModules {
   }
 }
 
+// utility functions
 class UtilsModules {
   getAllPluginFolders(paths) {
     const pluginPaths = {
@@ -73,6 +84,7 @@ class UtilsModules {
     for (let _path of paths) {
       let isParentDir = false;
 
+      // check if the plugin path is a parent folder
       if (_path.endsWith("/*")) {
         _path = _path.slice(0, -2);
         isParentDir = true;
@@ -97,6 +109,7 @@ class UtilsModules {
           ? SPB.Glob.getYml(path.join(_path, "settings.yml"))?.id
           : false;
 
+        // separate normal and spb plugins by checking if folder has settings.yml
         if (settingsYmlId) {
           pluginPaths.stashPluginBuilderPluginPaths.push({
             pluginPath: _path,
@@ -114,6 +127,7 @@ class UtilsModules {
     return pluginPaths;
   }
 
+  // zips the plugin folder and writes its details to index.yml folder
   packPlugin(pluginPath, pluginDistPath) {
     if (path.resolve(config.outDir) === path.resolve(pluginDistPath)) {
       pluginDistPath = Glob.getChildDirs(pluginDistPath, true)?.[0];
@@ -123,10 +137,11 @@ class UtilsModules {
 
     if (ymls.length) {
       const pluginYmlPath = Glob.getPluginYmlPath(pluginDistPath);
-      const pluginYmlData = SPB.Glob.getYml(pluginYmlPath);
-      const pluginRawYml = SPB.Glob.getFileContents(pluginYmlPath);
-      const indexYmlChunk = {};
+      const pluginYmlData = SPB.Glob.getYml(pluginYmlPath); // read yml data
+      const pluginRawYml = SPB.Glob.getFileContents(pluginYmlPath); // get yml raw data
+      const indexYmlChunk = {}; // index.yml data for this plugin
 
+      // set plugin yml file's basename as plugin id
       indexYmlChunk.id = path.basename(
         pluginYmlPath,
         path.extname(pluginYmlPath)
@@ -139,31 +154,38 @@ class UtilsModules {
         indexYmlChunk.metadata.description = pluginYmlData.description;
       }
 
+      // get version from raw data and cobine it with git latest commit sha hash
       indexYmlChunk.version = `${pluginRawYml.match(/^version:\s*(['"]?)([0-9]+(?:\.[0-9]+)*)\1/m)?.[2]?.trim() ?? ""}-${Shell.run(`git log -n 1 --pretty=format:%h -- "${pluginPath}"/*`)}`;
 
+      // get latest modified date
       indexYmlChunk.date = Shell.run(
         `TZ=UTC0 git log -n 1 --date="format-local:%F %T" --pretty=format:%ad -- "${pluginPath}"/*`
       );
 
       indexYmlChunk.path = `${indexYmlChunk.id}.zip`;
 
+      // zip the plugin dist folder
       Shell.run(
         `cd ${pluginDistPath} && zip -r ../${indexYmlChunk.id}.zip . && cd .. && rm -r ${path.basename(pluginDistPath)}`
       );
 
+      // get sha256 hash
       indexYmlChunk.sha256 = Shell.run(
         `sha256sum "${path.join(config.outDir, indexYmlChunk.path)}" | cut -d' ' -f1`
       );
 
+      // handle dependencies
       if (pluginYmlData.ui?.requires?.length)
         indexYmlChunk.requires = pluginYmlData.ui.requires;
 
       return indexYmlChunk;
     } else {
+      // if no yml file is found then its prob not a plugin folder so delete it from out path
       SPB.Glob.delete(pluginDistPath);
     }
   }
 
+  // copied external files like README.md, LICENSE, etc...
   copyExternalFiles(paths, dest) {
     paths.forEach((_path) => {
       let isCopyContents = false;
@@ -178,6 +200,7 @@ class UtilsModules {
   }
 }
 
+// function related to child process
 class ShellModules {
   run(command) {
     const stdout = execSync(command);
@@ -194,6 +217,7 @@ const Shell = new ShellModules();
 const allPluginFolders = Utils.getAllPluginFolders(config.plugins ?? ["./"]);
 const indexYml = [];
 
+// filter files and folder by excluding all exclude folders and files
 if (config.excludePluginFolders?.length) {
   allPluginFolders.normalPluginPaths =
     allPluginFolders.normalPluginPaths.filter(
@@ -207,21 +231,26 @@ if (config.excludePluginFolders?.length) {
     );
 }
 
+// copy normal plugins
 allPluginFolders.normalPluginPaths.forEach(({ pluginPath, pluginDistPath }) => {
   SPB.Glob.copy(pluginPath, config.outDir);
 
   console.log(path.basename(pluginPath), "built ✅");
 
+  // if its windows don't pack the plugin
   if (!isWin && config.mode.dist)
     indexYml.push(Utils.packPlugin(pluginPath, pluginDistPath)); // works only on linux
 });
+// build SPB plugins
 allPluginFolders.stashPluginBuilderPluginPaths.forEach(
   ({ pluginPath, pluginDistPath }) => {
     console.log(
       Shell.run(
         `npx stash-plugin-builder --in=${pluginPath} --out=${config.outDir}${config.mode.dist ? " --minify" : ""}`
       )
     );
+
+    // if its windows don't pack the plugin
     if (!isWin && config.mode.dist)
       indexYml.push(Utils.packPlugin(pluginPath, pluginDistPath)); // works only on linux
   }
@@ -230,6 +259,7 @@ allPluginFolders.stashPluginBuilderPluginPaths.forEach(
 if (indexYml.length && !isWin && config.mode.dist)
   SPB.Glob.writeYml(path.join(config.outDir, "index.yml"), indexYml);
 
+// copy all external files
 if (config.include?.length && config.mode.dist) {
   Utils.copyExternalFiles(
     config.include,