geomcli 0.5.17 → 0.5.18

package/dist/index.d.ts

@@ -2,6 +2,9 @@ import { tGeomFunc, tParamVal, EFormat, tAllPageDef, tPackage } from 'geometrix'
 
 declare function geom_write(iPartName: string, fgeom: tGeomFunc, simTime: number, iParam: tParamVal, iFormat: EFormat, iFace?: string, iDir?: string, iFname?: string): Promise<string>;
 
+/**
+ * Docs for `geom_cli` function.
+ */
 declare function geom_cli(iArgs: string[], dList: tAllPageDef, appPackage: tPackage, outDir?: string): Promise<void>;
 
 export { geom_cli, geom_write };

package/dist/index.js

@@ -114,7 +114,15 @@ async function geom_write(iPartName, fgeom, simTime, iParam, iFormat, iFace = ""
 }
 
 // src/geom_cli.ts
-import { PType, EFormat as EFormat2, designParam, prefixLog, paramListToVal, version_details } from "geometrix";
+import {
+  PType,
+  EFormat as EFormat2,
+  designParam,
+  prefixLog,
+  paramListToVal,
+  version_details,
+  checkImpPages
+} from "geometrix";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 function print_version_details(appPackage) {
@@ -298,24 +306,53 @@ function decompose_outopt(outopt) {
   const eFormat = { eWrite: rWrite, eFormat: rFormat, eFace: rFace, eSubdesign: rSubD };
   return eFormat;
 }
-function list_designs(dList, detail) {
+async function addDynamicPath(dList, iPath) {
+  const rList = dList;
+  if (iPath !== "") {
+    if (!iPath.endsWith(".js")) {
+      console.log(`err729: ${iPath} has an unexpected file extension`);
+      process.exit(1);
+    }
+    try {
+      console.log(`addDynamicPath: ${iPath}`);
+      const pages = await import(iPath);
+      const [cErr, cMsg] = checkImpPages(pages);
+      console.log(cMsg);
+      if (cErr) {
+        throw "err337: unexpected export type";
+      }
+      const pagK = Object.keys(pages);
+      for (const pagN of pagK) {
+        rList[`import/${pagN}`] = pages[pagN];
+      }
+    } catch (err) {
+      console.log(`err229: Error by importing ${iPath}`);
+      console.log(err);
+      process.exit(1);
+    }
+  }
+  return rList;
+}
+async function list_designs(dList, iPath, detail) {
   let rlog = "List of available designs:\n";
-  for (const [idx, dname] of get_design_array(dList).entries()) {
+  const dList2 = await addDynamicPath(dList, iPath);
+  for (const [idx, dname] of get_design_array(dList2).entries()) {
     rlog += `${(idx + 1).toString().padStart(4, " ")} : ${dname}
 `;
     if (detail) {
-      rlog += `        ${dList[dname].pDef.partName}
+      rlog += `        ${dList2[dname].pDef.partName}
 `;
-      rlog += `        ${dList[dname].pTitle}
+      rlog += `        ${dList2[dname].pTitle}
 `;
-      rlog += `        ${dList[dname].pDescription}
+      rlog += `        ${dList2[dname].pDescription}
 `;
     }
   }
   console.log(rlog);
 }
-function list_parameters(dList, selD, paramPath, modif) {
-  const theD = selectDesign(dList, selD);
+async function list_parameters(dList, iPath, selD, paramPath, modif) {
+  const dList2 = await addDynamicPath(dList, iPath);
+  const theD = selectDesign(dList2, selD);
   let rlog = `List of parameters of the design ${selD} (${theD.pDef.partName}):
 `;
   const dParam = designParam(theD.pDef);
@@ -360,9 +397,10 @@ function list_parameters(dList, selD, paramPath, modif) {
   }
   console.log(rlog);
 }
-function list_figures(dList, selD, paramPath, modif) {
-  const dPartName = selectDesignN(dList, selD);
-  const figN = get_figure_array(dList, selD, paramPath, modif);
+async function list_figures(dList, iPath, selD, paramPath, modif) {
+  const dList2 = await addDynamicPath(dList, iPath);
+  const dPartName = selectDesignN(dList2, selD);
+  const figN = get_figure_array(dList2, selD, paramPath, modif);
   let rlog = `List of figures of the design ${selD} (${dPartName}):
 `;
   for (const [idx, figNi] of figN.entries()) {
@@ -372,9 +410,10 @@ function list_figures(dList, selD, paramPath, modif) {
   }
   console.log(rlog);
 }
-function list_subdesigns(dList, selD, paramPath, modif) {
-  const dPartName = selectDesignN(dList, selD);
-  const subdA = get_subdesign_array(dList, selD, paramPath, modif);
+async function list_subdesigns(dList, iPath, selD, paramPath, modif) {
+  const dList2 = await addDynamicPath(dList, iPath);
+  const dPartName = selectDesignN(dList2, selD);
+  const subdA = get_subdesign_array(dList2, selD, paramPath, modif);
   const subdN = Object.keys(subdA);
   let rlog = `List of sub-designs of the design ${selD} (${dPartName}):
 `;
@@ -390,8 +429,9 @@ function list_subdesigns(dList, selD, paramPath, modif) {
   }
   console.log(rlog);
 }
-function list_subd_parameters(dList, selD, subdN, paramPath, modif) {
-  const subdParam = get_subd(dList, selD, subdN, paramPath, modif, true).dparam;
+async function list_subd_parameters(dList, iPath, selD, subdN, paramPath, modif) {
+  const dList2 = await addDynamicPath(dList, iPath);
+  const subdParam = get_subd(dList2, selD, subdN, paramPath, modif, true).dparam;
   const nameLength = 20;
   const nameLabel = "name".padEnd(nameLength, " ");
   let rlog = `   # : ${nameLabel} value init changed
@@ -407,11 +447,16 @@ function list_subd_parameters(dList, selD, subdN, paramPath, modif) {
   }
   console.log(rlog);
 }
-function list_outopt(dList, selD, paramPath, modif) {
-  const dPartName = selectDesignN(dList, selD);
+async function computeGeom2(dList, iPath, selD, paramPath, modif, printLog) {
+  const dList2 = await addDynamicPath(dList, iPath);
+  return computeGeom(dList2, selD, paramPath, modif, printLog);
+}
+async function list_outopt(dList, iPath, selD, paramPath, modif) {
+  const dList2 = await addDynamicPath(dList, iPath);
+  const dPartName = selectDesignN(dList2, selD);
   let rlog = `List of outputs of the design ${selD} (${dPartName}):
 `;
-  const outOpt = get_outopt_array(dList, selD, paramPath, modif);
+  const outOpt = get_outopt_array(dList2, selD, paramPath, modif);
   for (const [idx, oneOpt] of outOpt.entries()) {
     const idx2 = (idx + 1).toString().padStart(4, " ");
     rlog += `${idx2} : ${oneOpt}
@@ -421,13 +466,18 @@ function list_outopt(dList, selD, paramPath, modif) {
 }
 var cmd_write = false;
 async function geom_cli(iArgs, dList, appPackage, outDir = "output") {
-  const argv = yargs(hideBin(iArgs)).scriptName("geom_cli").version(appPackage.version).usage("Usage: $0 <global-options> command <command-argument>").example([
+  const argv = await yargs(hideBin(iArgs)).scriptName("geom_cli").version(appPackage.version).usage("Usage: $0 <global-options> command <command-argument>").example([
     ["$0 list-designs", "list the available designs"],
     ["$0 list-designs-detailed", "list the available designs with detailed information"],
     ["$0 -d heliostat/rake compute-log", "compute and print the log"],
     ["$0 -d heliostat/swing list-outopt", "list possible output-format-options"],
     ["$0 -d heliostat/rod write zip_all", "write a zip file"]
-  ]).option("design", {
+  ]).option("import", {
+    alias: "i",
+    type: "string",
+    description: "path to a javascript-geometrix-design-library",
+    default: ""
+  }).option("design", {
     alias: "d",
     type: "string",
     description: "design to be used by the command",
@@ -455,59 +505,85 @@ async function geom_cli(iArgs, dList, appPackage, outDir = "output") {
     default: ""
   }).command("versions", "print details about the app version and its dependencies", {}, () => {
     print_version_details(appPackage);
-  }).command(["list-designs", "list"], "list the available designs", {}, () => {
-    list_designs(dList, false);
-  }).command("list-designs-detailed", "list the available designs with details", {}, () => {
-    list_designs(dList, true);
-  }).command("list-parameters", "list the parameters of the selected design", {}, (argv2) => {
-    list_parameters(
-      dList,
-      argv2.design,
-      argv2.param,
-      argv2.modif
-    );
-  }).command("list-figures", "list the figures of the selected design", {}, (argv2) => {
-    list_figures(
-      dList,
-      argv2.design,
-      argv2.param,
-      argv2.modif
-    );
-  }).command("list-subdesigns", "list the subdesigns of the selected design", {}, (argv2) => {
-    list_subdesigns(
+  }).command(["list-designs", "list"], "list the available designs", {}, async (argv2) => {
+    await list_designs(dList, argv2.import, false);
+  }).command(
+    "list-designs-detailed",
+    "list the available designs with details",
+    {},
+    async (argv2) => {
+      await list_designs(dList, argv2.import, true);
+    }
+  ).command(
+    "list-parameters",
+    "list the parameters of the selected design",
+    {},
+    async (argv2) => {
+      await list_parameters(
+        dList,
+        argv2.import,
+        argv2.design,
+        argv2.param,
+        argv2.modif
+      );
+    }
+  ).command("list-figures", "list the figures of the selected design", {}, async (argv2) => {
+    await list_figures(
       dList,
+      argv2.import,
       argv2.design,
       argv2.param,
       argv2.modif
     );
   }).command(
+    "list-subdesigns",
+    "list the subdesigns of the selected design",
+    {},
+    async (argv2) => {
+      await list_subdesigns(
+        dList,
+        argv2.import,
+        argv2.design,
+        argv2.param,
+        argv2.modif
+      );
+    }
+  ).command(
     "list-subd-parameters <subdN>",
     "list the parameters of subdesigns",
     {},
-    (argv2) => {
-      list_subd_parameters(
+    async (argv2) => {
+      await list_subd_parameters(
         dList,
+        argv2.import,
         argv2.design,
         argv2.subdN,
         argv2.param,
         argv2.modif
       );
     }
-  ).command("compute-log", "Compute and print the log without writing file", {}, (argv2) => {
-    computeGeom(
-      dList,
-      argv2.design,
-      argv2.param,
-      argv2.modif,
-      true
-    );
-  }).command(
+  ).command(
+    "compute-log",
+    "Compute and print the log without writing file",
+    {},
+    async (argv2) => {
+      await computeGeom2(
+        dList,
+        argv2.import,
+        argv2.design,
+        argv2.param,
+        argv2.modif,
+        true
+      );
+    }
+  ).command(
     "list-outopt",
     "list the possible output format options of the selected design",
     {},
-    (argv2) => {
-      list_outopt(
+    async (argv2) => {
+      await list_outopt(
         dList,
+        argv2.import,
         argv2.design,
         argv2.param,
         argv2.modif
@@ -515,19 +591,21 @@ async function geom_cli(iArgs, dList, appPackage, outDir = "output") {
     }
   ).command("write <outopt>", "write the output format file", {}, () => {
     cmd_write = true;
-  }).demandCommand(1).help().strict().parseSync();
+  }).demandCommand(1).help().strict().parseAsync();
   if (cmd_write) {
     const iOutDir = argv.outDir;
     if (iOutDir === "") {
       console.log("err638: option 'outDir' is set to empty string. Nothing written!");
       process.exit(1);
     }
+    const iPath = argv.import;
+    const dList2 = await addDynamicPath(dList, iPath);
     const selD = argv.design;
     const outopt = argv.outopt;
     const paramPath = argv.param;
     const paramModif = argv.modif;
-    const theD = selectDesign(dList, selD);
-    const outOpt = get_outopt_array(dList, selD, paramPath, paramModif);
+    const theD = selectDesign(dList2, selD);
+    const outOpt = get_outopt_array(dList2, selD, paramPath, paramModif);
     if (!outOpt.includes(outopt)) {
       console.log(`err639: outopt ${outopt} is not a valid option`);
       process.exit(1);
@@ -543,7 +621,7 @@ async function geom_cli(iArgs, dList, appPackage, outDir = "output") {
       console.log(emsg);
       process.exit(1);
     }
-    computeGeom(dList, selD, paramPath, paramModif, true);
+    computeGeom(dList2, selD, paramPath, paramModif, true);
     try {
       if (oOpt.eWrite === 0 /* eEGOPARAMS */) {
         rlog += writeParams(
@@ -553,7 +631,7 @@ async function geom_cli(iArgs, dList, appPackage, outDir = "output") {
           argv.outFileName
         );
       } else if (oOpt.eWrite === 1 /* eSUBDPARAMS */) {
-        const subD = get_subd(dList, selD, oOpt.eSubdesign, paramPath, paramModif, false);
+        const subD = get_subd(dList2, selD, oOpt.eSubdesign, paramPath, paramModif, false);
         rlog += writeParams(
           subD.partName,
           paramListToVal(subD.dparam),

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "geomcli",
-	"version": "0.5.17",
+	"version": "0.5.18",
 	"description": "the nodejs companion library of geometrix",
 	"private": false,
 	"repository": {
@@ -41,21 +41,21 @@
 		"clean": "shx rm -fr build dist node_modules"
 	},
 	"dependencies": {
-		"geometrix": "^0.5.13",
+		"geometrix": "^0.5.14",
 		"yargs": "^17.7.2"
 	},
 	"devDependencies": {
 		"@types/yargs": "^17.0.32",
-		"@typescript-eslint/eslint-plugin": "^6.19.0",
-		"@typescript-eslint/parser": "^6.19.0",
+		"@typescript-eslint/eslint-plugin": "^6.20.0",
+		"@typescript-eslint/parser": "^6.20.0",
 		"eslint": "^8.56.0",
 		"eslint-config-prettier": "^9.1.0",
 		"npm-run-all": "^4.1.5",
-		"prettier": "^3.2.4",
+		"prettier": "^3.2.5",
 		"shx": "^0.3.4",
 		"tsup": "^8.0.1",
 		"typescript": "^5.3.3",
-		"vitest": "^1.2.1"
+		"vitest": "^1.2.2"
 	},
 	"exports": {
 		".": {