suh-dgeni-ngdocs/config.js

A package to generate ng-docs similar to what is used on AngularJS website.

var path = require('canonical-path');
var packagePath = __dirname;
var _ = require('lodash');
var Installer = require('./src/installer').Installer;
var Package = require('dgeni').Package;

// Create and export a new Dgeni package called dgeni-example. This package depends upon
// the jsdoc and nunjucks packages defined in the dgeni-packages npm module.
module.exports = function(conf){
  var installer = new Installer(conf);
  
  return new Package('suh-docs', [
    require('dgeni-packages/ngdoc'),
    require('dgeni-packages/nunjucks'),
    require('dgeni-packages/examples')
  ])

  .factory(require('./src/services/errorNamespaceMap'))
  .factory(require('./src/services/getMinerrInfo'))
  .factory(require('./src/services/getVersion'))
  .factory(require('./src/services/gitData'))

  .factory(require('./src/services/deployments/debug'))
  .factory(require('./src/services/deployments/default')(conf))
  .factory(require('./src/services/deployments/jquery'))
  .factory(require('./src/services/deployments/production'))

  .factory(require('./src/inline-tag-defs/type'))
  .factory(require('./src/inline-tag-defs/inlinenote'))

  //.processor(require('./src/processors/module-docs')(conf))
  .processor(require('./src/processors/error-docs'))
  .processor(require('./src/processors/index-page'))
  .processor(require('./src/processors/keywords'))
  .processor(require('./src/processors/pages-data')(conf))
  .processor(require('./src/processors/versions-data'))
  .processor(require('./src/processors/home-page')(conf))


  .config(function(dgeni, log, readFilesProcessor, writeFilesProcessor) {
    installer.install();
    dgeni.stopOnValidationError = (conf.debug && conf.debug.stopOnValidationError) || true;
    dgeni.stopOnProcessingError = true;

    log.level = (conf.logger && conf.logger.level)?conf.logger.level:'info';

    readFilesProcessor.basePath = conf.basePath; 
    readFilesProcessor.sourceFiles = conf.sourceFiles; 
    // readFilesProcessor.sourceFiles = [
    //   { include: 'src/**/*.js', basePath: 'src' },
    //   { include: 'docs/content/**/*.ngdoc', basePath: 'docs/content' }
    // ];

    writeFilesProcessor.outputFolder = conf.outputFolder;

  })


  .config(function(parseTagsProcessor,templateEngine,getInjectables) {
    parseTagsProcessor.tagDefinitions.push(require('./src/tag-defs/tutorial-step'));
    parseTagsProcessor.tagDefinitions.push(require('./src/tag-defs/sortOrder'));
    parseTagsProcessor.tagDefinitions.push(require('./src/tag-defs/lib'));
    parseTagsProcessor.tagDefinitions.push(require('./src/tag-defs/installation'));
    parseTagsProcessor.tagDefinitions.push(require('./src/tag-defs/note'));
    parseTagsProcessor.tagDefinitions.push(require('./src/tag-defs/todo'));
    parseTagsProcessor.tagDefinitions.push(require('./src/tag-defs/briefdesc'));
    parseTagsProcessor.tagDefinitions.push(require('./src/tag-defs/implements'));
    if (conf.tagDefinitions){
      _(conf.tagDefinitions).forEach(function(tag){
        parseTagsProcessor.tagDefinitions.push(require(tag));
      });
    }

    templateEngine.filters = templateEngine.filters.concat(getInjectables([
      require('./src/filters/briefdescfilter')
    ]));
  })


  .config(function(inlineTagProcessor, typeInlineTagDef,noteInlineTagDef) {
    inlineTagProcessor.inlineTagDefinitions.push(typeInlineTagDef);
    inlineTagProcessor.inlineTagDefinitions.push(noteInlineTagDef);
    if (conf.inlineTagDefinitions){
      _(conf.inlineTagDefinitions).forEach(function(tag){
        inlineTagProcessor.inlineTagDefinitions.push(require(tag));
      });
    }
  })


  .config(function(templateFinder, renderDocsProcessor, gitData) {
    templateFinder.templateFolders.unshift(path.resolve(packagePath, 'templates/examples'));
    templateFinder.templateFolders.unshift(path.resolve(packagePath, 'templates/ngdocs'));
    templateFinder.templateFolders.unshift(path.resolve(packagePath, 'templates'));
    
    if (conf.templates){
      _(conf.templates)
        .forEach(function(template){
          templateFinder.templateFolders.unshift(template);
        });
    }
    renderDocsProcessor.extraData.git = conf.git || gitData;
    renderDocsProcessor.extraData.payload = conf.extraData || {};
    // renderDocsProcessor
  })


  .config(function(computePathsProcessor, computeIdsProcessor,templateFinder,getAliases) {
    

    computePathsProcessor.pathTemplates.push({
      docTypes: ['error'],
      pathTemplate: 'error/${namespace}/${name}',
      outputPathTemplate: 'partials/error/${namespace}/${name}.html'
    });

    computePathsProcessor.pathTemplates.push({
      docTypes: ['errorNamespace'],
      pathTemplate: 'error/${name}',
      outputPathTemplate: 'partials/error/${name}.html'
    });

    computePathsProcessor.pathTemplates.push({
      docTypes: ['overview', 'tutorial'],
      getPath: function(doc) {
        var docPath = path.dirname(doc.fileInfo.relativePath);
        if ( doc.fileInfo.baseName !== 'index' ) {
          docPath = path.join(docPath, doc.fileInfo.baseName);
        }
        return docPath;
      },
      outputPathTemplate: 'partials/${path}.html'
    });

    computePathsProcessor.pathTemplates.push({
      docTypes: ['e2e-test'],
      getPath: function() {},
      outputPathTemplate: 'ptore2e/${example.id}/${deployment.name}_test.js'
    });

    computePathsProcessor.pathTemplates.push({
      docTypes: ['indexPage'],
      pathTemplate: '.',
      outputPathTemplate: '${id}.html'
    });

    computePathsProcessor.pathTemplates.push({
      docTypes: ['module' ],
      pathTemplate: '${area}/${name}',
      outputPathTemplate: 'partials/${area}/${name}.html'
    });

    computePathsProcessor.pathTemplates.push({
      docTypes: ['componentGroup' ],
      pathTemplate: '${area}/${moduleName}/${groupType}',
      outputPathTemplate: 'partials/${area}/${moduleName}/${groupType}.html'
    });

    computeIdsProcessor.idTemplates.push({
      docTypes: ['overview', 'tutorial', 'e2e-test', 'indexPage'],
      getId: function(doc) { return doc.fileInfo.baseName; },
      getAliases: function(doc) { return [doc.id]; }
    });

    computeIdsProcessor.idTemplates.push({
    docTypes: ['interface' ],
    idTemplate: 'module:${module}.${docType}:${name}',
    getAliases: getAliases
  });
     computePathsProcessor.pathTemplates.push({
    docTypes: ['interface'],
    pathTemplate: '${area}/${module}/${docType}/${name}',
    outputPathTemplate: 'partials/${area}/${module}/${docType}/${name}.html'
  });

     computeIdsProcessor.idTemplates.push({
    docTypes: ['controller' ],
    idTemplate: 'module:${module}.${docType}:${name}',
    getAliases: getAliases
  });
     computePathsProcessor.pathTemplates.push({
    docTypes: ['controller'],
    pathTemplate: '${area}/${module}/${docType}/${name}',
    outputPathTemplate: 'partials/${area}/${module}/${docType}/${name}.html'
  });

    computeIdsProcessor.idTemplates.push({
      docTypes: ['error'],
      getId: function(doc) { return 'error:' + doc.namespace + ':' + doc.name; },
      getAliases: function(doc) { return [doc.name, doc.namespace + ':' + doc.name, doc.id]; }
    },
    {
      docTypes: ['errorNamespace'],
      getId: function(doc) { return 'error:' + doc.name; },
      getAliases: function(doc) { return [doc.id]; }
    }
    );
  })

  .config(function(checkAnchorLinksProcessor) {
    checkAnchorLinksProcessor.base = '/';
    // We are only interested in docs that have an area (i.e. they are pages)
    checkAnchorLinksProcessor.checkDoc = function(doc) { return doc.area; };
  })


    //generateProtractorTestsProcessor,
    // generateExamplesProcessor,
  .config(function(
    generateIndexPagesProcessor,
    debugDeployment, defaultDeployment,
    jqueryDeployment, productionDeployment,
    generateExamplesProcessor,generateProtractorTestsProcessor ) {

    generateIndexPagesProcessor.deployments = [
      debugDeployment,
      defaultDeployment,
      jqueryDeployment,
      productionDeployment
    ];

    // generateExamplesProcessor.deployments = [
    //   debugDeployment,
    //   defaultDeployment,
    //   jqueryDeployment,
    //   productionDeployment
    // ];

    generateProtractorTestsProcessor.deployments = [
      defaultDeployment,
      jqueryDeployment
    ];

    generateProtractorTestsProcessor.basePath = conf.outputFolder||'build/docs/';

    generateExamplesProcessor.deployments = [
      debugDeployment,
      defaultDeployment,
      jqueryDeployment,
      productionDeployment
    ];
  });
};