hein 0.0.2 → 0.0.3

package/DIFFERENCES_WITH_CHAI.md

@@ -1,49 +0,0 @@
-# Differences with Chai
-
-## TypeScript
-
-While Chai does have typescript definitions from DefinitelyTyped, the types it provides are a lot looser than I would like.
-
-### Value typechecking
-
-For example, the following is not a typescript violation and the properties of the expectation object are not auto-completed:
-
-```typescript
-// Chai:
-expect({ a: 1 }).to.eql({ b: 1 }); // No typescript error
-
-// Hein:
-expect({ a: 1 }).to.eql({ b: 1 });
-/*
-Argument of type '{ b: number; }' is not assignable to parameter of type '{ a: number; }'.
-  Object literal may only specify known properties, and 'b' does not exist in type '{ a: number; }'.ts(2345)
-*/
-expect<any>({ a: 1 }).to.eql({ b: 1 }); // OK in case you really want to do this
-```
-
-### Method typechecking
-
-```typescript
-// Chai:
-expect('test').to.be.above(5); // No typescript error
-
-// Hein:
-expect('test').to.be.above(5);
-/*
-Property 'above' does not exist on type 'StringExpect<string>'.ts(2339)
-*/
-```
-
-## Always call methods, getters are not assertions
-
-With chai there are special properties that act as assertions. In Hein you have to call the method to assert.
-
-```typescript
-// Chai:
-expect(true).to.be.true;
-
-// Hein:
-expect(true).to.be.true();
-```
-
-I recommend using [no-unused-expressions eslint rule](https://typescript-eslint.io/rules/no-unused-expressions/) to avoid this.

package/dist/utils/assertion.d.ts

@@ -1,25 +0,0 @@
-export declare class AssertionError extends Error {
-    actual: any;
-    expected: any;
-    showDiff: boolean;
-    constructor(actual: any, expected: any, message: string);
-}
-interface ReportOptions<T, U> {
-    status: 'ok' | 'notok';
-    messageId?: T;
-    message?: string;
-    expected?: U;
-    actual?: U;
-    noStringify?: boolean;
-}
-export declare type Report<T> = <U>(args: ReportOptions<T, U>) => true | void;
-interface AssertionArguments<T extends string, U extends (...args: any[]) => void> {
-    messages: Record<T, string> & {
-        not: string;
-    };
-    test: (report: Report<T>) => U;
-}
-export declare const format: (message: string, data: Record<any, any>, noStringify: boolean) => string;
-export declare const createAssertion: <T extends string, U extends (...args: any[]) => void>({ messages, test }: AssertionArguments<T, U>) => U[];
-export {};
-//# sourceMappingURL=assertion.d.ts.map

package/dist/utils/assertion.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"assertion.d.ts","sourceRoot":"","sources":["../../src/utils/assertion.ts"],"names":[],"mappings":"AAUA,qBAAa,cAAe,SAAQ,KAAK;IAGlB,MAAM,EAAE,GAAG;IAAS,QAAQ,EAAE,GAAG;IAF7C,QAAQ,UAAQ;gBAEJ,MAAM,EAAE,GAAG,EAAS,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM;CAGxE;AAED,UAAU,aAAa,CAAC,CAAC,EAAE,CAAC;IACxB,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC;IACvB,SAAS,CAAC,EAAE,CAAC,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,CAAC,CAAC;IACb,MAAM,CAAC,EAAE,CAAC,CAAC;IACX,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,oBAAY,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;AAEtE,UAAU,kBAAkB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI;IAC7E,QAAQ,EAAE,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG;QAAE,GAAG,EAAE,MAAM,CAAC;KAAE,CAAC;IAC/C,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;CAClC;AAED,eAAO,MAAM,MAAM,YAAa,MAAM,QAAQ,OAAO,GAAG,EAAE,GAAG,CAAC,eAAe,OAAO,WAKnF,CAAC;AAEF,eAAO,MAAM,eAAe,yCAA0C,GAAG,EAAE,KAAK,IAAI,sDAiBnF,CAAC"}

package/dist/utils/assertion.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAssertion = exports.format = exports.AssertionError = void 0;
-const mustache = require("mustache");
-const lodash_1 = require("lodash");
-const stringify_1 = require("./stringify");
-// TODO: toggle this on and off inside format function
-mustache.escape = (x) => x;
-const { render } = mustache;
-class AssertionError extends Error {
-    constructor(actual, expected, message) {
-        super(message);
-        this.actual = actual;
-        this.expected = expected;
-        this.showDiff = true;
-    }
-}
-exports.AssertionError = AssertionError;
-const format = (message, data, noStringify) => {
-    if (noStringify) {
-        return render(message, data);
-    }
-    return render(message, (0, lodash_1.mapValues)(data, stringify_1.stringify));
-};
-exports.format = format;
-const createAssertion = ({ messages, test }) => {
-    const factory = ({ inverted } = {}) => {
-        const report = ({ status, messageId, message, actual, expected, noStringify }) => {
-            // console.trace({ status, messageId, message, actual, expected });
-            if (inverted && status === 'ok') {
-                throw new AssertionError(actual, expected, (0, exports.format)(message || messages[messageId] || messages.not, { actual, expected }, noStringify));
-            }
-            if (!inverted && status === 'notok') {
-                throw new AssertionError(actual, expected, (0, exports.format)(message || messages[messageId], { actual, expected }, noStringify));
-            }
-            return true;
-        };
-        return ((...args) => {
-            return test(report)(...args);
-        });
-    };
-    return [factory(), factory({ inverted: true })];
-};
-exports.createAssertion = createAssertion;
-//# sourceMappingURL=assertion.js.map

package/dist/utils/assertion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"assertion.js","sourceRoot":"","sources":["../../src/utils/assertion.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACrC,mCAAmC;AACnC,2CAAwC;AAGxC,sDAAsD;AACrD,QAAgB,CAAC,MAAM,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC;AAE5C,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC;AAE5B,MAAa,cAAe,SAAQ,KAAK;IAGrC,YAAmB,MAAW,EAAS,QAAa,EAAE,OAAe;QACjE,KAAK,CAAC,OAAO,CAAC,CAAC;QADA,WAAM,GAAN,MAAM,CAAK;QAAS,aAAQ,GAAR,QAAQ,CAAK;QAF7C,aAAQ,GAAG,IAAI,CAAC;IAIvB,CAAC;CACJ;AAND,wCAMC;AAkBM,MAAM,MAAM,GAAG,CAAC,OAAe,EAAE,IAAsB,EAAE,WAAoB,EAAE,EAAE;IACpF,IAAI,WAAW,EAAE;QACb,OAAO,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KAChC;IACD,OAAO,MAAM,CAAC,OAAO,EAAE,IAAA,kBAAS,EAAC,IAAI,EAAE,qBAAS,CAAC,CAAC,CAAC;AACvD,CAAC,CAAC;AALW,QAAA,MAAM,UAKjB;AAEK,MAAM,eAAe,GAAG,CAAuD,EAAE,QAAQ,EAAE,IAAI,EAA4B,EAAE,EAAE;IAClI,MAAM,OAAO,GAAG,CAAC,EAAE,QAAQ,KAAiB,EAAE,EAAE,EAAE;QAC9C,MAAM,MAAM,GAAc,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,EAAE;YACxF,mEAAmE;YACnE,IAAI,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE;gBAC7B,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAA,cAAM,EAAC,OAAO,IAAI,QAAQ,CAAC,SAAS,CAAC,IAAI,QAAQ,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;aACzI;YACD,IAAI,CAAC,QAAQ,IAAI,MAAM,KAAK,OAAO,EAAE;gBACjC,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAA,cAAM,EAAC,OAAO,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;aACzH;YACD,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC;QACF,OAAO,CAAC,CAAC,GAAG,IAAW,EAAE,EAAE;YACvB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QACjC,CAAC,CAAM,CAAC;IACZ,CAAC,CAAC;IACF,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC,CAAC;AAjBW,QAAA,eAAe,mBAiB1B"}

package/dist/utils/stringify.d.ts

@@ -1,2 +0,0 @@
-export declare const stringify: (value: any) => any;
-//# sourceMappingURL=stringify.d.ts.map

package/dist/utils/stringify.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stringify.d.ts","sourceRoot":"","sources":["../../src/utils/stringify.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,UAAW,GAAG,QAWnC,CAAC"}

package/dist/utils/stringify.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringify = void 0;
-const loupe_1 = require("loupe");
-const stringify = (value) => {
-    if (typeof value === 'string') {
-        return `'${value}'`;
-    }
-    if (value instanceof RegExp) {
-        return value.toString();
-    }
-    if (value instanceof Error) {
-        return `${value.name}: ${value.message}`;
-    }
-    return (0, loupe_1.inspect)(value);
-};
-exports.stringify = stringify;
-//# sourceMappingURL=stringify.js.map

package/dist/utils/stringify.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"stringify.js","sourceRoot":"","sources":["../../src/utils/stringify.ts"],"names":[],"mappings":";;;AAAA,iCAAgC;AAEzB,MAAM,SAAS,GAAG,CAAC,KAAU,EAAE,EAAE;IACpC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC3B,OAAO,IAAK,KAAM,GAAG,CAAC;KACzB;IACD,IAAI,KAAK,YAAY,MAAM,EAAE;QACzB,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;KAC3B;IACD,IAAI,KAAK,YAAY,KAAK,EAAE;QACxB,OAAO,GAAI,KAAK,CAAC,IAAK,KAAM,KAAK,CAAC,OAAQ,EAAE,CAAC;KAChD;IACD,OAAO,IAAA,eAAO,EAAC,KAAK,CAAC,CAAC;AAC1B,CAAC,CAAC;AAXW,QAAA,SAAS,aAWpB"}

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-    "compilerOptions": {
-        "outDir": "./dist",
-        "module": "CommonJS",
-        "moduleResolution": "node",
-        "target": "ES2018",
-        "noUnusedLocals": true,
-        "declaration": true,
-        "declarationMap": true,
-        "sourceMap": true,
-        "baseUrl": ".",
-        "lib": [
-            "ES2022"
-        ]
-    },
-    "include": [
-        "src/**/*.ts"
-    ]
-}