From 8af22ae8780078c5a5de88d1e26a1655cc7b0616 Mon Sep 17 00:00:00 2001
From: John Lees-Miller <jdleesmiller@gmail.com>
Date: Fri, 15 May 2020 10:32:18 +0100
Subject: [PATCH] Improve assertion messages in test utility

---
 libraries/o-error/test/support/index.js | 51 ++++++++++++++++---------
 1 file changed, 33 insertions(+), 18 deletions(-)

diff --git a/libraries/o-error/test/support/index.js b/libraries/o-error/test/support/index.js
index afa90c003e..46dd49967b 100644
--- a/libraries/o-error/test/support/index.js
+++ b/libraries/o-error/test/support/index.js
@@ -3,36 +3,51 @@ const { expect } = require('chai')
 const OError = require('../..')
 
 exports.expectError = function OErrorExpectError(e, expected) {
-  // should set the name to the error's name
-  expect(e.name).to.equal(expected.name)
+  expect(
+    e.name,
+    "error should set the name property to the error's name"
+  ).to.equal(expected.name)
 
-  // should be an instance of the error type
-  expect(e instanceof expected.klass).to.be.true
+  expect(
+    e instanceof expected.klass,
+    'error should be an instance of the error type'
+  ).to.be.true
 
-  // should be an instance of the built-in Error type
-  expect(e instanceof Error).to.be.true
+  expect(
+    e instanceof Error,
+    'error should be an instance of the built-in Error type'
+  ).to.be.true
 
-  // should be recognised by util.isError
-  expect(require('util').types.isNativeError(e)).to.be.true
+  expect(
+    require('util').types.isNativeError(e),
+    'error should be recognised by util.types.isNativeError'
+  ).to.be.true
 
-  // should have a stack trace
-  expect(e.stack).to.be.truthy
+  expect(e.stack, 'error should have a stack trace').to.be.truthy
 
-  // toString should return the default error message formatting
-  expect(e.toString()).to.equal(expected.message)
+  expect(
+    e.toString(),
+    'toString should return the default error message formatting'
+  ).to.equal(expected.message)
 
-  // stack should start with the default error message formatting
-  expect(e.stack.split('\n')[0]).to.match(new RegExp(`^${expected.name}:`))
+  expect(
+    e.stack.split('\n')[0],
+    'stack should start with the default error message formatting'
+  ).to.match(new RegExp(`^${expected.name}:`))
 
-  // first stack frame should be the function where the error was thrown
-  expect(e.stack.split('\n')[1]).to.match(expected.firstFrameRx)
+  expect(
+    e.stack.split('\n')[1],
+    'first stack frame should be the function where the error was thrown'
+  ).to.match(expected.firstFrameRx)
 }
 
 exports.expectFullStackWithoutStackFramesToEqual = function (error, expected) {
-  // But the stack contains all of the errors and tags.
   const fullStack = OError.getFullStack(error)
   const fullStackWithoutFrames = fullStack
     .split('\n')
     .filter((line) => !/^\s+at\s/.test(line))
-  expect(fullStackWithoutFrames).to.deep.equal(expected)
+  expect(
+    fullStackWithoutFrames,
+    'full stack without frames should equal'
+  ).to.deep.equal(expected)
 }