tstyche 2.1.0 → 3.0.0-beta.0

package/README.md

@@ -2,10 +2,8 @@
 
 [![version][version-badge]][version-url]
 [![license][license-badge]][license-url]
-[![requirements][requirements-badge]][requirements-url]
 [![install-size][install-size-badge]][install-size-url]
 [![coverage][coverage-badge]][coverage-url]
-[![discord][discord-badge]][discord-url]
 
 The Essential Type Testing Tool.
 
@@ -80,7 +78,7 @@ Visit [https://tstyche.org](https://tstyche.org) to view the full documentation.
 
 ## Feedback
 
-If you have any questions or suggestions, [start a discussion](https://github.com/tstyche/tstyche/discussions/new/choose) or [open an issue](https://github.com/tstyche/tstyche/issues/new/choose) on GitHub. Preferring a chat? Join our [Discord server][discord-url].
+If you have any questions or suggestions, [start a discussion](https://github.com/tstyche/tstyche/discussions/new/choose) or [open an issue](https://github.com/tstyche/tstyche/issues/new/choose) on GitHub. Preferring a chat? Join our [Discord server](https://discord.gg/gCSasd3QJq).
 
 ## License
 
@@ -90,11 +88,7 @@ If you have any questions or suggestions, [start a discussion](https://github.co
 [version-url]: https://npmjs.com/package/tstyche
 [license-badge]: https://badgen.net/github/license/tstyche/tstyche
 [license-url]: https://github.com/tstyche/tstyche/blob/main/LICENSE.md
-[requirements-badge]: https://badgen.net/npm/node/tstyche
-[requirements-url]: https://tstyche.org/reference/requirements
 [install-size-badge]: https://badgen.net/packagephobia/install/tstyche
 [install-size-url]: https://packagephobia.com/result?p=tstyche
 [coverage-badge]: https://badgen.net/codacy/coverage/a581ca5c323a455886b7bdd9623c4ec8
 [coverage-url]: https://app.codacy.com/gh/tstyche/tstyche/coverage/dashboard
-[discord-badge]: https://badgen.net/static/chat/on%20Discord
-[discord-url]: https://discord.gg/gCSasd3QJq

package/build/tstyche.d.ts

@@ -1,26 +1,11 @@
 import type ts from 'typescript';
 
-declare enum CancellationReason {
-    ConfigChange = "configChange",
-    ConfigError = "configError",
-    FailFast = "failFast",
-    WatchClose = "watchClose"
-}
-
-declare class CancellationToken {
-    #private;
-    get isCancellationRequested(): boolean;
-    get reason(): CancellationReason | undefined;
-    cancel(reason: CancellationReason): void;
-    reset(): void;
-}
-
 declare class StoreService {
     #private;
     constructor();
     getSupportedTags(): Promise<Array<string>>;
-    install(tag: string, cancellationToken?: CancellationToken): Promise<string | undefined>;
-    load(tag: string, cancellationToken?: CancellationToken): Promise<typeof ts | undefined>;
+    install(tag: string): Promise<string | undefined>;
+    load(tag: string): Promise<typeof ts | undefined>;
     open(): Promise<void>;
     update(): Promise<void>;
     validateTag(tag: string): Promise<boolean | undefined>;
@@ -147,7 +132,6 @@ declare class Diagnostic {
     static error(text: string | Array<string>, origin?: DiagnosticOrigin): Diagnostic;
     extendWith(text: string | Array<string>, origin?: DiagnosticOrigin): Diagnostic;
     static fromDiagnostics(diagnostics: Array<ts.Diagnostic>, compiler: typeof ts): Array<Diagnostic>;
-    static fromError(text: string | Array<string>, error: unknown): Diagnostic;
     static warning(text: string | Array<string>, origin?: DiagnosticOrigin): Diagnostic;
 }
 
@@ -274,12 +258,12 @@ declare enum Color {
     Gray = "90"
 }
 
-type ScribblerNode = Array<ScribblerNode> | ScribblerJsx.Element | string | undefined;
+type ScribblerNode = Array<ScribblerNode> | ScribblerJsx.Element | string | number | undefined;
 type FunctionComponent = (props: Record<string, unknown>) => ScribblerJsx.Element;
 declare namespace ScribblerJsx {
     interface Element {
         props: Record<string, unknown>;
-        type: FunctionComponent | string;
+        type: FunctionComponent | number | string;
     }
     interface ElementChildrenAttribute {
         children: ScribblerNode;
@@ -320,7 +304,7 @@ interface TextProps {
 }
 declare function Text({ children, color, indent }: TextProps): ScribblerJsx.Element;
 
-declare function addsPackageStepText(compilerVersion: string, installationPath: string): ScribblerJsx.Element;
+declare function addsPackageStepText(packageVersion: string, packagePath: string): ScribblerJsx.Element;
 
 declare function describeNameText(name: string, indent?: number): ScribblerJsx.Element;
 
@@ -485,6 +469,21 @@ declare class SelectService {
     selectFiles(): Promise<Array<string>>;
 }
 
+declare enum CancellationReason {
+    ConfigChange = "configChange",
+    ConfigError = "configError",
+    FailFast = "failFast",
+    WatchClose = "watchClose"
+}
+
+declare class CancellationToken {
+    #private;
+    get isCancellationRequested(): boolean;
+    get reason(): CancellationReason | undefined;
+    cancel(reason: CancellationReason): void;
+    reset(): void;
+}
+
 declare class TSTyche {
     #private;
     static version: string;
@@ -512,6 +511,10 @@ declare class Environment {
      * Specifies whether interactive elements should be disabled in the output.
      */
     static get noInteractive(): boolean;
+    /**
+     * The base URL of the 'npm' registry to use.
+     */
+    static get npmRegistry(): string;
     /**
      * The directory where to store the 'typescript' packages.
      */
@@ -537,8 +540,8 @@ type Event = ["config:error", {
 }] | ["run:end", {
     result: Result;
 }] | ["store:info", {
-    compilerVersion: string;
-    installationPath: string;
+    packagePath: string;
+    packageVersion: string;
 }] | ["store:error", {
     diagnostics: Array<Diagnostic>;
 }] | ["target:start", {
@@ -656,9 +659,8 @@ 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(indexText: string, countText: string, signatureText: string): string;
+    static overloadGaveTheFollowingError(index: number, count: number, signatureText: string): string;
     static raisedTypeError(count?: number): string;
     static typeArgumentMustBe(argumentNameText: string, expectedText: string): string;
     static typeDidNotRaiseError(isTypeNode: boolean): string;
@@ -729,7 +731,6 @@ declare class ExpectService {
     toAcceptProps: ToAcceptProps;
     toBe: ToBe;
     toBeAny: PrimitiveTypeMatcher;
-    toBeAssignable: ToBeAssignableWith;
     toBeAssignableTo: ToBeAssignableTo;
     toBeAssignableWith: ToBeAssignableWith;
     toBeBigInt: PrimitiveTypeMatcher;
@@ -743,12 +744,10 @@ declare class ExpectService {
     toBeUniqueSymbol: PrimitiveTypeMatcher;
     toBeUnknown: PrimitiveTypeMatcher;
     toBeVoid: PrimitiveTypeMatcher;
-    toEqual: ToBe;
     toHaveProperty: ToHaveProperty;
     toMatch: ToMatch;
     toRaiseError: ToRaiseError;
     constructor(compiler: typeof ts, typeChecker: TypeChecker);
-    static assertTypeChecker(typeChecker: ts.TypeChecker): typeChecker is TypeChecker;
     match(assertion: Assertion, onDiagnostics: DiagnosticsHandler): MatchResult | undefined;
 }