refactor(changelog): change version headline

lib/commands/changelog.js

@@ -38,22 +38,18 @@ const getPendingChanges = require('../steps/pending-changes');
 
 const generateChangeLog = require('../steps/changelog');
 
-async function showChangelog(cwd, pkg, options) {
-  function ensureVersionTag() {
-    return ensureTag(cwd, `v${pkg.version}`);
-  }
-
-  function runTask(task) {
-    return task(cwd, pkg, options);
-  }
+function ensureVersionTag(cwd, pkg) {
+  return ensureTag(cwd, `v${pkg.version}`);
+}
 
+async function showChangelog(cwd, pkg, options) {
   function printChangelog() {
     process.stdout.write(`${options.changelog}\n`);
   }
 
-  const tasks = [ensureVersionTag, getPendingChanges, generateChangeLog];
-
-  for (const task of tasks) await runTask(task);
+  for (const task of [ensureVersionTag, getPendingChanges, generateChangeLog]) {
+    await task(cwd, pkg, options);
+  }
 
   return printChangelog();
 }

lib/commands/release.js

@@ -84,10 +84,6 @@ function release(cwd, pkg, options) {
     publishToNpm,
   ];
 
-  function runTask(task) {
-    return task(cwd, pkg, options);
-  }
-
   async function runPublishTasks() {
     if (options.pr) {
       debug('Never publishing from a PR');
@@ -109,7 +105,9 @@ function release(cwd, pkg, options) {
       publishTasks = [publishToNpm];
     }
 
-    for (const task of publishTasks) await runTask(task);
+    for (const task of publishTasks) {
+      await task(cwd, pkg, options);
+    }
 
     return null;
   }

lib/git/commits.js

@@ -86,6 +86,11 @@ function parseCommit(commit) {
   return { ...data, sha: sha || data.sha, parentSha };
 }
 
+/**
+ *
+ * @param {{type: string, header: string}} commit
+ * @return {*|boolean}
+ */
 function isNotRandomMerge(commit) {
   // DotCI adds these :(
   return commit.type || `${commit.header}`.indexOf('Merge ') !== 0;
@@ -111,6 +116,10 @@ function gracefulEmptyState(error) {
   throw error;
 }
 
+/**
+ * @param {string} fromRevision
+ * @return {string|*[]}
+ */
 function createRange(fromRevision) {
   if (fromRevision && fromRevision !== 'v0.0.0') {
     return `${fromRevision}..HEAD`;
@@ -119,15 +128,13 @@ function createRange(fromRevision) {
   return [];
 }
 
-function getCommits(directory, fromRevision) {
+function getCommits(cwd, fromRevision) {
   return run(
     'git',
     ['log', '--reverse', '--topo-order', GIT_LOG_FORMAT].concat(
       createRange(fromRevision)
     ),
-    {
-      cwd: directory,
-    }
+    { cwd }
   ).then(parseLogOutput, gracefulEmptyState);
 }
 

lib/steps/changelog.js

@@ -192,22 +192,28 @@ ${changelog}`;
    */
 
   function formatCommits(orphans) {
+    const orphansCommits = orphans.map(formatCommit);
     const changes = prs
       .map(formatPR)
-      .concat(orphans.map(formatCommit))
+      .concat(orphansCommits)
       .map(line => {
         return `* ${line}`;
       });
     return changes.join('\n');
   }
 
-  for (const pr of prs) await addPullRequestCommits(pkg, commits, pr);
+  for (const pr of prs) {
+    await addPullRequestCommits(pkg, commits, pr);
+  }
 
   removeInvalidPRs(prs);
+
   let changelog = removePRCommits(commits, prs);
   changelog = formatCommits(changelog);
   changelog = prependBreakingChanges(changelog);
+
   options.changelog = changelog;
+
   return changelog;
 }
 

lib/steps/pending-changes.js

@@ -86,11 +86,11 @@ function normalizeReferences(meta, commit) {
   return commit;
 }
 
-function getPendingChanges(cwd, pkg, options) {
+async function getPendingChanges(cwd, pkg, options) {
   const meta = parseRepository(pkg.repository);
-  return getCommits(cwd, `v${pkg.version}`).then(commits => {
-    options.commits = commits.map(normalizeReferences.bind(null, meta));
-  });
+  const commits = await getCommits(cwd, `v${pkg.version}`);
+
+  options.commits = commits.map(normalizeReferences.bind(null, meta));
 }
 
 module.exports = getPendingChanges;

lib/steps/version-commit.js

@@ -103,15 +103,18 @@ function createVersionCommit(cwd, pkg, options) {
     changeLogContent = '';
   }
 
-  changeLogContent = `### ${options.nextVersion} - ${getCurrentDate()}\n\n${
+  changeLogContent = `### v${options.nextVersion} (${getCurrentDate()})\n\n${
     options.changelog
   }${changeLogContent}`;
   fs.writeFileSync(changeLogFile, `${changeLogContent.trim()}\n`);
+
   const packageJsonFile = path.join(cwd, 'package.json');
   pkg.version = options.nextVersion;
   fs.writeFileSync(packageJsonFile, `${JSON.stringify(pkg, null, 2)}\n`);
+
   const files = ['CHANGELOG.md', 'package.json'];
   updatePackageLockVersion(cwd, pkg.version, files);
+
   return addFiles(cwd, files)
     .then(commit.bind(null, cwd, `v${pkg.version}`))
     .then(getHEAD.bind(null, cwd))

package.json

@@ -38,7 +38,7 @@
     "conventional-commits-parser": "^3.1.0",
     "debug": "^4.2.0",
     "glob": "^7.1.6",
-    "gofer": "^5.0.3",
+    "gofer": "^5.0.4",
     "minimist": "^1.2.5",
     "rc": "^1.2.8",
     "semver": "^7.3.2"

test/git/commits.test.js

@@ -151,6 +151,7 @@ describe('getCommits', () => {
       assertIssue('Jira', expected);
     });
   });
+
   describe('with multiple commits', () => {
     const dirname = withFixture('multiple-commits');
     let allCommits = null;

test/steps/version-commit.test.js

@@ -66,9 +66,11 @@ describe('createVersionCommit', () => {
 
   before(resetVars);
   afterEach(resetVars);
+
   describe('with no package-lock.json', () => {
     const dirname = withFixture('multiple-commits');
     let currentDate;
+
     before('commits with the original author', done => {
       execFile('git', ['show'], { cwd: dirname }, (err, stdout) => {
         if (err) return done(err);
@@ -98,7 +100,7 @@ describe('createVersionCommit', () => {
         .readFileSync(`${dirname}/CHANGELOG.md`, 'utf8')
         .split('\n');
 
-      assert.strictEqual(version, `### 1.0.0 - ${currentDate}`);
+      assert.strictEqual(version, `### v1.0.0 (${currentDate})`);
       assert.strictEqual(commit1, '* New stuff');
       assert.strictEqual(commit2, '* Interesting features');
     });
@@ -112,6 +114,7 @@ describe('createVersionCommit', () => {
       });
     });
   });
+
   describe('using package-lock.json', () => {
     const dirname = withFixture('with-plock');
 
@@ -136,6 +139,7 @@ describe('createVersionCommit', () => {
 
   describe('with unused package-lock.json', () => {
     const dirname = withFixture('with-bogus-plock');
+
     before('create version commit', () =>
       createVersionCommit(dirname, pkg, options)
     );