tstyche 1.0.0-beta.5 → 1.0.0-beta.7

package/CHANGELOG.md

@@ -1,19 +1,43 @@
 # Changelog
 
+## [1.0.0-beta.7] - 2023-12-29
+
+### Changed
+
+- **Breaking!** Add new `Expect` class to validate provided values and orchestrate matchers logic ([#39](https://github.com/tstyche/tstyche/pull/39))
+
+### Added
+
+- **New!** Load local language service plugins to support files like `.svelte` or `.vue` ([#56](https://github.com/tstyche/tstyche/pull/56))
+
+### Fixed
+
+- Make the source argument checks stricter for the `.toHaveProperty()` matcher ([#46](https://github.com/tstyche/tstyche/pull/46))
+
+## [1.0.0-beta.6] - 2023-12-03
+
+### Added
+
+- **New!** Add `.toHaveProperty()` matcher ([#36](https://github.com/tstyche/tstyche/pull/36))
+
+### Fixed
+
+- Accept template literals as arguments of the `.toRaiseError()` matcher ([#38](https://github.com/tstyche/tstyche/pull/38))
+
 ## [1.0.0-beta.5] - 2023-11-27
 
 ### Changed
 
-- **Breaking:** Move retry logic to the `Lock` class ([#31](https://github.com/tstyche/tstyche/pull/31))
+- **Breaking!** Move retry logic to the `Lock` class ([#31](https://github.com/tstyche/tstyche/pull/31))
 - Bring back support for Node.js 16 ([#28](https://github.com/tstyche/tstyche/pull/28), [#27](https://github.com/tstyche/tstyche/pull/27))
 
 ### Added
 
-- Add support for the `current` target tag ([#33](https://github.com/tstyche/tstyche/pull/33))
+- **New!** Add support for the `current` target tag ([#33](https://github.com/tstyche/tstyche/pull/33))
 
 ### Fixed
 
-- Allow `.raiseError()` to take template literals as arguments. ([#35](https://github.com/tstyche/tstyche/pull/35))
+- Allow `.raiseError()` to take template literals as arguments ([#35](https://github.com/tstyche/tstyche/pull/35))
 
 ## [1.0.0-beta.4] - 2023-11-24
 
@@ -23,9 +47,9 @@
 
 ### Removed
 
-- **Breaking:** Remove the `context()` helper ([#24](https://github.com/tstyche/tstyche/pull/24))
-- **Breaking:** Drop support for Node.js 16 ([#22](https://github.com/tstyche/tstyche/pull/22))
-- **Breaking:** Rename methods of the `StoreService` class ([`5d74201`](https://github.com/tstyche/tstyche/commit/5d74201))
+- **Breaking!** Remove the `context()` helper ([#24](https://github.com/tstyche/tstyche/pull/24))
+- **Breaking!** Drop support for Node.js 16 ([#22](https://github.com/tstyche/tstyche/pull/22))
+- **Breaking!** Rename methods of the `StoreService` class ([`5d74201`](https://github.com/tstyche/tstyche/commit/5d74201))
 
 ### Fixed
 
@@ -55,6 +79,8 @@
 
 _First pre-release._
 
+[1.0.0-beta.7]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.7
+[1.0.0-beta.6]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.6
 [1.0.0-beta.5]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.5
 [1.0.0-beta.4]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.4
 [1.0.0-beta.3]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.3

package/README.md

@@ -2,7 +2,7 @@
 
 [![version][version-src]][version-href]
 [![license][license-src]][license-href]
-[![checks][checks-src]][checks-href]
+[![packagephobia][packagephobia-src]][packagephobia-href]
 [![coverage][coverage-src]][coverage-href]
 
 The Essential Type Testing Tool.
@@ -56,9 +56,10 @@ test("handles numbers", () => {
 
 Here is the list of all matchers:
 
-- `.toBeAssignable()`, `.toEqual()`, `.toMatch()` compares types or types of expression;
-- `.toRaiseError()` captures the error message or code;
-- `.toBeString()`, `.toBeNumber()`, `.toBeVoid()` and 9 more checks for primitive types.
+- `.toBeAssignable()`, `.toEqual()`, `.toMatch()` compares types or types of expression,
+- `.toHaveProperty()` looks up keys on an object type,
+- `.toRaiseError()` captures the type error message or code,
+- `.toBeString()`, `.toBeNumber()`, `.toBeVoid()` and 9 more shorthand checks for primitive types.
 
 ## Runner
 
@@ -82,7 +83,7 @@ Visit [https://tstyche.org](https://tstyche.org) to view the full documentation.
 [version-href]: https://npmjs.com/package/tstyche
 [license-src]: https://badgen.net/github/license/tstyche/tstyche
 [license-href]: https://github.com/tstyche/tstyche/blob/main/LICENSE.md
-[checks-src]: https://badgen.net/github/checks/tstyche/tstyche
-[checks-href]: https://github.com/tstyche/tstyche/actions/workflows/checks.yml
+[packagephobia-src]: https://badgen.net/packagephobia/install/tstyche
+[packagephobia-href]: https://packagephobia.com/result?p=tstyche
 [coverage-src]: https://badgen.net/codecov/c/github/tstyche/tstyche
 [coverage-href]: https://app.codecov.io/gh/tstyche/tstyche

package/build/index.d.cts

@@ -133,6 +133,10 @@ interface Matchers {
          */
         (target: unknown): void;
     };
+    /**
+     * Checks if a property key exists on the source type.
+     */
+    toHaveProperty: (key: string | number | symbol) => void;
     /**
      * Checks if the target type is a subtype the source type.
      */

package/build/index.d.ts

@@ -133,6 +133,10 @@ interface Matchers {
          */
         (target: unknown): void;
     };
+    /**
+     * Checks if a property key exists on the source type.
+     */
+    toHaveProperty: (key: string | number | symbol) => void;
     /**
      * Checks if the target type is a subtype the source type.
      */

package/build/tstyche.d.ts

@@ -23,6 +23,7 @@ declare class Diagnostic {
     constructor(text: string | Array<string>, category: DiagnosticCategory, origin?: DiagnosticOrigin | undefined);
     add(options: {
         code?: string;
+        origin?: DiagnosticOrigin;
         related?: Array<Diagnostic>;
     }): this;
     static error(text: string | Array<string>, origin?: DiagnosticOrigin): Diagnostic;
@@ -39,18 +40,12 @@ declare class StoreService {
     install(tag: string, signal?: AbortSignal): Promise<string | undefined>;
     load(tag: string, signal?: AbortSignal): Promise<typeof ts | undefined>;
     open(signal?: AbortSignal): Promise<void>;
-    prune(): Promise<void>;
+    prune: () => Promise<void>;
     resolveTag(tag: string): string | undefined;
     update(signal?: AbortSignal): Promise<void>;
     validateTag(tag: string): boolean;
 }
 
-interface TypeChecker extends ts.TypeChecker {
-    isTypeAssignableTo?: (source: ts.Type, target: ts.Type) => boolean;
-    isTypeIdenticalTo?: (source: ts.Type, target: ts.Type) => boolean;
-    isTypeSubtypeOf?: (source: ts.Type, target: ts.Type) => boolean;
-}
-
 declare enum OptionBrand {
     String = "string",
     Number = "number",
@@ -210,9 +205,10 @@ declare class TSTyche {
     run(testFiles: Array<string | URL>): Promise<void>;
 }
 
-declare enum AssertionSource {
-    Argument = 0,
-    TypeArgument = 1
+declare class Cli {
+    #private;
+    constructor(process: NodeJS.Process);
+    run(commandLineArgs: Array<string>): Promise<void>;
 }
 
 declare enum TestMemberBrand {
@@ -233,9 +229,8 @@ declare class TestTree {
     compiler: typeof ts;
     diagnostics: Array<ts.Diagnostic>;
     sourceFile: ts.SourceFile;
-    typeChecker?: TypeChecker | undefined;
     members: Array<TestMember | Assertion>;
-    constructor(compiler: typeof ts, diagnostics: Array<ts.Diagnostic>, sourceFile: ts.SourceFile, typeChecker?: TypeChecker | undefined);
+    constructor(compiler: typeof ts, diagnostics: Array<ts.Diagnostic>, sourceFile: ts.SourceFile);
     get hasOnly(): boolean;
 }
 
@@ -249,7 +244,6 @@ declare class TestMember {
     diagnostics: Array<ts.Diagnostic>;
     members: Array<TestMember | Assertion>;
     name: string;
-    typeChecker?: TypeChecker | undefined;
     constructor(brand: TestMemberBrand, node: ts.CallExpression, parent: TestTree | TestMember, flags: TestMemberFlags);
     get ancestorNames(): Array<string>;
     validate(): Array<Diagnostic>;
@@ -268,16 +262,8 @@ declare class Assertion extends TestMember {
     constructor(brand: TestMemberBrand, node: ts.CallExpression, parent: TestTree | TestMember, flags: TestMemberFlags, matcherNode: MatcherNode, modifierNode: ts.PropertyAccessExpression, notNode: ts.PropertyAccessExpression | undefined);
     get ancestorNames(): Array<string>;
     get matcherName(): ts.MemberName;
-    get sourceArguments(): ts.NodeArray<ts.Expression>;
-    get sourceType(): {
-        source: AssertionSource;
-        type: ts.Type;
-    } | undefined;
-    get targetArguments(): ts.NodeArray<ts.Expression>;
-    get targetType(): {
-        source: AssertionSource;
-        type: ts.Type;
-    } | undefined;
+    get source(): ts.NodeArray<ts.Expression> | ts.NodeArray<ts.TypeNode>;
+    get target(): ts.NodeArray<ts.Expression> | ts.NodeArray<ts.TypeNode>;
 }
 
 declare class CollectService {
@@ -287,21 +273,7 @@ declare class CollectService {
     readonly modifierIdentifiers: string[];
     readonly notIdentifier = "not";
     constructor(compiler: typeof ts);
-    createTestTree(sourceFile: ts.SourceFile, semanticDiagnostics?: Array<ts.Diagnostic>, typeChecker?: ts.TypeChecker | undefined): TestTree;
-}
-
-declare class Checker {
-    #private;
-    compiler: typeof ts;
-    constructor(compiler: typeof ts);
-    explain(assertion: Assertion): Array<Diagnostic>;
-    match(assertion: Assertion): boolean;
-}
-
-declare class Cli {
-    #private;
-    constructor(process: NodeJS.Process);
-    run(commandLineArgs: Array<string>): Promise<void>;
+    createTestTree(sourceFile: ts.SourceFile, semanticDiagnostics?: Array<ts.Diagnostic>): TestTree;
 }
 
 declare class Environment {
@@ -481,6 +453,89 @@ declare class EventEmitter {
     static removeHandler(handler: EventHandler): void;
 }
 
+interface MatchResult {
+    explain: () => Array<Diagnostic>;
+    isMatch: boolean;
+}
+interface TypeChecker extends ts.TypeChecker {
+    isTypeAssignableTo: (source: ts.Type, target: ts.Type) => boolean;
+    isTypeIdenticalTo: (source: ts.Type, target: ts.Type) => boolean;
+    isTypeSubtypeOf: (source: ts.Type, target: ts.Type) => boolean;
+}
+
+declare class PrimitiveTypeMatcher {
+    #private;
+    typeChecker: TypeChecker;
+    constructor(typeChecker: TypeChecker, targetTypeFlag: ts.TypeFlags, targetTypeText: string);
+    match(sourceType: ts.Type, isNot: boolean): MatchResult;
+}
+
+declare class ToBeAssignable {
+    #private;
+    typeChecker: TypeChecker;
+    constructor(typeChecker: TypeChecker);
+    match(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): MatchResult;
+}
+
+declare class ToEqual {
+    #private;
+    typeChecker: TypeChecker;
+    constructor(typeChecker: TypeChecker);
+    match(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): MatchResult;
+}
+
+declare class ToHaveProperty {
+    #private;
+    compiler: typeof ts;
+    typeChecker: TypeChecker;
+    constructor(compiler: typeof ts, typeChecker: TypeChecker);
+    match(sourceType: ts.Type, targetType: ts.StringLiteralType | ts.NumberLiteralType | ts.UniqueESSymbolType, isNot: boolean): MatchResult;
+}
+
+declare class ToMatch {
+    #private;
+    typeChecker: TypeChecker;
+    constructor(typeChecker: TypeChecker);
+    match(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): MatchResult;
+}
+
+declare class ToRaiseError {
+    #private;
+    compiler: typeof ts;
+    typeChecker: TypeChecker;
+    constructor(compiler: typeof ts, typeChecker: TypeChecker);
+    match(source: {
+        diagnostics: Array<ts.Diagnostic>;
+        node: ts.Expression | ts.TypeNode;
+    }, targetTypes: Array<ts.StringLiteralType | ts.NumberLiteralType>, isNot: boolean): MatchResult;
+}
+
+declare class Expect {
+    #private;
+    compiler: typeof ts;
+    typeChecker: TypeChecker;
+    toBeAny: PrimitiveTypeMatcher;
+    toBeAssignable: ToBeAssignable;
+    toBeBigInt: PrimitiveTypeMatcher;
+    toBeBoolean: PrimitiveTypeMatcher;
+    toBeNever: PrimitiveTypeMatcher;
+    toBeNull: PrimitiveTypeMatcher;
+    toBeNumber: PrimitiveTypeMatcher;
+    toBeString: PrimitiveTypeMatcher;
+    toBeSymbol: PrimitiveTypeMatcher;
+    toBeUndefined: PrimitiveTypeMatcher;
+    toBeUniqueSymbol: PrimitiveTypeMatcher;
+    toBeUnknown: PrimitiveTypeMatcher;
+    toBeVoid: PrimitiveTypeMatcher;
+    toEqual: ToEqual;
+    toHaveProperty: ToHaveProperty;
+    toMatch: ToMatch;
+    toRaiseError: ToRaiseError;
+    constructor(compiler: typeof ts, typeChecker: TypeChecker);
+    static assertTypeChecker(typeChecker: ts.TypeChecker): typeChecker is TypeChecker;
+    match(assertion: Assertion, expectResult: ExpectResult): MatchResult | undefined;
+}
+
 /**
  * Options to configure an instance of the {@link Logger}.
  */
@@ -554,17 +609,6 @@ declare class TaskRunner {
     run(testFiles: Array<URL>, target: Array<string>, signal?: AbortSignal): Promise<Result>;
 }
 
-declare enum Color {
-    Reset = "0",
-    Red = "31",
-    Green = "32",
-    Yellow = "33",
-    Blue = "34",
-    Magenta = "35",
-    Cyan = "36",
-    Gray = "90"
-}
-
 declare function addsPackageStepText(compilerVersion: string, installationPath: string): JSX.Element;
 
 declare function describeNameText(name: string, indent?: number): JSX.Element;
@@ -575,16 +619,9 @@ declare function fileStatusText(status: FileResultStatus, testFile: URL): JSX.El
 
 declare function fileViewText(lines: Array<JSX.Element>, addEmptyFinalLine: boolean): JSX.Element;
 
-interface LineProps {
-    children?: JSX.ElementChildrenAttribute["children"];
-    color?: Color;
-    indent?: number;
-}
-declare class Line implements JSX.ElementClass {
-    readonly props: LineProps;
-    constructor(props: LineProps);
-    render(): JSX.Element;
-}
+declare function formattedText(input: string | Array<string> | Record<string, unknown>): JSX.Element;
+
+declare function helpText(optionDefinitions: Map<string, OptionDefinition>, tstycheVersion: string): JSX.Element;
 
 declare function summaryText({ duration, expectCount, fileCount, onlyMatch, pathMatch, skipMatch, targetCount, testCount, }: {
     duration: number;
@@ -599,21 +636,21 @@ declare function summaryText({ duration, expectCount, fileCount, onlyMatch, path
 
 declare function testNameText(status: "fail" | "pass" | "skip" | "todo", name: string, indent?: number): JSX.Element;
 
-interface TextProps {
-    children?: JSX.ElementChildrenAttribute["children"];
-    color?: Color | undefined;
-    indent?: number | undefined;
-}
-declare class Text implements JSX.ElementClass {
-    readonly props: TextProps;
-    constructor(props: TextProps);
-    render(): JSX.Element;
-}
-
 declare function usesCompilerStepText(compilerVersion: string, tsconfigFilePath: string | undefined, options?: {
     prependEmptyLine: boolean;
 }): JSX.Element;
 
+declare enum Color {
+    Reset = "0",
+    Red = "31",
+    Green = "32",
+    Yellow = "33",
+    Blue = "34",
+    Magenta = "35",
+    Cyan = "36",
+    Gray = "90"
+}
+
 type ElementChildren = Array<ElementChildren> | JSX.Element | string | undefined;
 type ComponentConstructor = new (props: Record<string, unknown>) => JSX.ElementClass;
 declare global {
@@ -676,4 +713,4 @@ declare class Scribbler {
     render(element: JSX.Element | null): string;
 }
 
-export { Assertion, AssertionSource, Checker, Cli, CollectService, Color, type CommandLineOptions, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, type DiagnosticOrigin, Environment, type Event, EventEmitter, type EventHandler, ExpectResult, FileResult, type FileResultStatus, type ItemDefinition, Line, Logger, type LoggerOptions, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionGroup, ProjectResult, ProjectService, Reporter, type ResolvedConfig, Result, ResultCount, ResultManager, ResultStatus, ResultTiming, Scribbler, type ScribblerOptions, StoreService, SummaryReporter, TSTyche, TargetResult, TaskRunner, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, Text, ThoroughReporter, type TypeChecker, addsPackageStepText, describeNameText, diagnosticText, fileStatusText, fileViewText, summaryText, testNameText, usesCompilerStepText };
+export { Assertion, Cli, CollectService, type CommandLineOptions, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, type DiagnosticOrigin, Environment, type Event, EventEmitter, type EventHandler, Expect, ExpectResult, FileResult, type FileResultStatus, type ItemDefinition, Logger, type LoggerOptions, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionGroup, ProjectResult, ProjectService, Reporter, type ResolvedConfig, Result, ResultCount, ResultManager, ResultStatus, ResultTiming, Scribbler, type ScribblerOptions, StoreService, SummaryReporter, TSTyche, TargetResult, TaskRunner, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, ThoroughReporter, type TypeChecker, addsPackageStepText, describeNameText, diagnosticText, fileStatusText, fileViewText, formattedText, helpText, summaryText, testNameText, usesCompilerStepText };