feat: add header field to output releases

Author: jedwards1211

src/changelog-parser.js

@@ -1,9 +1,10 @@
 // @flow
 
-const versionRx = `v?\\d+\\.\\d+(\\.\\d+(-[-a-z0-9.]+)?)?`
+const versionRx = `\\[?v?\\d+\\.\\d+(\\.\\d+(-[-a-z0-9.]+)?)?\\]?`
 
 export type Release = {
   version: string,
+  header: string,
   body?: string,
   date?: Date,
   error?: Error,
@@ -19,11 +20,14 @@ export default function parseChangelog(text: string): { [string]: Release } {
   let start = 0
   let release: ?Release
   while ((match = versionHeaderRx.exec(text))) {
-    // console.log(match)
-    let version = match[1] || match[5]
+    const rawVersion = match[1] || match[5]
+    let version = rawVersion.replace(/\[|\]/g, '')
     if (!match[2] && !match[6]) version += '.0'
     if (release) release.body = text.substring(start, match.index).trim()
-    release = { version }
+    release = {
+      version,
+      header: `${rawVersion}${match[4] || match[8] || ''}`.trim(),
+    }
     result[version] = release
     start = match.index + match[0].length
   }

src/index.js

@@ -86,7 +86,11 @@ export async function whatBroke(
     }
     prevVersion = version
 
-    const release: Release = { version, date: new Date(npmInfo.time[version]) }
+    const release: Release = {
+      version,
+      header: version,
+      date: new Date(npmInfo.time[version]),
+    }
     releases.push(release)
 
     const { url } =
@@ -99,14 +103,28 @@ export async function whatBroke(
       const { owner, repo } = parseRepositoryUrl(url)
 
       try {
-        release.body = (await octokit.repos.getReleaseByTag({
+        const body = (await octokit.repos.getReleaseByTag({
           owner,
           repo,
           tag: `v${version}`,
         })).data.body
+
+        release.body = body
+
+        const parsed = parseChangelog(body)
+        for (let v in parsed) {
+          if (v === version) {
+            const { header, body } = parsed[v]
+            release.header = header
+            release.body = body
+            break
+          }
+        }
       } catch (error) {
         const changelog = await getChangelog(owner, repo)
-        if (changelog[version]) release.body = changelog[version].body
+        const { header, body } = changelog[version] || {}
+        release.header = header
+        release.body = body
       }
       if (!release.body) {
         release.error = new Error(
@@ -143,8 +161,8 @@ if (!module.parent) {
   /* eslint-env node */
   whatBroke(pkg, { fromVersion, toVersion, full }).then(
     (changelog: Array<Release>) => {
-      for (const { version, body, error } of changelog) {
-        process.stdout.write(chalk.bold(version) + '\n\n')
+      for (const { header, body, error } of changelog) {
+        process.stdout.write(chalk.bold(`# ${header}`) + '\n\n')
         if (body) process.stdout.write(body + '\n\n')
         if (error) {
           process.stdout.write(`Failed to get changelog: ${error.stack}\n\n`)