dgeni-packages/base/processors/write-files.js

A collection of dgeni packages for generating documentation from source code

const path = require('canonical-path');

/**
 * @dgProcessor writeFilesProcessor
 * @param {Object} log A service that provides logging
 * @description Write the value of `doc.renderedContent` to a file a  `doc.outputPath`.
 * @property {String} outputFolder The base path to the folder where files are outputted
 */
module.exports = function writeFilesProcessor(log, readFilesProcessor, writeFile) {
  return {
    outputFolder: null,
    $validate: {
      outputFolder: { presence: true },
    },
    $runAfter:['writing-files'],
    $runBefore: ['files-written'],
    $process(docs) {
      const outputFolder = this.outputFolder;
      return Promise.all(docs.map(doc => {

        if ( !doc.outputPath ) {
          log.debug('Document "' + doc.id + ', ' + doc.docType + '" has no outputPath.');
        } else {

          const outputFile = path.resolve(readFilesProcessor.basePath, outputFolder, doc.outputPath);

          log.silly('writing file', outputFile);
          return writeFile(outputFile, doc.renderedContent).then(() => {
            log.debug('written file', outputFile);
            return outputFile;
          });

        }
      })).then(() => docs);
    }
  };
};