tstyche 1.0.0-beta.6 → 1.0.0-beta.8

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## [1.0.0-beta.8] - 2024-01-05
+
+### Changed
+
+- **Breaking!** Make `"target": ["current"]` the default instead of `"target": ["latest"]` ([#81](https://github.com/tstyche/tstyche/pull/81), [#80](https://github.com/tstyche/tstyche/pull/80), [#66](https://github.com/tstyche/tstyche/pull/66))
+- **New!** Load the installed TypeScript package for type testing instead of installing another copy to the store ([#71](https://github.com/tstyche/tstyche/pull/71), [#64](https://github.com/tstyche/tstyche/pull/64))
+
+### Added
+
+- Add the `Path` class ([#59](https://github.com/tstyche/tstyche/pull/59))
+
+### Fixed
+
+- Correctly handle command line options that do not take a value ([#58](https://github.com/tstyche/tstyche/pull/58))
+
+## [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
@@ -65,6 +94,8 @@
 
 _First pre-release._
 
+[1.0.0-beta.8]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.8
+[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

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.
@@ -83,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/tstyche.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
 
-import type ts from 'typescript/lib/tsserverlibrary.js';
+import type ts from 'typescript';
 
 declare enum DiagnosticCategory {
     Error = "error",
@@ -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;
@@ -35,26 +36,21 @@ declare class Diagnostic {
 declare class StoreService {
     #private;
     constructor();
-    get supportedTags(): Array<string>;
+    getSupportedTags(signal?: AbortSignal): Promise<Array<string>>;
     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>;
-    resolveTag(tag: string): string | undefined;
+    prune: () => Promise<void>;
+    resolveTag(tag: string, signal?: AbortSignal): Promise<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;
+    validateTag(tag: string, signal?: AbortSignal): Promise<boolean>;
 }
 
 declare enum OptionBrand {
     String = "string",
     Number = "number",
     Boolean = "boolean",
+    True = "true",// an option which does not take a value
     List = "list",
     Object = "object"
 }
@@ -82,7 +78,7 @@ interface BaseOptionDefinition {
     required?: boolean;
 }
 interface PrimitiveTypeOptionDefinition extends BaseOptionDefinition {
-    brand: OptionBrand.String | OptionBrand.Number | OptionBrand.Boolean;
+    brand: OptionBrand.String | OptionBrand.Number | OptionBrand.Boolean | OptionBrand.True;
 }
 interface ListTypeOptionDefinition extends BaseOptionDefinition {
     brand: OptionBrand.List;
@@ -115,7 +111,7 @@ interface CommandLineOptions {
      */
     failFast?: boolean;
     /**
-     * Print the list of CLI options with brief descriptions and exit.
+     * Print the list of command line options with brief descriptions and exit.
      */
     help?: boolean;
     /**
@@ -195,7 +191,7 @@ declare class ConfigService {
     get commandLineOptions(): CommandLineOptions;
     get configFileOptions(): ConfigFileOptions;
     static get defaultOptions(): Required<ConfigFileOptions>;
-    parseCommandLine(commandLineArgs: Array<string>): void;
+    parseCommandLine(commandLineArgs: Array<string>): Promise<void>;
     readConfigFile(filePath?: string, // TODO take URL as well
     sourceText?: string): Promise<void>;
     resolveConfig(): ResolvedConfig;
@@ -205,14 +201,15 @@ declare class ConfigService {
 declare class TSTyche {
     #private;
     readonly resolvedConfig: ResolvedConfig;
+    static readonly version = "__version__";
     constructor(resolvedConfig: ResolvedConfig, storeService: StoreService);
-    static get version(): string;
     run(testFiles: Array<string | URL>): Promise<void>;
 }
 
-declare enum AssertionSource {
-    Argument = 0,
-    TypeArgument = 1
+declare class Cli {
+    #private;
+    constructor(process: NodeJS.Process);
+    run(commandLineArguments: Array<string>): Promise<void>;
 }
 
 declare enum TestMemberBrand {
@@ -231,25 +228,22 @@ declare enum TestMemberFlags {
 
 declare class TestTree {
     compiler: typeof ts;
-    diagnostics: Array<ts.Diagnostic>;
+    diagnostics: Set<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: Set<ts.Diagnostic>, sourceFile: ts.SourceFile);
     get hasOnly(): boolean;
 }
 
 declare class TestMember {
-    #private;
     brand: TestMemberBrand;
     node: ts.CallExpression;
     parent: TestTree | TestMember;
     flags: TestMemberFlags;
     compiler: typeof ts;
-    diagnostics: Array<ts.Diagnostic>;
+    diagnostics: Set<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>;
@@ -259,25 +253,15 @@ interface MatcherNode extends ts.CallExpression {
     expression: ts.PropertyAccessExpression;
 }
 declare class Assertion extends TestMember {
-    #private;
     matcherNode: MatcherNode;
     modifierNode: ts.PropertyAccessExpression;
     notNode: ts.PropertyAccessExpression | undefined;
     isNot: boolean;
-    name: string;
     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,25 +271,15 @@ 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 {
     #private;
+    /**
+     * Is `true` if the TypeScript package is installed.
+     */
+    static get isTypeScriptInstalled(): boolean;
     /**
      * Specifies whether color should be disabled in the output.
      */
@@ -481,6 +455,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}.
  */
@@ -521,6 +578,46 @@ declare class Logger {
     writeWarning(body: JSX.Element | Array<JSX.Element>): void;
 }
 
+declare function addsPackageStepText(compilerVersion: string, installationPath: string): JSX.Element;
+
+declare function describeNameText(name: string, indent?: number): JSX.Element;
+
+declare function diagnosticText(diagnostic: Diagnostic): JSX.Element;
+
+declare function fileStatusText(status: FileResultStatus, testFile: URL): JSX.Element;
+
+declare function fileViewText(lines: Array<JSX.Element>, addEmptyFinalLine: boolean): 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;
+    expectCount: ResultCount;
+    fileCount: ResultCount;
+    onlyMatch: string | undefined;
+    pathMatch: Array<string>;
+    skipMatch: string | undefined;
+    targetCount: ResultCount;
+    testCount: ResultCount;
+}): JSX.Element;
+
+declare function testNameText(status: "fail" | "pass" | "skip" | "todo", name: string, indent?: number): JSX.Element;
+
+declare function usesCompilerStepText(compilerVersion: string, tsconfigFilePath: string | undefined, options?: {
+    prependEmptyLine: boolean;
+}): JSX.Element;
+
+declare class Path {
+    static basename(filePath: string): string;
+    static dirname(filePath: string): string;
+    static join(...filePaths: Array<string>): string;
+    static normalizeSlashes(filePath: string): string;
+    static relative(from: string, to: string): string;
+    static resolve(...filePaths: Array<string>): string;
+}
+
 declare class ProjectService {
     #private;
     compiler: typeof ts;
@@ -565,16 +662,6 @@ declare enum Color {
     Gray = "90"
 }
 
-declare function addsPackageStepText(compilerVersion: string, installationPath: string): JSX.Element;
-
-declare function describeNameText(name: string, indent?: number): JSX.Element;
-
-declare function diagnosticText(diagnostic: Diagnostic): JSX.Element;
-
-declare function fileStatusText(status: FileResultStatus, testFile: URL): JSX.Element;
-
-declare function fileViewText(lines: Array<JSX.Element>, addEmptyFinalLine: boolean): JSX.Element;
-
 interface LineProps {
     children?: JSX.ElementChildrenAttribute["children"];
     color?: Color;
@@ -586,34 +673,6 @@ declare class Line implements JSX.ElementClass {
     render(): JSX.Element;
 }
 
-declare function summaryText({ duration, expectCount, fileCount, onlyMatch, pathMatch, skipMatch, targetCount, testCount, }: {
-    duration: number;
-    expectCount: ResultCount;
-    fileCount: ResultCount;
-    onlyMatch: string | undefined;
-    pathMatch: Array<string>;
-    skipMatch: string | undefined;
-    targetCount: ResultCount;
-    testCount: ResultCount;
-}): JSX.Element;
-
-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;
-
 type ElementChildren = Array<ElementChildren> | JSX.Element | string | undefined;
 type ComponentConstructor = new (props: Record<string, unknown>) => JSX.ElementClass;
 declare global {
@@ -676,4 +735,15 @@ 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 };
+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;
+}
+
+export { Assertion, Cli, CollectService, Color, type CommandLineOptions, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, type DiagnosticOrigin, Environment, type Event, EventEmitter, type EventHandler, Expect, ExpectResult, FileResult, type FileResultStatus, type ItemDefinition, Line, Logger, type LoggerOptions, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionGroup, Path, 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, formattedText, helpText, summaryText, testNameText, usesCompilerStepText };