@runtime-type-inspector/transpiler 3.3.5 → 3.3.7

package/index.cjs

@@ -964,7 +964,7 @@
 	function parseJSDoc(src) {
 	  var expandType = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : expandTypeDepFree;
 	  // Parse something like: @param {Object} [kwargs={}] Optional arguments.
-	  var regex = /@param \{(.*?)\} ([\[\]a-zA-Z0-9_$=\{\}\.'" ]+)/g;
+	  var regex = /@param \{(.*?)\} ([\[\]a-zA-Z0-9_$=\-\{\}\.'" ]+)/g;
 	  var matches = _toConsumableArray(src.matchAll(regex));
 	  /** @type {Record<string, ExpandTypeReturnType>} */
 	  var params = Object.create(null);
@@ -976,10 +976,22 @@
 	    //   name: [kwargs={}] The configuration parameters.
 	    //   name: [d = 1.0] Sample spacing
 	    if (name[0] === '[') {
-	      // Possible improvement: counting opening/closing brackets for perfect match
-	      var closer = name.lastIndexOf(']');
+	      // Counting opening/closing brackets for perfect match
+	      var openCloseCount = 1;
+	      var i = 1;
+	      for (; i < name.length; i++) {
+	        var c = name[i];
+	        if (c === '[') {
+	          openCloseCount++;
+	        } else if (c === ']') {
+	          openCloseCount--;
+	        }
+	        if (openCloseCount === 0) {
+	          break;
+	        }
+	      }
 	      // Afterwards name will be: d = 1.0
-	      name = name.substring(1, closer);
+	      name = name.substring(1, i);
 	      // mark it for the type:
 	      optional = true;
 	    }
@@ -3610,6 +3622,12 @@
 	        var tmp = JSON.stringify(templates, null, 2).replaceAll('\n', '\n' + spaces);
 	        out += "\n".concat(spaces, "const rtiTemplates = ").concat(tmp, ";");
 	      }
+	      function newlineBeforeFirst() {
+	        if (first) {
+	          out += '\n';
+	          first = false;
+	        }
+	      }
 	      //out += `${spaces}/*${spaces}  node.type=${node.type}\n${spaces}
 	      //  ${JSON.stringify(jsdoc)}\n${parent}\n${spaces}*/\n`;
 	      var _loop = function _loop(name) {
@@ -3653,11 +3671,19 @@
 	                  try {
 	                    for (_iterator.s(); !(_step = _iterator.n()).done;) {
 	                      var element = _step.value;
+	                      if (element.type === 'RestElement') {
+	                        // Case for:
+	                        // function test([a, b, ...rest] = [1, 2, 3]) {return rest;}
+	                        /** @todo We could typecheck the rest element too */
+	                        // console.log("Ignore RestElement", element);
+	                        continue;
+	                      }
 	                      if (element.type !== 'Identifier') {
 	                        _this2.warn('Only Identifier case handled right now');
 	                        continue;
 	                      }
 	                      var _t = JSON.stringify(type.elementType, null, 2).replaceAll('\n', '\n' + spaces);
+	                      newlineBeforeFirst();
 	                      if (templates) {
 	                        out += "".concat(spaces, "if (!inspectTypeWithTemplates(").concat(element.name, ", ").concat(_t, ", '").concat(_loc, "', '").concat(nameFancy, "', rtiTemplates)) {\n");
 	                      } else {
@@ -3672,13 +3698,19 @@
 	                  }
 	                  return 0; // continue
 	                } else if (param.left.type === 'ObjectPattern') {
-	                  if (type.type === 'object') {
+	                  // If we have properties from JSDoc, we can create individual type inspections.
+	                  if (type !== null && type !== void 0 && type.properties && Object.keys(type.properties).length) {
 	                    // Add a type assertion for each property of the ObjectPattern
 	                    var _iterator2 = _createForOfIteratorHelper(param.left.properties),
 	                      _step2;
 	                    try {
 	                      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
 	                        var property = _step2.value;
+	                        if (property.type !== 'ObjectProperty') {
+	                          // E.g. case of RestElement, {a, b, c, ...kwargs}
+	                          // console.log("Ignore property", property);
+	                          continue;
+	                        }
 	                        if (property.key.type !== 'Identifier') {
 	                          _this2.warn('ObjectPattern> Only Identifier case handled right now');
 	                          continue;
@@ -3694,6 +3726,7 @@
 	                          continue;
 	                        }
 	                        var _t2 = JSON.stringify(subType, null, 2).replaceAll('\n', '\n' + spaces);
+	                        newlineBeforeFirst();
 	                        if (templates) {
 	                          out += "".concat(spaces, "if (!inspectTypeWithTemplates(").concat(keyName, ", ").concat(_t2, ", '").concat(_loc, "', '").concat(nameFancy, "', rtiTemplates)) {\n");
 	                        } else {
@@ -3707,7 +3740,7 @@
 	                      _iterator2.f();
 	                    }
 	                    return 0; // continue
-	                  } else if (typeof type === 'string') {
+	                  } else {
 	                    // The case when we have an ObjectPattern with a @typedef
 	                    name = "arguments[".concat(paramIndex, "]");
 	                  }
@@ -3737,10 +3770,7 @@
 	          if (loc === 'ContactPoint#constructor' || loc === 'ContactResult#constructor' || loc === 'SingleContactResult#constructor') {
 	            prevCheck = 'arguments.length !== 0 && ';
 	          }
-	          if (first) {
-	            out += '\n';
-	            first = false;
-	          }
+	          newlineBeforeFirst();
 	          if (templates) {
 	            out += "".concat(spaces, "if (").concat(prevCheck, "!inspectTypeWithTemplates(").concat(name, ", ").concat(t, ", '").concat(loc, "', '").concat(nameFancy, "', rtiTemplates)) {\n");
 	          } else {

package/index.mjs

@@ -744,7 +744,7 @@ function simplifyType(type, optional) {
  */
 function parseJSDoc(src, expandType = expandTypeDepFree) {
   // Parse something like: @param {Object} [kwargs={}] Optional arguments.
-  const regex = /@param \{(.*?)\} ([\[\]a-zA-Z0-9_$=\{\}\.'" ]+)/g;
+  const regex = /@param \{(.*?)\} ([\[\]a-zA-Z0-9_$=\-\{\}\.'" ]+)/g;
   const matches = [...src.matchAll(regex)];
   /** @type {Record<string, ExpandTypeReturnType>} */
   const params = Object.create(null);
@@ -756,10 +756,22 @@ function parseJSDoc(src, expandType = expandTypeDepFree) {
     //   name: [kwargs={}] The configuration parameters.
     //   name: [d = 1.0] Sample spacing
     if (name[0] === '[') {
-      // Possible improvement: counting opening/closing brackets for perfect match
-      const closer = name.lastIndexOf(']');
+      // Counting opening/closing brackets for perfect match
+      let openCloseCount = 1;
+      let i = 1;
+      for (; i < name.length; i++) {
+        const c = name[i];
+        if (c === '[') {
+          openCloseCount++;
+        } else if (c === ']') {
+          openCloseCount--;
+        }
+        if (openCloseCount === 0) {
+          break;
+        }
+      }
       // Afterwards name will be: d = 1.0
-      name = name.substring(1, closer);
+      name = name.substring(1, i);
       // mark it for the type:
       optional = true;
     }
@@ -3301,6 +3313,12 @@ class Asserter extends Stringifier {
       const tmp = JSON.stringify(templates, null, 2).replaceAll('\n', '\n' + spaces);
       out += `\n${spaces}const rtiTemplates = ${tmp};`;
     }
+    function newlineBeforeFirst() {
+      if (first) {
+        out += '\n';
+        first = false;
+      }
+    }
     //out += `${spaces}/*${spaces}  node.type=${node.type}\n${spaces}
     //  ${JSON.stringify(jsdoc)}\n${parent}\n${spaces}*/\n`;
     for (let name in params) {
@@ -3338,11 +3356,19 @@ class Asserter extends Stringifier {
             if (param.left.type === 'ArrayPattern' && type.type === 'array') {
               // Add a type assertion for each element of the ArrayPattern
               for (const element of param.left.elements) {
+                if (element.type === 'RestElement') {
+                  // Case for:
+                  // function test([a, b, ...rest] = [1, 2, 3]) {return rest;}
+                  /** @todo We could typecheck the rest element too */
+                  // console.log("Ignore RestElement", element);
+                  continue;
+                }
                 if (element.type !== 'Identifier') {
                   this.warn('Only Identifier case handled right now');
                   continue;
                 }
                 const _t = JSON.stringify(type.elementType, null, 2).replaceAll('\n', '\n' + spaces);
+                newlineBeforeFirst();
                 if (templates) {
                   out += `${spaces}if (!inspectTypeWithTemplates(${element.name}, ${_t}, '${_loc}', '${nameFancy}', rtiTemplates)) {\n`;
                 } else {
@@ -3352,9 +3378,15 @@ class Asserter extends Stringifier {
               }
               continue;
             } else if (param.left.type === 'ObjectPattern') {
-              if (type.type === 'object') {
+              // If we have properties from JSDoc, we can create individual type inspections.
+              if (type != null && type.properties && Object.keys(type.properties).length) {
                 // Add a type assertion for each property of the ObjectPattern
                 for (const property of param.left.properties) {
+                  if (property.type !== 'ObjectProperty') {
+                    // E.g. case of RestElement, {a, b, c, ...kwargs}
+                    // console.log("Ignore property", property);
+                    continue;
+                  }
                   if (property.key.type !== 'Identifier') {
                     this.warn('ObjectPattern> Only Identifier case handled right now');
                     continue;
@@ -3370,6 +3402,7 @@ class Asserter extends Stringifier {
                     continue;
                   }
                   const _t2 = JSON.stringify(subType, null, 2).replaceAll('\n', '\n' + spaces);
+                  newlineBeforeFirst();
                   if (templates) {
                     out += `${spaces}if (!inspectTypeWithTemplates(${keyName}, ${_t2}, '${_loc}', '${nameFancy}', rtiTemplates)) {\n`;
                   } else {
@@ -3378,7 +3411,7 @@ class Asserter extends Stringifier {
                   out += `${spaces}  youCanAddABreakpointHere();\n${spaces}}\n`;
                 }
                 continue;
-              } else if (typeof type === 'string') {
+              } else {
                 // The case when we have an ObjectPattern with a @typedef
                 name = `arguments[${paramIndex}]`;
               }
@@ -3408,10 +3441,7 @@ class Asserter extends Stringifier {
       if (_loc3 === 'ContactPoint#constructor' || _loc3 === 'ContactResult#constructor' || _loc3 === 'SingleContactResult#constructor') {
         prevCheck = 'arguments.length !== 0 && ';
       }
-      if (first) {
-        out += '\n';
-        first = false;
-      }
+      newlineBeforeFirst();
       if (templates) {
         out += `${spaces}if (${prevCheck}!inspectTypeWithTemplates(${name}, ${t}, '${_loc3}', '${nameFancy}', rtiTemplates)) {\n`;
       } else {

package/package.json

@@ -1,7 +1,7 @@
 {
   "bin": "bin.js",
   "name": "@runtime-type-inspector/transpiler",
-  "version": "3.3.5",
+  "version": "3.3.7",
   "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.3.5",
+    "@runtime-type-inspector/runtime": "^3.3.7",
     "typescript": "^5.1.6"
   },
   "files": [