changed-log/src/get-commits-from-tags.js

Returns all commit messages between 2 versions of an NPM module

var la = require('lazy-ass')
var check = require('check-more-types')
var utils = require('./utils')
var _ = require('lodash')
var R = require('ramda')
var Promise = require('bluebird')

/* eslint no-console:0 */
var log = console.log.bind(console)
var reposApi = utils.github.repos
var gTags = Promise.promisify(reposApi.getTags)
var debug = require('debug')('tags')

function nameAndSha (tags) {
  if (check.array(tags)) {
    return _.map(tags, nameAndSha)
  }
  return {
    name: tags.name,
    sha: tags.commit.sha
  }
}

function trimVersions (tags) {
  return tags.map(function (tag) {
    tag.name = utils.trimVersion(tag.name)
    return tag
  })
}

function getTags (options) {
  la(check.object(options), 'missing options', options)
  utils.verifyRepoOptions(options)

  var messageOptions = _.clone(options)
  if (utils.github.twoFactor) {
    messageOptions.headers = {
      'X-GitHub-OTP': utils.github.twoFactor
    }
  }

  return gTags(messageOptions)
    .tap(check.array)
    .then(nameAndSha)
    .then(trimVersions)
}

var isLatest = check.schema({
  from: check.equal('latest')
})

function getLatestTag (question) {
  la(isLatest(question), 'wrong latest schema', question)
  return getTags(_.pick(question, 'user', 'repo'))
    .then(function (allTags) {
      la(check.array(allTags), 'missing tags', allTags)
      // assuming the tags are sorted, with latest the first
      return {
        latest: allTags[0]
      }
    })
}

const justTagNames = R.map(R.prop('name'))

function getFromToTags (question) {
  if (isLatest(question)) {
    return getLatestTag(question)
  }

  var tagSchema = {
    from: check.unemptyString,
    to: check.unemptyString
  }
  la(check.schema(tagSchema, question), question)

  return getTags(_.pick(question, 'user', 'repo'))
    .then(function (allTags) {
      la(check.array(allTags), 'missing tags', allTags)
      var fromTagIndex = _.findIndex(allTags, 'name', question.from)
      if (fromTagIndex === -1) {
        const msg = 'Cannot find "from" tag ' + question.from
        const fullMsg = msg + '\navailable tags ' +
          justTagNames(allTags).join(', ')
        return Promise.reject(new Error(fullMsg))
      }

      la(fromTagIndex !== -1, 'cannot find tag', question.from, 'all tags', allTags)

      var toTagIndex = question.to === 'latest' ? 0
        : _.findIndex(allTags, 'name', question.to)
      if (toTagIndex === -1) {
        const msg = 'Cannot find "to" tag with value "' + question.to + '"'
        const fullMsg = msg + '\navailable tags ' +
          justTagNames(allTags).join(', ')
        return Promise.reject(new Error(fullMsg))
      }
      la(toTagIndex !== -1, 'cannot to tag', question.to, 'all tags', allTags)

      debug('from tag %s index %d to tag %s index %d',
        question.from, fromTagIndex,
        question.to, toTagIndex)

      if (fromTagIndex < toTagIndex) {
        debug('flipping the tag order')
        var tmp = fromTagIndex
        fromTagIndex = toTagIndex
        toTagIndex = tmp

        tmp = question.from
        question.from = question.to
        question.to = tmp
      }

      var fromTag = allTags[fromTagIndex]
      var toTag = allTags[toTagIndex]

      return {
        fromTag: fromTag,
        toTag: toTag,
        allTags: allTags
      }
    })
}

module.exports = getFromToTags

if (!module.parent) {
  (function examples () {
    /* eslint no-unused-vars:0 */
    function nextUpdateExample () {
      var question = {
        user: 'bahmutov',
        repo: 'next-update',
        from: '0.8.0',
        to: '0.8.2' // or 'latest?'
      }

      log('Getting commit SHA for the given tags')
      log(question)
      getFromToTags(question)
        .then(log)
    }

    function nextUpdateReverseTagOrderExample () {
      var question = {
        user: 'bahmutov',
        repo: 'next-update',
        from: '0.8.2',
        to: '0.8.0'
      }

      log('Getting commit SHA for the given tags')
      log(question)
      getFromToTags(question)
        .then(log)
    }

    function chalkExample () {
      var question = {
        user: 'chalk',
        repo: 'chalk',
        from: '0.5.1',
        to: '0.3.0'
      }

      log('Getting commit SHA for the given tags')
      log('%s / %s from %s to %s',
        question.user, question.repo, question.from, question.to)
      getFromToTags(question)
        .then(log)
    }

    function fromLatestChalkExample () {
      var question = {
        user: 'chalk',
        repo: 'chalk',
        from: 'latest'
      }

      log('Getting commit SHA for the given tags')
      log('%s / %s from latest tag', question.user, question.repo)
      getFromToTags(question)
        .then(log)
    }

    function getLatestTagExample () {
      var question = {
        user: 'chalk',
        repo: 'chalk',
        from: 'latest'
      }
      getLatestTag(question).then(log).done()
    }

    // chalkExample();
    // nextUpdateReverseTagOrderExample();
    fromLatestChalkExample()
    // getLatestTagExample();
  }())
}