bio-dts 0.15.2 → 0.15.3

package/lib/post-transform.js

@@ -409,7 +409,7 @@ export default function transform(src, transformOptions = {}) {
         const returnTags = tags.filter(t => t.name === 'return' || t.name === 'returns');
 
         if (returnTags.length > 1) {
-          throw error(hostPath.value, 'must specify zero or one @return(s) type in @overload fn');
+          throw error(hostPath.value, `must specify zero or one @return(s) in JSDoc - found ${returnTags.length}`);
         }
 
         return [
@@ -502,6 +502,14 @@ declare function p${
     return replacements;
   }
 
+  /**
+   * Clean the given (JSDoc) comment node - strip what is not necessary in
+   * type declarations: remove JSDoc only annotations, fixup type parameters.
+   *
+   * @param {any} comment - the comment node
+   *
+   * @return {any|null} - the cleaned comment node or null if it shall be dropped
+   */
   function cleanComment(comment) {
 
     /**
@@ -566,11 +574,13 @@ declare function p${
   }
 
   /**
+   * Cleans comments on the given node - strip what is not necessary
+   * in type declarations.
+   *
    * @param { Path<any> } nodePath
    */
   function cleanComments(nodePath) {
 
-    // clean JSDoc comments: remove annotation, fixup type parameters
     const comments = nodePath.get('comments') || { value: [] };
 
     for (const key of keys(comments.value || []).reverse()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bio-dts",
-  "version": "0.15.2",
+  "version": "0.15.3",
   "description": "Generate sane and clean types from JavaScript sources",
   "type": "module",
   "bin": "./bin/cmd.js",