unleash/lib/changelog.js

Unleash your code into the wild yonder

const
  colors = require('chalk'),
  log    = require('fancy-log')

/**
 * changelog module.
 * @module lib/changelog
 */

function createBitbucketEnterpriseCommitLink () {
  const pkg = require(`${process.cwd()}/package`)
  const repository = pkg.repository.url

  return function (commit) {
    const commitStr = commit.substring(0,8)
    return repository ?
      `[${commitStr}](${repository}/commits/${commitStr})` :
      commitStr
  }
}

/**
 * Output change information from git commits to CHANGELOG.md
 *
 * @param options - {Object} that contains all the options of the changelog writer
 *   - repoType: The {String} repo type (github or bitbucket) of the project (default to `"github"`),
 *   - version: The {String} semantic version to add a change log for
 * @param done - {Function} that gets called when the changelog write task has completed
 *
 * @return `Function`.
**/
function writeChangelog (options, done) {
  options.repoType = options.repoType || 'github'

  log('Using repo type: ', colors.magenta(options.repoType))

  const pkg = require(`${process.cwd()}/package`)

  const opts = {
    log: log,
    repository: pkg.repository.url,
    version: options.version
  }

  // Github uses "commit", Bitbucket Enterprise uses "commits"
  if (options.repoType === 'bitbucket') 
    opts.commitLink = createBitbucketEnterpriseCommitLink()
  

  return require('nf-conventional-changelog')(opts, (err, clog) => {
    if (err) 
      throw new Error(err)
    else {
      require('fs').writeFileSync(`${process.cwd()}/CHANGELOG.md`, clog)
      return done && typeof done === 'function' && done()
    }
  })
}

module.exports = writeChangelog
module.exports.createBitbucketEnterpriseCommitLink = createBitbucketEnterpriseCommitLink