tstyche 1.0.0-beta.7 → 1.0.0-beta.8

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # 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
@@ -79,6 +94,7 @@
 
 _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

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",
@@ -36,20 +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;
+    resolveTag(tag: string, signal?: AbortSignal): Promise<string | undefined>;
     update(signal?: AbortSignal): Promise<void>;
-    validateTag(tag: string): 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"
 }
@@ -77,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;
@@ -110,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;
     /**
@@ -190,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;
@@ -200,15 +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 class Cli {
     #private;
     constructor(process: NodeJS.Process);
-    run(commandLineArgs: Array<string>): Promise<void>;
+    run(commandLineArguments: Array<string>): Promise<void>;
 }
 
 declare enum TestMemberBrand {
@@ -227,21 +228,20 @@ declare enum TestMemberFlags {
 
 declare class TestTree {
     compiler: typeof ts;
-    diagnostics: Array<ts.Diagnostic>;
+    diagnostics: Set<ts.Diagnostic>;
     sourceFile: ts.SourceFile;
     members: Array<TestMember | Assertion>;
-    constructor(compiler: typeof ts, diagnostics: Array<ts.Diagnostic>, sourceFile: ts.SourceFile);
+    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;
     constructor(brand: TestMemberBrand, node: ts.CallExpression, parent: TestTree | TestMember, flags: TestMemberFlags);
@@ -253,12 +253,10 @@ 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;
@@ -278,6 +276,10 @@ declare class CollectService {
 
 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.
      */
@@ -576,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;
@@ -609,37 +651,6 @@ declare class TaskRunner {
     run(testFiles: Array<URL>, target: Array<string>, signal?: AbortSignal): Promise<Result>;
 }
 
-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 enum Color {
     Reset = "0",
     Red = "31",
@@ -651,6 +662,17 @@ declare enum Color {
     Gray = "90"
 }
 
+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;
+}
+
 type ElementChildren = Array<ElementChildren> | JSX.Element | string | undefined;
 type ComponentConstructor = new (props: Record<string, unknown>) => JSX.ElementClass;
 declare global {
@@ -713,4 +735,15 @@ declare class Scribbler {
     render(element: JSX.Element | null): string;
 }
 
-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 };
+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 };