turbo-gulp
Version:
Gulp tasks to boost high-quality projects.
29 lines (27 loc) • 3.89 kB
JavaScript
import gulpTypedoc from "gulp-typedoc";
import { resolveTsLocations } from "./_typescript";
export function getTypedocTask(gulp, tsConfig, options) {
const resolved = resolveTsLocations(tsConfig);
const task = function () {
return gulp
.src(resolved.absScripts, { base: tsConfig.srcDir })
// TODO(demurgos): Fix gulp typedoc: add missing `tsconfig` key?
.pipe(gulpTypedoc({
// 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;
}
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIl9zcmMvdGFyZ2V0LXRhc2tzL3R5cGVkb2MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxXQUFXLE1BQU0sY0FBYyxDQUFDO0FBR3ZDLE9BQU8sRUFBdUIsa0JBQWtCLEVBQW9CLE1BQU0sZUFBZSxDQUFDO0FBTzFGLE1BQU0seUJBQXlCLElBQVUsRUFBRSxRQUEwQixFQUFFLE9BQXVCO0lBQzVGLE1BQU0sUUFBUSxHQUF3QixrQkFBa0IsQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUVuRSxNQUFNLElBQUksR0FBaUI7UUFDekIsT0FBTyxJQUFJO2FBQ1IsR0FBRyxDQUFDLFFBQVEsQ0FBQyxVQUFVLEVBQUUsRUFBQyxJQUFJLEVBQUUsUUFBUSxDQUFDLE1BQU0sRUFBQyxDQUFDO1lBQ2xELGdFQUFnRTthQUMvRCxJQUFJLENBQUMsV0FBVyxDQUFPO1lBQ3RCLDJDQUEyQztZQUMzQyxNQUFNLEVBQUUsVUFBVTtZQUNsQixNQUFNLEVBQUUsUUFBUTtZQUNoQixRQUFRLEVBQUUsUUFBUSxDQUFDLFlBQVk7WUFDL0IsbUJBQW1CLEVBQUUsS0FBSztZQUMxQixHQUFHLEVBQUUsT0FBTyxDQUFDLEdBQUc7WUFDaEIscUNBQXFDO1lBQ3JDLElBQUksRUFBRSxPQUFPLENBQUMsSUFBSTtZQUNsQiw4QkFBOEI7WUFDOUIsT0FBTyxFQUFFLENBQUMsc0JBQXNCLENBQUM7WUFDakMsb0JBQW9CLEVBQUUsS0FBSztZQUMzQixPQUFPLEVBQUUsSUFBSTtTQUNkLENBQUMsQ0FBQyxDQUFDO0lBQ1IsQ0FBQyxDQUFDO0lBQ0YsSUFBSSxDQUFDLFdBQVcsR0FBRyxVQUFVLENBQUM7SUFDOUIsT0FBTyxJQUFJLENBQUM7QUFDZCxDQUFDIiwiZmlsZSI6InRhcmdldC10YXNrcy90eXBlZG9jLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgR3VscCB9IGZyb20gXCJndWxwXCI7XG5pbXBvcnQgZ3VscFR5cGVkb2MgZnJvbSBcImd1bHAtdHlwZWRvY1wiO1xuaW1wb3J0IHsgQWJzUG9zaXhQYXRoIH0gZnJvbSBcIi4uL3R5cGVzXCI7XG5pbXBvcnQgeyBUYXNrRnVuY3Rpb24gfSBmcm9tIFwiLi4vdXRpbHMvZ3VscC10YXNrLWZ1bmN0aW9uXCI7XG5pbXBvcnQgeyBSZXNvbHZlZFRzTG9jYXRpb25zLCByZXNvbHZlVHNMb2NhdGlvbnMsIFR5cGVzY3JpcHRDb25maWcgfSBmcm9tIFwiLi9fdHlwZXNjcmlwdFwiO1xuXG5leHBvcnQgaW50ZXJmYWNlIFR5cGVkb2NPcHRpb25zIHtcbiAgZGlyOiBBYnNQb3NpeFBhdGg7XG4gIG5hbWU6IHN0cmluZztcbn1cblxuZXhwb3J0IGZ1bmN0aW9uIGdldFR5cGVkb2NUYXNrKGd1bHA6IEd1bHAsIHRzQ29uZmlnOiBUeXBlc2NyaXB0Q29uZmlnLCBvcHRpb25zOiBUeXBlZG9jT3B0aW9ucyk6IFRhc2tGdW5jdGlvbiB7XG4gIGNvbnN0IHJlc29sdmVkOiBSZXNvbHZlZFRzTG9jYXRpb25zID0gcmVzb2x2ZVRzTG9jYXRpb25zKHRzQ29uZmlnKTtcblxuICBjb25zdCB0YXNrOiBUYXNrRnVuY3Rpb24gPSBmdW5jdGlvbiAoKSB7XG4gICAgcmV0dXJuIGd1bHBcbiAgICAgIC5zcmMocmVzb2x2ZWQuYWJzU2NyaXB0cywge2Jhc2U6IHRzQ29uZmlnLnNyY0Rpcn0pXG4gICAgICAvLyBUT0RPKGRlbXVyZ29zKTogRml4IGd1bHAgdHlwZWRvYzogYWRkIG1pc3NpbmcgYHRzY29uZmlnYCBrZXk/XG4gICAgICAucGlwZShndWxwVHlwZWRvYyg8YW55PiB7XG4gICAgICAgIC8vIFR5cGVTY3JpcHQgb3B0aW9ucyAoc2VlIHR5cGVzY3JpcHQgZG9jcylcbiAgICAgICAgbW9kdWxlOiBcImNvbW1vbmpzXCIsXG4gICAgICAgIHRhcmdldDogXCJlczIwMTdcIixcbiAgICAgICAgdHNjb25maWc6IHJlc29sdmVkLnRzY29uZmlnSnNvbixcbiAgICAgICAgaW5jbHVkZURlY2xhcmF0aW9uczogZmFsc2UsXG4gICAgICAgIG91dDogb3B0aW9ucy5kaXIsXG4gICAgICAgIC8vIFR5cGVEb2Mgb3B0aW9ucyAoc2VlIHR5cGVkb2MgZG9jcylcbiAgICAgICAgbmFtZTogb3B0aW9ucy5uYW1lLFxuICAgICAgICAvLyB0aGVtZTogXCIvcGF0aC90by9teS90aGVtZVwiLFxuICAgICAgICBwbHVnaW5zOiBbXCJleHRlcm5hbC1tb2R1bGUtbmFtZVwiXSxcbiAgICAgICAgaWdub3JlQ29tcGlsZXJFcnJvcnM6IGZhbHNlLFxuICAgICAgICB2ZXJzaW9uOiB0cnVlLFxuICAgICAgfSkpO1xuICB9O1xuICB0YXNrLmRpc3BsYXlOYW1lID0gXCJfdHlwZWRvY1wiO1xuICByZXR1cm4gdGFzaztcbn1cbiJdLCJzb3VyY2VSb290IjoiLi4ifQ==