dgeni-alive/src/processors/structuredParam.js

Live doc generator on top of Dgeni

'use strict';

module.exports = function structuredParamProcessor (log) {

  var _ = require('lodash');

  var debug = function () {
    log.debug.apply(this, arguments);
  };

  var processParams = function (params) {
    var newParams = [], parent = null;
    _(params)
    .forEach(function (param) {
      var splitted = param.name.split('.');
      if(splitted.length === 1){
        parent = param;
        parent.level = 0;
        newParams.push(parent);
      }else if(splitted.length === 2 && parent && parent.name === splitted[0]){
        if(!parent.nestedParams){
          parent.nestedParams = [];
        }
        param.name = splitted[1];
        param.level = 1;
        parent.nestedParams.push(param);
      }else{
        param.level = 0;
        newParams.push(param);
      }
    });
    //debug('parameters: ', newParams);
    return newParams;
  };

  return {
    $runAfter: ['paths-computed'],
    $runBefore: ['rendering-docs'],
    $process: function (docs) {
      _(docs)
      .filter('methods').forEach(function (doc) {
        _(doc.methods).filter('params').forEach(function (method) {
          method.params = processParams(method.params);
        });
      });
      _(docs)
      .filter('params').forEach(function (doc) {
        doc.params = processParams(doc.params);
      });

    }
  };
};