feat: write an issue comment with the details

Author: z0al

Diff for: lib/format.js

@@ -1,24 +1,37 @@
 /**
  * Formats commitlint report as GitHub status report
  * 
- * @param {*} report 
+ * @param {Object} report 
  */
 const format = report => {
-	const { errors, warnings } = report
+	const { commits } = report
 
-	// Summary
-	let message = `found ${errors.length} problems, ${warnings.length} warnings`
+	// Keep errors/warnings count
+	let errorsCount = 0
+	let warnsCount = 0
+
+	// Details message
+	let message = ''
 
-	// TODO: write PR comment instead of multi-line description
-	// // Errors
-	// if (errors.length > 0) {
-	// 	message += '\n' + errors.map(e => '✖ ' + e.message).join('\n')
-	// }
-	// // Warnings
-	// if (warnings.length > 0) {
-	// 	message += '\n' + warnings.map(e => '⚠ ' + e.message).join('\n')
-	// }
+	for (const commit in commits) {
+		message += `* Commit: ${commit}\n`
+		const { errors, warnings } = commits[commit]
+		for (const e of errors) {
+			message += `  - ✖ ${e.message}\n`
+		}
+		for (const w of warnings) {
+			message += `  - ⚠ ${w.message}\n`
+		}
+		errorsCount += errors.length
+		warnsCount += warnings.length
+	}
 
-	return message
+	// Summary
+	const summary = `found ${errorsCount} problems, ${warnsCount} warnings`
+	if (errorsCount > 0 || warnsCount > 0) {
+		message = `There were the following issues with this Pull Request\n${message}`
+	}
+	return { summary, message }
 }
+
 module.exports = format

Diff for: lib/lint.js

@@ -22,7 +22,7 @@ const commitlint = async ({ github, payload }) => {
 	}
 
 	// Pending
-	github.repos.createStatus({
+	await github.repos.createStatus({
 		...statusInfo,
 		state: 'pending',
 		description: 'Waiting for the status to be reported'
@@ -33,25 +33,38 @@ const commitlint = async ({ github, payload }) => {
 		github.pullRequests.getCommits({ repo: name, owner: owner.login, number }),
 		async commits => {
 			// empty summary
-			const report = { valid: true, errors: [], warnings: [] }
+			const report = { valid: true, commits: {} }
 			const { rules } = await load(config)
 
-			// Iterate over all commits
+			// Iterates over all commits
 			for (const d of commits.data) {
-				const rep = await lint(d.commit.message, rules)
-				if (!rep.valid) {
+				const { valid, errors, warnings } = await lint(d.commit.message, rules)
+				if (!valid) {
 					report.valid = false
 				}
-				report.errors = report.errors.concat(rep.errors)
-				report.warnings = report.errors.concat(rep.warnings)
+
+				if (errors.length > 0 || warnings.length > 0) {
+					report.commits[d.sha] = { errors, warnings }
+				}
 			}
 
-			// Final report
-			github.repos.createStatus({
+			const { summary, message } = format(report)
+
+			// Final status
+			await github.repos.createStatus({
 				...statusInfo,
 				state: report.valid ? 'success' : 'error',
-				description: format(report)
+				description: summary
 			})
+			// Write a comment with the details (if any)
+			if (message) {
+				await github.issues.createComment({
+					repo: name,
+					owner: owner.login,
+					number,
+					body: message
+				})
+			}
 		}
 	)
 }

Diff for: test/bot.test.js

@@ -30,7 +30,7 @@ describe('commitlint-bot', () => {
 		robot.auth = () => Promise.resolve(github)
 	})
 
-	describe('updates status to pending', () => {
+	describe('status update to pending', () => {
 		const pending = {
 			...baseStatus,
 			state: 'pending',
@@ -48,7 +48,7 @@ describe('commitlint-bot', () => {
 		})
 	})
 
-	describe('gets the list of commits for PRs', () => {
+	describe('fetching the list of commits', () => {
 		const info = { repo: 'repo', owner: 'user', number: 1 }
 
 		it('works with new PRs', async () => {
@@ -61,4 +61,40 @@ describe('commitlint-bot', () => {
 			expect(github.pullRequests.getCommits).toHaveBeenCalledWith(info)
 		})
 	})
+
+	describe('no comment when no errors/warnings', () => {
+		it('works with new PRs', async () => {
+			github = githubMock(['fix: bug #1'])
+			robot.auth = () => Promise.resolve(github)
+
+			await robot.receive(events.opened)
+			expect(github.issues.createComment).toNotHaveBeenCalled()
+		})
+
+		it('works with updated PRs', async () => {
+			github = githubMock(['fix: bug #1'])
+			robot.auth = () => Promise.resolve(github)
+
+			await robot.receive(events.synchronize)
+			expect(github.issues.createComment).toNotHaveBeenCalled()
+		})
+	})
+
+	// describe('write comment on errors/warnings', () => {
+	// 	it('works with new PRs', async () => {
+	// 		github = githubMock(['fix: bug #1'])
+	// 		robot.auth = () => Promise.resolve(github)
+
+	// 		await robot.receive(events.opened)
+	// 		expect(github.issues.createComment).toHaveBeenCalled()
+	// 	})
+
+	// 	it('works with updated PRs', async () => {
+	// 		github = githubMock(['fix: bug #1'])
+	// 		robot.auth = () => Promise.resolve(github)
+
+	// 		await robot.receive(events.synchronize)
+	// 		expect(github.issues.createComment).toHaveBeenCalled()
+	// 	})
+	// })
 })

Diff for: test/format.test.js

@@ -0,0 +1,43 @@
+// Packages
+const expect = require('expect')
+
+// Ours
+const format = require('../lib/format')
+
+describe('lib/format', () => {
+	const report1 = { commits: {} }
+	const report2 = {
+		commits: {
+			'1': { errors: [], warnings: [{ message: 'warning message' }] }
+		}
+	}
+	const report3 = {
+		commits: {
+			'2': {
+				errors: [{ message: 'error message' }],
+				warnings: [{ message: 'warning message' }]
+			}
+		}
+	}
+
+	it('generates summary', () => {
+		// Report 1
+		expect(format(report1).summary).toEqual('found 0 problems, 0 warnings')
+		// Report 2
+		expect(format(report2).summary).toEqual('found 0 problems, 1 warnings')
+		// Report 3
+		expect(format(report3).summary).toEqual('found 1 problems, 1 warnings')
+	})
+
+	it('generates comment body', () => {
+		// Report 1
+		expect(format(report1).message).toEqual('')
+		// Report 2
+		expect(format(report2).message).toMatch(/Commit: 1/)
+		expect(format(report2).message).toMatch(/warning message/)
+		// Report 3
+		expect(format(report3).message).toMatch(/Commit: 2/)
+		expect(format(report3).message).toMatch(/error message/)
+		expect(format(report3).message).toMatch(/warning message/)
+	})
+})

Diff for: test/mocks/github.js

@@ -2,17 +2,22 @@
 const expect = require('expect')
 
 // Mock necessary GitHub APIs here
-module.exports = (data = ['fix: issue #1']) => {
+module.exports = (data = []) => {
 	return {
+		issues: {
+			createComment: expect.createSpy()
+		},
 		repos: {
 			createStatus: expect.createSpy()
 		},
 		pullRequests: {
-			getCommits: expect.createSpy().andReturn({
-				data: data.map(e => {
-					return { commit: { message: e } }
+			getCommits: expect.createSpy().andReturn(
+				Promise.resolve({
+					data: data.map(e => {
+						return { sha: 'abcd', commit: { message: e } }
+					})
 				})
-			})
+			)
 		},
 		paginate: async (fn, callback) => {
 			callback(await fn)