feat(overall): scripting, reporting, simplicity

removed scripting capability, and all messages except for errors, then fixed test example to reflect
this

scripting removed completely, quiet option removed

Author: MutableLoss

README.md

@@ -69,12 +69,6 @@ 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;
-```
-
 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. 
 
 ```
@@ -84,7 +78,7 @@ buildOptions.updateApi = true;
 Setting this option to _true_ tells NODe to create and overwrite the existing documents with each request. 
 
 
-### As a Script
+### As a Script (0.10.2 and earlier)
 
 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.
 

app/index.js

@@ -27,39 +27,20 @@ var buildOptions = {
   buildDir: process.cwd(),
   buildVersion: process.version.slice(1),
   buildName: 'node-documents',
-  buildQuiet: false,
   updateApi: true
 }
 
-var options = process.argv.slice(2);
-
-// check for command line scripting options
-if(options[0] !== []) {
-  options.forEach(function(ops, index) {
-    if (ops.startsWith('-v')) {
-      buildOptions.buildVersion = options[index + 1];
-      flags[3] = '--node-version=' + version;
-    } else if (ops.startsWith('-f')) {
-      buildDir = options[index + 1];
-      if (buildDir.slice(-1) !== docEnd) { buildDir += docEnd; }
-      buildOptions.buildDir = buildDir + buildOptions.buildName;
-    }
-    if (index === options.length - 1) { checkOptions(); }
-  });
-}
-
 // Check for modular options
 function convertFile(file) {
   // take file and generate html file
   count++;
   flags[2] = apiDir + 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, {flag: 'w'});
   var createFile = spawn('node', flags);
   createFile.stdout.pipe(fileStream);
-  createFile.on('error', (err) => console.error('Error writing: ', err));
+  createFile.on('error', (err) => console.error('NODe: Error writing: ', err));
 }
 
 // grab template file and assets
@@ -77,8 +58,7 @@ function checkFiles() {
 function copyAssets() {
   fsx.copy(apiAssets, buildOptions.buildDir + 'assets', function(err) {
     // Quiet this error since it will show if assets already exist
-    if (err && !buildOptions.buildQuiet) { return console.log('Error copying assets:', err); }
-    if (!buildOptions.buildQuiet) { console.log('NODe: asset copy success'); }
+    if (err) { return console.log('NODe: Error copying assets:', err); }
   });
   checkFiles();
 }
@@ -91,9 +71,7 @@ function checkFolders() {
         if (err || buildOptions.updateApi) { copyAssets(); }
       });
     } else {
-      if (!buildOptions.buildQuiet) console.log('NODe API: creating build folder');
       fs.mkdir(buildOptions.buildDir, (err, out) => {
-        if(err && !buildOptions.buildQuiet) { console.log('NODe API: Build folder already exists'); }
         copyAssets();
       });
     }
@@ -105,7 +83,6 @@ function checkOptions() {
   if(buildOptions.buildDir.slice(0,1)) { buildOptions.buildDir = buildOptions.buildDir.replace(/^~/, os.homedir); }
   if (buildOptions.buildDir.slice(-1) !== docEnd) { buildOptions.buildDir += docEnd; }
   buildOptions.buildDir += buildOptions.buildName + docEnd;
-  if (!buildOptions.buildQuiet) { console.log('NODe API: Building to Directory: %s', buildOptions.buildDir); }
   checkFolders();
 }
 

example/test.js

@@ -11,7 +11,6 @@ var buildOptions = require('../app/index.js').buildOptions;
 // Test version change
 buildOptions.buildVersion = '4.4.0';
 buildOptions.buildName = 'apidoc';
-buildOptions.buildQuiet = true;
 
 // Use this to overwrite existing API documents
 // buildOptions.updateApi = true;

package.json

@@ -8,7 +8,7 @@
     "test": "istanbul cover _mocha -- -R spec test/module.test.js",
     "precommit": "npm test && npm run check-coverage",
     "commit": "git-cz",
-    "check-coverage": "istanbul check-coverage --statements 70 --branches 39 --functions 70 --lines 75",
+    "check-coverage": "istanbul check-coverage --statements 80 --branches 35 --functions 80 --lines 85",
     "report-coverage": "cat ./coverage/lcov.info | codecov",
     "semantic-release": "semantic-release pre && npm publish && semantic-release post"
   },