feat: add commit-plaintext changelog formatting

Author: codebytere

changelog-maker.js

@@ -10,26 +10,35 @@ const stripAnsi = require('strip-ansi')
 const pkgtoId = require('pkg-to-id')
 const commitStream = require('commit-stream')
 const gitexec = require('gitexec')
-const commitToOutput = require('./commit-to-output')
+const { commitToOutput, formatType } = require('./commit-to-output')
 const groupCommits = require('./group-commits')
 const collectCommitLabels = require('./collect-commit-labels')
-const { isReleaseCommit } = require('./groups')
+const { isReleaseCommit, toGroups } = require('./groups')
 const pkg = require('./package.json')
 const debug = require('debug')(pkg.name)
 const argv = require('minimist')(process.argv.slice(2))
 
 const quiet = argv.quiet || argv.q
-const simple = argv.simple || argv.s
 const help = argv.h || argv.help
 const commitUrl = argv['commit-url'] || 'https://github.com/{ghUser}/{ghRepo}/commit/{ref}'
 const pkgFile = path.join(process.cwd(), 'package.json')
 const pkgData = fs.existsSync(pkgFile) ? require(pkgFile) : {}
 const pkgId = pkgtoId(pkgData)
 
+const getFormat = () => {
+  if (argv.simple || argv.s) {
+    return formatType.SIMPLE
+  } else if (argv.plaintext || argv.p) {
+    return formatType.PLAINTEXT
+  }
+  return formatType.MARKDOWN
+}
+
 const ghId = {
   user: argv._[0] || pkgId.user || 'nodejs',
   repo: argv._[1] || (pkgId.name && stripScope(pkgId.name)) || 'node'
 }
+
 const gitcmd = 'git log --pretty=full --since="{{sincecmd}}" --until="{{untilcmd}}"'
 const commitdatecmd = '$(git show -s --format=%cd `{{refcmd}}`)'
 const untilcmd = ''
@@ -119,9 +128,26 @@ function onCommitList (err, list) {
       list = groupCommits(list)
     }
 
-    list = list.map((commit) => {
-      return commitToOutput(commit, simple, ghId, commitUrl)
-    })
+    const format = getFormat()
+    if (format === formatType.PLAINTEXT) {
+      const formatted = []
+
+      let currentGroup
+      for (const commit of list) {
+        const commitGroup = toGroups(commit.summary)
+        if (currentGroup !== commitGroup) {
+          formatted.push(`${commitGroup}:`)
+          currentGroup = commitGroup
+        }
+        formatted.push(commitToOutput(commit, formatType.PLAINTEXT, ghId, commitUrl))
+      }
+
+      list = formatted
+    } else {
+      list = list.map((commit) => {
+        return commitToOutput(commit, format, ghId, commitUrl)
+      })
+    }
 
     if (!quiet) {
       printCommits(list)

commit-to-output.js

@@ -9,6 +9,28 @@ function cleanMarkdown (txt) {
   return txt.replace(/([_~*\\[\]<>])/g, '\\$1')
 }
 
+const formatType = {
+  PLAINTEXT: 'plaintext',
+  MARKDOWN: 'markdown',
+  SIMPLE: 'simple'
+}
+
+function toStringPlaintext (data) {
+  let s = ''
+  s += (data.semver || []).length ? `(${data.semver.join(', ').toUpperCase()}) ` : ''
+
+  if (data.revert) {
+    s += `Revert "${data.group}: ${data.summary} `
+  } else {
+    s += `${data.summary} `
+  }
+
+  s += data.author ? `(${data.author}) ` : ''
+  s += data.pr ? data.prUrl : ''
+
+  return `  * ${s.trim()}`
+}
+
 function toStringSimple (data) {
   let s = ''
   s += `* [${data.sha.substr(0, 10)}] - `
@@ -47,7 +69,7 @@ function toStringMarkdown (data) {
       : s)
 }
 
-function commitToOutput (commit, simple, ghId, commitUrl) {
+function commitToOutput (commit, format, ghId, commitUrl) {
   const data = {}
   const prUrlMatch = commit.prUrl && commit.prUrl.match(/^https?:\/\/.+\/([^/]+\/[^/]+)\/\w+\/\d+$/i)
   const urlHash = `#${commit.ghIssue}` || commit.prUrl
@@ -63,7 +85,16 @@ function commitToOutput (commit, simple, ghId, commitUrl) {
   data.pr = prUrlMatch && ((prUrlMatch[1] !== `${ghId.user}/${ghId.repo}` ? prUrlMatch[1] : '') + urlHash)
   data.prUrl = prUrlMatch && commit.prUrl
 
-  return (simple ? toStringSimple : toStringMarkdown)(data)
+  if (format === formatType.SIMPLE) {
+    return toStringSimple(data)
+  } else if (format === formatType.PLAINTEXT) {
+    return toStringPlaintext(data)
+  }
+
+  return toStringMarkdown(data)
 }
 
-module.exports = commitToOutput
+module.exports = {
+  commitToOutput,
+  formatType
+}

group-commits.js

@@ -2,7 +2,7 @@
 
 const { toGroups } = require('./groups')
 
-function groupCommits (list) {
+function groupCommits (list, plaintext = false) {
   const groupList = list.reduce((groupList, commit) => {
     const group = toGroups(commit.summary) || '*'
 
@@ -14,9 +14,11 @@ function groupCommits (list) {
     return groupList
   }, {})
 
-  return Object.keys(groupList).sort().reduce((p, group) => {
+  const grouped = Object.keys(groupList).sort().reduce((p, group) => {
     return p.concat(groupList[group])
   }, [])
+
+  return grouped
 }
 
 module.exports = groupCommits

test.js

@@ -44,6 +44,16 @@ test('test simple', (t) => {
   t.end()
 })
 
+test('test plaintext', (t) => {
+  t.equal(exec('--start-ref=9c700d2 --end-ref=dd937e9 --group --filter-release --plaintext'),
+    `feature:
+  * refactor and improve --commit-url (Rod Vagg)
+test:
+  * update refs for testing (Rod Vagg)
+`)
+  t.end()
+})
+
 test('test group, semver labels, PR-URL', (t) => {
   t.equal(exec('--start-ref=v2.2.7 --end-ref=9c700d29 --group --filter-release --simple'),
     `* [cc442b6534] - (SEMVER-MINOR) minor nit (Rod Vagg) https://github.com/nodejs/node/pull/23715