Linkify commits - fixes sindresorhus#233 (sindresorhus#234)

Author: SamVerschueren

lib/ui.js

@@ -3,6 +3,7 @@ const execa = require('execa');
 const inquirer = require('inquirer');
 const pTap = require('p-tap');
 const chalk = require('chalk');
+const githubUrlFromGit = require('github-url-from-git');
 const util = require('./util');
 const version = require('./version');
 
@@ -30,6 +31,7 @@ function prettyVersionDiff(oldVersion, inc) {
 module.exports = options => {
 	const pkg = util.readPkg();
 	const oldVersion = pkg.version;
+	const repositoryUrl = githubUrlFromGit(pkg.repository.url);
 
 	console.log(`\nPublish a new version of ${chalk.bold.magenta(pkg.name)} ${chalk.dim(`(current: ${oldVersion})`)}\n`);
 
@@ -118,7 +120,10 @@ module.exports = options => {
 									.map(commit => {
 										const commitParts = commit.match(/^(.+)\s([a-f0-9]{7})$/);
 
-										return `- ${commitParts[1]}  ${chalk.dim(commitParts[2])}`;
+										const commitMessage = util.linkifyIssues(repositoryUrl, commitParts[1]);
+										const commitId = util.linkifyCommit(repositoryUrl, commitParts[2]);
+
+										return `- ${commitMessage}  ${commitId}`;
 									})
 									.join('\n');
 

lib/util.js

@@ -1,5 +1,8 @@
 'use strict';
 const readPkgUp = require('read-pkg-up');
+const issueRegex = require('issue-regex');
+const hyperlinker = require('hyperlinker');
+const supportsHyperlinks = require('supports-hyperlinks');
 
 exports.readPkg = () => {
 	const pkg = readPkgUp.sync().pkg;
@@ -10,3 +13,27 @@ exports.readPkg = () => {
 
 	return pkg;
 };
+
+exports.linkifyIssues = (url, message) => {
+	if (!supportsHyperlinks.stdout) {
+		return message;
+	}
+
+	return message.replace(issueRegex(), issue => {
+		const issuePart = issue.replace('#', '/issues/');
+
+		if (issue.startsWith('#')) {
+			return hyperlinker(issue, `${url}${issuePart}`);
+		}
+
+		return hyperlinker(issue, `https://github.com/${issuePart}`);
+	});
+};
+
+exports.linkifyCommit = (url, commit) => {
+	if (!supportsHyperlinks.stdout) {
+		return commit;
+	}
+
+	return hyperlinker(commit, `${url}/commit/${commit}`);
+};

package.json

@@ -9,7 +9,7 @@
     "node": ">=4"
   },
   "scripts": {
-    "test": "xo && ava"
+    "test": "xo && FORCE_HYPERLINK=1 ava"
   },
   "files": [
     "index.js",
@@ -32,8 +32,11 @@
     "chalk": "^2.3.0",
     "del": "^3.0.0",
     "execa": "^0.8.0",
+    "github-url-from-git": "^1.5.0",
     "has-yarn": "^1.0.0",
+    "hyperlinker": "^1.0.0",
     "inquirer": "^3.0.6",
+    "issue-regex": "^1.0.0",
     "listr": "^0.12.0",
     "listr-input": "^0.1.1",
     "log-symbols": "^2.1.0",
@@ -45,6 +48,7 @@
     "semver": "^5.2.0",
     "split": "^1.0.0",
     "stream-to-observable": "^0.2.0",
+    "supports-hyperlinks": "^1.0.1",
     "update-notifier": "^2.1.0"
   },
   "devDependencies": {

test/hyperlinks.js

@@ -0,0 +1,12 @@
+import test from 'ava';
+import m from '../lib/util';
+
+test('link issues', t => {
+	t.is(m.linkifyIssues('https://github.com/unicorn/rainbow', 'Commit message - fixes #4'), 'Commit message - fixes ]8;;https://github.com/unicorn/rainbow/issues/4#4]8;;');
+	t.is(m.linkifyIssues('https://github.com/unicorn/rainbow', 'Commit message - fixes #3 #4'), 'Commit message - fixes ]8;;https://github.com/unicorn/rainbow/issues/3#3]8;; ]8;;https://github.com/unicorn/rainbow/issues/4#4]8;;');
+	t.is(m.linkifyIssues('https://github.com/unicorn/rainbow', 'Commit message - fixes foo/bar#4'), 'Commit message - fixes ]8;;https://github.com/foo/bar/issues/4foo/bar#4]8;;');
+});
+
+test('link commit', t => {
+	t.is(m.linkifyCommit('https://github.com/unicorn/rainbow', '5063f8a'), ']8;;https://github.com/unicorn/rainbow/commit/5063f8a5063f8a]8;;');
+});