bio-dts 0.8.0 → 0.8.1

package/README.md

@@ -20,10 +20,14 @@ npx bio-dts --outDir dist/types -r lib
 
 ## Features
 
-* Generates clean type definitions from ES5 code bases
-* Supports ES5 prototypical classes + inheritance
-* Supports optional parameters before required ones
+Generates clean type definitions from ES5 code bases:
+
+* ES5 prototypical classes + inheritance
+* Optional parameters before required ones
+* Function overloading (via `@overlord` annotations, actually works!)
 * Converts JSDoc to [TSDoc](https://github.com/microsoft/tsdoc)
+* Only exposed documented parameters
+* Validates, where needed declared parameters
 
 Checkout the [test fixtures](./test/fixtures) for full coverage.
 

package/bin/cmd.js

@@ -21,7 +21,9 @@ async function run() {
   } = ts.parseCommandLine(args);
 
   const help = args.includes('--help') || args.includes('-h');
-  const verbose = args.includes('--verbose');
+  const verboseMatch = /--verbose(?:=([^\s$]+))?(\s|$)/.exec(args);
+
+  const verbose = verboseMatch ? verboseMatch[1] || true : false;
   const recursive = args.includes('--recursive') || args.includes('-r');
 
   if (help) {
@@ -58,13 +60,17 @@ async function run() {
 
   console.log(`Generating types for ${files.length} files...`);
 
-  generateTypes(files, {
+  const generateOptions = {
     allowJs: true,
     declaration: true,
     emitDeclarationOnly: true,
     ...options,
     verbose
-  });
+  };
+
+  verbose && console.log('Using options ', generateOptions);
+
+  generateTypes(files, generateOptions);
 
   console.log('Done.');
 }

package/lib/generate-types.js

@@ -25,10 +25,11 @@ export default function generateTypes(fileNames, options) {
    * @return {string}
    */
   host.readFile = (fileName) => {
-    options.verbose && console.debug('[generate-types] [pre]', fileName);
 
     let src = host._readFile(fileName);
 
+    isVerbose(options, fileName) && console.debug('[generate-types] [pre]', fileName, src);
+
     if (names.has(path.resolve(fileName))) {
       try {
         src = preTransform(src);
@@ -38,13 +39,15 @@ export default function generateTypes(fileNames, options) {
       }
     }
 
+    isVerbose(options, fileName) && console.debug('[generate-types] [pre] [generated]', fileName, src);
+
     return src;
   };
 
   host._writeFile = host.writeFile;
 
   host.writeFile = (fileName, text, ...args) => {
-    options.verbose && console.debug('[generate-types] [post]', fileName, text);
+    isVerbose(options, fileName) && console.debug('[generate-types] [post]', fileName, text);
 
     try {
       text = postTransform(text);
@@ -53,10 +56,21 @@ export default function generateTypes(fileNames, options) {
       throw err;
     }
 
+    isVerbose(options, fileName) && console.debug('[generate-types] [post] [generated]', fileName, text);
+
     host._writeFile(fileName, text, ...args);
   };
 
   const program = ts.createProgram(fileNames, options, host);
 
   program.emit();
+}
+
+function isVerbose(options, fileName) {
+
+  if (typeof options.verbose === 'boolean') {
+    return options.verbose;
+  }
+
+  return fileName.includes(options.verbose);
 }

package/lib/parsers/jsdoc.js

@@ -108,7 +108,7 @@ export function parse(str) {
         const contents = tag.param.contents = str.substring(match.start + 1, match.end - 1);
         const idxEq = contents.indexOf('=');
 
-        tag.param.name = idxEq !== -1 ? contents.substring(0, idxEq) : contents;
+        tag.param.name = idxEq !== -1 ? contents.substring(0, idxEq).trim() : contents;
       } else {
         j = skipText(str, i);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bio-dts",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Generate sane and clean types from JavaScript sources",
   "type": "module",
   "main": "index.js",
@@ -11,6 +11,10 @@
     "test": "mocha test",
     "test:dts": "node bin/cmd.js --outDir dist -r test/fixtures"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nikku/bio-dts"
+  },
   "author": "Nico Rehwaldt",
   "license": "MIT",
   "dependencies": {