fix(reporter): Use multiline strings to escape YAML #77
Conversation
| level = level + 1 | ||
| m.printExtras(extra[item], level) | ||
| if extra[item]._roca_isMultilineString = true |
There was a problem hiding this comment.
🤔 where does this get set? I can't find it 🔎
There was a problem hiding this comment.
There was a problem hiding this comment.
it's a little funky... but i'm not sure how else to render multiline in only these scenarios
There was a problem hiding this comment.
👓 I swear I command-f'd for that 🤦
There was a problem hiding this comment.
although we could always render every string as multiline? the raw YAML output would just be harder to read.
There was a problem hiding this comment.
although we could always render every string as multiline? the raw YAML output would just be harder to read.
That's certainly an option. I'm fine with either!
| @@ -0,0 +1,7 @@ | |||
| ' Initializes a tap instance and prints out the plan. | |||
There was a problem hiding this comment.
This fixes a previous bug I just noticed. When I converted roca_main to TS, I put tap.brs in executable script format, instead of pulling it into the execution scope, because I thought that it only self-referenced.
But, I missed the roca.log() function, that also uses tap.brs. So now, the executable part is still run (this file), but the Tap object and function definitions are pulled into scope.
There was a problem hiding this comment.
The reason I'm fixing here is because roca.log() uses the printExtras function that this PR modifies.
Summary
Closes #72. This converts all of our expected/actual values to be YAML multiline strings, which has the effect of escaping any YAML special characters that may appear in strings/variable names.
Also, converting everything to a string ensures that
tap-mocha-reporteralways shows an error diff -- it does not print any diff output if the types of expected vs. actual are not the same.This also fixes a bug where
roca.log("message")was not working due to a reference error.