@xylabs/vitest-extended 4.3.4 → 4.3.6

package/dist/neutral/customMatchers.d.ts

@@ -23,5 +23,9 @@ export declare const matchers: {
         message: () => string;
         pass: boolean;
     };
+    toIncludeAllMembers(received: unknown[], expected: unknown[]): {
+        pass: boolean;
+        message: () => string;
+    };
 };
 //# sourceMappingURL=customMatchers.d.ts.map

package/dist/neutral/customMatchers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customMatchers.d.ts","sourceRoot":"","sources":["../../src/customMatchers.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,QAAQ;8BACO,OAAO,gBAAgB,MAAM;;;;2BAchC,OAAO;;;;6BACL,OAAO;;;;2BACT,OAAO;;;;wBACV,OAAO;;;;uBAYR,OAAO;;;;CAY3B,CAAA"}
+{"version":3,"file":"customMatchers.d.ts","sourceRoot":"","sources":["../../src/customMatchers.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,QAAQ;8BACO,OAAO,gBAAgB,MAAM;;;;2BAchC,OAAO;;;;6BACL,OAAO;;;;2BACT,OAAO;;;;wBACV,OAAO;;;;uBAYR,OAAO;;;;kCAYI,OAAO,EAAE,YAAY,OAAO,EAAE;;;;CAwB7D,CAAA"}

package/dist/neutral/index.mjs

@@ -43,6 +43,24 @@ var matchers = {
       message: () => `expected ${received} to be true but was not true`,
       pass: false
     };
+  },
+  toIncludeAllMembers(received, expected) {
+    if (!Array.isArray(received) || !Array.isArray(expected)) {
+      return {
+        pass: false,
+        message: () => "Expected both received and expected values to be arrays."
+      };
+    }
+    const missingMembers = expected.filter((item) => !received.includes(item));
+    return missingMembers.length === 0 ? {
+      pass: true,
+      message: () => `Expected array not to include all members of ${JSON.stringify(expected)}, but it does.`
+    } : {
+      pass: false,
+      message: () => `Expected array to include all members of ${JSON.stringify(expected)}. Missing members: ${JSON.stringify(
+        missingMembers
+      )}.`
+    };
   }
 };
 expect.extend(matchers);

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/customMatchers.ts"],"sourcesContent":["import { expect } from 'vitest'\n\nfunction toBeType(received: unknown, expectedType: string) {\n  const pass = typeof received === expectedType && !Number.isNaN(received)\n  return pass\n    ? {\n        message: () => `expected ${received} not to be a ${expectedType}`,\n        pass: true,\n      }\n    : {\n        message: () => `expected ${received} to be a ${expectedType}`,\n        pass: false,\n      }\n}\n\nexport const matchers = {\n  toBeArrayOfSize(received: unknown, expectedSize: number) {\n    const pass = Array.isArray(received) && received.length === expectedSize\n    return pass\n      ? {\n          message: () => `expected array not to have size ${expectedSize}, but received array of size ${received.length}`,\n          pass: true,\n        }\n      : {\n          message: () => Array.isArray(received)\n            ? `expected array of size ${expectedSize}, but received array of size ${received.length}`\n            : `expected array of size ${expectedSize}, but received a non-array`,\n          pass: false,\n        }\n  },\n  toBeNumber: (received: unknown) => toBeType(received, 'number'),\n  toBeFunction: (received: unknown) => toBeType(received, 'function'),\n  toBeString: (received: unknown) => toBeType(received, 'string'),\n  toBeFalse(received: unknown) {\n    const pass = received === false\n    return pass\n      ? {\n          message: () => `expected ${received} to be false`,\n          pass: true,\n        }\n      : {\n          message: () => `expected ${received} to be false but was not false`,\n          pass: false,\n        }\n  },\n  toBeTrue(received: unknown) {\n    const pass = received === true\n    return pass\n      ? {\n          message: () => `expected ${received} to be true`,\n          pass: true,\n        }\n      : {\n          message: () => `expected ${received} to be true but was not true`,\n          pass: false,\n        }\n  },\n}\n\nexpect.extend(matchers)\n"],"mappings":";AAAA,SAAS,cAAc;AAEvB,SAAS,SAAS,UAAmB,cAAsB;AACzD,QAAM,OAAO,OAAO,aAAa,gBAAgB,CAAC,OAAO,MAAM,QAAQ;AACvE,SAAO,OACH;AAAA,IACE,SAAS,MAAM,YAAY,QAAQ,gBAAgB,YAAY;AAAA,IAC/D,MAAM;AAAA,EACR,IACA;AAAA,IACE,SAAS,MAAM,YAAY,QAAQ,YAAY,YAAY;AAAA,IAC3D,MAAM;AAAA,EACR;AACN;AAEO,IAAM,WAAW;AAAA,EACtB,gBAAgB,UAAmB,cAAsB;AACvD,UAAM,OAAO,MAAM,QAAQ,QAAQ,KAAK,SAAS,WAAW;AAC5D,WAAO,OACH;AAAA,MACE,SAAS,MAAM,mCAAmC,YAAY,gCAAgC,SAAS,MAAM;AAAA,MAC7G,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,MAAM,QAAQ,QAAQ,IACjC,0BAA0B,YAAY,gCAAgC,SAAS,MAAM,KACrF,0BAA0B,YAAY;AAAA,MAC1C,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,YAAY,CAAC,aAAsB,SAAS,UAAU,QAAQ;AAAA,EAC9D,cAAc,CAAC,aAAsB,SAAS,UAAU,UAAU;AAAA,EAClE,YAAY,CAAC,aAAsB,SAAS,UAAU,QAAQ;AAAA,EAC9D,UAAU,UAAmB;AAC3B,UAAM,OAAO,aAAa;AAC1B,WAAO,OACH;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,SAAS,UAAmB;AAC1B,UAAM,OAAO,aAAa;AAC1B,WAAO,OACH;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR;AAAA,EACN;AACF;AAEA,OAAO,OAAO,QAAQ;","names":[]}
+{"version":3,"sources":["../../src/customMatchers.ts"],"sourcesContent":["import { expect } from 'vitest'\n\nfunction toBeType(received: unknown, expectedType: string) {\n  const pass = typeof received === expectedType && !Number.isNaN(received)\n  return pass\n    ? {\n        message: () => `expected ${received} not to be a ${expectedType}`,\n        pass: true,\n      }\n    : {\n        message: () => `expected ${received} to be a ${expectedType}`,\n        pass: false,\n      }\n}\n\nexport const matchers = {\n  toBeArrayOfSize(received: unknown, expectedSize: number) {\n    const pass = Array.isArray(received) && received.length === expectedSize\n    return pass\n      ? {\n          message: () => `expected array not to have size ${expectedSize}, but received array of size ${received.length}`,\n          pass: true,\n        }\n      : {\n          message: () => Array.isArray(received)\n            ? `expected array of size ${expectedSize}, but received array of size ${received.length}`\n            : `expected array of size ${expectedSize}, but received a non-array`,\n          pass: false,\n        }\n  },\n  toBeNumber: (received: unknown) => toBeType(received, 'number'),\n  toBeFunction: (received: unknown) => toBeType(received, 'function'),\n  toBeString: (received: unknown) => toBeType(received, 'string'),\n  toBeFalse(received: unknown) {\n    const pass = received === false\n    return pass\n      ? {\n          message: () => `expected ${received} to be false`,\n          pass: true,\n        }\n      : {\n          message: () => `expected ${received} to be false but was not false`,\n          pass: false,\n        }\n  },\n  toBeTrue(received: unknown) {\n    const pass = received === true\n    return pass\n      ? {\n          message: () => `expected ${received} to be true`,\n          pass: true,\n        }\n      : {\n          message: () => `expected ${received} to be true but was not true`,\n          pass: false,\n        }\n  },\n  toIncludeAllMembers(received: unknown[], expected: unknown[]) {\n    if (!Array.isArray(received) || !Array.isArray(expected)) {\n      return {\n        pass: false,\n        message: () => 'Expected both received and expected values to be arrays.',\n      }\n    }\n\n    const missingMembers = expected.filter(item => !received.includes(item))\n\n    return missingMembers.length === 0\n      ? {\n          pass: true,\n          message: () =>\n            `Expected array not to include all members of ${JSON.stringify(expected)}, but it does.`,\n        }\n      : {\n          pass: false,\n          message: () =>\n            `Expected array to include all members of ${JSON.stringify(expected)}. Missing members: ${JSON.stringify(\n              missingMembers,\n            )}.`,\n        }\n  },\n}\n\nexpect.extend(matchers)\n"],"mappings":";AAAA,SAAS,cAAc;AAEvB,SAAS,SAAS,UAAmB,cAAsB;AACzD,QAAM,OAAO,OAAO,aAAa,gBAAgB,CAAC,OAAO,MAAM,QAAQ;AACvE,SAAO,OACH;AAAA,IACE,SAAS,MAAM,YAAY,QAAQ,gBAAgB,YAAY;AAAA,IAC/D,MAAM;AAAA,EACR,IACA;AAAA,IACE,SAAS,MAAM,YAAY,QAAQ,YAAY,YAAY;AAAA,IAC3D,MAAM;AAAA,EACR;AACN;AAEO,IAAM,WAAW;AAAA,EACtB,gBAAgB,UAAmB,cAAsB;AACvD,UAAM,OAAO,MAAM,QAAQ,QAAQ,KAAK,SAAS,WAAW;AAC5D,WAAO,OACH;AAAA,MACE,SAAS,MAAM,mCAAmC,YAAY,gCAAgC,SAAS,MAAM;AAAA,MAC7G,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,MAAM,QAAQ,QAAQ,IACjC,0BAA0B,YAAY,gCAAgC,SAAS,MAAM,KACrF,0BAA0B,YAAY;AAAA,MAC1C,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,YAAY,CAAC,aAAsB,SAAS,UAAU,QAAQ;AAAA,EAC9D,cAAc,CAAC,aAAsB,SAAS,UAAU,UAAU;AAAA,EAClE,YAAY,CAAC,aAAsB,SAAS,UAAU,QAAQ;AAAA,EAC9D,UAAU,UAAmB;AAC3B,UAAM,OAAO,aAAa;AAC1B,WAAO,OACH;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,SAAS,UAAmB;AAC1B,UAAM,OAAO,aAAa;AAC1B,WAAO,OACH;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,oBAAoB,UAAqB,UAAqB;AAC5D,QAAI,CAAC,MAAM,QAAQ,QAAQ,KAAK,CAAC,MAAM,QAAQ,QAAQ,GAAG;AACxD,aAAO;AAAA,QACL,MAAM;AAAA,QACN,SAAS,MAAM;AAAA,MACjB;AAAA,IACF;AAEA,UAAM,iBAAiB,SAAS,OAAO,UAAQ,CAAC,SAAS,SAAS,IAAI,CAAC;AAEvE,WAAO,eAAe,WAAW,IAC7B;AAAA,MACE,MAAM;AAAA,MACN,SAAS,MACP,gDAAgD,KAAK,UAAU,QAAQ,CAAC;AAAA,IAC5E,IACA;AAAA,MACE,MAAM;AAAA,MACN,SAAS,MACP,4CAA4C,KAAK,UAAU,QAAQ,CAAC,sBAAsB,KAAK;AAAA,QAC7F;AAAA,MACF,CAAC;AAAA,IACL;AAAA,EACN;AACF;AAEA,OAAO,OAAO,QAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/vitest-extended",
-  "version": "4.3.4",
+  "version": "4.3.6",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "log",
@@ -41,11 +41,11 @@
     "packages/**/*"
   ],
   "dependencies": {
-    "vitest": "^2.1.4"
+    "vitest": "^2.1.5"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.2.3",
-    "@xylabs/tsconfig": "^4.2.3",
+    "@xylabs/ts-scripts-yarn3": "^4.2.4",
+    "@xylabs/tsconfig": "^4.2.4",
     "typescript": "^5.6.3"
   },
   "engines": {

package/src/customMatchers.ts

@@ -55,6 +55,30 @@ export const matchers = {
           pass: false,
         }
   },
+  toIncludeAllMembers(received: unknown[], expected: unknown[]) {
+    if (!Array.isArray(received) || !Array.isArray(expected)) {
+      return {
+        pass: false,
+        message: () => 'Expected both received and expected values to be arrays.',
+      }
+    }
+
+    const missingMembers = expected.filter(item => !received.includes(item))
+
+    return missingMembers.length === 0
+      ? {
+          pass: true,
+          message: () =>
+            `Expected array not to include all members of ${JSON.stringify(expected)}, but it does.`,
+        }
+      : {
+          pass: false,
+          message: () =>
+            `Expected array to include all members of ${JSON.stringify(expected)}. Missing members: ${JSON.stringify(
+              missingMembers,
+            )}.`,
+        }
+  },
 }
 
 expect.extend(matchers)

package/src/vitest.customMatchers.d.ts

@@ -21,6 +21,10 @@ declare module 'vitest' {
   interface Assertion<T = unknown> {
     toBeArrayOfSize(size: number): T
   }
+
+  interface Assertion<T = unknown> {
+    toIncludeAllMembers(received: unknown[], expected: unknown[]): T
+  }
   interface expect {
     toBeArrayOfSize(size: number): T
     toBeFalse(): T
@@ -28,5 +32,6 @@ declare module 'vitest' {
     toBeNumber(): T
     toBeString(): T
     toBeTrue(): T
+    toIncludeAllMembers(received: unknown[], expected: unknown[]): T
   }
 }