refactor(format): it's only about comment right now

Author: z0al

lib/format.js

@@ -1,36 +1,7 @@
-/**
- * Formats commitlint report as GitHub status report
- *
- * @param {Object} report
- */
-function format({ commits }) {
-	// Keep errors/warnings count
-	let errorsCount = 0
-	let warnsCount = 0
-
-	// Details message
-	let message = ''
-
-	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
-	}
-
-	// Summary
-	const summary = `found ${errorsCount} problems, ${warnsCount} warnings`
-	if (errorsCount > 0 || warnsCount > 0) {
-		message = `
+const template = `
 There were the following issues with this Pull Request
 
-${message}
+<PLACEHOLDER>
 
 You may need to [change the commit messages][ref] to comply with the \
 repository contributing guidelines.
@@ -46,8 +17,22 @@ Happy coding!
 [repo]: https://github.com/ahmed-taj/commitlint-bot
 [issues]: https://github.com/ahmed-taj/commitlint-bot/issues
 `
-	}
-	return { summary, message }
+
+/**
+ * Formats array of commits warnings/errors as GitHub comment
+ *
+ * @param {Array} report
+ */
+function format(commits) {
+	let message = ''
+
+	commits.forEach(c => {
+		message += `* Commit: ${c.sha}\n`
+		message += c.errors.map(e => `  - ✖ ${e.message}`).join('\n')
+		message += c.warnings.map(w => `  - ⚠ ${w.message}`).join('\n')
+	})
+
+	return template.replace('<PLACEHOLDER>', message)
 }
 
 module.exports = format

test/format.test.js

@@ -1,47 +1,36 @@
-// Packages
-const expect = require('expect')
-
 // Ours
 const format = require('../lib/format')
 
-const values = [
+const commits = [
 	// #1
-	{ commits: {} },
-	// #2
-	{
-		commits: {
-			'1': { errors: [], warnings: [{ message: 'warning message' }] }
+	[
+		{
+			sha: 'abc',
+			errors: [],
+			warnings: [{ message: 'warning message' }]
 		}
-	},
-	// #3
-	{
-		commits: {
-			'2': {
-				errors: [{ message: 'error message' }],
-				warnings: [{ message: 'warning message' }]
-			}
+	],
+
+	// #2
+	[
+		{
+			sha: 'def',
+			errors: [{ message: 'error message' }],
+			warnings: [{ message: 'warning message' }]
 		}
-	}
+	]
 ]
 
-test('generates summary', () => {
-	// #1
-	expect(format(values[0]).summary).toEqual('found 0 problems, 0 warnings')
-	// #2
-	expect(format(values[1]).summary).toEqual('found 0 problems, 1 warnings')
-	// #3
-	expect(format(values[2]).summary).toEqual('found 1 problems, 1 warnings')
+test('repalces placeholder', () => {
+	expect(format(commits[0])).not.toMatch(/PLACEHOLDER/)
 })
 
 test('generates comment body', () => {
 	// #1
-	expect(format(values[0]).message).toEqual('')
-
+	expect(format(commits[0])).toMatch(/Commit: abc/)
+	expect(format(commits[0])).toMatch(/warning message/)
 	// #2
-	expect(format(values[1]).message).toMatch(/Commit: 1/)
-	expect(format(values[1]).message).toMatch(/warning message/)
-	// #3
-	expect(format(values[2]).message).toMatch(/Commit: 2/)
-	expect(format(values[2]).message).toMatch(/error message/)
-	expect(format(values[2]).message).toMatch(/warning message/)
+	expect(format(commits[1])).toMatch(/Commit: def/)
+	expect(format(commits[1])).toMatch(/error message/)
+	expect(format(commits[1])).toMatch(/warning message/)
 })