Enable console logging for tests

package.json

@@ -28,6 +28,7 @@
     "jsdoc": "^3.6.3",
     "jsdoc-api": "^5.0.3",
     "mocha": "^5.2.0",
+    "object-to-spawn-args": "^2.0.0",
     "ts-node": "^7.0.1"
   },
   "peerDependencies": {

test/expected/namespace_all.d.ts

@@ -9,7 +9,7 @@ declare namespace FoobarNS {
          * @param [opt_this = 10] - An object.
          * @param [opt_2 = 10] - An object.
          */
-        f<S>(f: FoobarNS.Foo.FCallback, opt_this?: any, opt_2?: number[] | {
+        f<S>(f: FoobarNS.Foo.FCallback, opt_this?: number, opt_2?: number[] | {
             [key: number]: string[];
         }): void;
     }

test/fixtures/namespace_all.js

@@ -25,7 +25,7 @@ FoobarNS.Foo = function Foo() {
 /**
  * A generic method.
  * @param {FoobarNS.Foo.FCallback} f A function.
- * @param [opt_this=10] An object.
+ * @param {number} [opt_this=10] An object.
  * @param {number[]|object<number, string[]>} [opt_2=10] An object.
  * @template S
  */

test/lib/index.ts

@@ -1,10 +1,7 @@
-// tslint:disable-next-line
-/// <reference path="../typings/jsdoc-api.d.ts" />
-
 import * as fs from 'fs';
 import * as path from 'path';
-import * as jsdocApi from 'jsdoc-api';
 import { expect } from 'chai';
+import { renderSync } from './render';
 
 const DEST_DIR = path.resolve(path.join(__dirname, '../_temp'));
 const DATA_DIR = path.resolve(path.join(__dirname, '../fixtures'));
@@ -19,12 +16,12 @@ before(() => {
 });
 
 export function compileJsdoc(sourcePath: string) {
-    jsdocApi.renderSync({
+    renderSync({
         files: sourcePath,
         cache: false,
         destination: DEST_DIR,
         configure: CONFIG_PATH
-    } as any);
+    });
 }
 
 export function expectJsDoc(fileName: string) {

test/lib/jsdoc-api.d.ts

@@ -0,0 +1,88 @@
+import Cache from 'cache-point';
+import FileSet from 'file-set';
+
+export namespace JsdocApi {
+    function explain(options: JsdocOptions): Promise<any[]>;
+    function explainSync(options: JsdocOptions): any[];
+    function renderSync(options: JsdocOptions): void;
+}
+
+export interface JsdocOptions {
+    /** One or more filenames to process. Either this or `source` must be supplied. */
+    files?: string|string[];
+    /** A string containing source code to process. Either this or `source` must be supplied. */
+    source?: string;
+    /** Set to `true` to cache the output - future invocations with the same input will return immediately. */
+    cache?: boolean;
+    /** Only display symbols with the given access: "public", "protected", "private" or "undefined", or "all" for all access levels. Default: all except "private". */
+    access?: string;
+    /** The path to the configuration file. Default: path/to/jsdoc/conf.json. */
+    configure?: string;
+    /** The path to the output folder. Use "console" to dump data to the console. Default: ./out/. */
+    destination?: string;
+    /** Assume this encoding when reading all source files. Default: utf8. */
+    encoding?: string;
+    /** Display symbols marked with the `@private` tag. Equivalent to "--access all". Default: false. */
+    private?: boolean;
+    /** The path to the project's package file. Default: path/to/sourcefiles/package.json */
+    package?: string;
+    /** Treat errors as fatal errors, and treat warnings as errors. Default: false. */
+    pedantic?: boolean;
+    /** A query string to parse and store in jsdoc.env.opts.query. Example: foo=bar&baz=true. */
+    query?: string;
+    /** Recurse into subdirectories when scanning for source files and tutorials. */
+    recurse?: boolean;
+    /** The path to the project's README file. Default: path/to/sourcefiles/README.md. */
+    readme?: string;
+    /** The path to the template to use. Default: path/to/jsdoc/templates/default. */
+    template?: string;
+    /** Directory in which JSDoc should search for tutorials. */
+    tutorials?: string;
+}
+
+export class TempFile {
+    path: string;
+}
+
+/**
+ * Command base class. The command `receiver` being the `child_process` module.
+ */
+export abstract class JsdocCommand {
+    cache?: Cache;
+    tempFile: TempFile | null;
+    options: JsdocOptions;
+    jsdocOptions: JsdocOptions;
+    jsdocPath: string;
+    inputFileSet?: FileSet;
+    output?: any;
+
+    constructor (options: JsdocOptions, cache?: Cache);
+
+    abstract getOutput(): any;
+
+    /**
+     * Template method returning the jsdoc output. Invoke later (for example via a command-queuing system) or immediately as required.
+     *
+     * 1. preExecute
+     * 2. validate
+     * 3. getOutput
+     * 4. postExecute
+     *
+     */
+    execute(): any;
+
+    /**
+     * Perform pre-execution processing here, e.g. expand input glob patterns.
+     */
+    preExecute(): void;
+
+    /**
+     * Return an Error instance if execution should not proceed.
+     */
+    validate(): null | Error;
+
+    /**
+     * perform post-execution cleanup
+     */
+    postExecute(): void;
+}

test/lib/jsdoc-api.js

@@ -0,0 +1,3 @@
+exports.JsdocApi = require('jsdoc-api');
+exports.JsdocCommand = require('jsdoc-api/lib/jsdoc-command');
+exports.TempFile = require('jsdoc-api/lib/temp-file');

test/lib/render.ts

@@ -0,0 +1,28 @@
+import { JsdocCommand, JsdocOptions } from './jsdoc-api';
+import { spawnSync } from 'child_process';
+
+const toSpawnArgs = require('object-to-spawn-args') as
+    (object: object, options?: { quote?: boolean; optionEqualsValue?: boolean }) => string[];
+
+class RenderSync extends JsdocCommand {
+    getOutput (err?: Error) {
+        if (err) throw err;
+
+        const jsdocArgs = toSpawnArgs(this.jsdocOptions)
+            .concat(this.options.source ? this.tempFile!.path : this.options.files!);
+
+        jsdocArgs.unshift(this.jsdocPath);
+
+        spawnSync('node', jsdocArgs, {
+            cwd: process.cwd(),
+            env: process.env,
+            stdio: 'inherit',
+            encoding: 'utf-8'
+        });
+    }
+}
+
+export function renderSync(options: JsdocOptions) {
+    const command = new RenderSync(options);
+    return command.execute();
+}