feat(app): call compodoc, with options

Author: vogloblinsky

README.md

@@ -1,3 +1,6 @@
+# gulp-compodoc
+[Compodoc](https://github.com/compodoc/compodoc) plugin for gulp
+
 <p align="center">
   <img src="https://avatars3.githubusercontent.com/u/23202313" alt="Compodoc: The missing documentation tool for your Angular application" width="226">
   <br>
@@ -7,42 +10,42 @@
   <a href="http://opensource.org/licenses/MIT"><img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT badge"></a>
 </p>
 
-# gulp-compodoc
-Compodoc plugin for gulp
+<p align="center">The missing documentation tool for your Angular application</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/groupe-sii/compodoc/master/screenshots/main-view.png" alt="Compodoc: The missing documentation tool for your Angular application">
+</p>
 
 ## Install
 
 ```
 $ npm install --save-dev gulp-compodoc
 ```
 
-
 ## Usage
 
 ```js
 const gulp = require('gulp'),
     compodoc= require('gulp-compodoc');
 
 gulp.task('default', () => {
-	gulp.src('src/**/*.ts')
-		.pipe(compodoc())
+	return gulp.src('src/**/*.ts')
+		.pipe(compodoc({
+            output: 'documentation',
+            tsconfig: 'src/tsconfig.json',
+            serve: true
+        }))
 );
 ```
 
 
 ## API
 
-### compodoc([options])
+### compodoc(options)
 
 #### options
 
-##### foo
-
-Type: `boolean`<br>
-Default: `false`
-
-Lorem ipsum.
-
+All options from [compodoc](https://github.com/compodoc/compodoc) are available. The list is available [here](https://github.com/compodoc/compodoc#usage).
 
 ## License
 

index.js

@@ -0,0 +1,37 @@
+'use strict';
+const gutil = require('gulp-util'),
+      PluginError = gutil.PluginError,
+      es = require('event-stream'),
+      through = require('through2'),
+      compodocModule = require('compodoc'),
+      PLUGIN_NAME = 'gulp-compodoc';
+
+function compodoc(options) {
+    var files = [];
+	options = options || {};
+
+    return es.through(function(file) {
+		files.push(file.path);
+	}, function() {
+		var stream = this;
+
+		if (files.length === 0) {
+			stream.emit('error', new PluginError(PLUGIN_NAME, 'No input files for compodoc.'));
+			stream.emit('end');
+			return;
+		} else if (!options.output) {
+			stream.emit('error', new PluginError(PLUGIN_NAME, 'You must either specify the \'output\' option.'));
+			stream.emit('end');
+			return;
+		} else {
+            var app = new compodocModule.Application(options);
+
+            app.setFiles(files);
+            app.generate();
+
+			return;
+		}
+	});
+}
+
+module.exports = compodoc;

package.json

@@ -34,7 +34,7 @@
   "dependencies": {
     "gulp-util": "^3.0.7",
     "through2": "^2.0.1",
-    "compodoc": "^0.0.23"
+    "compodoc": "^0.0.24"
   },
   "devDependencies": {
     "gulp": "^3.9.1"