Gulp-TypeDoc

Synopsis

Gulp plugin to execute the TypeDoc tool by Sebastian Lenz (https://sebastian-lenz.github.io/typedoc)

Installation

You do not need to install typedoc separately, just install gulp-typedoc:

npm install --save-dev gulp-typedoc

Usage

The plugin takes an object, of which all properties are passed transparently to the typedoc executable. Pipe in TypeScript files. The documentation files are not piped out, this is a future extension.

Code Example

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

gulp.task("typedoc", function() {
	return gulp
		.src(["data/*.ts"])
		.pipe(typedoc({ 
			module: "commonjs", 
			out: "./out", 
			name: "my-project", 
			target: "es5",
			includeDeclarations: true
		}))
	;
});

Troubleshooting

If you have very many files, you will run into a "command line too long" error, especially on Windows. This is because each filename gets put on the command line of a single typedoc command. In that case, it's easier to write a task that puts a directory into typedoc instead of separate files:

var child_process = require("child_process");

gulp.task("typedoc", function(cb) {
	child_process.exec("typedoc --out ./doc --module commonjs --target es5 --name MyProject ./my_code_directory/", cb);
});

Changelog

1.1.0

Allow specifying boolean arguments for typedoc; Replace module "gulp-clean" by "del"

1.0.6

Moved to typedoc version 0.2.x

1.0.5

Moved to typedoc version 0.1.x

1.0.3

Use require.resolve() to find typedoc more reliably

1.0.2

Allow any typedoc version 0.0.x

Contributors

• Rogier Schouten rogier.schouten@gmail.com
• Daan Wissing d.wissing@spiritit.com

License

Apache-2.0