add support for api-data.json file output (#1427)

bin/apidoc

@@ -78,6 +78,8 @@ program
 
   .option('-o, --output <output>', 'Output dirname.', 'doc/')
 
+  .option('--write-json', 'Will create api-data.json file with parsed API info.', false)
+
   .option('--parse-filters <parse-filters...>', 'Optional user defined filters. Format name=filename', [])
 
   .option('--parse-languages <parse-languages...>', 'Optional user defined languages. Format name=filename', [])
@@ -131,6 +133,7 @@ const options = {
   filterBy: argv.filterBy,
   logFormat: argv.logFormat,
   warnError: argv.warnError,
+  writeJson: argv.writeJson,
 };
 
 if (options.debug) {

lib/writer.js

@@ -63,6 +63,13 @@ class Writer {
     this.log.verbose('Copying fonts to: ' + assetsPath);
     this.fs.copySync(this.path.join(this.opt.template, 'fonts'), assetsPath);
 
+    // save the parsed api file
+    if (this.opt.writeJson) {
+      const jsonFile = this.path.join(assetsPath, 'api-data.json');
+      this.log.verbose('Saving parsed API to: ' + jsonFile);
+      this.fs.writeFileSync(jsonFile, this.api.data);
+    }
+
     // CSS from dependencies
     this.log.verbose('Copying bootstrap css to: ' + assetsPath);
     this.fs.copySync(this.findAsset('bootstrap/dist/css/bootstrap.min.css'), this.path.join(assetsPath, 'bootstrap.min.css'));

test/apidoc_test.js

@@ -33,14 +33,15 @@ function testFullExample (config) {
 
   // create
   it('should create example in ' + outputPath, async function () {
-    const cmd = 'node ./bin/apidoc ' + (config ? '-c ' + config : '') + ' -i ' + 'example -o ' + outputPath + ' -q -d';
+    const cmd = 'node ./bin/apidoc ' + (config ? '-c ' + config : '') + ' --write-json -i ' + 'example -o ' + outputPath + ' -q -d';
     const { stdout, stderr } = await exec(cmd);
   }).timeout(80000);
 
   // check we actually created output files
   it('should find created files', done => {
     const outputFiles = [
       'assets/main.bundle.js',
+      'assets/api-data.json',
       'index.html',
     ];