tstyche 1.0.0-rc.2 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [1.0.0] - 2024-02-20
+
+_Stable release based on [1.0.0-rc.2]._
+
 ## [1.0.0-rc.2] - 2024-02-14
 
 ### Fixed
@@ -136,6 +140,7 @@
 
 _First pre-release._
 
+[1.0.0]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0
 [1.0.0-rc.2]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-rc.2
 [1.0.0-rc.1]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-rc.1
 [1.0.0-rc]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-rc

package/build/tstyche.d.ts

@@ -51,7 +51,6 @@ declare enum OptionBrand {
     True = "true",// an option which does not take a value
     List = "list"
 }
-
 declare enum OptionGroup {
     CommandLine = 2,
     ConfigFile = 4
@@ -179,7 +178,7 @@ declare class ConfigService {
 declare class TSTyche {
     #private;
     readonly resolvedConfig: ResolvedConfig;
-    static readonly version = "1.0.0-rc.2";
+    static readonly version = "1.0.0";
     constructor(resolvedConfig: ResolvedConfig, storeService: StoreService);
     run(testFiles: Array<string | URL>): Promise<void>;
 }
@@ -195,7 +194,6 @@ declare enum TestMemberBrand {
     Test = "test",
     Expect = "expect"
 }
-
 declare enum TestMemberFlags {
     None = 0,
     Fail = 1,
@@ -282,7 +280,6 @@ declare class ResultTiming {
     get duration(): number;
 }
 
-type FileResultStatus = ResultStatus.Runs | ResultStatus.Passed | ResultStatus.Failed;
 declare enum ResultStatus {
     Runs = "runs",
     Passed = "passed",
@@ -327,6 +324,7 @@ declare class DescribeResult {
     constructor(describe: TestMember, parent: DescribeResult | undefined);
 }
 
+type FileResultStatus = ResultStatus.Runs | ResultStatus.Passed | ResultStatus.Failed;
 declare class FileResult {
     testFile: URL;
     diagnostics: Array<Diagnostic>;
@@ -346,11 +344,12 @@ declare class ProjectResult {
     constructor(compilerVersion: string, projectConfigFilePath: string | undefined);
 }
 
+type TargetResultStatus = ResultStatus.Runs | ResultStatus.Passed | ResultStatus.Failed;
 declare class TargetResult {
     versionTag: string;
     testFiles: Array<URL>;
     results: Map<string | undefined, ProjectResult>;
-    status: ResultStatus.Runs | ResultStatus.Passed | ResultStatus.Failed;
+    status: TargetResultStatus;
     timing: ResultTiming;
     constructor(versionTag: string, testFiles: Array<URL>);
 }
@@ -454,24 +453,30 @@ interface TypeChecker extends ts.TypeChecker {
 declare class PrimitiveTypeMatcher {
     #private;
     typeChecker: TypeChecker;
-    constructor(typeChecker: TypeChecker, targetTypeFlag: ts.TypeFlags, targetTypeText: string);
-    match(sourceType: ts.Type, isNot: boolean): MatchResult;
+    constructor(typeChecker: TypeChecker, targetTypeFlag: ts.TypeFlags);
+    match(sourceType: ts.Type): MatchResult;
 }
 
-declare class ToBeAssignable {
-    #private;
+declare abstract class RelationMatcherBase {
     typeChecker: TypeChecker;
+    abstract relation: Relation;
+    abstract relationExplanationText: string;
     constructor(typeChecker: TypeChecker);
+    protected explain(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): Array<Diagnostic>;
     match(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): MatchResult;
 }
 
-declare class ToEqual {
-    #private;
-    typeChecker: TypeChecker;
-    constructor(typeChecker: TypeChecker);
+declare class ToBeAssignable extends RelationMatcherBase {
+    relation: Relation;
+    relationExplanationText: string;
     match(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): MatchResult;
 }
 
+declare class ToEqual extends RelationMatcherBase {
+    relation: Relation;
+    relationExplanationText: string;
+}
+
 declare class ToHaveProperty {
     #private;
     compiler: typeof ts;
@@ -480,11 +485,9 @@ declare class ToHaveProperty {
     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 ToMatch extends RelationMatcherBase {
+    relation: Relation;
+    relationExplanationText: string;
 }
 
 declare class ToRaiseError {
@@ -746,4 +749,4 @@ declare class Version {
     static isVersionTag(target: string): boolean;
 }
 
-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, Version, type WriteStream, addsPackageStepText, describeNameText, diagnosticText, fileStatusText, fileViewText, formattedText, helpText, summaryText, testNameText, usesCompilerStepText };
+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, type TargetResultStatus, TaskRunner, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, Text, ThoroughReporter, type TypeChecker, Version, type WriteStream, addsPackageStepText, describeNameText, diagnosticText, fileStatusText, fileViewText, formattedText, helpText, summaryText, testNameText, usesCompilerStepText };

package/build/tstyche.js

@@ -999,6 +999,15 @@ class DescribeResult {
     }
 }
 
+var ResultStatus;
+(function (ResultStatus) {
+    ResultStatus["Runs"] = "runs";
+    ResultStatus["Passed"] = "passed";
+    ResultStatus["Failed"] = "failed";
+    ResultStatus["Skipped"] = "skipped";
+    ResultStatus["Todo"] = "todo";
+})(ResultStatus || (ResultStatus = {}));
+
 class ExpectResult {
     assertion;
     parent;
@@ -1254,15 +1263,6 @@ class ResultManager {
     }
 }
 
-var ResultStatus;
-(function (ResultStatus) {
-    ResultStatus["Runs"] = "runs";
-    ResultStatus["Passed"] = "passed";
-    ResultStatus["Failed"] = "failed";
-    ResultStatus["Skipped"] = "skipped";
-    ResultStatus["Todo"] = "todo";
-})(ResultStatus || (ResultStatus = {}));
-
 class TargetResult {
     versionTag;
     testFiles;
@@ -1695,7 +1695,6 @@ var TestMemberBrand;
     TestMemberBrand["Test"] = "test";
     TestMemberBrand["Expect"] = "expect";
 })(TestMemberBrand || (TestMemberBrand = {}));
-
 var TestMemberFlags;
 (function (TestMemberFlags) {
     TestMemberFlags[TestMemberFlags["None"] = 0] = "None";
@@ -1708,69 +1707,61 @@ var TestMemberFlags;
 class PrimitiveTypeMatcher {
     typeChecker;
     #targetTypeFlag;
-    #targetTypeText;
-    constructor(typeChecker, targetTypeFlag, targetTypeText) {
+    constructor(typeChecker, targetTypeFlag) {
         this.typeChecker = typeChecker;
         this.#targetTypeFlag = targetTypeFlag;
-        this.#targetTypeText = targetTypeText;
     }
-    #explain(sourceType, isNot) {
+    #explain(sourceType) {
         const sourceTypeText = this.typeChecker.typeToString(sourceType);
-        return isNot
-            ? [Diagnostic.error(`Type '${this.#targetTypeText}' is identical to type '${sourceTypeText}'.`)]
-            : [Diagnostic.error(`Type '${this.#targetTypeText}' is not identical to type '${sourceTypeText}'.`)];
+        return [Diagnostic.error(`The source type is '${sourceTypeText}'.`)];
     }
-    match(sourceType, isNot) {
+    match(sourceType) {
         const isMatch = Boolean(sourceType.flags & this.#targetTypeFlag);
         return {
-            explain: () => this.#explain(sourceType, isNot),
+            explain: () => this.#explain(sourceType),
             isMatch,
         };
     }
 }
 
-class ToBeAssignable {
+class RelationMatcherBase {
     typeChecker;
     constructor(typeChecker) {
         this.typeChecker = typeChecker;
     }
-    #explain(sourceType, targetType, isNot) {
+    explain(sourceType, targetType, isNot) {
         const sourceTypeText = this.typeChecker.typeToString(sourceType);
         const targetTypeText = this.typeChecker.typeToString(targetType);
         return isNot
-            ? [Diagnostic.error(`Type '${targetTypeText}' is assignable to type '${sourceTypeText}'.`)]
-            : [Diagnostic.error(`Type '${targetTypeText}' is not assignable to type '${sourceTypeText}'.`)];
+            ? [Diagnostic.error(`Type '${targetTypeText}' is ${this.relationExplanationText} type '${sourceTypeText}'.`)]
+            : [Diagnostic.error(`Type '${targetTypeText}' is not ${this.relationExplanationText} type '${sourceTypeText}'.`)];
     }
     match(sourceType, targetType, isNot) {
-        const isMatch = this.typeChecker.isTypeRelatedTo(targetType, sourceType, this.typeChecker.relation.assignable);
+        const isMatch = this.typeChecker.isTypeRelatedTo(sourceType, targetType, this.relation);
         return {
-            explain: () => this.#explain(sourceType, targetType, isNot),
+            explain: () => this.explain(sourceType, targetType, isNot),
             isMatch,
         };
     }
 }
 
-class ToEqual {
-    typeChecker;
-    constructor(typeChecker) {
-        this.typeChecker = typeChecker;
-    }
-    #explain(sourceType, targetType, isNot) {
-        const sourceTypeText = this.typeChecker.typeToString(sourceType);
-        const targetTypeText = this.typeChecker.typeToString(targetType);
-        return isNot
-            ? [Diagnostic.error(`Type '${targetTypeText}' is identical to type '${sourceTypeText}'.`)]
-            : [Diagnostic.error(`Type '${targetTypeText}' is not identical to type '${sourceTypeText}'.`)];
-    }
+class ToBeAssignable extends RelationMatcherBase {
+    relation = this.typeChecker.relation.assignable;
+    relationExplanationText = "assignable to";
     match(sourceType, targetType, isNot) {
-        const isMatch = this.typeChecker.isTypeRelatedTo(sourceType, targetType, this.typeChecker.relation.identity);
+        const isMatch = this.typeChecker.isTypeRelatedTo(targetType, sourceType, this.relation);
         return {
-            explain: () => this.#explain(sourceType, targetType, isNot),
+            explain: () => this.explain(sourceType, targetType, isNot),
             isMatch,
         };
     }
 }
 
+class ToEqual extends RelationMatcherBase {
+    relation = this.typeChecker.relation.identity;
+    relationExplanationText = "identical to";
+}
+
 class ToHaveProperty {
     compiler;
     typeChecker;
@@ -1812,25 +1803,9 @@ class ToHaveProperty {
     }
 }
 
-class ToMatch {
-    typeChecker;
-    constructor(typeChecker) {
-        this.typeChecker = typeChecker;
-    }
-    #explain(sourceType, targetType, isNot) {
-        const sourceTypeText = this.typeChecker.typeToString(sourceType);
-        const targetTypeText = this.typeChecker.typeToString(targetType);
-        return isNot
-            ? [Diagnostic.error(`Type '${targetTypeText}' is a subtype of type '${sourceTypeText}'.`)]
-            : [Diagnostic.error(`Type '${targetTypeText}' is not a subtype of type '${sourceTypeText}'.`)];
-    }
-    match(sourceType, targetType, isNot) {
-        const isMatch = this.typeChecker.isTypeRelatedTo(sourceType, targetType, this.typeChecker.relation.subtype);
-        return {
-            explain: () => this.#explain(sourceType, targetType, isNot),
-            isMatch,
-        };
-    }
+class ToMatch extends RelationMatcherBase {
+    relation = this.typeChecker.relation.subtype;
+    relationExplanationText = "a subtype of";
 }
 
 class ToRaiseError {
@@ -1952,19 +1927,19 @@ class Expect {
     constructor(compiler, typeChecker) {
         this.compiler = compiler;
         this.typeChecker = typeChecker;
-        this.toBeAny = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Any, "any");
+        this.toBeAny = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Any);
         this.toBeAssignable = new ToBeAssignable(this.typeChecker);
-        this.toBeBigInt = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.BigInt, "bigint");
-        this.toBeBoolean = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Boolean, "boolean");
-        this.toBeNever = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Never, "never");
-        this.toBeNull = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Null, "null");
-        this.toBeNumber = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Number, "number");
-        this.toBeString = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.String, "string");
-        this.toBeSymbol = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.ESSymbol, "symbol");
-        this.toBeUndefined = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Undefined, "undefined");
-        this.toBeUniqueSymbol = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.UniqueESSymbol, "unique symbol");
-        this.toBeUnknown = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Unknown, "unknown");
-        this.toBeVoid = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Void, "void");
+        this.toBeBigInt = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.BigInt);
+        this.toBeBoolean = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Boolean);
+        this.toBeNever = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Never);
+        this.toBeNull = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Null);
+        this.toBeNumber = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Number);
+        this.toBeString = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.String);
+        this.toBeSymbol = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.ESSymbol);
+        this.toBeUndefined = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Undefined);
+        this.toBeUniqueSymbol = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.UniqueESSymbol);
+        this.toBeUnknown = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Unknown);
+        this.toBeVoid = new PrimitiveTypeMatcher(this.typeChecker, this.compiler.TypeFlags.Void);
         this.toEqual = new ToEqual(this.typeChecker);
         this.toHaveProperty = new ToHaveProperty(this.compiler, this.typeChecker);
         this.toMatch = new ToMatch(this.typeChecker);
@@ -2021,7 +1996,7 @@ class Expect {
                     this.#onSourceArgumentMustBeProvided(assertion, expectResult);
                     return;
                 }
-                return this[matcherNameText].match(this.#getType(assertion.source[0]), assertion.isNot);
+                return this[matcherNameText].match(this.#getType(assertion.source[0]));
             case "toHaveProperty": {
                 if (assertion.source[0] == null) {
                     this.#onSourceArgumentMustBeProvided(assertion, expectResult);
@@ -2580,7 +2555,7 @@ class TSTyche {
     #abortController = new AbortController();
     #storeService;
     #taskRunner;
-    static version = "1.0.0-rc.2";
+    static version = "1.0.0";
     constructor(resolvedConfig, storeService) {
         this.resolvedConfig = resolvedConfig;
         this.#storeService = storeService;
@@ -3194,7 +3169,6 @@ var OptionBrand;
     OptionBrand["True"] = "true";
     OptionBrand["List"] = "list";
 })(OptionBrand || (OptionBrand = {}));
-
 var OptionGroup;
 (function (OptionGroup) {
     OptionGroup[OptionGroup["CommandLine"] = 2] = "CommandLine";
@@ -3589,7 +3563,7 @@ class StoreService {
                 `The resolution of the '${tag}' tag may be outdated.`,
             ]));
         }
-        return this.#manifest.versions.includes(tag) || tag in this.#manifest.resolutions || tag === "current";
+        return tag in this.#manifest.resolutions || this.#manifest.versions.includes(tag);
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tstyche",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0",
   "description": "The Essential Type Testing Tool.",
   "keywords": [
     "typescript",
@@ -50,35 +50,38 @@
     "lint": "eslint ./ --config eslint.config.json --ext .js,.cts,.ts,.tsx",
     "prepack": "yarn clean && yarn build",
     "prepublish": "yarn test",
-    "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest --config jest.config.js",
+    "test": "yarn test:unit && yarn test:e2e",
     "test:coverage": "yarn build --sourcemap && c8 --config c8.config.json yarn test:e2e",
-    "test:e2e": "yarn test --testMatch '**/tests/*.test.js'",
+    "test:e2e": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest --config jest.config.js",
     "test:examples": "tstyche examples",
     "test:types": "tstyche tests",
-    "test:unit": "yarn test --testMatch '**/source/**/__tests__/*.test.ts?(x)'"
+    "test:unit": "mocha --config mocha.config.json"
   },
   "devDependencies": {
     "@jest/globals": "29.7.0",
     "@rollup/plugin-typescript": "11.1.6",
-    "@types/node": "20.11.17",
-    "@typescript-eslint/eslint-plugin": "7.0.1",
-    "@typescript-eslint/parser": "7.0.1",
+    "@types/chai": "4.3.11",
+    "@types/mocha": "10.0.6",
+    "@types/node": "20.11.19",
+    "@typescript-eslint/eslint-plugin": "7.0.2",
+    "@typescript-eslint/parser": "7.0.2",
     "ajv": "8.12.0",
     "c8": "9.1.0",
-    "cspell": "8.3.2",
+    "chai": "5.1.0",
+    "cspell": "8.4.0",
     "dprint": "0.45.0",
     "eslint": "8.56.0",
     "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jest": "27.8.0",
+    "eslint-plugin-jest": "27.9.0",
     "eslint-plugin-jest-formatting": "3.1.0",
     "eslint-plugin-simple-import-sort": "12.0.0",
     "jest": "29.7.0",
-    "jest-serializer-ansi-escapes": "2.0.1",
     "magic-string": "0.30.7",
-    "rollup": "4.10.0",
+    "mocha": "10.3.0",
+    "pretty-ansi": "1.0.0",
+    "rollup": "4.12.0",
     "rollup-plugin-dts": "6.1.0",
-    "ts-node": "10.9.2",
     "tslib": "2.6.2",
     "typescript": "5.3.3"
   },