Jeff Williams d09b14ddc3
fix(jsdoc-test-matchers): replace HTML formatter
If you have two HTML fragments, f1 and f2, and both fragments contain `<h2>text</h2>`, diffable-html arbitrarily adds and removes whitespace within the `<h2>` based on the surrounding context. That makes it useless for our purposes.

Prettier's behavior appears to be much more consistent.
2023-01-07 08:29:16 -08:00

88 lines
2.5 KiB
JavaScript

const _ = require('lodash');
const { addMatchers } = require('add-matchers');
const { format } = require('prettier');
function formatHtml(str) {
return format(str, {
parser: 'html',
tabWidth: 2,
});
}
// Prettier lazy-loads its parsers, so preload the HTML parser while we know we're not mocked.
require('prettier/parser-html');
// Add matchers from https://github.com/JamieMason/Jasmine-Matchers.
require('jasmine-expect');
addMatchers({
toBeError(value) {
return value instanceof Error;
},
toBeErrorOfType(other, value) {
return value instanceof Error && value.name === other;
},
toBeInstanceOf(other, value) {
let otherName;
let valueName;
if (typeof value !== 'object') {
throw new TypeError(`Expected object value, got ${typeof value}`);
}
valueName = value.constructor.name;
if (typeof other === 'string') {
// Class name.
otherName = other;
} else if (typeof other === 'function') {
// Class constructor.
otherName = other.name;
} else {
otherName = other.constructor.name;
}
return valueName === otherName;
},
toContainHtml(other, value) {
const otherDiffable = formatHtml(other);
const valueDiffable = formatHtml(value);
return valueDiffable.includes(otherDiffable);
},
toHaveOwnProperty(other, value) {
return Object.hasOwn(value, other);
},
// The objects in `value` must have all of the keys and values from the corresponding objects in
// `other`. The object in `value` can have additional properties as well. For example, if
// `other[0]` is `{ a: 1 }`, and `value[0]` is `{ a: 1, b: 2 }`, then the objects match.
toMatchArrayOfObjects(other, value) {
let isMatch = true;
if (!Array.isArray(value)) {
throw new TypeError(`Expected array value, got ${typeof value}`);
}
if (!Array.isArray(other)) {
throw new TypeError(`Expected array value as expected value, got ${typeof other}`);
}
if (other.length !== value.length) {
isMatch = false;
} else {
for (let i = 0, l = value.length; i < l; i++) {
if (!_.isMatch(value[i], other[i])) {
isMatch = false;
break;
}
}
}
return isMatch;
},
// The `value` object must have all of the keys and values from the `other` object. The `value`
// object can have additional properties as well. For example, if `other` is `{ a: 1 }`, and
// `value` is `{ a: 1, b: 2 }`, then the objects match.
toMatchObject(other, value) {
return _.isMatch(value, other);
},
});