js-skald/bin/js-skald.js

The simple JavaScript API reference/code documentation generator

#!/usr/bin/env node

/******************************************************************************

js-skald - the simple JavaScript documentation generator

Copryright 2016 (c), Chris Vasseng <chris@tinkerer.xyz>

Licensed under the MIT license. See attached LICENSE file.

******************************************************************************/

var parser = require('../lib/parser.js'),
    fs = require('fs'),   
    templates = require('../lib/templates')(),
    async = require('async'),
    args = process.argv,
    outdir =  'output/',
    funs = [],
    mkdirp = require('mkdirp'),
    transform = require('../lib/transformtree.js')
;

require('colors');

console.log('js-skald - the crappy doc generator'.green);

function isFolder(filename) {
  return fs.lstatSync(filename).isDirectory();
}

function processFiles(list, outdir, name) {
  var funs = [],
      blockTree = {      
        name: 'global',
        namespaces: {},
        children: []
      }
  ;

  if (outdir[outdir.length - 1] !== '/') {
    outdir += '/';
  }

  function pushFile(filename) {    
    //console.log('Adding', filename.toString().bold, 'to queue');
    funs.push(
      function (next) {
        parser.parseFile(filename, function (blocks) {
          transform(blocks, blockTree);
          next();
        });      
      }
    );
  }

  mkdirp(outdir, function () {
    templates.load(__dirname + '/../templates/', function () {
      if (list && list.forEach) {
        list.forEach(function (filename) {
          var files;

          if (isFolder(filename)) {
            if (filename[filename.length - 1] !== '/') {
              filename += '/';
            }
            files = fs.readdirSync(filename) || [];
            files.forEach(function (fname) {
              if (fname.indexOf('.js')) {
                pushFile(filename + fname);
              }
            });          
          } else {
            pushFile(filename);
          }
        });
      }

      async.waterfall(funs, function () {
        fs.writeFile(outdir + name + '.json', JSON.stringify(blockTree, undefined, '  ', function (err) {
          return err && console.log('Error when writing json'.red, err);
        }));

        templates.dmp('docs', outdir + name + '.md', blockTree, function () {

        });
      });
    });
  });
}

function fromArgs() { 
  var arguments = Array.prototype.slice.call(args);
  arguments.slice(0, 1);
  processFiles(arguments, outdir, 'docs');
}

fs.readFile('.skald', function (err, data) {
  if (err) return fromArgs();

  try {
    data = JSON.parse(data.toString());

    data.output = data.output || outdir;
    data.name = data.name || 'Untitled Application';
    data.usePackageJson = data.usePackageJson || false;
    data.version = data.version || 'unknown version';

    if (data.sources && data.sources.forEach) {
      processFiles(data.sources, data.output, data.name);
    } else if (data.groups) {
      Object.keys(data.groups).forEach(function (name) {
        processFiles(data.groups[name], data.output, name.replace(/\s/g, '-'));
      });
    }

  } catch (e) {
    console.log('error parsing skald file'.red, e);
  }
});