feat(build options): allow file updates

new updateApi build option allows users to force NODe to update the document files with every
request

Author: MutableLoss

README.md

@@ -62,23 +62,31 @@ If you need to change the desired build directory, build folder name, or build v
 ```
 var buildOptions = require('node-offline-api').buildOptions;
 
-buildOptions.buildDir: '/Users/username/Documents';
-buildOptions.buildName: 'MyAPIDocs';
-buildOptions.version: '4.4.0';
+buildOptions.buildDir = '/Users/username/Documents';
+buildOptions.buildName = 'MyAPIDocs';
+buildOptions.version = '4.4.0';
 
 createDocs();
 ```
 
 By default the build can be quite verbose when creating the documents. If you would prefer that the builds be silent, the buildQuiet option is offered allowing the build to complete silently, except when actual errors occur.
 
 ```
-buildOptions.buildQuiet: true
+buildOptions.buildQuiet = true;
 ```
 
+The way that NODe is written protects already generated documents by ignoring future requests when documents already exist. If you plan to update your documents many times with the same build name directory you will want to use the updateApi option. 
+
+```
+buildOptions.updateApi = true;
+```
+
+Setting this option to _true_ tells NODe to create and overwrite the existing documents with each request. 
+
 
 ### As a Script
 
-You can also use NODe as your own script simply to pull and create Node.js documentation. 
+You can also use NODe as your own script simply to pull and create Node.js documentation, but with less options. Even though this feature has less options, the options that do not exist can be easily scripted.
 
 ```
 $ npm start

app/index.js

@@ -28,6 +28,7 @@ var buildOptions = {
   buildVersion: process.version.slice(1),
   buildName: 'node-documents',
   buildQuiet: false,
+  updateApi: false
 }
 
 var options = process.argv.slice(2);
@@ -56,7 +57,7 @@ function convertFile(file) {
   var filename = file.slice(0,-3);
   if (!buildOptions.buildQuiet) console.log('Creating doc ' + filename);
   var pathname = buildOptions.buildDir + filename + '.html';
-  var fileStream = fs.createWriteStream(pathname);
+  var fileStream = fs.createWriteStream(pathname, {flag: 'w'});
   var createFile = spawn('node', flags);
   createFile.stdout.pipe(fileStream);
   createFile.on('close', (code) => {
@@ -88,9 +89,9 @@ function copyAssets() {
 function checkFolders() {
   fs.stat(buildOptions.buildDir, function(err, out) {
     if (out) {
-      if (!buildOptions.buildQuiet) console.log('NODe API: build folder exists');
-      fs.stat(buildOptions.buildDir + 'assets', function(err, out) {
+      fs.stat(buildOptions.buildDir + 'assets', function(err, out) { 
         if (err) { copyAssets(); }
+        if (buildOptions.updateApi) { copyAssets(); }
       });
     } else {
       if (!buildOptions.buildQuiet) console.log('NODe API: creating build folder');

example/test.js

@@ -13,4 +13,7 @@ buildOptions.buildVersion = '4.4.0';
 buildOptions.buildName = 'apidoc';
 buildOptions.buildQuiet = true;
 
+// Use this to overwrite existing API documents
+// buildOptions.updateApi = true;
+
 createDocs();