expect-webdriverio 5.6.5 → 5.6.7

package/lib/util/formatMessage.js

@@ -1,10 +1,6 @@
 import { printDiffOrStringify, printExpected, printReceived } from 'jest-matcher-utils';
 import { equals } from '../jasmineUtils.js';
 import { isElementArray } from './elementsUtil.js';
-const EXPECTED_LABEL = 'Expected';
-const RECEIVED_LABEL = 'Received';
-const NOT_SUFFIX = ' [not]';
-const NOT_EXPECTED_LABEL = EXPECTED_LABEL + NOT_SUFFIX;
 export const getSelector = (el) => {
     let result = typeof el.selector === 'string' ? el.selector : '<fn>';
     if (Array.isArray(el) && el.props.length > 0) {
@@ -30,11 +26,9 @@ export const getSelectors = (el) => {
     }
     return selectors.reverse().join('.');
 };
-export const not = (isNot) => {
-    return `${isNot ? 'not ' : ''}`;
-};
-export const enhanceError = (subject, expected, actual, context, verb, expectation, arg2 = '', { message = '', containing = false }) => {
-    const { isNot = false } = context;
+const not = (isNot) => `${isNot ? 'not ' : ''}`;
+export const enhanceError = (subject, expected, actual, context, verb, expectation, expectedValueArgument2 = '', { message = '', containing = false } = {}) => {
+    const { isNot = false, useNotInLabel = true } = context;
     subject = typeof subject === 'string' ? subject : getSelectors(subject);
     let contain = '';
     if (containing) {
@@ -43,25 +37,31 @@ export const enhanceError = (subject, expected, actual, context, verb, expectati
     if (verb) {
         verb += ' ';
     }
-    let diffString = isNot && equals(actual, expected)
-        ? `${EXPECTED_LABEL}: ${printExpected(expected)}\n${RECEIVED_LABEL}: ${printReceived(actual)}`
-        : printDiffOrStringify(expected, actual, EXPECTED_LABEL, RECEIVED_LABEL, true);
-    if (isNot) {
-        diffString = diffString
-            .replace(EXPECTED_LABEL, NOT_EXPECTED_LABEL)
-            .replace(RECEIVED_LABEL, RECEIVED_LABEL + ' '.repeat(NOT_SUFFIX.length));
-    }
+    const label = {
+        expected: isNot && useNotInLabel ? 'Expected [not]' : 'Expected',
+        received: isNot && useNotInLabel ? 'Received      ' : 'Received'
+    };
+    const diffString = equals(actual, expected) ? `\
+${label.expected}: ${printExpected(expected)}
+${label.received}: ${printReceived(actual)}`
+        : printDiffOrStringify(expected, actual, label.expected, label.received, true);
     if (message) {
         message += '\n';
     }
-    if (arg2) {
-        arg2 = ` ${arg2}`;
+    if (expectedValueArgument2) {
+        expectedValueArgument2 = ` ${expectedValueArgument2}`;
     }
-    const msg = `${message}Expect ${subject} ${not(isNot)}to ${verb}${expectation}${arg2}${contain}\n\n${diffString}`;
+    const msg = `\
+${message}Expect ${subject} ${not(isNot)}to ${verb}${expectation}${expectedValueArgument2}${contain}
+
+${diffString}`;
     return msg;
 };
-export const enhanceErrorBe = (subject, pass, context, verb, expectation, options) => {
-    return enhanceError(subject, not(context.isNot) + expectation, not(!pass) + expectation, context, verb, expectation, '', options);
+export const enhanceErrorBe = (subject, context, options) => {
+    const { isNot, verb, expectation } = context;
+    const expected = `${not(isNot)}${expectation}`;
+    const actual = `${not(!isNot)}${expectation}`;
+    return enhanceError(subject, expected, actual, { ...context, useNotInLabel: false }, verb, expectation, '', options);
 };
 export const numberError = (options = {}) => {
     if (typeof options.eq === 'number') {

package/lib/utils.js

@@ -56,14 +56,14 @@ const waitUntil = async (condition, isNot = false, { wait = DEFAULT_OPTIONS.wait
     }
 };
 async function executeCommandBe(received, command, options) {
-    const { isNot, expectation, verb = 'be' } = this;
+    const { isNot, verb = 'be' } = this;
     let el = await received?.getElement();
     const pass = await waitUntil(async () => {
         const result = await executeCommand.call(this, el, async (element) => ({ result: await command(element) }), options);
         el = result.el;
         return result.success;
     }, isNot, options);
-    const message = enhanceErrorBe(el, pass, this, verb, expectation, options);
+    const message = enhanceErrorBe(el, { ...this, verb }, options);
     return {
         pass,
         message: () => message,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "5.6.5",
+  "version": "5.6.7",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
@@ -55,7 +55,9 @@
     "build": "run-s clean compile",
     "clean": "run-p clean:*",
     "clean:build": "rimraf ./lib",
-    "compile": "tsc --build tsconfig.build.json",
+    "compile": "run-s compile:*",
+    "compile:lib": "tsc --build tsconfig.build.json",
+    "compile:check": "if [ ! -f lib/index.js ] || [ $(find lib -type f | wc -l) -le 30 ]; then echo 'File structure under lib is broken'; exit 1; fi",
     "tsc:root-types": "node types-checks-filter-out-node_modules.js",
     "test": "run-s test:*",
     "test:tsc": "tsc --project tsconfig.json --noEmit --rootDir .",
@@ -94,7 +96,7 @@
     "eslint": "^9.39.2",
     "husky": "^9.1.7",
     "npm-run-all2": "^8.0.4",
-    "release-it": "^19.1.0",
+    "release-it": "^20.0.1",
     "rimraf": "^6.1.2",
     "shelljs": "^0.10.0",
     "typescript": "^5.9.3",

package/types/expect-webdriverio.d.ts

@@ -320,7 +320,7 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
      */
     toHaveHTML: FnWhenElementOrArrayLike<ActualT, (
         html: string | RegExp | ExpectWebdriverIO.PartialMatcher<string> | Array<string | RegExp>,
-        options?: ExpectWebdriverIO.StringOptions
+        options?: ExpectWebdriverIO.HTMLOptions
     ) => Promise<void>>
 
     /**