solidoc2/generator.js

Solidity Documentation Generator 2

const pino = require('pino')
const path = require('path')
const fs = require('fs')
const temp = require('./helpers/template-helper')

const logger = pino({
  prettyPrint: true
})

const serializeContract = (contract, contracts) => {
  let template = temp.ContractTemplate

  require('require-all')({
    dirname: path.join(__dirname, 'serializers'),
    filter: /(.+serializer)\.js$/,
    resolve: (serializer) => {
      template = serializer.serialize(contract, template, contracts)
    }
  })

  return template
}

const serialize = (contracts, outputDirectory, cb) => {
  logger.info('Total contracts: %s.', contracts.length)

  for (let i = 0; i < contracts.length; i++) {
    const contract = contracts[i]
    const result = serializeContract(contract, contracts).replace(/[\r\n]\s*[\r\n]/g, '\n\n')
    const file = path.join(outputDirectory, `${contract.contractName}.md`)

    logger.info('Writing %s.', file)
    fs.writeFileSync(file, result)

    if (typeof (cb) === 'function') {
      cb(contract, result, file)
    }
  }
}

module.exports = {
  serialize
}