@runtime-type-inspector/transpiler 3.2.4 → 3.2.6

package/index.cjs

@@ -876,46 +876,43 @@
 	    // Strip the rest (either leftover of optional value or description)
 	    name = name.split(' ')[0].split('=')[0].trim();
 	    var simplifiedType = simplifyType(type, optional);
-	    var parts = name.split(".");
-	    if (parts.length === 3) {
-	      // Something like: @param {number[]} settings.render.skyboxRotation - Rotation of skybox.
-	      var parts0 = parts[0]; // settings
-	      var parts1 = parts[1]; // render
-	      var parts2 = parts[2]; // skyboxRotation
-	      var toptype = params[parts0];
-	      toptype.properties[parts1].properties = toptype.properties[parts1].properties || {};
-	      toptype.properties[parts1].properties[parts2] = simplifiedType;
-	    } else if (parts.length === 2) {
-	      // Something like: @param {number} description[].components
-	      var _parts = parts[0]; // description[]
-	      var _parts2 = parts[1]; // components
-	      if (_parts.endsWith('[]')) {
-	        _parts = _parts.slice(0, -2); // description[] -> description
-	      }
-
-	      var _toptype = params[_parts];
-	      if ((_toptype === null || _toptype === void 0 ? void 0 : _toptype.type) === "union") {
-	        var typeObject = _toptype.members.find(function (_) {
-	          return (_ === null || _ === void 0 ? void 0 : _.type) === 'object';
-	        });
-	        typeObject.properties[_parts2] = simplifiedType;
-	        //typeObject.properties = simplifiedType; // todo add test case
-	      } else if ((_toptype === null || _toptype === void 0 ? void 0 : _toptype.type) === "array") {
-	        _toptype.elementType.properties[_parts2] = simplifiedType;
-	      } else if ((_toptype === null || _toptype === void 0 ? void 0 : _toptype.type) === "object") {
-	        _toptype.properties = _toptype.properties || {};
-	        _toptype.properties[_parts2] = simplifiedType;
-	      } else {
-	        console.warn("parseJSDoc> skipping @param, unseen syntax detected, please check if your JSDoc is valid or open an issue about this", {
-	          src: src,
-	          toptype: _toptype,
-	          parts0: _parts,
-	          parts1: _parts2,
-	          simplifiedType: simplifiedType
-	        });
+	    // Turn "options.stats[].unitsName" into ['options', 'stats', 'unitsName'].
+	    var parts = name.split(/[\[\]]*\./);
+	    var properties = params;
+	    var _iterator = _createForOfIteratorHelper(parts),
+	      _step;
+	    try {
+	      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+	        var part = _step.value;
+	        /** @type {object} */
+	        var toptype = properties[part];
+	        if (!toptype) {
+	          // No toptype means we resolved as far as possible, now we can add `simplifiedType`.
+	          console.assert(part === parts.at(-1), 'Current part and last part should be the same.');
+	          properties[part] = simplifiedType;
+	        } else if (toptype.type === "union") {
+	          var typeObject = toptype.members.find(function (_) {
+	            return (_ === null || _ === void 0 ? void 0 : _.type) === 'object';
+	          });
+	          properties = typeObject.properties;
+	        } else if (toptype.type === "array") {
+	          properties = toptype.elementType.properties;
+	        } else if (toptype.type === "object") {
+	          toptype.properties = toptype.properties || Object.create(null);
+	          properties = toptype.properties;
+	        } else {
+	          console.warn("parseJSDoc> Skipping @param, unseen syntax detected. Please check if your JSDoc is valid or open an issue about this!", {
+	            src: src,
+	            toptype: toptype,
+	            parts: parts,
+	            simplifiedType: simplifiedType
+	          });
+	        }
 	      }
-	    } else {
-	      params[name] = simplifiedType;
+	    } catch (err) {
+	      _iterator.e(err);
+	    } finally {
+	      _iterator.f();
 	    }
 	  });
 	  if (Object.keys(params).length === 0) {
@@ -1425,15 +1422,19 @@
 	    function get() {
 	      return '  '.repeat(this.numSpaces);
 	    }
+	  }, {
+	    key: "path",
+	    get: function get() {
+	      return this.parents.map(function (_) {
+	        return _.type;
+	      }).join('/');
+	    }
 	  }, {
 	    key: "debugSpaces",
 	    value: function debugSpaces() {
 	      var spaces = this.spaces,
-	        parents = this.parents;
+	        path = this.path;
 	      var n = spaces.length;
-	      var path = parents.map(function (_) {
-	        return _.type;
-	      }).join('/');
 	      return "".concat(spaces, "// got ").concat(n, " spaces for ").concat(path, "\n");
 	    }
 	    /**
@@ -3580,6 +3581,7 @@
 	  }, {
 	    key: "getName",
 	    value: function getName(node) {
+	      var _node4, _node5;
 	      var toSource = this.toSource.bind(this);
 	      if (node.type === 'BlockStatement') {
 	        node = this.parent;
@@ -3615,10 +3617,20 @@
 	          return 'getName> missing parent for ' + node.type;
 	        case 'ObjectMethod':
 	          return toSource(key);
-	        default:
-	          this.warn('getName> unhandled type', type, 'for', node);
-	          return '/*MISSING*/';
+	        case 'BinaryExpression':
+	          var goodNames = ['FunctionDeclaration', 'ClassMethod', 'ClassPrivateMethod'];
+	          var goodParent = this.parents.findLast(function (_) {
+	            return goodNames.includes(_.type);
+	          });
+	          if (goodParent) {
+	            return this.getName(goodParent);
+	          }
+	          // top scope
+	          return "".concat(this.filename, ":").concat((_node4 = node) === null || _node4 === void 0 || (_node4 = _node4.loc) === null || _node4 === void 0 || (_node4 = _node4.start) === null || _node4 === void 0 ? void 0 : _node4.line);
 	      }
+	      this.warn('getName> unhandled type', type, 'for', node, this.path);
+	      //debugger;
+	      return "".concat(this.filename, ":").concat((_node5 = node) === null || _node5 === void 0 || (_node5 = _node5.loc) === null || _node5 === void 0 || (_node5 = _node5.start) === null || _node5 === void 0 ? void 0 : _node5.line);
 	    }
 	    /**
 	     * @override
@@ -3637,7 +3649,8 @@
 	      var left_ = this.toSource(left);
 	      var right_ = this.toSource(right);
 	      if (operator === '/') {
-	        return "validateDivision(".concat(left_, ", ").concat(right_, ")");
+	        var loc = this.getName(node);
+	        return "validateDivision(".concat(left_, ", ").concat(right_, ", ").concat(JSON.stringify(loc), ")");
 	      }
 	      return "".concat(left_, " ").concat(operator, " ").concat(right_);
 	    }

package/index.mjs

@@ -619,44 +619,32 @@ function parseJSDoc(src, expandType = expandTypeDepFree) {
     // Strip the rest (either leftover of optional value or description)
     name = name.split(' ')[0].split('=')[0].trim();
     const simplifiedType = simplifyType(type, optional);
-    const parts = name.split(".");
-    if (parts.length === 3) {
-      // Something like: @param {number[]} settings.render.skyboxRotation - Rotation of skybox.
-      const parts0 = parts[0]; // settings
-      const parts1 = parts[1]; // render
-      const parts2 = parts[2]; // skyboxRotation
-      const toptype = params[parts0];
-      toptype.properties[parts1].properties = toptype.properties[parts1].properties || {};
-      toptype.properties[parts1].properties[parts2] = simplifiedType;
-    } else if (parts.length === 2) {
-      // Something like: @param {number} description[].components
-      let parts0 = parts[0]; // description[]
-      const parts1 = parts[1]; // components
-      if (parts0.endsWith('[]')) {
-        parts0 = parts0.slice(0, -2); // description[] -> description
-      }
-
-      const toptype = params[parts0];
-      if ((toptype == null ? void 0 : toptype.type) === "union") {
+    // Turn "options.stats[].unitsName" into ['options', 'stats', 'unitsName'].
+    const parts = name.split(/[\[\]]*\./);
+    let properties = params;
+    for (const part of parts) {
+      /** @type {object} */
+      const toptype = properties[part];
+      if (!toptype) {
+        // No toptype means we resolved as far as possible, now we can add `simplifiedType`.
+        console.assert(part === parts.at(-1), 'Current part and last part should be the same.');
+        properties[part] = simplifiedType;
+      } else if (toptype.type === "union") {
         const typeObject = toptype.members.find(_ => (_ == null ? void 0 : _.type) === 'object');
-        typeObject.properties[parts1] = simplifiedType;
-        //typeObject.properties = simplifiedType; // todo add test case
-      } else if ((toptype == null ? void 0 : toptype.type) === "array") {
-        toptype.elementType.properties[parts1] = simplifiedType;
-      } else if ((toptype == null ? void 0 : toptype.type) === "object") {
-        toptype.properties = toptype.properties || {};
-        toptype.properties[parts1] = simplifiedType;
+        properties = typeObject.properties;
+      } else if (toptype.type === "array") {
+        properties = toptype.elementType.properties;
+      } else if (toptype.type === "object") {
+        toptype.properties = toptype.properties || Object.create(null);
+        properties = toptype.properties;
       } else {
-        console.warn("parseJSDoc> skipping @param, unseen syntax detected, please check if your JSDoc is valid or open an issue about this", {
+        console.warn("parseJSDoc> Skipping @param, unseen syntax detected. Please check if your JSDoc is valid or open an issue about this!", {
           src,
           toptype,
-          parts0,
-          parts1,
+          parts,
           simplifiedType
         });
       }
-    } else {
-      params[name] = simplifiedType;
     }
   });
   if (Object.keys(params).length === 0) {
@@ -1121,13 +1109,15 @@ class Stringifier {
   get spaces() {
     return '  '.repeat(this.numSpaces);
   }
+  get path() {
+    return this.parents.map(_ => _.type).join('/');
+  }
   debugSpaces() {
     const {
       spaces,
-      parents
+      path
     } = this;
     const n = spaces.length;
-    const path = parents.map(_ => _.type).join('/');
     return `${spaces}// got ${n} spaces for ${path}\n`;
   }
   /**
@@ -3219,6 +3209,7 @@ class Asserter extends Stringifier {
    * @returns {string} Stringification of the node.
    */
   getName(node) {
+    var _node, _node2;
     const toSource = this.toSource.bind(this);
     if (node.type === 'BlockStatement') {
       node = this.parent;
@@ -3253,10 +3244,18 @@ class Asserter extends Stringifier {
         return 'getName> missing parent for ' + node.type;
       case 'ObjectMethod':
         return toSource(key);
-      default:
-        this.warn('getName> unhandled type', type, 'for', node);
-        return '/*MISSING*/';
+      case 'BinaryExpression':
+        const goodNames = ['FunctionDeclaration', 'ClassMethod', 'ClassPrivateMethod'];
+        const goodParent = this.parents.findLast(_ => goodNames.includes(_.type));
+        if (goodParent) {
+          return this.getName(goodParent);
+        }
+        // top scope
+        return `${this.filename}:${(_node = node) == null || (_node = _node.loc) == null || (_node = _node.start) == null ? void 0 : _node.line}`;
     }
+    this.warn('getName> unhandled type', type, 'for', node, this.path);
+    //debugger;
+    return `${this.filename}:${(_node2 = node) == null || (_node2 = _node2.loc) == null || (_node2 = _node2.start) == null ? void 0 : _node2.line}`;
   }
   /**
    * @override
@@ -3275,7 +3274,8 @@ class Asserter extends Stringifier {
     const left_ = this.toSource(left);
     const right_ = this.toSource(right);
     if (operator === '/') {
-      return `validateDivision(${left_}, ${right_})`;
+      const loc = this.getName(node);
+      return `validateDivision(${left_}, ${right_}, ${JSON.stringify(loc)})`;
     }
     return `${left_} ${operator} ${right_}`;
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "bin": "bin.js",
   "name": "@runtime-type-inspector/transpiler",
-  "version": "3.2.4",
+  "version": "3.2.6",
   "description": "Validating JSDoc types at runtime for high-quality types - Trust is good, control is better.",
   "main": "index.cjs",
   "module": "index.mjs",
@@ -19,7 +19,7 @@
   "homepage": "https://github.com/kungfooman/RuntimeTypeInspector.js#readme",
   "dependencies": {
     "@babel/parser": "^7.23.0",
-    "@runtime-type-inspector/runtime": "^3.2.4",
+    "@runtime-type-inspector/runtime": "^3.2.6",
     "typescript": "^5.1.6"
   },
   "files": [