simple-changelog/src/changelog.js

Simple GitHub release changelog from public semantic commits

'use strict'

const R = require('ramda')
const leavePublic = require('new-public-commits').leavePublic
const newPublicCommits = require('new-public-commits').newPublicCommits
const stripIndent = require('common-tags').stripIndent
const la = require('lazy-ass')
const is = require('check-more-types')
const simple = require('simple-commit-message')
const ggit = require('ggit')
const debug = require('debug')('simple-changelog')
const utils = require('./utils')

const isCommit = is.schema({
  id: is.maybe.commitId,
  subject: is.unemptyString,
  type: is.unemptyString,
  scope: is.maybe.unemptyString
})

function groupParsedCommits (commits) {
  la(is.array(commits), 'expected a list', commits)
  const grouped = R.groupBy(R.prop('type'), commits)
  return grouped
}

function groupCommits (commits) {
  const parsed = commits
    .map(c => {
      const p = simple.parse(c.message)
      if (p) {
        p.id = c.id
      }
      return p
    })
    .filter(is.defined)
  return groupParsedCommits(parsed)
}

function commitString (commit) {
  la(isCommit(commit), 'invalid commit format', commit)
  let msg = '* ' + commit.subject
  if (commit.id) {
    msg += ' (' + commit.id + ')'
  }
  return msg
}

function commitSubjectList (commits) {
  return commits.map(commitString).join('\n')
}

function scopeCommits (commits) {
  const grouped = R.groupBy(R.prop('scope'))(commits)
  let s = ''
  Object.keys(grouped).forEach(scope => {
    const scopedCommits = grouped[scope]
    if (scope !== 'undefined') {
      s += '### ' + scope + '\n'
    }
    s += commitSubjectList(scopedCommits) + '\n'
  })
  return s
}

function groupedToString (grouped) {
  debug('forming changelog from commits group')
  debug(grouped)

  let msg = ''

  if (is.array(grouped.major)) {
    msg += '## Breaking major changes 🔥\n' + scopeCommits(grouped.major) + '\n'
  }
  if (is.array(grouped.feat)) {
    msg += '## New features 👍\n' + scopeCommits(grouped.feat) + '\n'
  }
  if (is.array(grouped.fix)) {
    msg += '## Bug fixes ✅\n' + scopeCommits(grouped.fix) + '\n'
  }
  return msg
}

function commitsToString (commits) {
  const filtered = leavePublic(commits)
  debug('only public commits')
  debug(filtered)
  const grouped = groupCommits(filtered)
  return groupedToString(grouped)
}

function allCommitsToString (commits) {
  console.log('all commits to string')
  console.log(commits)
  const extended = commits.map(c => {
    return {
      id: c.id,
      subject: c.message,
      type: 'unknown type'
    }
  })
  return commitSubjectList(extended)
}

function getTagString (version) {
  const date = utils.getDateString()
  const head = stripIndent`
    <a name="${version}"></a>
    # ${version} (${date})
  `
  return head
}

function versionAndCommitsToLog (version, commits) {
  const head = getTagString(version)
  const commitsLog = commitsToString(commits)
  return head + '\n' + commitsLog
}

function versionAndAllCommitsToLog (version, commits) {
  const head = getTagString(version)
  const commitsLog = allCommitsToString(commits)
  return head + '\n' + commitsLog
}

function formChangelog (version, n) {
  la(is.unemptyString(version), 'missing release version')
  if (arguments.length === 2) {
    la(is.positive(n), 'invalid number of commits', n)
  }
  return newPublicCommits().then(commits => {
    debug('found %d public commit(s)', commits.length)

    if (is.not.empty(commits)) {
      return versionAndCommitsToLog(version, commits)
    }
    if (!n) {
      return versionAndCommitsToLog(version, commits)
    }

    debug('getting commits after last tag')
    return ggit.commits.afterLastTag().then(list => {
      debug('%d commit(s) after last tag', list.length)
      if (list.length < n) {
        return versionAndAllCommitsToLog(version, list)
      } else {
        return versionAndCommitsToLog(version, commits)
      }
    })
  })
}

module.exports = {
  formChangelog,
  versionAndCommitsToLog,
  versionAndAllCommitsToLog,
  allCommitsToString,
  commitsToString,
  groupCommits,
  groupParsedCommits,
  groupedToString
}