conventional-changelog-atomix/writer-opts.js

conventional-changelog atomix preset

const compareFunc = require('compare-func')
const Q = require('q')
const readFile = Q.denodeify(require('fs').readFile)
const { resolve } = require('path')


function getWriterOpts() {
  return {
    transform: (commit, context) => {
      // let discard = true;
      const issues = []

      // commit.notes.forEach(note => {
      //   note.title = `BREAKING CHANGES`;
      //   // discard = false;
      // });

      if (/^v?\d+\.\d+\.\d+/.test(commit.header)) {
        return undefined
      }

      if (commit.type === 'feat') {
        commit.type = 'Features'
      }
      else if (commit.type === 'fix') {
        commit.type = 'Bug Fixes'
      }
      else if (commit.type === 'perf') {
        commit.type = 'Performance Improvements'
      }
      else if (commit.type === 'revert') {
        commit.type = 'Reverts'
      // } else if (discard) {
      //   return;
      }
      else if (commit.type === 'docs') {
        commit.type = 'Documentation'
      }
      else if (commit.type === 'style') {
        commit.type = 'Styles'
      }
      else if (commit.type === 'refactor') {
        commit.type = 'Code Refactoring'
      }
      else if (commit.type === 'test') {
        commit.type = 'Tests'
      }
      else if (commit.type === 'chore') {
        commit.type = 'Chores'
      }
      else if (commit.type === 'build') {
        commit.type = 'Build system'
      }

      if (commit.scope === '*') {
        commit.scope = ''
      }

      if (typeof commit.hash === 'string') {
        commit.hash = commit.hash.substring(0, 7) // eslint-disable-line no-magic-numbers
      }

      if (typeof commit.subject === 'string') {
        let url = context.repository
          ? `${context.host}/${context.owner}/${context.repository}`
          : context.repoUrl

        if (url) {
          url = `${url}/issues/`
          // Issue URLs.
          commit.subject = commit.subject.replace(/#(\d+)/g, (_, issue) => {
            issues.push(issue)
            return `[#${issue}](${url}${issue})`
          })
        }
        if (context.host) {
          // User URLs.
          commit.subject = commit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9]){0,38})/g, `[@$1](${context.host}/$1)`)
        }

        commit.subject = commit.subject.replace(/\<+/g, '&lt;').replace(/\>+/g, '&gt;')
      }

      if (typeof commit.header === 'string') {
        commit.header = commit.header.replace(/\<+/g, '&lt;').replace(/\>+/g, '&gt;')
      }


      // remove references that already appear in the subject
      commit.references = commit.references.filter((reference) => {
        if (issues.indexOf(reference.issue) === -1) {
          return true
        }

        return false
      })

      return commit
    },
    groupBy: 'type',
    commitGroupsSort: 'title',
    commitsSort: ['scope', 'subject'],
    noteGroupsSort: 'title',
    notesSort: compareFunc,
  }
}


module.exports = Q.all([
  readFile(resolve(__dirname, './templates/template.hbs'), 'utf-8'),
  readFile(resolve(__dirname, './templates/header.hbs'), 'utf-8'),
  readFile(resolve(__dirname, './templates/commit.hbs'), 'utf-8'),
  readFile(resolve(__dirname, './templates/footer.hbs'), 'utf-8'),
])
  .spread((template, header, commit, footer) => {
    const writerOpts = getWriterOpts()

    writerOpts.mainTemplate = template
    writerOpts.headerPartial = header
    writerOpts.commitPartial = commit
    writerOpts.footerPartial = footer

    return writerOpts
  })