bio-dts 0.8.1 → 0.10.0

package/lib/generate-types.js

@@ -17,6 +17,7 @@ export default function generateTypes(fileNames, options) {
 
   const host = ts.createCompilerHost(options);
 
+  // @ts-expect-error
   host._readFile = host.readFile;
 
   /**
@@ -26,6 +27,7 @@ export default function generateTypes(fileNames, options) {
    */
   host.readFile = (fileName) => {
 
+    // @ts-expect-error
     let src = host._readFile(fileName);
 
     isVerbose(options, fileName) && console.debug('[generate-types] [pre]', fileName, src);
@@ -44,6 +46,7 @@ export default function generateTypes(fileNames, options) {
     return src;
   };
 
+  // @ts-expect-error
   host._writeFile = host.writeFile;
 
   host.writeFile = (fileName, text, ...args) => {
@@ -58,6 +61,7 @@ export default function generateTypes(fileNames, options) {
 
     isVerbose(options, fileName) && console.debug('[generate-types] [post] [generated]', fileName, text);
 
+    // @ts-expect-error
     host._writeFile(fileName, text, ...args);
   };
 

package/lib/parsers/jsdoc.js

@@ -1,3 +1,28 @@
+/**
+ * @typedef { {
+ *   start: number,
+ *   end: number,
+ *   name: string,
+ *   type?: {
+ *     start: number,
+ *     end: number,
+ *     value: string
+ *   },
+ *   param: {
+ *     start: number,
+ *     end: number,
+ *     name?: string,
+ *     contents?: string,
+ *     value: string
+ *   },
+ *   description?: {
+ *     start: number,
+ *     end: number,
+ *     value: string
+ *   }
+ * } } JsdocTag
+ */
+
 function skipWhitespace(str, pos) {
   let i = pos;
 
@@ -65,11 +90,20 @@ function findNewline(str, pos) {
   return i;
 }
 
+/**
+ * @param {string} str
+ *
+ * @return {JsdocTag[]}
+ */
 export function parse(str) {
 
   var i = 0, j;
 
   var tags = [];
+
+  /**
+   * @type { Partial<JsdocTag> }
+   */
   var tag;
 
   while ((i = str.indexOf('@', i)) && i !== -1) {
@@ -133,7 +167,7 @@ export function parse(str) {
 
     tag.end = j;
 
-    tags.push(tag);
+    tags.push(/** @type { JsdocTag } */ (tag));
 
     i = j + 1;
   }

package/lib/parsers/typescript-dts.js

@@ -1,6 +1,10 @@
 import { parser } from 'recast/parsers/babel.js';
 import getBabelOptions from 'recast/parsers/_babel_options.js';
 
+/**
+ * @typedef { import('recast/parsers/_babel_options.js').Overrides } Overrides
+ */
+
 /**
  * @param {string} source
  * @param {Overrides} [options]

package/lib/post-transform.js

@@ -9,9 +9,14 @@ import {
   replace as replaceJSDoc
 } from './parsers/jsdoc.js';
 
+/**
+ * @template T
+ *
+ * @typedef { import('./util.js').Path<T> } Path
+ */
 
 /**
- * @param { { name: string, comments?: any[] } }
+ * @param { { name: string, key?: { name?: string }, comments?: any[] } } m
  *
  * @return {boolean}
  */
@@ -136,7 +141,7 @@ export default function transform(src) {
   /**
    * Ensure optional args methods are properly escaped
    *
-   * @param {import('./util.js').Path} nodePath
+   * @param {Path<any>} nodePath
    *
    * @return {any[]} replacements
    */
@@ -286,7 +291,7 @@ export default function transform(src) {
    * type Woop = import('./Woop').default;
    * ```
    *
-   * @param {import('./util.js').Path} nodePath
+   * @param {Path<any>} nodePath
    *
    * @return {any[]} replacements
    */
@@ -309,7 +314,7 @@ export default function transform(src) {
   /**
    * Ensure that only documented method parameters are used.
    *
-   * @param {Path} nodePath
+   * @param {Path<any>} nodePath
    *
    * @return {boolean} true if modified
    */
@@ -356,7 +361,7 @@ export default function transform(src) {
    * Our strategy is to parse for separate `@overlord` annotated tags,
    * use the meta-data, and generate a completely new method from it.
    *
-   * @param {Path} nodePath
+   * @param {Path<any>} nodePath
    *
    * @return {boolean} true if modified
    */
@@ -485,6 +490,9 @@ declare function p${
 
   function cleanComment(comment) {
 
+    /**
+     * @type { [ { start: number, end: number }, replacement?: string ][] }
+     */
     const replacements = [];
 
     const doc = comment.value.replace(/\n\s+/g, '\n ');
@@ -525,7 +533,6 @@ declare function p${
       return null;
     } else {
       return b.commentBlock.from({
-        type: 'CommentBlock',
         leading: true,
         value: newDoc
       });
@@ -533,7 +540,7 @@ declare function p${
   }
 
   /**
-   * @param {import('./util.js').Path} nodePath
+   * @param {Path<any>} nodePath
    */
   function cleanComments(nodePath) {
 
@@ -552,21 +559,20 @@ declare function p${
     }
   }
 
-  traverse(body, function(path) {
-
-    const {
-      value
-    } = path;
+  function transformPath(path) {
 
     // filter private members
-    if (!isPublic(value)) {
+    if (!isPublic(path.value)) {
       return replace(path);
     }
 
+    // generate overloads based on @overlord annotation
     if (generateOverloads(path)) {
       return false;
     }
 
+    // fix optional before required args
+    // (just fine in JavaScript)
     if (fixOptionalArgsMethods(path)) {
       return false;
     }
@@ -575,15 +581,27 @@ declare function p${
     cleanComments(path);
 
     fixTypeExport(path);
-  });
+  }
+
+  const nodes = [ body ];
 
-  for (const [ path, args ] of replacements) {
-    try {
-      path.replace(...args);
-    } catch (err) {
-      console.error('Failed to replace path', path, ...args, err);
+  while (nodes.length) {
+    const node = nodes.shift();
 
-      throw error(path.value, 'failed to replace path: ' + err.message);
+    traverse(node, transformPath);
+
+    while (replacements.length) {
+      const [ path, args ] = replacements.shift();
+
+      try {
+        const replacedPaths = path.replace(...args);
+
+        nodes.push(...replacedPaths);
+      } catch (err) {
+        console.error('Failed to replace path', path, ...args, err);
+
+        throw error(path.value, 'failed to replace path: ' + err.message);
+      }
     }
   }
 
@@ -602,7 +620,7 @@ function traverse(path, cb) {
   }
 
   for (const key of keys(val).reverse()) {
-    if ([ 'loc', 'start', 'end' ].includes(key)) {
+    if (typeof key === 'string' && [ 'loc', 'start', 'end' ].includes(key)) {
       continue;
     }
 
@@ -639,9 +657,9 @@ function getFunctionKind(node) {
 /**
  * Return host path for node (with attached comments).
  *
- * @param {Path} nodePath
+ * @param {Path<any>} nodePath
  *
- * @return {Path}
+ * @return {Path<any>}
  */
 function getHostPath(nodePath) {
   return [ 'ExportDefaultDeclaration', 'ExportNamedDeclaration' ].includes(nodePath.parentPath.value.type)
@@ -650,9 +668,9 @@ function getHostPath(nodePath) {
 }
 
 /**
- * @param {Node} node
+ * @param { { loc: { start: { line: number, column: number } } } } node
  *
- * @return {string}
+ * @return {Error}
  */
 function error(node, message) {
 

package/lib/pre-transform.js

@@ -6,7 +6,6 @@ import {
 
 function superCall() {
   return b.expressionStatement.from({
-    'type': 'ExpressionStatement',
     'expression': {
       'type': 'CallExpression',
       'callee': {
@@ -21,7 +20,6 @@ function clazzConstructor(cls, comments) {
   const constructor = cls.ctor.value;
 
   return b.classMethod.from({
-    'type': 'ClassMethod',
     'static': false,
     'key': {
       'type': 'Identifier',
@@ -100,7 +98,6 @@ function clazzDefinition(cls, ctor) {
   });
 
   return b.classDeclaration.from({
-    'type': 'ClassDeclaration',
     'id': {
       'type': 'Identifier',
       'name': cls.name
@@ -153,6 +150,7 @@ function splitComment(cls) {
 
 /**
  * @param {string} src
+ *
  * @return {string}
  */
 export default function transform(src) {
@@ -162,21 +160,23 @@ export default function transform(src) {
 
   const inheritsImports = findInheritsImports(body);
 
-  const classes = findConstructors(body);
-
   // query
-  for (const cls of classes) {
-    cls.members = [
-      ...findEmbeddedMembers(cls),
-      ...findProtoMembers(cls, body)
-    ];
+  const classes = findConstructors(body).map(cls => {
+    return {
+      ...cls,
 
-    cls.staticMembers = [
-      ...findStaticMembers(cls, body)
-    ];
+      members: [
+        ...findEmbeddedMembers(cls),
+        ...findProtoMembers(cls, body)
+      ],
 
-    cls.superDeclaration = findSuperDeclarations(cls, body, inheritsImports);
-  }
+      staticMembers: [
+        ...findStaticMembers(cls, body)
+      ],
+
+      superDeclaration: findSuperDeclarations(cls, body, inheritsImports)
+    };
+  });
 
   // transform
   for (const cls of classes) {
@@ -273,6 +273,15 @@ function findSuperDeclarations(cls, nodes, importDeclarations) {
 
 }
 
+/**
+ * @param {any[]} nodes
+ *
+ * @return { {
+ *   name: string,
+ *   ctor: any,
+ *   node: any
+ * }[] }
+ */
 function findConstructors(nodes) {
 
   const fns = matcher`

package/lib/util.js

@@ -2,10 +2,8 @@ import { parse as recastParse, print as recastPrint } from 'recast';
 import { Path as PathConstructor } from 'ast-types';
 
 /**
- * @typedef { {
- *   get(...any) => any,
- *   value: any
- * } } Path
+ * @template T extends
+ * @typedef { import('ast-types/lib/path.js').Path<T> } Path
  */
 
 import * as typescriptParser from './parsers/typescript.js';
@@ -17,7 +15,7 @@ const formatOptions = {
   useTabs: false,
   reuseWhitespace: false,
   tabWidth: 2,
-  quote: 'single'
+  quote: /** @type { 'single' } */ ('single')
 };
 
 /**
@@ -75,19 +73,21 @@ export function print(node) {
 }
 
 /**
- * @param {any} node
+ * @template V
  *
- * @return {Path}
+ * @param {V} node
+ *
+ * @return {Path<V>}
  */
 export function path(node) {
   return new PathConstructor(node);
 }
 
 /**
- * @param {string[]} strings
+ * @param {TemplateStringsArray} strings
  * @param {...any} args
  *
- * @return { (node) => [][] }
+ * @return { (node) => any[][] }
  */
 export function matcher(strings, ...args) {
 
@@ -102,9 +102,7 @@ export function matcher(strings, ...args) {
     return code;
   }, '');
 
-  const ast = parse(code, {
-    parser: typescriptParser
-  });
+  const ast = parse(code);
 
   const body = path(ast).get('program', 'body');
 
@@ -187,11 +185,13 @@ export function matcher(strings, ...args) {
   }
 
   /**
-   * @param {Path} node
-   * @param {Path} expectedNode
-   * @param {Path[]} results
+   * @template T
+   * @template V
+   * @param {Path<T>} node
+   * @param {Path<V>} expectedNode
+   * @param {Path<any>[]} results
    *
-   * @return {Path[] || null}
+   * @return {Path<any>[] | null}
    */
   function matchNode(node, expectedNode, results = []) {
 
@@ -209,7 +209,7 @@ export function matcher(strings, ...args) {
     }
 
     for (const key of keys(expectedNode.value)) {
-      if ([ 'loc', 'start', 'end' ].includes(key)) {
+      if (typeof key === 'string' && [ 'loc', 'start', 'end' ].includes(key)) {
         continue;
       }
 
@@ -241,13 +241,16 @@ export function matcher(strings, ...args) {
           DBG && console.log('BAIL no array match', key);
           return;
         }
-      } else
-      if (isNode(expectedVal.value)) {
+      }
+
+      else if (isNode(expectedVal.value)) {
         if (!matchNode(nodeVal, expectedVal, results)) {
           DBG && console.log('BAIL no match', key);
           return;
         }
-      } else {
+      }
+
+      else {
         if (nodeVal.value !== expectedVal.value) {
           DBG && console.log('BAIL no primitive match', key);
           return;

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "bio-dts",
-  "version": "0.8.1",
+  "version": "0.10.0",
   "description": "Generate sane and clean types from JavaScript sources",
   "type": "module",
-  "main": "index.js",
   "bin": "bin/cmd.js",
+  "exports": {
+    ".": "./index.js",
+    "./lib/*.js": "./lib/*.js",
+    "./package.json": "./package.json"
+  },
   "scripts": {
-    "all": "npm run lint && npm run test && npm run test:dts",
+    "all": "run-s lint check-types test test:dts",
     "lint": "eslint .",
+    "check-types": "tsc --noEmit",
     "test": "mocha test",
     "test:dts": "node bin/cmd.js --outDir dist -r test/fixtures"
   },
@@ -18,16 +23,20 @@
   "author": "Nico Rehwaldt",
   "license": "MIT",
   "dependencies": {
-    "@babel/parser": "^7.21.2",
-    "recast": "^0.22.0",
+    "@babel/parser": "^7.23.9",
+    "recast": "^0.23.4",
     "tiny-glob": "^0.2.9"
   },
   "devDependencies": {
-    "chai": "^4.3.7",
-    "eslint": "^8.36.0",
+    "@babel/types": "^7.23.9",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.11.19",
+    "chai": "^5.1.0",
+    "eslint": "^8.56.0",
     "eslint-plugin-bpmn-io": "^1.0.0",
     "mocha": "^10.2.0",
-    "typescript": "^5.0.2"
+    "npm-run-all2": "^6.1.2",
+    "typescript": "^5.3.3"
   },
   "files": [
     "bin",