bio-dts 0.11.0 → 0.13.0

package/README.md

@@ -34,13 +34,15 @@ Checkout the [test fixtures](./test/fixtures) for full coverage.
 
 ## API
 
-```javascript
+```js
 import {
   preTransform,
   postTransform,
   generateTypes
 } from 'bio-dts';
 
+import * as typescript from 'typescript';
+
 // transform JS so it keeps the shape,
 // but is properly digestable by the typescript
 // compiler
@@ -54,5 +56,5 @@ const transformedCode = postTransform(tsCode);
 // typescript compiler
 generateTypes(files, {
   outDir: 'dist'
-});
+}, typescript);
 ```

package/bin/cmd.js

@@ -5,6 +5,7 @@ import Module from 'node:module';
 import glob from 'tiny-glob';
 
 import path from 'node:path';
+import os from 'node:os';
 import fs from 'node:fs';
 
 import generateTypes from '../lib/generate-types.js';
@@ -21,9 +22,9 @@ async function run() {
   } = ts.parseCommandLine(args);
 
   const help = args.includes('--help') || args.includes('-h');
-  const verboseMatch = /--verbose(?:=([^\s$]+))?(\s|$)/.exec(args);
+  const [ _verbose, _verboseGrep ] = args.flatMap(arg => /^--verbose(?:=(.*))?$/.exec(arg) || []);
 
-  const verbose = verboseMatch ? verboseMatch[1] || true : false;
+  const verbose = _verbose ? _verboseGrep || true : false;
   const recursive = args.includes('--recursive') || args.includes('-r');
 
   if (help) {
@@ -70,9 +71,40 @@ async function run() {
 
   verbose && console.log('Using options ', generateOptions);
 
-  generateTypes(files, generateOptions);
+  const {
+    diagnostics
+  } = generateTypes(files, generateOptions, ts);
+
+  const errors = diagnostics.filter(d => d.category === ts.DiagnosticCategory.Error);
+
+  if (errors.length) {
+
+    const formatHost = {
+      getNewLine() {
+        return os.EOL;
+      },
+
+      getCurrentDirectory() {
+        return process.cwd();
+      },
+
+      getCanonicalFileName(fileName) {
+        return fileName;
+      }
+    };
+
+    console.log('Done with errors:');
+    console.log();
+    console.log(
+      ts.formatDiagnosticsWithColorAndContext(errors, formatHost)
+    );
+
+    return 5;
+  }
 
   console.log('Done.');
+
+  return 0;
 }
 
 function isDir(fileName) {
@@ -103,7 +135,9 @@ function getTypescript() {
   }
 }
 
-run().catch(err => {
+run().then(errorCode => {
+  process.exit(errorCode);
+}, err => {
   console.error(err);
 
   process.exit(1);

package/lib/generate-types.js

@@ -1,17 +1,29 @@
 import path from 'node:path';
 
-import ts from 'typescript';
-
 import preTransform from './pre-transform.js';
 
 import postTransform from './post-transform.js';
 
+/**
+ * @typedef { import('typescript').CompilerOptions } CompilerOptions
+ * @typedef { import('typescript').createCompilerHost } createCompilerHost
+ * @typedef { import('typescript').createProgram } createProgram
+ * @typedef { {
+ *   createCompilerHost: createCompilerHost,
+ *   createProgram: createProgram
+ * } } TypeScript
+ */
 
 /**
- * @param {string[]} fileNames
- * @param {ts.CompilerOptions} options
+ * @param { string[] } fileNames
+ * @param { CompilerOptions } options
+ * @param { TypeScript } ts
  */
-export default function generateTypes(fileNames, options) {
+export default function generateTypes(fileNames, options, ts) {
+
+  if (!ts) {
+    throw new Error('must provide <ts=TypeScript>');
+  }
 
   const names = new Set(fileNames.map((p) => path.resolve(p)));
 
@@ -30,18 +42,18 @@ export default function generateTypes(fileNames, options) {
     // @ts-expect-error
     let src = host._readFile(fileName);
 
-    isVerbose(options, fileName) && console.debug('[generate-types] [pre]', fileName, src);
-
     if (names.has(path.resolve(fileName))) {
+      isVerbose(options, fileName) && console.debug('[generate-types] [pre]', fileName, src);
+
       try {
         src = preTransform(src);
       } catch (err) {
-        console.error(`failed to parse ${fileName} [pre] with contents ${src}`, err);
+        console.error(`[generate-types] [pre] failed to parse ${fileName} with contents ${src}`, err);
         throw err;
       }
-    }
 
-    isVerbose(options, fileName) && console.debug('[generate-types] [pre] [generated]', fileName, src);
+      isVerbose(options, fileName) && console.debug('[generate-types] [pre] [generated]', fileName, src);
+    }
 
     return src;
   };
@@ -52,14 +64,16 @@ export default function generateTypes(fileNames, options) {
   host.writeFile = (fileName, text, ...args) => {
     isVerbose(options, fileName) && console.debug('[generate-types] [post]', fileName, text);
 
-    try {
-      text = postTransform(text);
-    } catch (err) {
-      console.error(`failed to parse ${fileName} [post] with contents ${text}`, err);
-      throw err;
-    }
+    if (fileName.toLowerCase().endsWith('.d.ts')) {
+      try {
+        text = postTransform(text);
+      } catch (err) {
+        console.error(`[generate-types] [post] failed to parse ${fileName} with contents ${text}`, err);
+        throw err;
+      }
 
-    isVerbose(options, fileName) && console.debug('[generate-types] [post] [generated]', fileName, text);
+      isVerbose(options, fileName) && console.debug('[generate-types] [post] [generated]', fileName, text);
+    }
 
     // @ts-expect-error
     host._writeFile(fileName, text, ...args);
@@ -67,7 +81,7 @@ export default function generateTypes(fileNames, options) {
 
   const program = ts.createProgram(fileNames, options, host);
 
-  program.emit();
+  return program.emit();
 }
 
 function isVerbose(options, fileName) {
@@ -76,5 +90,9 @@ function isVerbose(options, fileName) {
     return options.verbose;
   }
 
+  if (typeof options.verbose === 'undefined') {
+    return false;
+  }
+
   return fileName.includes(options.verbose);
 }

package/lib/post-transform.js

@@ -127,7 +127,7 @@ export default function transform(src) {
 
       const actualName = param.argument?.name || param.name;
 
-      if (actualName !== expectedName) {
+      if (isNamedParam(param) && actualName !== expectedName) {
         throw error(node, `documented parameter <${ expectedName }> differs from actual parameter <${ actualName }>`);
       }
 
@@ -210,7 +210,8 @@ export default function transform(src) {
         variations.forEach((variation) => {
           const builder = {
             'RestElement': b.restElement,
-            'Identifier': b.identifier
+            'Identifier': b.identifier,
+            'ObjectPattern': b.objectPattern
           }[param.type];
 
           variation.push(builder.from(param));
@@ -416,7 +417,7 @@ export default function transform(src) {
       return;
     }
 
-    const replacements = overloads.slice().reverse().map(overload => {
+    const replacements = overloads.slice().map(overload => {
 
       const {
         comment,
@@ -502,7 +503,7 @@ declare function p${
 
       // remove full line including the non-TS tag
       if (
-        /class|constructor|template|method|typedef|property|this|overlord/.test(tag.name) ||
+        /class|constructor|template|method|typedef|property|this|overlord|overload/.test(tag.name) ||
         tag.param?.name?.includes('.')
       ) {
         replacements.push([ { start: tag.start - 4, end: tag.end } ]);
@@ -682,6 +683,10 @@ function getHostPath(nodePath) {
     : nodePath;
 }
 
+function isNamedParam(param) {
+  return param.type === 'Identifier' || param.type == 'RestElement';
+}
+
 /**
  * @param { { loc: { start: { line: number, column: number } } } } node
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bio-dts",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "description": "Generate sane and clean types from JavaScript sources",
   "type": "module",
   "bin": "bin/cmd.js",
@@ -10,11 +10,12 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "all": "run-s lint check-types test 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"
+    "test:dts:default": "node bin/cmd.js --outDir test/fixtures/snapshots/default -r test/fixtures",
+    "test:dts:declaration-map": "node bin/cmd.js --declarationMap --outDir test/fixtures/snapshots/declaration-map -r test/fixtures"
   },
   "repository": {
     "type": "git",
@@ -23,20 +24,20 @@
   "author": "Nico Rehwaldt",
   "license": "MIT",
   "dependencies": {
-    "@babel/parser": "^7.23.9",
-    "recast": "^0.23.4",
+    "@babel/parser": "^7.26.3",
+    "recast": "^0.23.9",
     "tiny-glob": "^0.2.9"
   },
   "devDependencies": {
     "@babel/types": "^7.23.9",
-    "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.19",
-    "chai": "^5.1.0",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^20.17.12",
+    "chai": "^5.1.2",
     "eslint": "^8.56.0",
     "eslint-plugin-bpmn-io": "^1.0.0",
-    "mocha": "^10.2.0",
-    "npm-run-all2": "^6.1.2",
-    "typescript": "^5.3.3"
+    "mocha": "^10.8.2",
+    "npm-run-all2": "^7.0.2",
+    "typescript": "^5.7.3"
   },
   "files": [
     "bin",