tstyche 3.0.0-beta.1 → 3.0.0-beta.3

package/README.md

@@ -39,8 +39,8 @@ To organize, debug and plan tests TSTyche has:
 The assertions can be used to write type tests (like in the above example) or mixed in your functional tests:
 
 ```ts
-import assert from "node:assert/strict";
-import { test } from "node:test";
+import assert from "node:assert";
+import test from "node:test";
 import * as tstyche from "tstyche";
 
 function secondItem<T>(target: Array<T>): T | undefined {
@@ -56,7 +56,7 @@ test("handles numbers", () => {
 
 Here is the list of all matchers:
 
-- `.toBe()`, `.toBeAssignableTo()`, `.toBeAssignableWith()`, `.toMatch()` compare types or types of expression,
+- `.toBe()`, `.toBeAssignableTo()`, `.toBeAssignableWith()` compare types or types of expression,
 - `.toAcceptProps()` checks types of JSX component's props,
 - `.toHaveProperty()` looks up keys on an object type,
 - `.toRaiseError()` captures the type error message or code,

package/build/index.cjs

@@ -14,4 +14,6 @@ const noopChain = new Proxy(doNothing, {
 exports.describe = noopChain;
 exports.expect = noopChain;
 exports.it = noopChain;
+exports.omit = doNothing;
+exports.pick = doNothing;
 exports.test = noopChain;

package/build/index.d.cts

@@ -97,28 +97,6 @@ interface Matchers {
          */
         (target: unknown): void;
     };
-    /**
-     * Checks if the source type is assignable with the target type.
-     *
-     * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
-     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-     */
-    toBeAssignable: {
-        /**
-         * Checks if the source type is assignable with the target type.
-         *
-         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
-         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-         */
-        <Target>(): void;
-        /**
-         * Checks if the source type is assignable with type of the target expression.
-         *
-         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
-         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-         */
-        (target: unknown): void;
-    };
     /**
      * Checks if the source type is assignable to the target type.
      */
@@ -145,42 +123,26 @@ interface Matchers {
          */
         (target: unknown): void;
     };
-    /**
-     * Checks if the source type is identical to the target type.
-     *
-     * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
-     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-     */
-    toEqual: {
-        /**
-         * Checks if the source type is identical to the target type.
-         *
-         * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
-         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-         */
-        <Target>(): void;
-        /**
-         * Checks if the source type is identical to type of the target expression.
-         *
-         * @deprecated This matcher will be removed in TSTyche 3.
-         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-         */
-        (target: unknown): void;
-    };
     /**
      * Checks if a property key exists on the source type.
      */
     toHaveProperty: (key: string | number | symbol) => void;
     /**
      * Checks if the source type matches the target type.
+     *
+     * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
      */
     toMatch: {
         /**
          * Checks if the source type matches the target type.
+         *
+         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
          */
         <Target>(): void;
         /**
          * Checks if the source type matches type of the target expression.
+         *
+         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
          */
         (target: unknown): void;
     };
@@ -340,6 +302,18 @@ interface Expect {
         };
     };
 }
+/**
+ * Builds an assertion.
+ */
+declare const expect: Expect;
+/**
+ * Reshapes type of the given object by removing the specified keys.
+ */
+declare function omit<T, K extends PropertyKey>(object: T, ...keys: [K, ...Array<K>]): Omit<T, K>;
+/**
+ * Reshapes type of the given object by keeping only the specified keys.
+ */
+declare function pick<T, K extends keyof T>(object: T, ...keys: [K, ...Array<K>]): Pick<T, K>;
 /**
  * Defines a test group.
  */
@@ -352,9 +326,5 @@ declare const test: Test;
  * Defines a single test.
  */
 declare const it: Test;
-/**
- * Builds an assertion.
- */
-declare const expect: Expect;
 
-export { describe, expect, it, test };
+export { describe, expect, it, omit, pick, test };

package/build/index.d.ts

@@ -97,28 +97,6 @@ interface Matchers {
          */
         (target: unknown): void;
     };
-    /**
-     * Checks if the source type is assignable with the target type.
-     *
-     * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
-     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-     */
-    toBeAssignable: {
-        /**
-         * Checks if the source type is assignable with the target type.
-         *
-         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
-         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-         */
-        <Target>(): void;
-        /**
-         * Checks if the source type is assignable with type of the target expression.
-         *
-         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
-         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-         */
-        (target: unknown): void;
-    };
     /**
      * Checks if the source type is assignable to the target type.
      */
@@ -145,42 +123,26 @@ interface Matchers {
          */
         (target: unknown): void;
     };
-    /**
-     * Checks if the source type is identical to the target type.
-     *
-     * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
-     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-     */
-    toEqual: {
-        /**
-         * Checks if the source type is identical to the target type.
-         *
-         * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
-         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-         */
-        <Target>(): void;
-        /**
-         * Checks if the source type is identical to type of the target expression.
-         *
-         * @deprecated This matcher will be removed in TSTyche 3.
-         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
-         */
-        (target: unknown): void;
-    };
     /**
      * Checks if a property key exists on the source type.
      */
     toHaveProperty: (key: string | number | symbol) => void;
     /**
      * Checks if the source type matches the target type.
+     *
+     * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
      */
     toMatch: {
         /**
          * Checks if the source type matches the target type.
+         *
+         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
          */
         <Target>(): void;
         /**
          * Checks if the source type matches type of the target expression.
+         *
+         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
          */
         (target: unknown): void;
     };
@@ -340,6 +302,18 @@ interface Expect {
         };
     };
 }
+/**
+ * Builds an assertion.
+ */
+declare const expect: Expect;
+/**
+ * Reshapes type of the given object by removing the specified keys.
+ */
+declare function omit<T, K extends PropertyKey>(object: T, ...keys: [K, ...Array<K>]): Omit<T, K>;
+/**
+ * Reshapes type of the given object by keeping only the specified keys.
+ */
+declare function pick<T, K extends keyof T>(object: T, ...keys: [K, ...Array<K>]): Pick<T, K>;
 /**
  * Defines a test group.
  */
@@ -352,9 +326,5 @@ declare const test: Test;
  * Defines a single test.
  */
 declare const it: Test;
-/**
- * Builds an assertion.
- */
-declare const expect: Expect;
 
-export { describe, expect, it, test };
+export { describe, expect, it, omit, pick, test };

package/build/index.js

@@ -9,4 +9,4 @@ const noopChain = new Proxy(doNothing, {
     },
 });
 
-export { noopChain as describe, noopChain as expect, noopChain as it, noopChain as test };
+export { noopChain as describe, noopChain as expect, noopChain as it, doNothing as omit, doNothing as pick, noopChain as test };

package/build/tstyche.d.ts

@@ -1,11 +1,47 @@
 import type ts from 'typescript';
 
-declare class TestTree {
-    diagnostics: Set<ts.Diagnostic>;
-    members: Array<TestMember | Assertion>;
-    sourceFile: ts.SourceFile;
-    constructor(diagnostics: Set<ts.Diagnostic>, sourceFile: ts.SourceFile);
-    get hasOnly(): boolean;
+declare enum OptionBrand {
+    String = "string",
+    Number = "number",
+    Boolean = "boolean",
+    BareTrue = "bareTrue",// a boolean option that does not take a value and when specified is interpreted as 'true'
+    List = "list"
+}
+
+declare enum OptionGroup {
+    CommandLine = 2,
+    ConfigFile = 4
+}
+
+declare class ConfigDiagnosticText {
+    #private;
+    static expected(element: string): string;
+    static expectsListItemType(optionName: string, optionBrand: OptionBrand): string;
+    static expectsValue(optionName: string, optionGroup: OptionGroup): string;
+    static fileDoesNotExist(filePath: string): string;
+    static seen(element: string): string;
+    static testFileMatchCannotStartWith(segment: string): Array<string>;
+    static requiresValueType(optionName: string, optionBrand: OptionBrand, optionGroup: OptionGroup): string;
+    static unknownOption(optionName: string): string;
+    static versionIsNotSupported(value: string): string;
+    static watchCannotBeEnabled(): string;
+}
+
+declare class StoreService {
+    #private;
+    constructor();
+    getSupportedTags(): Promise<Array<string> | undefined>;
+    install(tag: string): Promise<void>;
+    load(tag: string): Promise<typeof ts | undefined>;
+    open(): Promise<void>;
+    prune(): Promise<void>;
+    update(): Promise<void>;
+    validateTag(tag: string): Promise<boolean | undefined>;
+}
+
+declare enum DiagnosticCategory {
+    Error = "error",
+    Warning = "warning"
 }
 
 declare enum TestMemberBrand {
@@ -13,6 +49,7 @@ declare enum TestMemberBrand {
     Test = "test",
     Expect = "expect"
 }
+
 declare enum TestMemberFlags {
     None = 0,
     Fail = 1,
@@ -21,6 +58,14 @@ declare enum TestMemberFlags {
     Todo = 8
 }
 
+declare class TestTree {
+    diagnostics: Set<ts.Diagnostic>;
+    members: Array<TestMember | Assertion>;
+    sourceFile: ts.SourceFile;
+    constructor(diagnostics: Set<ts.Diagnostic>, sourceFile: ts.SourceFile);
+    get hasOnly(): boolean;
+}
+
 declare class TestMember {
     #private;
     brand: TestMemberBrand;
@@ -54,22 +99,28 @@ declare class CollectService {
     createTestTree(sourceFile: ts.SourceFile, semanticDiagnostics?: Array<ts.Diagnostic>): TestTree;
 }
 
+declare class SourceFile {
+    #private;
+    fileName: string;
+    text: string;
+    constructor(fileName: string, text: string);
+    getLineStarts(): Array<number>;
+    getLineAndCharacterOfPosition(position: number): {
+        line: number;
+        character: number;
+    };
+}
+
 declare class DiagnosticOrigin {
     assertion: Assertion | undefined;
     end: number;
-    sourceFile: ts.SourceFile;
+    sourceFile: SourceFile | ts.SourceFile;
     start: number;
-    constructor(start: number, end: number, sourceFile: ts.SourceFile, assertion?: Assertion);
+    constructor(start: number, end: number, sourceFile: SourceFile | ts.SourceFile, assertion?: Assertion);
     static fromAssertion(assertion: Assertion): DiagnosticOrigin;
-    static fromJsonNode(node: ts.Node, sourceFile: ts.SourceFile, skipTrivia: (position: number, sourceFile: ts.SourceFile) => number): DiagnosticOrigin;
     static fromNode(node: ts.Node, assertion?: Assertion): DiagnosticOrigin;
 }
 
-declare enum DiagnosticCategory {
-    Error = "error",
-    Warning = "warning"
-}
-
 declare class Diagnostic {
     #private;
     category: DiagnosticCategory;
@@ -199,43 +250,6 @@ interface EnvironmentOptions {
     typescriptPath: string | undefined;
 }
 
-declare enum OptionBrand {
-    String = "string",
-    Number = "number",
-    Boolean = "boolean",
-    BareTrue = "bareTrue",// a boolean option that does not take a value and when specified is interpreted as 'true'
-    List = "list"
-}
-declare enum OptionGroup {
-    CommandLine = 2,
-    ConfigFile = 4
-}
-
-declare class ConfigDiagnosticText {
-    #private;
-    static doubleQuotesExpected(): string;
-    static expectsListItemType(optionName: string, optionBrand: OptionBrand): string;
-    static expectsValue(optionName: string, optionGroup: OptionGroup): string;
-    static fileDoesNotExist(filePath: string): string;
-    static testFileMatchCannotStartWith(segment: string): Array<string>;
-    static requiresValueType(optionName: string, optionBrand: OptionBrand, optionGroup: OptionGroup): string;
-    static unknownOption(optionName: string): string;
-    static versionIsNotSupported(value: string): string;
-    static watchCannotBeEnabled(): string;
-}
-
-declare class StoreService {
-    #private;
-    constructor();
-    getSupportedTags(): Promise<Array<string> | undefined>;
-    install(tag: string): Promise<void>;
-    load(tag: string): Promise<typeof ts | undefined>;
-    open(): Promise<void>;
-    prune(): Promise<void>;
-    update(): Promise<void>;
-    validateTag(tag: string): Promise<boolean | undefined>;
-}
-
 interface ResolvedConfig extends EnvironmentOptions, Omit<CommandLineOptions, keyof ConfigFileOptions | "config">, Required<ConfigFileOptions> {
     /**
      * The path to a TSTyche configuration file.
@@ -525,6 +539,8 @@ declare class Cli {
 
 type Event = ["config:error", {
     diagnostics: Array<Diagnostic>;
+}] | ["deprecation:info", {
+    diagnostics: Array<Diagnostic>;
 }] | ["select:error", {
     diagnostics: Array<Diagnostic>;
 }] | ["run:start", {
@@ -651,6 +667,7 @@ declare class ExpectDiagnosticText {
     static argumentMustBeProvided(argumentNameText: string): string;
     static componentAcceptsProps(isTypeNode: boolean): string;
     static componentDoesNotAcceptProps(isTypeNode: boolean): string;
+    static matcherIsDeprecated(matcherNameText: string): Array<string>;
     static matcherIsNotSupported(matcherNameText: string): string;
     static overloadGaveTheFollowingError(index: number, count: number, signatureText: string): string;
     static raisedTypeError(count?: number): string;
@@ -844,4 +861,4 @@ declare class WatchService {
     watch(cancellationToken: CancellationToken): AsyncIterable<Array<Task>>;
 }
 
-export { Assertion, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, type CommandLineOptions, ConfigDiagnosticText, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, type Event, EventEmitter, type EventHandler, ExitCodeHandler, ExpectResult, ExpectService, type FileWatchHandler, FileWatcher, type InputHandler, InputService, type ItemDefinition, Line, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionGroup, OutputService, Path, ProjectResult, ProjectService, type ResolvedConfig, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, RunReporter, Runner, Scribbler, ScribblerJsx, type ScribblerOptions, SelectDiagnosticText, SelectService, SetupReporter, StoreService, SummaryReporter, TSTyche, TargetResult, type TargetResultStatus, Task, TaskResult, type TaskResultStatus, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, Text, type TypeChecker, Version, type WatchHandler, WatchReporter, WatchService, Watcher, type WatcherOptions, addsPackageText, defaultOptions, describeNameText, diagnosticText, environmentOptions, fileViewText, formattedText, helpText, summaryText, taskStatusText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };
+export { Assertion, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, type CommandLineOptions, ConfigDiagnosticText, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, type Event, EventEmitter, type EventHandler, ExitCodeHandler, ExpectResult, ExpectService, type FileWatchHandler, FileWatcher, type InputHandler, InputService, type ItemDefinition, Line, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionGroup, OutputService, Path, ProjectResult, ProjectService, type ResolvedConfig, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, RunReporter, Runner, Scribbler, ScribblerJsx, type ScribblerOptions, SelectDiagnosticText, SelectService, SetupReporter, SourceFile, StoreService, SummaryReporter, TSTyche, TargetResult, type TargetResultStatus, Task, TaskResult, type TaskResultStatus, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, Text, type TypeChecker, Version, type WatchHandler, WatchReporter, WatchService, Watcher, type WatcherOptions, addsPackageText, defaultOptions, describeNameText, diagnosticText, environmentOptions, fileViewText, formattedText, helpText, summaryText, taskStatusText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };