@vitest/expect 0.27.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021-Present Anthony Fu <https://github.com/antfu>
+Copyright (c) 2021-Present Matias Capeletto <https://github.com/patak-dev>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,17 @@
+# @vitest/expect
+
+Jest's expect matchers as a Chai plugin.
+
+## Usage
+
+```js
+import * as chai from 'chai'
+import { JestAsymmetricMatchers, JestChaiExpect, JestExtend } from '@vitest/expect'
+
+// allows using expect.extend instead of chai.use to extend plugins
+chai.use(JestExtend)
+// adds all jest matchers to expect
+chai.use(JestChaiExpect)
+// adds asymmetric matchers like stringContaining, objectContaining
+chai.use(JestAsymmetricMatchers)
+```

package/dist/index.d.ts

@@ -0,0 +1,191 @@
+import { use } from 'chai';
+import { stringify } from '@vitest/utils';
+
+type Formatter = (input: string | number | null | undefined) => string;
+
+declare const EXPECTED_COLOR: Formatter;
+declare const RECEIVED_COLOR: Formatter;
+declare const INVERTED_COLOR: Formatter;
+declare const BOLD_WEIGHT: Formatter;
+declare const DIM_COLOR: Formatter;
+declare function matcherHint(matcherName: string, received?: string, expected?: string, options?: MatcherHintOptions): string;
+declare const printReceived: (object: unknown) => string;
+declare const printExpected: (value: unknown) => string;
+declare function diff(a: any, b: any, options?: DiffOptions): string;
+
+declare const jestMatcherUtils_stringify: typeof stringify;
+declare const jestMatcherUtils_EXPECTED_COLOR: typeof EXPECTED_COLOR;
+declare const jestMatcherUtils_RECEIVED_COLOR: typeof RECEIVED_COLOR;
+declare const jestMatcherUtils_INVERTED_COLOR: typeof INVERTED_COLOR;
+declare const jestMatcherUtils_BOLD_WEIGHT: typeof BOLD_WEIGHT;
+declare const jestMatcherUtils_DIM_COLOR: typeof DIM_COLOR;
+declare const jestMatcherUtils_matcherHint: typeof matcherHint;
+declare const jestMatcherUtils_printReceived: typeof printReceived;
+declare const jestMatcherUtils_printExpected: typeof printExpected;
+declare const jestMatcherUtils_diff: typeof diff;
+declare namespace jestMatcherUtils {
+  export {
+    jestMatcherUtils_stringify as stringify,
+    jestMatcherUtils_EXPECTED_COLOR as EXPECTED_COLOR,
+    jestMatcherUtils_RECEIVED_COLOR as RECEIVED_COLOR,
+    jestMatcherUtils_INVERTED_COLOR as INVERTED_COLOR,
+    jestMatcherUtils_BOLD_WEIGHT as BOLD_WEIGHT,
+    jestMatcherUtils_DIM_COLOR as DIM_COLOR,
+    jestMatcherUtils_matcherHint as matcherHint,
+    jestMatcherUtils_printReceived as printReceived,
+    jestMatcherUtils_printExpected as printExpected,
+    jestMatcherUtils_diff as diff,
+  };
+}
+
+type FirstFunctionArgument<T> = T extends (arg: infer A) => unknown ? A : never;
+type ChaiPlugin = FirstFunctionArgument<typeof use>;
+type Tester = (a: any, b: any) => boolean | undefined;
+interface MatcherHintOptions {
+    comment?: string;
+    expectedColor?: Formatter;
+    isDirectExpectCall?: boolean;
+    isNot?: boolean;
+    promise?: string;
+    receivedColor?: Formatter;
+    secondArgument?: string;
+    secondArgumentColor?: Formatter;
+}
+interface DiffOptions {
+    aAnnotation?: string;
+    aColor?: Formatter;
+    aIndicator?: string;
+    bAnnotation?: string;
+    bColor?: Formatter;
+    bIndicator?: string;
+    changeColor?: Formatter;
+    changeLineTrailingSpaceColor?: Formatter;
+    commonColor?: Formatter;
+    commonIndicator?: string;
+    commonLineTrailingSpaceColor?: Formatter;
+    contextLines?: number;
+    emptyFirstOrLastLinePlaceholder?: string;
+    expand?: boolean;
+    includeChangeCounts?: boolean;
+    omitAnnotationLines?: boolean;
+    patchColor?: Formatter;
+    compareKeys?: any;
+}
+interface MatcherState {
+    assertionCalls: number;
+    currentTestName?: string;
+    dontThrow?: () => void;
+    error?: Error;
+    equals: (a: unknown, b: unknown, customTesters?: Array<Tester>, strictCheck?: boolean) => boolean;
+    expand?: boolean;
+    expectedAssertionsNumber?: number | null;
+    expectedAssertionsNumberErrorGen?: (() => Error) | null;
+    isExpectingAssertions?: boolean;
+    isExpectingAssertionsError?: Error | null;
+    isNot: boolean;
+    promise: string;
+    suppressedErrors: Array<Error>;
+    testPath?: string;
+    utils: typeof jestMatcherUtils & {
+        iterableEquality: Tester;
+        subsetEquality: Tester;
+    };
+}
+interface SyncExpectationResult {
+    pass: boolean;
+    message: () => string;
+    actual?: any;
+    expected?: any;
+}
+type AsyncExpectationResult = Promise<SyncExpectationResult>;
+type ExpectationResult = SyncExpectationResult | AsyncExpectationResult;
+interface RawMatcherFn<T extends MatcherState = MatcherState> {
+    (this: T, received: any, expected: any, options?: any): ExpectationResult;
+}
+type MatchersObject<T extends MatcherState = MatcherState> = Record<string, RawMatcherFn<T>>;
+
+interface AsymmetricMatcherInterface {
+    asymmetricMatch(other: unknown): boolean;
+    toString(): string;
+    getExpectedType?(): string;
+    toAsymmetricMatcher?(): string;
+}
+declare abstract class AsymmetricMatcher<T, State extends MatcherState = MatcherState> implements AsymmetricMatcherInterface {
+    protected sample: T;
+    protected inverse: boolean;
+    $$typeof: symbol;
+    constructor(sample: T, inverse?: boolean);
+    protected getMatcherContext(expect?: Vi.ExpectStatic): State;
+    abstract asymmetricMatch(other: unknown): boolean;
+    abstract toString(): string;
+    getExpectedType?(): string;
+    toAsymmetricMatcher?(): string;
+}
+declare class StringContaining extends AsymmetricMatcher<string> {
+    constructor(sample: string, inverse?: boolean);
+    asymmetricMatch(other: string): boolean;
+    toString(): string;
+    getExpectedType(): string;
+}
+declare class Anything extends AsymmetricMatcher<void> {
+    asymmetricMatch(other: unknown): boolean;
+    toString(): string;
+    toAsymmetricMatcher(): string;
+}
+declare class ObjectContaining extends AsymmetricMatcher<Record<string, unknown>> {
+    constructor(sample: Record<string, unknown>, inverse?: boolean);
+    getPrototype(obj: object): any;
+    hasProperty(obj: object | null, property: string): boolean;
+    asymmetricMatch(other: any): boolean;
+    toString(): string;
+    getExpectedType(): string;
+}
+declare class ArrayContaining<T = unknown> extends AsymmetricMatcher<Array<T>> {
+    constructor(sample: Array<T>, inverse?: boolean);
+    asymmetricMatch(other: Array<T>): boolean;
+    toString(): string;
+    getExpectedType(): string;
+}
+declare class Any extends AsymmetricMatcher<any> {
+    constructor(sample: unknown);
+    fnNameFor(func: Function): string;
+    asymmetricMatch(other: unknown): boolean;
+    toString(): string;
+    getExpectedType(): string;
+    toAsymmetricMatcher(): string;
+}
+declare class StringMatching extends AsymmetricMatcher<RegExp> {
+    constructor(sample: string | RegExp, inverse?: boolean);
+    asymmetricMatch(other: string): boolean;
+    toString(): string;
+    getExpectedType(): string;
+}
+declare const JestAsymmetricMatchers: ChaiPlugin;
+
+declare function equals(a: unknown, b: unknown, customTesters?: Array<Tester>, strictCheck?: boolean): boolean;
+declare function isAsymmetric(obj: any): boolean;
+declare function hasAsymmetric(obj: any, seen?: Set<unknown>): boolean;
+declare function isA(typeName: string, value: unknown): boolean;
+declare function fnNameFor(func: Function): string;
+declare function hasProperty(obj: object | null, property: string): boolean;
+declare function isImmutableUnorderedKeyed(maybeKeyed: any): boolean;
+declare function isImmutableUnorderedSet(maybeSet: any): boolean;
+declare const iterableEquality: (a: any, b: any, aStack?: Array<any>, bStack?: Array<any>) => boolean | undefined;
+declare const subsetEquality: (object: unknown, subset: unknown) => boolean | undefined;
+declare const typeEquality: (a: any, b: any) => boolean | undefined;
+declare const arrayBufferEquality: (a: unknown, b: unknown) => boolean | undefined;
+declare const sparseArrayEquality: (a: unknown, b: unknown) => boolean | undefined;
+declare const generateToBeMessage: (deepEqualityName: string, expected?: string, actual?: string) => string;
+
+declare const MATCHERS_OBJECT: unique symbol;
+declare const JEST_MATCHERS_OBJECT: unique symbol;
+declare const GLOBAL_EXPECT: unique symbol;
+
+declare const getState: <State extends MatcherState = MatcherState>(expect: Vi.ExpectStatic) => State;
+declare const setState: <State extends MatcherState = MatcherState>(state: Partial<State>, expect: Vi.ExpectStatic) => void;
+
+declare const JestChaiExpect: ChaiPlugin;
+
+declare const JestExtend: ChaiPlugin;
+
+export { Any, Anything, ArrayContaining, AsymmetricMatcher, AsymmetricMatcherInterface, AsyncExpectationResult, ChaiPlugin, DiffOptions, ExpectationResult, FirstFunctionArgument, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, MatcherHintOptions, MatcherState, MatchersObject, ObjectContaining, RawMatcherFn, StringContaining, StringMatching, SyncExpectationResult, Tester, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, setState, sparseArrayEquality, subsetEquality, typeEquality };