rogierschouten/gulp-typedoc

Is there a way to generate docs in presence of TypeScript errors?

Closed this issue · 3 comments

Is there a way to generate docs in presence of TypeScript errors?
Sometimes, even often, it is needed to make docs for your team, even when code has a few compile-time glitches.
Thank you for this work. Awesome and useful lib.

Thanks mate! You'd have to ask at TypeDoc, not at gulp-typedoc...

TypeDoc guys have a say in TypeStrong/typedoc#116

TLDR; Version 0.3.6 (of TypeDoc) is now on NPM which allows you to specify the --ignoreCompilerErrors argument.

How can this flag be set in gulp-typedoc?

Gulp-typedoc transparently passes all options on to typedoc. Simply specify ignoreCompilerErrors like so:

var typedoc = require("gulp-typedoc");

gulp.task("typedoc", function() {
    return gulp
        .src(["data/*.ts"])
        .pipe(typedoc({ 
            ignoreCompilerErrors: true
        }))
    ;
});

I hope this helps you out. If it doesn't work, let me know.