How to use inspectSymbol method in chai

1var hasMap = typeof Map === 'function' && Map.prototype;2var mapSizeDescriptor = Object.getOwnPropertyDescriptor && hasMap ? Object.getOwnPropertyDescriptor(Map.prototype, 'size') : null;3var mapSize = hasMap && mapSizeDescriptor && typeof mapSizeDescriptor.get === 'function' ? mapSizeDescriptor.get : null;4var mapForEach = hasMap && Map.prototype.forEach;5var hasSet = typeof Set === 'function' && Set.prototype;6var setSizeDescriptor = Object.getOwnPropertyDescriptor && hasSet ? Object.getOwnPropertyDescriptor(Set.prototype, 'size') : null;7var setSize = hasSet && setSizeDescriptor && typeof setSizeDescriptor.get === 'function' ? setSizeDescriptor.get : null;8var setForEach = hasSet && Set.prototype.forEach;9var booleanValueOf = Boolean.prototype.valueOf;10var objectToString = Object.prototype.toString;11var bigIntValueOf = typeof BigInt === 'function' ? BigInt.prototype.valueOf : null;12var inspectCustom = require('./util.inspect').custom;13var inspectSymbol = (inspectCustom && isSymbol(inspectCustom)) ? inspectCustom : null;14module.exports = function inspect_ (obj, opts, depth, seen) {15    if (!opts) opts = {};16    if (has(opts, 'quoteStyle') && (opts.quoteStyle !== 'single' && opts.quoteStyle !== 'double')) {17        throw new TypeError('option "quoteStyle" must be "single" or "double"');18    }19    if (typeof obj === 'undefined') {20        return 'undefined';21    }22    if (obj === null) {23        return 'null';24    }25    if (typeof obj === 'boolean') {26        return obj ? 'true' : 'false';27    }28    if (typeof obj === 'string') {29        return inspectString(obj, opts);30    }31    if (typeof obj === 'number') {32      if (obj === 0) {33        return Infinity / obj > 0 ? '0' : '-0';34      }35      return String(obj);36    }37    if (typeof obj === 'bigint') {38      return String(obj) + 'n';39    }40    var maxDepth = typeof opts.depth === 'undefined' ? 5 : opts.depth;41    if (typeof depth === 'undefined') depth = 0;42    if (depth >= maxDepth && maxDepth > 0 && typeof obj === 'object') {43        return '[Object]';44    }45    if (typeof seen === 'undefined') seen = [];46    else if (indexOf(seen, obj) >= 0) {47        return '[Circular]';48    }49    function inspect (value, from) {50        if (from) {51            seen = seen.slice();52            seen.push(from);53        }54        return inspect_(value, opts, depth + 1, seen);55    }56    if (typeof obj === 'function') {57        var name = nameOf(obj);58        return '[Function' + (name ? ': ' + name : '') + ']';59    }60    if (isSymbol(obj)) {61        var symString = Symbol.prototype.toString.call(obj);62        return typeof obj === 'object' ? markBoxed(symString) : symString;63    }64    if (isElement(obj)) {65        var s = '<' + String(obj.nodeName).toLowerCase();66        var attrs = obj.attributes || [];67        for (var i = 0; i < attrs.length; i++) {68            s += ' ' + attrs[i].name + '=' + wrapQuotes(quote(attrs[i].value), 'double', opts);69        }70        s += '>';71        if (obj.childNodes && obj.childNodes.length) s += '...';72        s += '</' + String(obj.nodeName).toLowerCase() + '>';73        return s;74    }75    if (isArray(obj)) {76        if (obj.length === 0) return '[]';77        return '[ ' + arrObjKeys(obj, inspect).join(', ') + ' ]';78    }79    if (isError(obj)) {80        var parts = arrObjKeys(obj, inspect);81        if (parts.length === 0) return '[' + String(obj) + ']';82        return '{ [' + String(obj) + '] ' + parts.join(', ') + ' }';83    }84    if (typeof obj === 'object') {85        if (inspectSymbol && typeof obj[inspectSymbol] === 'function') {86            return obj[inspectSymbol]();87        } else if (typeof obj.inspect === 'function') {88            return obj.inspect();89        }90    }91    if (isMap(obj)) {92        var parts = [];93        mapForEach.call(obj, function (value, key) {94            parts.push(inspect(key, obj) + ' => ' + inspect(value, obj));95        });96        return collectionOf('Map', mapSize.call(obj), parts);97    }98    if (isSet(obj)) {99        var parts = [];100        setForEach.call(obj, function (value ) {101            parts.push(inspect(value, obj));102        });103        return collectionOf('Set', setSize.call(obj), parts);104    }105    if (isNumber(obj)) {106        return markBoxed(inspect(Number(obj)));107    }108    if (isBigInt(obj)) {109        return markBoxed(inspect(bigIntValueOf.call(obj)));110    }111    if (isBoolean(obj)) {112        return markBoxed(booleanValueOf.call(obj));113    }114    if (isString(obj)) {115        return markBoxed(inspect(String(obj)));116    }117    if (!isDate(obj) && !isRegExp(obj)) {118        var xs = arrObjKeys(obj, inspect);119        if (xs.length === 0) return '{}';120        return '{ ' + xs.join(', ') + ' }';121    }122    return String(obj);123};124function wrapQuotes (s, defaultStyle, opts) {125    var quoteChar = (opts.quoteStyle || defaultStyle) === 'double' ? '"' : "'";126    return quoteChar + s + quoteChar;127}128function quote (s) {129    return String(s).replace(/"/g, '&quot;');130}131function isArray (obj) { return toStr(obj) === '[object Array]'; }132function isDate (obj) { return toStr(obj) === '[object Date]'; }133function isRegExp (obj) { return toStr(obj) === '[object RegExp]'; }134function isError (obj) { return toStr(obj) === '[object Error]'; }135function isSymbol (obj) { return toStr(obj) === '[object Symbol]'; }136function isString (obj) { return toStr(obj) === '[object String]'; }137function isNumber (obj) { return toStr(obj) === '[object Number]'; }138function isBigInt (obj) { return toStr(obj) === '[object BigInt]'; }139function isBoolean (obj) { return toStr(obj) === '[object Boolean]'; }140var hasOwn = Object.prototype.hasOwnProperty || function (key) { return key in this; };141function has (obj, key) {142    return hasOwn.call(obj, key);143}144function toStr (obj) {145    return objectToString.call(obj);146}147function nameOf (f) {148    if (f.name) return f.name;149    var m = String(f).match(/^function\s*([\w$]+)/);150    if (m) return m[1];151}152function indexOf (xs, x) {153    if (xs.indexOf) return xs.indexOf(x);154    for (var i = 0, l = xs.length; i < l; i++) {155        if (xs[i] === x) return i;156    }157    return -1;158}159function isMap (x) {160    if (!mapSize) {161        return false;162    }163    try {164        mapSize.call(x);165        try {166            setSize.call(x);167        } catch (s) {168            return true;169        }170        return x instanceof Map; // core-js workaround, pre-v2.5.0171    } catch (e) {}172    return false;173}174function isSet (x) {175    if (!setSize) {176        return false;177    }178    try {179        setSize.call(x);180        try {181            mapSize.call(x);182        } catch (m) {183            return true;184        }185        return x instanceof Set; // core-js workaround, pre-v2.5.0186    } catch (e) {}187    return false;188}189function isElement (x) {190    if (!x || typeof x !== 'object') return false;191    if (typeof HTMLElement !== 'undefined' && x instanceof HTMLElement) {192        return true;193    }194    return typeof x.nodeName === 'string'195        && typeof x.getAttribute === 'function'196    ;197}198function inspectString (str, opts) {199    var s = str.replace(/(['\\])/g, '\\$1').replace(/[\x00-\x1f]/g, lowbyte);200    return wrapQuotes(s, 'single', opts);201}202function lowbyte (c) {203    var n = c.charCodeAt(0);204    var x = { 8: 'b', 9: 't', 10: 'n', 12: 'f', 13: 'r' }[n];205    if (x) return '\\' + x;206    return '\\x' + (n < 0x10 ? '0' : '') + n.toString(16);207}208function markBoxed (str) {209    return 'Object(' + str + ')';210}211function collectionOf (type, size, entries) {212    return type + ' (' + size + ') {' + entries.join(', ') + '}';213}214function arrObjKeys (obj, inspect) {215    var isArr = isArray(obj);216    var xs = [];217    if (isArr) {218        xs.length = obj.length;219        for (var i = 0; i < obj.length; i++) {220            xs[i] = has(obj, i) ? inspect(obj[i], obj) : '';221        }222    }223    for (var key in obj) {224        if (!has(obj, key)) continue;225        if (isArr && String(Number(key)) === key && key < obj.length) continue;226        if (/[^\w$]/.test(key)) {227            xs.push(inspect(key, obj) + ': ' + inspect(obj[key], obj));228        } else {229            xs.push(key + ': ' + inspect(obj[key], obj));230        }231    }232    return xs;...

1'use strict'2/* global BigInt */3/* eslint-disable valid-typeof,no-redeclare,no-control-regex */4var hasMap = typeof Map === 'function' && Map.prototype5var mapSizeDescriptor = Object.getOwnPropertyDescriptor && hasMap6  ? Object.getOwnPropertyDescriptor(Map.prototype, 'size') : null7var mapSize = hasMap && mapSizeDescriptor && typeof mapSizeDescriptor.get === 'function'8  ? mapSizeDescriptor.get : null9var mapForEach = hasMap && Map.prototype.forEach10var hasSet = typeof Set === 'function' && Set.prototype11var setSizeDescriptor = Object.getOwnPropertyDescriptor && hasSet12  ? Object.getOwnPropertyDescriptor(Set.prototype, 'size') : null13var setSize = hasSet && setSizeDescriptor && typeof setSizeDescriptor.get === 'function'14  ? setSizeDescriptor.get : null15var setForEach = hasSet && Set.prototype.forEach16var booleanValueOf = Boolean.prototype.valueOf17var objectToString = Object.prototype.toString18var bigIntValueOf = typeof BigInt === 'function' ? BigInt.prototype.valueOf : null19// var inspectCustom = require('util').inspect.custom;20// console.log(inspectCustom);21// var inspectSymbol = (inspectCustom && isSymbol(inspectCustom)) ? inspectCustom : null;22var inspectSymbol = null23module.exports = function inspect_ (obj, opts, depth, seen) {24  if (!opts) opts = {}25  if (has(opts, 'quoteStyle') &&26    (opts.quoteStyle !== 'single' && opts.quoteStyle !== 'double')) {27    throw new TypeError('option "quoteStyle" must be "single" or "double"')28  }29  if (typeof obj === 'undefined') {30    return 'undefined'31  }32  if (obj === null) {33    return 'null'34  }35  if (typeof obj === 'boolean') {36    return obj ? 'true' : 'false'37  }38  if (typeof obj === 'string') {39    return inspectString(obj, opts)40  }41  if (typeof obj === 'number') {42    if (obj === 0) {43      return Infinity / obj > 0 ? '0' : '-0'44    }45    return String(obj)46  }47  if (typeof obj === 'bigint') {48    return String(obj) + 'n'49  }50  var maxDepth = typeof opts.depth === 'undefined' ? 5 : opts.depth51  if (typeof depth === 'undefined') depth = 052  if (depth >= maxDepth && maxDepth > 0 && typeof obj === 'object') {53    return '[Object]'54  }55  if (typeof seen === 'undefined') seen = []56  else if (indexOf(seen, obj) >= 0) {57    return '[Circular]'58  }59  function inspect (value, from) {60    if (from) {61      seen = seen.slice()62      seen.push(from)63    }64    return inspect_(value, opts, depth + 1, seen)65  }66  if (typeof obj === 'function') {67    var name = nameOf(obj)68    return '[Function' + (name ? ': ' + name : '') + ']'69  }70  if (isSymbol(obj)) {71    var symString = Symbol.prototype.toString.call(obj)72    return typeof obj === 'object' ? markBoxed(symString) : symString73  }74  if (isElement(obj)) {75    var s = '<' + String(obj.nodeName).toLowerCase()76    var attrs = obj.attributes || []77    for (var i = 0; i < attrs.length; i++) {78      s += ' ' + attrs[i].name + '=' + wrapQuotes(quote(attrs[i].value), 'double', opts)79    }80    s += '>'81    if (obj.childNodes && obj.childNodes.length) s += '...'82    s += '</' + String(obj.nodeName).toLowerCase() + '>'83    return s84  }85  if (isArray(obj)) {86    if (obj.length === 0) return '[]'87    return '[ ' + arrObjKeys(obj, inspect).join(', ') + ' ]'88  }89  if (isError(obj)) {90    var parts = arrObjKeys(obj, inspect)91    if (parts.length === 0) return '[' + String(obj) + ']'92    return '{ [' + String(obj) + '] ' + parts.join(', ') + ' }'93  }94  if (typeof obj === 'object') {95    if (inspectSymbol && typeof obj[inspectSymbol] === 'function') {96      return obj[inspectSymbol]()97    } else if (typeof obj.inspect === 'function') {98      return obj.inspect()99    }100  }101  if (isMap(obj)) {102    var parts = []103    mapForEach.call(obj, function (value, key) {104      parts.push(inspect(key, obj) + ' => ' + inspect(value, obj))105    })106    return collectionOf('Map', mapSize.call(obj), parts)107  }108  if (isSet(obj)) {109    var parts = []110    setForEach.call(obj, function (value) {111      parts.push(inspect(value, obj))112    })113    return collectionOf('Set', setSize.call(obj), parts)114  }115  if (isNumber(obj)) {116    return markBoxed(inspect(Number(obj)))117  }118  if (isBigInt(obj)) {119    return markBoxed(inspect(bigIntValueOf.call(obj)))120  }121  if (isBoolean(obj)) {122    return markBoxed(booleanValueOf.call(obj))123  }124  if (isString(obj)) {125    return markBoxed(inspect(String(obj)))126  }127  if (!isDate(obj) && !isRegExp(obj)) {128    var xs = arrObjKeys(obj, inspect)129    if (xs.length === 0) return '{}'130    return '{ ' + xs.join(', ') + ' }'131  }132  return String(obj)133}134function wrapQuotes (s, defaultStyle, opts) {135  var quoteChar = (opts.quoteStyle || defaultStyle) === 'double' ? '"' : "'"136  return quoteChar + s + quoteChar137}138function quote (s) {139  return String(s).replace(/"/g, '&quot;')140}141function isArray (obj) { return toStr(obj) === '[object Array]' }142function isDate (obj) { return toStr(obj) === '[object Date]' }143function isRegExp (obj) { return toStr(obj) === '[object RegExp]' }144function isError (obj) { return toStr(obj) === '[object Error]' }145function isSymbol (obj) { return toStr(obj) === '[object Symbol]' }146function isString (obj) { return toStr(obj) === '[object String]' }147function isNumber (obj) { return toStr(obj) === '[object Number]' }148function isBigInt (obj) { return toStr(obj) === '[object BigInt]' }149function isBoolean (obj) { return toStr(obj) === '[object Boolean]' }150var hasOwn = Object.prototype.hasOwnProperty || function (key) { return key in this }151function has (obj, key) {152  return hasOwn.call(obj, key)153}154function toStr (obj) {155  return objectToString.call(obj)156}157function nameOf (f) {158  if (f.name) return f.name159  var m = String(f).match(/^function\s*([\w$]+)/)160  if (m) return m[1]161}162function indexOf (xs, x) {163  if (xs.indexOf) return xs.indexOf(x)164  for (var i = 0, l = xs.length; i < l; i++) {165    if (xs[i] === x) return i166  }167  return -1168}169function isMap (x) {170  if (!mapSize) {171    return false172  }173  try {174    mapSize.call(x)175    try {176      setSize.call(x)177    } catch (s) {178      return true179    }180    return x instanceof Map // core-js workaround, pre-v2.5.0181  } catch (e) { }182  return false183}184function isSet (x) {185  if (!setSize) {186    return false187  }188  try {189    setSize.call(x)190    try {191      mapSize.call(x)192    } catch (m) {193      return true194    }195    return x instanceof Set // core-js workaround, pre-v2.5.0196  } catch (e) { }197  return false198}199function isElement (x) {200  return false201}202function inspectString (str, opts) {203  var s = str.replace(/(['\\])/g, '\\$1').replace(/[\x00-\x1f]/g, lowbyte)204  return wrapQuotes(s, 'single', opts)205}206function lowbyte (c) {207  var n = c.charCodeAt(0)208  var x = { 8: 'b', 9: 't', 10: 'n', 12: 'f', 13: 'r' }[n]209  if (x) return '\\' + x210  return '\\x' + (n < 0x10 ? '0' : '') + n.toString(16)211}212function markBoxed (str) {213  return 'Object(' + str + ')'214}215function collectionOf (type, size, entries) {216  return type + ' (' + size + ') {' + entries.join(', ') + '}'217}218function arrObjKeys (obj, inspect) {219  var isArr = isArray(obj)220  var xs = []221  if (isArr) {222    xs.length = obj.length223    for (var i = 0; i < obj.length; i++) {224      xs[i] = has(obj, i) ? inspect(obj[i], obj) : ''225    }226  }227  for (var key in obj) {228    if (!has(obj, key)) continue229    if (isArr && String(Number(key)) === key && key < obj.length) continue230    if (/[^\w$]/.test(key)) {231      xs.push(inspect(key, obj) + ': ' + inspect(obj[key], obj))232    } else {233      xs.push(key + ': ' + inspect(obj[key], obj))234    }235  }236  return xs...

1const test = require("tape");2const inspectSymbol = require("util").inspect.custom;3const jsdiff = require("diff");4const cheerio = require("cheerio");5const prettier = require("prettier");6if (typeof test.Test.prototype.equalHtml === "undefined") {7  const getValue = (chunk) => chunk.value;8  const rejectAdded = (chunk) => !chunk.added;9  const rejectRemoved = (chunk) => !chunk.removed;10  const rejectModified = (chunk) => !chunk.added && !chunk.removed;11  test.Test.prototype.equalHtml = function equalHtml(a, b, msg, extra) {12    if (arguments.length < 2) {13      throw new TypeError("two arguments must be provided to compare");14    }15    const normalizedA = prettier.format(cheerio.load(a)("body").html(), {16      parser: "html",17      printWidth: Infinity,18    });19    const normalizedB = prettier.format(cheerio.load(b)("body").html(), {20      parser: "html",21      printWidth: Infinity,22    });23    const diff = jsdiff.diffLines(normalizedA, normalizedB);24    this._assert(diff.every(rejectModified), {25      message: typeof msg !== "undefined" ? msg : "should be equal as html",26      operator: "equalHtml",27      actual: {28        [inspectSymbol]: () =>29          // joining with a circle instead of `\n` because `tap-spec` can't do yaml30          // https://github.com/scottcorgan/tap-spec/issues/5731          diff32            .filter(rejectAdded)33            .map(getValue)34            .join(" 🔴 ")35            .replace(/\n/g, "\\n"),36      },37      expected: {38        [inspectSymbol]: () =>39          // joining with a circle instead of `\n` because `tap-spec` can't do yaml40          // https://github.com/scottcorgan/tap-spec/issues/5741          diff42            .filter(rejectRemoved)43            .map(getValue)44            .join(" 🔵 ")45            .replace(/\n/g, "\\n"),46      },47      extra: extra,48    });49  };...