Merge pull request #36 from dhershman1/development

Development  v4.2.0

Author: dhershman1

.github/ISSUE_TEMPLATE/bug_report.md

@@ -28,7 +28,7 @@ If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
  - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
+ - Node Version: [e.g. 14]
  - Version [e.g. 22]
 
 **Additional context**

README.md

@@ -8,10 +8,6 @@ Silly small, silly easy junit output formatter for tap.
 
 Works with [tape](https://github.com/substack/tape) and other tap based tests just pipe it into tap-junit
 
-## Changelog
-
-You can checkout the changelog at: https://github.com/dhershman1/tap-junit/blob/master/changelog.md
-
 ## Parameters
 
 - `-c, --classname` - The name you want to apply to the `testsuite` element (if not set no name is given to the output testsuite)

changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v4.2.0
+
+### Improved
+
+- Made the error diag more dynamic to handle different types of outputs instead of static and expecting
+
 ## v4.1.0
 
 ### New

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tap-junit",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Silly small, silly easy junit output formatter for tap.",
   "main": "src/index.js",
   "bin": {
@@ -10,6 +10,7 @@
     "prepack": "npm run lint",
     "clear": "rimraf output/**",
     "test": "tape tests/pass.js | cross-env bin/tap-junit -o output/test -n pass -s suite-name -p",
+    "ava": "bin/tap-junit --output output --name ava.xml --suite ava --input tests/ava.tap -p",
     "test:input": "cross-env bin/tap-junit --output output --name api.xuni --suite api-test --input tests/non-tape.tap",
     "test:zero": "tape tests/pass.js | cross-env bin/tap-junit > output/pass-zero.xml",
     "test:nontape": "cross-env bin/tap-junit --output output/test --name nontape.xml < tests/non-tape.tap",

src/serialize.js

@@ -1,20 +1,16 @@
 const { EOL } = require('os')
 const { create } = require('xmlbuilder2')
 
-function buildDetails (data) {
-  if (!data) {
-    return ''
-  }
-
-  let str = '\n---\n'
-
-  for (const key in data) {
-    str += `${key}: ${data[key]}\n`
-  }
-
-  str += '---\n'
+function formatDiag (diag) {
+  return Object.entries(diag).reduce((acc, [key, value]) => {
+    if (typeof value === 'object') {
+      acc.push(`${key}: \n  ${formatDiag(value)}`)
+    } else {
+      acc.push(`${key}: ${value.replace(/\n/g, ' ')}`)
+    }
 
-  return str
+    return acc
+  }, []).join('\n')
 }
 
 /**
@@ -50,7 +46,11 @@ function buildFailureParams (fail, comment) {
   if (fail.diag) {
     failObj['@message'] = fail.diag.message
     failObj['@type'] = fail.diag.severity || 'fail'
-    failObj['#'] = fail.todo ? `${fail.todo}\n ${comment}` : `${buildDetails(fail.diag.data)} ${comment}`
+    failObj['#'] = fail.todo ? `${fail.todo}\n ${comment}` : `
+    ---
+    ${formatDiag(fail.diag)}
+    ...
+    ${comment}`
   } else {
     failObj['#'] = `\n${comment}`
   }

tests/ava.tap

@@ -0,0 +1,16 @@
+TAP version 13
+not ok 1 - 2+2=4
+  ---
+    name: AssertionError
+    assertion: is
+    values:
+      'Difference:': |-
+        - 4
+        + 5
+    at: 'test.js:4:4'
+  ...
+
+1..1
+# tests 1
+# pass 0
+# fail 1