feat: add showSuccessMessage config option (#54)

Author: miszo

dangerfile.ts

@@ -1,3 +1,3 @@
 import jest from './dist'
 
-jest()
+jest({ showSuccessMessage: true })

src/__tests__/index.test.ts

@@ -27,13 +27,30 @@ beforeEach(() => {
   }
 })
 
-test('messages with passing test results', () => {
+test('no fails with passing test results', () => {
   jestResults({
     testResultsJsonPath: fixture('passing-tests.json'),
   })
   expect(global['fail']).not.toHaveBeenCalled()
 })
 
+test('passing test results with visible success message', () => {
+  jestResults({
+    testResultsJsonPath: fixture('passing-tests.json'),
+    showSuccessMessage: true,
+  })
+  expect(global['message']).toHaveBeenCalledWith(
+    expect.stringMatching(/Jest tests passed/)
+  )
+})
+
+test('passing test results without visible success message', () => {
+  jestResults({
+    testResultsJsonPath: fixture('passing-tests.json'),
+  })
+  expect(global['message']).not.toHaveBeenCalled()
+})
+
 test('fails with failing test results', () => {
   jestResults({
     testResultsJsonPath: fixture('failing-tests.json'),

src/index.ts

@@ -11,19 +11,23 @@ import {
 } from './types'
 declare var danger: DangerDSLType
 declare function fail(message?: string): void
+declare function message(message?: string): void
 
 export interface IPluginConfig {
   testResultsJsonPath: string
+  showSuccessMessage: boolean
 }
 
 export default function jest(config: Partial<IPluginConfig> = {}) {
-  const { testResultsJsonPath = 'test-results.json' } = config
+  const {
+    testResultsJsonPath = 'test-results.json',
+    showSuccessMessage = false,
+  } = config
   try {
     const jsonFileContents = fs.readFileSync(testResultsJsonPath, 'utf8')
     const jsonResults: IJestTestResults = JSON.parse(jsonFileContents)
     if (jsonResults.success) {
-      // tslint:disable-next-line:no-console
-      console.log('Jest tests passed :+1:')
+      jestSuccessFeedback(jsonResults, showSuccessMessage)
       return
     }
 
@@ -42,6 +46,20 @@ export default function jest(config: Partial<IPluginConfig> = {}) {
   }
 }
 
+const jestSuccessFeedback = (
+  jsonResults: IJestTestResults,
+  showSuccessMessage: boolean
+): void => {
+  if (!showSuccessMessage) {
+    // tslint:disable-next-line:no-console
+    console.log(':+1: Jest tests passed')
+  } else {
+    message(
+      `:+1: Jest tests passed: ${jsonResults.numPassedTests}/${jsonResults.numTotalTests} (${jsonResults.numPendingTests} skipped)`
+    )
+  }
+}
+
 const presentErrorsForOldStyleResults = (jsonResults: IJestTestOldResults) => {
   const failing = jsonResults.testResults.filter(tr => tr.status === 'failed')