@intelligentgraphics/ig.gfx.packager 2.2.0 → 2.3.1

package/build/index.js

@@ -2432,7 +2432,7 @@ const getLastTag = async (packageName, packageFolder) => {
   try {
     const {
       stdout: releasedTagString
-    } = await execa.sync(`git describe --tags --abbrev=0 --match *${packageName}*`, {
+    } = await execa.sync(`git describe --tags --abbrev=0 --match "*${packageName}*"`, {
       cwd: rootGitDir,
       shell: true
     });
@@ -3580,6 +3580,270 @@ const buildSortedPackageMap = folders => {
 
 /***/ }),
 
+/***/ "./src/commands/generate.ts":
+/*!**********************************!*\
+  !*** ./src/commands/generate.ts ***!
+  \**********************************/
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+
+Object.defineProperty(exports, "__esModule", ({
+  value: true
+}));
+exports.extract = extract;
+
+var fs = _interopRequireWildcard(__webpack_require__(/*! fs-extra */ "fs-extra"));
+
+var _path = _interopRequireDefault(__webpack_require__(/*! path */ "path"));
+
+var ts = _interopRequireWildcard(__webpack_require__(/*! typescript */ "typescript"));
+
+var _tsc = __webpack_require__(/*! ../tsc */ "./src/tsc.ts");
+
+var _os = _interopRequireDefault(__webpack_require__(/*! os */ "os"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function findTsNode(node, callback) {
+  let result;
+  ts.forEachChild(node, child => {
+    if (callback(child)) {
+      result = child;
+      return true;
+    }
+  });
+  return result;
+}
+
+function getParamsFromJsDoc(text) {
+  let lines = text.split(_os.default.EOL);
+  let splitLines = lines.map(line => line.split(":").map(s => s.trim()));
+  let params = {};
+  splitLines.filter(line => line.length > 1).forEach(line => {
+    params[line[0]] = line[1];
+  });
+  return params;
+}
+
+function getDescFromJsDoc(text) {
+  let lines = text.split(_os.default.EOL);
+  let splitLines = lines.map(line => line.split(":").map(s => s.trim()));
+  let desc = "";
+  splitLines.filter(line => line.length == 1).forEach((line, i) => {
+    desc += (i == 0 ? "" : " ") + line[0];
+  });
+  return desc.substring(0, 98);
+}
+
+function capitalizeFirstLetter(string) {
+  return (string === null || string === void 0 ? void 0 : string.charAt(0).toUpperCase()) + (string === null || string === void 0 ? void 0 : string.slice(1));
+}
+
+function parseDefault(value, type) {
+  const uType = capitalizeFirstLetter(type);
+  if (value === "null") return null;
+
+  switch (uType) {
+    case "LengthM":
+    case "ArcDEG":
+    case "Float":
+      return parseFloat(value);
+
+    case "Integer":
+    case "Int":
+      return parseInt(value);
+
+    case "Boolean":
+    case "Bool":
+      return value === "true";
+
+    case "Material":
+    case "String":
+    default:
+      return value.replace(/^"/, '').replace(/"$/, '');
+  }
+}
+
+function findEvaluatorNode(node) {
+  if (ts.isModuleDeclaration(node) && node.body && ts.isModuleDeclaration(node.body) && node.body.body) {
+    const classDeclaration = findTsNode(node.body.body, child => {
+      var _child$heritageClause;
+
+      if (!ts.isClassDeclaration(child)) {
+        return false;
+      }
+
+      const isEvaluator = (_child$heritageClause = child.heritageClauses) === null || _child$heritageClause === void 0 ? void 0 : _child$heritageClause.some(clause => {
+        if (clause.token !== ts.SyntaxKind.ExtendsKeyword) {
+          return false;
+        }
+
+        return clause.types.some(type => type.getText().includes("Evaluator"));
+      });
+      return isEvaluator !== null && isEvaluator !== void 0 ? isEvaluator : false;
+    });
+    return classDeclaration;
+  }
+}
+
+function getParameter(evaluatorNode) {
+  var _evaluatorNode$member;
+
+  let memb = (_evaluatorNode$member = evaluatorNode.members) === null || _evaluatorNode$member === void 0 ? void 0 : _evaluatorNode$member.find(member => {
+    var _member$name;
+
+    return (member === null || member === void 0 ? void 0 : (_member$name = member.name) === null || _member$name === void 0 ? void 0 : _member$name.getText().toLowerCase()) == "create";
+  });
+
+  if (ts.isMethodDeclaration(memb)) {
+    return memb.parameters.find(para => para.name.getText().toLowerCase() == "parameters");
+  }
+}
+
+function findParametersInterface(node, interfaceName) {
+  if (ts.isModuleDeclaration(node) && node.body && ts.isModuleDeclaration(node.body) && node.body.body) {
+    const interfaceDeclaration = findTsNode(node.body.body, child => ts.isInterfaceDeclaration(child) && child.name.getText() == interfaceName);
+    return interfaceDeclaration;
+  }
+
+  return undefined;
+}
+
+function getModuleName(sourceFile) {
+  let fullName = "";
+
+  if (ts.isModuleDeclaration(sourceFile)) {
+    fullName += sourceFile.name.getText();
+    let packageB = sourceFile.body;
+
+    if (ts.isModuleDeclaration(packageB)) {
+      fullName += "." + packageB.name.getText();
+    }
+  }
+
+  return fullName;
+}
+
+function genParameters(interfac) {
+  return interfac.members.map((member, i) => {
+    let para = {};
+    para.Name = member.name.getText();
+    if (para.Name.length > 45) throw new Error(`Parameter name length >45 '${para.Name}'`);
+    let rawDocTags = ts.getJSDocTags(member);
+
+    if (rawDocTags.length) {
+      let dict = getTagDict(rawDocTags);
+      if (dict.summary) para.Description = dict.summary;
+      if (dict.creatorType) para.Type = dict.creatorType;
+      if (dict.default && dict.creatorType) para.Default = parseDefault(dict.default, dict.creatorType);
+      para.DisplayIndex = i + 1;
+    }
+
+    return para;
+  });
+}
+
+function getTagDict(tags) {
+  let dict = {};
+  tags.forEach(tag => {
+    dict[tag.tagName.text] = tag.comment;
+  });
+  return dict;
+}
+
+function findParametersInterfaceInFiles(program, fileList, name) {
+  for (const file of fileList) {
+    const sourceFile = program.getSourceFile(file);
+
+    if (sourceFile === undefined) {
+      throw new Error(`Expected a source file to exist for file name "${file}"`);
+    }
+
+    let interfaceDeclaration;
+    ts.forEachChild(sourceFile, node => {
+      interfaceDeclaration = findParametersInterface(node, name);
+      return interfaceDeclaration !== undefined;
+    });
+
+    if (interfaceDeclaration !== undefined) {
+      return interfaceDeclaration;
+    }
+  }
+
+  return undefined;
+}
+/**
+ * Extracts and returns script array for _Index.json from a src folder
+ *
+ * @param folderPath path to a src folder
+ */
+
+
+function extract(folderPath, ignore = []) {
+  const files = (0, _tsc.findTypescriptFiles)(_path.default.join(folderPath, "src"));
+  const filtered = files.filter(path => {
+    return !ignore.some(suffix => path.endsWith(suffix));
+  });
+  let arr = new Array();
+  let program = ts.createProgram(filtered, {
+    allowJs: true
+  });
+  program.getTypeChecker();
+  filtered.forEach(file => {
+    // Create a Program to represent the project, then pull out the
+    // source file to parse its AST.
+    const sourceFile = program.getSourceFile(file); // Loop through the root AST nodes of the file
+
+    ts.forEachChild(sourceFile, node => {
+      let obj = {};
+      const evalNode = findEvaluatorNode(node);
+
+      if (evalNode === undefined) {
+        return;
+      }
+
+      let moduleName = getModuleName(node);
+
+      if (evalNode.name === undefined) {
+        throw new Error(`Expected evaluator class to have a name`);
+      }
+
+      obj.Name = moduleName + "." + evalNode.name.getText();
+      if (obj.Name.length > 45) throw new Error(`Package name length >45 '${obj.Name}'`);
+      let para = getParameter(evalNode);
+      let paraName = para === null || para === void 0 ? void 0 : para.type.typeName.getText();
+      let interfac = findParametersInterfaceInFiles(program, filtered, paraName);
+
+      if (interfac === undefined) {
+        throw new Error(`Failed to find parameters type declaration for evaluator ${evalNode.name.getText()}`);
+      }
+
+      let rawDocTags = ts.getJSDocTags(evalNode);
+
+      if (rawDocTags.length) {
+        let dict = getTagDict(rawDocTags);
+        if (dict.summary) obj.Description = dict.summary;
+        if (dict.creatorType) obj.Type = dict.creatorType;
+      }
+
+      obj.Parameters = genParameters(interfac);
+      arr.push(obj);
+    });
+  });
+
+  let pathX = _path.default.join(folderPath, "_Index.json");
+
+  fs.writeFileSync(pathX, JSON.stringify(arr, null, 4));
+}
+
+/***/ }),
+
 /***/ "./src/commands/release.ts":
 /*!*********************************!*\
   !*** ./src/commands/release.ts ***!
@@ -3719,10 +3983,10 @@ const releaseFolder = async (folderPath, options) => {
     fs.ensureDirSync(releasesPath);
     fs.copyFileSync(path.join(options.cwd, "bin", zipFileName), path.join(releasesPath, zipFileName));
   }
-}; //https://regex101.com/r/VfoI7n/1
+}; // https://regex101.com/r/LtGAu5/1
 
 
-const logRegex = /console\.log\(\s*"([\w\s\.\(\)]+)\ *Copyright[\w\s\(\)\.]+(\d{4}|\d{4} - \d{4})([\w\s\(\)\.]+)?"\)/i;
+const logRegex = /console\.log\(\s*"([\w\s\.\(\)]+)\ *Copyright[\w\s\(\)\.]+(\d{4}|\d{4} - \d{4})([\w\s\(\)\.]+)?",?\s*\)/i;
 const currentYear = new Date(Date.now()).getFullYear();
 
 const getVersionFile = folder => {
@@ -3772,7 +4036,7 @@ const getVersionFile = folder => {
     return invalidVersionFile();
   }
 
-  const [, description, copyright, copyrightStuff] = match;
+  const [_full, _description, copyright, copyrightStuff] = match;
   const copyrightYears = copyright.match(/^(\d+)( ?- ?(\d+))?$/);
   let years;
 
@@ -3783,7 +4047,6 @@ const getVersionFile = folder => {
   }
 
   return {
-    version: parseVersion(description),
     write: createVersionFileWriter(years, copyrightStuff),
     reset: () => {
       _igTools.FileUtil.writeFile(filePath, versionFile);
@@ -4154,9 +4417,7 @@ Packaging without a javascript file is only allowed when animation json files ar
   if (animations.size > 0) {
     const [scriptDomain, scriptSubdomain] = data.Scope.split(".");
     const scope = `${scriptDomain}.${scriptSubdomain}`;
-
-    if (!library.includes(scope)) {
-      library += `
+    library += `
 				var ${scriptDomain};
 				(function (${scriptDomain}) {
 					var ${scriptSubdomain};
@@ -4164,7 +4425,6 @@ Packaging without a javascript file is only allowed when animation json files ar
 					})(${scriptSubdomain} = ${scriptDomain}.${scriptSubdomain} || (${scriptDomain}.${scriptSubdomain} = {}));
 				})(${scriptDomain} || (${scriptDomain} = {}));
 			`;
-    }
 
     for (const [name, data] of animations) {
       library += `${scope}.${name} = ` + data + ";";
@@ -8082,7 +8342,7 @@ module.exports = require("util");
 /***/ ((module) => {
 
 "use strict";
-module.exports = JSON.parse('{"name":"@intelligentgraphics/ig.gfx.packager","version":"2.2.0","description":"IG.GFX.Packager 2.2.0 (2.2.0.100)","author":"Michael Beier <mb@intelligentgraphics.biz>","main":"build/index.js","private":false,"publishConfig":{"access":"public"},"engines":{"node":">=14.0.0"},"bin":{"packager":"./build/index.js"},"files":["build","locales","scripts"],"scripts":{"dist":"webpack","clean":"rimraf build *.tsbuildinfo","prepublishOnly":"yarn clean && yarn dist","test":"jest","_postinstall":"node scripts/postinstall.js"},"dependencies":{"ajv":"^8.6.2","axios":"^0.21.1","core-js":"^3.16.0","execa":"^5.1.1","fs-extra":"^10.0.0","glob":"^7.1.4","jszip":"^3.10.0","rimraf":"^3.0.2","source-map-support":"^0.5.19","terser":"^4.8.0","typedoc":"~0.23.2","typescript":"~4.7.4","update-notifier":"^5.1.0","v8-compile-cache":"^2.1.1","y18n":"^5.0.8","yargs":"^17.0.1"},"devDependencies":{"@babel/plugin-proposal-class-properties":"^7.18.6","@babel/plugin-proposal-object-rest-spread":"^7.18.9","@babel/preset-env":"^7.18.9","@intelligentgraphics/ig.tools.core":"^1.5.1","@intelligentgraphics/ig.utilities":"^1.6.6","@types/fs-extra":"^9.0.12","@types/glob":"^7.1.4","@types/node":"^16.4.11","@types/rimraf":"^3.0.1","@types/update-notifier":"^5.1.0","@types/yargs":"^17.0.2","babel-loader":"^8.1.0","ts-loader":"^9.2.5","ts-node":"^10.1.0","webpack":"^5.64.4","webpack-cli":"^4.7.2"}}');
+module.exports = JSON.parse('{"name":"@intelligentgraphics/ig.gfx.packager","version":"2.3.1","description":"IG.GFX.Packager 2.3.1 (2.3.1.100)","author":"Michael Beier <mb@intelligentgraphics.biz>","main":"build/index.js","private":false,"publishConfig":{"access":"public"},"engines":{"node":">=14.0.0"},"bin":{"packager":"./build/index.js"},"files":["build","locales","scripts"],"scripts":{"dist":"webpack","clean":"rimraf build *.tsbuildinfo","prepublishOnly":"yarn clean && yarn dist","test":"jest","_postinstall":"node scripts/postinstall.js","format":"prettier --write \\"**/*.{ts,tsx,json}\\""},"dependencies":{"ajv":"^8.6.2","axios":"^0.21.1","core-js":"^3.16.0","execa":"^5.1.1","fs-extra":"^10.0.0","glob":"^7.1.4","jszip":"^3.10.0","rimraf":"^3.0.2","source-map-support":"^0.5.19","terser":"^4.8.0","typedoc":"~0.23.2","typescript":"~4.7.4","update-notifier":"^5.1.0","v8-compile-cache":"^2.1.1","y18n":"^5.0.8","yargs":"^17.0.1"},"devDependencies":{"@babel/plugin-proposal-class-properties":"^7.18.6","@babel/plugin-proposal-object-rest-spread":"^7.18.9","@babel/preset-env":"^7.18.9","@intelligentgraphics/ig.tools.core":"^1.5.2","@intelligentgraphics/ig.utilities":"^1.6.6","@types/fs-extra":"^9.0.12","@types/glob":"^7.1.4","@types/node":"^16.4.11","@types/rimraf":"^3.0.1","@types/update-notifier":"^5.1.0","@types/yargs":"^17.0.2","babel-loader":"^8.1.0","ts-loader":"^9.2.5","ts-node":"^10.1.0","webpack":"^5.64.4","webpack-cli":"^4.7.2"}}');
 
 /***/ })
 
@@ -8138,6 +8398,8 @@ var _localization = __webpack_require__(/*! ./localization */ "./src/localizatio
 
 var _build = __webpack_require__(/*! ./commands/build */ "./src/commands/build.ts");
 
+var _generate = __webpack_require__(/*! ./commands/generate */ "./src/commands/generate.ts");
+
 const _excluded = ["directories"],
       _excluded2 = ["directory", "user", "password", "service", "license"];
 
@@ -8301,7 +8563,7 @@ yargs.command({
       }
 
       if (license && !license.endsWith(".iglic")) {
-        captureError(new Error(`Expected the license path to end with the extension .iglic`));
+        captureError(new Error(`Expected the license path to end with the extension .iglic. Received the path "${license}". You may need to reload your environment variables by restarting the program you're using to execute the packager.`));
         return;
       }
     }
@@ -8348,6 +8610,22 @@ yargs.command({
     releaseFolders(fullOptions).catch(captureError);
   }
 });
+yargs.command({
+  command: "generateIndex [directory]",
+  builder: argv => {
+    return argv.option("ignore", {
+      type: "array",
+      default: [],
+      description: (0, _localization.translate)("options.ignore.description")
+    });
+  },
+  handler: ({
+    directory,
+    ignore
+  }) => {
+    (0, _generate.extract)(directory, ignore);
+  }
+});
 yargs.demandCommand().pkgConf("packager").showHelpOnFail(false).version().argv;
 const notifier = (0, _updateNotifier.default)({
   pkg: pjson,