@xylabs/vitest-extended 5.0.81 → 5.0.83

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/vitest-extended",
-  "version": "5.0.81",
+  "version": "5.0.83",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "log",
@@ -39,10 +39,11 @@
   "types": "./types.d.ts",
   "files": [
     "dist",
+    "src",
     "types.d.ts"
   ],
   "dependencies": {
-    "@xylabs/vitest-matchers": "~5.0.81"
+    "@xylabs/vitest-matchers": "~5.0.83"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "~7.4.11",

package/src/customMatchers.ts

@@ -0,0 +1,4 @@
+import { matchers } from '@xylabs/vitest-matchers'
+import { expect } from 'vitest'
+
+expect.extend(matchers)

package/src/index.ts

@@ -0,0 +1 @@
+export * from './customMatchers.ts'

package/src/spec/extended.spec.ts

@@ -0,0 +1,37 @@
+import '../customMatchers.ts'
+
+import {
+  describe, expect, it,
+} from 'vitest'
+
+describe('vitest-extended matchers', () => {
+  it('toBeTrue works', () => {
+    expect(true).toBeTrue()
+  })
+
+  it('toBeFalse works', () => {
+    expect(false).toBeFalse()
+  })
+
+  it('toBeArray works', () => {
+    expect([1, 2]).toBeArray()
+  })
+
+  it('toBeString works', () => {
+    expect('hello').toBeString()
+  })
+
+  it('toBeNumber works', () => {
+    expect(42).toBeNumber()
+  })
+
+  it('toBeObject works', () => {
+    expect({}).toBeObject()
+  })
+
+  it('toBeEmpty works', () => {
+    expect([]).toBeEmpty()
+    expect('').toBeEmpty()
+    expect({}).toBeEmpty()
+  })
+})

package/src/vitest.customMatchers.d.ts

@@ -0,0 +1,31 @@
+// vitest.customMatchers.d.ts
+import 'vitest'
+
+interface CustomMatchers<T = unknown> {
+  toBeArray(): T
+  toBeArrayOfSize(size: number): T
+  toBeEmpty(): T
+  toBeFalse(): T
+  toBeFunction(): T
+  toBeInteger(): T
+  toBeNegative(): T
+  toBeNumber(): T
+  toBeObject(): T
+  toBeOneOf(expected: unknown[]): T
+  toBePositive(): T
+  toBeString(): T
+  toBeTrue(): T
+  toBeValidDate(): T
+  toContainAllKeys(expectedKeys: string[]): T
+  toContainAllValues(expectedValues: unknown[]): T
+  toContainKey(key: string): T
+  toContainValues(expectedValues: unknown[]): T
+  toInclude(expected: unknown): T
+  toIncludeAllMembers(expected: unknown[]): T
+}
+
+// Extend the expect Matchers interface
+declare module 'vitest' {
+  interface Assertion<T = unknown> extends CustomMatchers<T> {}
+  interface AsymmetricMatchersContaining extends CustomMatchers {}
+}