@bitjson/typedoc/tasks/typedoc.js

Create api documentation for TypeScript projects.

module.exports = function (grunt) {
    'use strict';

    var Path = require('path');
    var TypeDoc = require(Path.join(__dirname, '..', 'bin', 'typedoc.js'));

    grunt.registerMultiTask('typedoc', 'Generate documentations for TypeScript projects', function () {
        var options = this.options({});
        if (!options.out && !options.json) {
            grunt.log.error('You must either specify the \'out\' or \'json\' option.');
            return false;
        }

        if (this.filesSrc.length == 0) {
            grunt.log.error('No source files specified.');
            return false;
        }

        var out = options.out;
        var json = options.json;
        delete options.out;
        delete options.json;

        options.logger = function(message, level, newLine) {
            switch (level) {
                case TypeDoc.LogLevel.Success:
                    grunt.log.ok(message);
                    break;
                case TypeDoc.LogLevel.Info:
                case TypeDoc.LogLevel.Warn:
                    if (newLine) {
                        grunt.log.writeln(message);
                    } else {
                        grunt.log.write(message);
                    }
                    break;
                case TypeDoc.LogLevel.Error:
                    grunt.log.error(message);
                    break;
                default:
                    grunt.verbose.write(message);
                    break;
            }
        };

        var app = new TypeDoc.Application(options);
        var project = app.convert(app.expandInputFiles(this.filesSrc));
        if (!project) {
            return false;
        }

        if (out) app.generateDocs(project, out);
        if (json) app.generateJson(project, json);
        return true;
    });
};