[added] the watch method to the Documentation class

Author: thealjey

bin/docs-watch.js

@@ -0,0 +1,5 @@
+/* @flow */
+
+import {Documentation} from '../src/Documentation';
+
+new Documentation().watch();

bin/docs.js

@@ -1,17 +1,5 @@
 /* @flow */
 
 import {Documentation} from '../src/Documentation';
-import {log, consoleStyles} from '../src/logger';
-import {createReadStream, createWriteStream} from 'fs';
-import {join} from 'path';
 
-const rootDir = join(__dirname, '..'),
-  docsDir = join(rootDir, 'docs'),
-  docs = new Documentation(),
-  {green} = consoleStyles;
-
-docs.run(() => {
-  createReadStream(join(rootDir, 'LICENSE')).pipe(createWriteStream(join(docsDir, 'LICENSE')));
-  createReadStream(join(rootDir, 'README.md')).pipe(createWriteStream(join(docsDir, 'README.md')));
-  log(green('Generated API documentation!'));
-});
+new Documentation().run();

package.json

@@ -10,6 +10,7 @@
   "scripts": {
     "test": "babel-node ./node_modules/.bin/isparta cover _mocha --root src -- -R nyan",
     "docs-build": "babel-node bin/docs",
+    "docs-watch": "babel-node bin/docs-watch",
     "lint": "flow && eslint ./",
     "build": "babel-node bin/build",
     "release": "release"

src/Documentation.js

@@ -5,8 +5,11 @@ import {join} from 'path';
 import noop from 'lodash/noop';
 import {logError} from './logger';
 import {findBinary} from './findBinary';
+import {watch} from './watch';
+import tinylr from 'tiny-lr';
 
-const cwd = process.cwd(),
+const LIVERELOAD_PORT = 35729,
+  cwd = process.cwd(),
   defaultOptions = {
     inputDir: join(cwd, 'src'),
     outputDir: join(cwd, 'docs'),
@@ -83,4 +86,29 @@ export class Documentation {
     });
   }
 
+  /**
+   * Watch for changes and automatically re-build the documentation.
+   *
+   * Please install, enable and, optionally, allow access to file urls (if you want to be able to browse the generated
+   * documentation without the need for a server) to the LiveReload browser extension.
+   *
+   * @memberof Documentation
+   * @instance
+   * @method watch
+   * @param {Function} [callback=function () {}] - a callback function
+   */
+  watch(callback: () => void = noop) {
+    const lr = tinylr();
+
+    lr.listen(LIVERELOAD_PORT);
+
+    watch(this.options.inputDir, 'js', () => {
+      this.run(() => {
+        callback();
+        lr.changed({body: {files: '*'}});
+      });
+    });
+    this.run(callback);
+  }
+
 }