tstyche 4.0.0-rc.1 → 4.0.0

package/README.md

@@ -5,7 +5,7 @@
 [![install-size][install-size-badge]][install-size-url]
 [![coverage][coverage-badge]][coverage-url]
 
-The Essential Type Testing Tool.
+Everything You Need for Type Testing.
 
 ---
 
@@ -37,21 +37,29 @@ To organize, debug and plan tests TSTyche has:
 
 ## Assertions
 
-The assertions can be used to write type tests (like in the above example) or mixed in your functional tests:
+The assertions can be used to write type tests (like in the above example) or mixed in your unit tests:
 
 ```ts
 import assert from "node:assert";
 import test from "node:test";
 import * as tstyche from "tstyche";
 
-function secondItem<T>(target: Array<T>): T | undefined {
-  return target[1];
+function toMilliseconds(value: number) {
+  if (typeof value === "number" && !Number.isNaN(value)) {
+    return value * 1000;
+  }
+
+  throw new Error("Not a number");
 }
 
-test("handles numbers", () => {
-  assert.strictEqual(secondItem([1, 2, 3]), 2);
+test("toMilliseconds", () => {
+  const sample = toMilliseconds(10);
+
+  assert.equal(sample, 10_000);
+  tstyche.expect(sample).type.toBe<number>();
 
-  tstyche.expect(secondItem([1, 2, 3])).type.toBe<number | undefined>();
+  // Will pass as a type test and not throw at runtime
+  tstyche.expect(toMilliseconds).type.not.toBeCallableWith("20");
 });
 ```
 

package/build/tstyche.d.ts

@@ -40,6 +40,7 @@ declare class ConfigDiagnosticText {
     static requiresValueType(optionName: string, optionBrand: OptionBrand): string;
     static seen(element: string): string;
     static testFileMatchCannotStartWith(segment: string): Array<string>;
+    static unexpected(element: string): string;
     static unknownOption(optionName: string): string;
     static usage(optionName: string, optionBrand: OptionBrand): Array<string>;
     static versionIsNotSupported(value: string): string;

package/build/tstyche.js

@@ -49,6 +49,9 @@ class ConfigDiagnosticText {
             "The test files are only collected within the 'rootPath' directory.",
         ];
     }
+    static unexpected(element) {
+        return `Unexpected ${element}.`;
+    }
     static unknownOption(optionName) {
         return `Unknown option '${optionName}'.`;
     }
@@ -1375,6 +1378,13 @@ class ConfigParser {
                 related: [Diagnostic.error(relatedText, leftBraceToken.origin)],
             });
             this.#onDiagnostics(diagnostic);
+            return;
+        }
+        const unexpectedToken = this.#jsonScanner.readToken(/\S/);
+        if (unexpectedToken.text != null) {
+            const text = ConfigDiagnosticText.unexpected("token");
+            const diagnostic = Diagnostic.error(text, unexpectedToken.origin);
+            this.#onDiagnostics(diagnostic);
         }
     }
     async parse() {
@@ -1474,9 +1484,10 @@ class JsonScanner {
     readToken(token) {
         this.#skipTrivia();
         this.#previousPosition = this.#position;
-        if (this.#peekCharacter() === token) {
+        const character = this.#peekCharacter();
+        if (typeof token === "string" ? token === character : token.test(character)) {
             this.#position++;
-            return new JsonNode(token, this.#getOrigin());
+            return new JsonNode(character, this.#getOrigin());
         }
         return new JsonNode(undefined, this.#getOrigin());
     }
@@ -3037,7 +3048,8 @@ class AssertionNode extends TestTreeNode {
             this.target = this.matcherNode.typeArguments ?? this.matcherNode.arguments;
         }
         for (const diagnostic of parent.diagnostics) {
-            if (diagnosticBelongsToNode(diagnostic, this.source)) {
+            if (diagnosticBelongsToNode(diagnostic, this.source) ||
+                (this.target != null && diagnosticBelongsToNode(diagnostic, this.target))) {
                 this.diagnostics.add(diagnostic);
                 parent.diagnostics.delete(diagnostic);
             }
@@ -4894,7 +4906,7 @@ class TaskRunner {
 class Runner {
     #eventEmitter = new EventEmitter();
     #resolvedConfig;
-    static version = "4.0.0-rc.1";
+    static version = "4.0.0";
     constructor(resolvedConfig) {
         this.#resolvedConfig = resolvedConfig;
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tstyche",
-  "version": "4.0.0-rc.1",
-  "description": "The Essential Type Testing Tool.",
+  "version": "4.0.0",
+  "description": "Everything You Need for Type Testing.",
   "keywords": [
     "typescript",
     "types",