turbo-gulp/target-tasks/typedoc.ts

Gulp tasks to boost high-quality projects.

import { Gulp } from "gulp";
import gulpTypedoc from "gulp-typedoc";
import { AbsPosixPath } from "../types";
import { TaskFunction } from "../utils/gulp-task-function";
import { ResolvedTsLocations, resolveTsLocations, TypescriptConfig } from "./_typescript";

export interface TypedocOptions {
  dir: AbsPosixPath;
  name: string;
}

export function getTypedocTask(gulp: Gulp, tsConfig: TypescriptConfig, options: TypedocOptions): TaskFunction {
  const resolved: ResolvedTsLocations = resolveTsLocations(tsConfig);

  const task: TaskFunction = function () {
    return gulp
      .src(resolved.absScripts, {base: tsConfig.srcDir})
      // TODO(demurgos): Fix gulp typedoc: add missing `tsconfig` key?
      .pipe(gulpTypedoc(<any> {
        // TypeScript options (see typescript docs)
        module: "commonjs",
        target: "es2017",
        tsconfig: resolved.tsconfigJson,
        includeDeclarations: false,
        out: options.dir,
        // TypeDoc options (see typedoc docs)
        name: options.name,
        // theme: "/path/to/my/theme",
        plugins: ["external-module-name"],
        ignoreCompilerErrors: false,
        version: true,
      }));
  };
  task.displayName = "_typedoc";
  return task;
}