tstyche 1.0.0-beta.5 → 1.0.0-beta.6

package/CHANGELOG.md

@@ -1,19 +1,29 @@
 # Changelog
 
+## [1.0.0-beta.6] - 2023-12-03
+
+### Added
+
+- **New!** Add `.toHaveProperty()` matcher ([#36](https://github.com/tstyche/tstyche/pull/36))
+
+### Fixed
+
+- Accept template literals as arguments of the `.toRaiseError()` matcher ([#38](https://github.com/tstyche/tstyche/pull/38))
+
 ## [1.0.0-beta.5] - 2023-11-27
 
 ### Changed
 
-- **Breaking:** Move retry logic to the `Lock` class ([#31](https://github.com/tstyche/tstyche/pull/31))
+- **Breaking!** Move retry logic to the `Lock` class ([#31](https://github.com/tstyche/tstyche/pull/31))
 - Bring back support for Node.js 16 ([#28](https://github.com/tstyche/tstyche/pull/28), [#27](https://github.com/tstyche/tstyche/pull/27))
 
 ### Added
 
-- Add support for the `current` target tag ([#33](https://github.com/tstyche/tstyche/pull/33))
+- **New!** Add support for the `current` target tag ([#33](https://github.com/tstyche/tstyche/pull/33))
 
 ### Fixed
 
-- Allow `.raiseError()` to take template literals as arguments. ([#35](https://github.com/tstyche/tstyche/pull/35))
+- Allow `.raiseError()` to take template literals as arguments ([#35](https://github.com/tstyche/tstyche/pull/35))
 
 ## [1.0.0-beta.4] - 2023-11-24
 
@@ -23,9 +33,9 @@
 
 ### Removed
 
-- **Breaking:** Remove the `context()` helper ([#24](https://github.com/tstyche/tstyche/pull/24))
-- **Breaking:** Drop support for Node.js 16 ([#22](https://github.com/tstyche/tstyche/pull/22))
-- **Breaking:** Rename methods of the `StoreService` class ([`5d74201`](https://github.com/tstyche/tstyche/commit/5d74201))
+- **Breaking!** Remove the `context()` helper ([#24](https://github.com/tstyche/tstyche/pull/24))
+- **Breaking!** Drop support for Node.js 16 ([#22](https://github.com/tstyche/tstyche/pull/22))
+- **Breaking!** Rename methods of the `StoreService` class ([`5d74201`](https://github.com/tstyche/tstyche/commit/5d74201))
 
 ### Fixed
 
@@ -55,6 +65,7 @@
 
 _First pre-release._
 
+[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
 [1.0.0-beta.3]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.3

package/README.md

@@ -56,9 +56,10 @@ test("handles numbers", () => {
 
 Here is the list of all matchers:
 
-- `.toBeAssignable()`, `.toEqual()`, `.toMatch()` compares types or types of expression;
-- `.toRaiseError()` captures the error message or code;
-- `.toBeString()`, `.toBeNumber()`, `.toBeVoid()` and 9 more checks for primitive types.
+- `.toBeAssignable()`, `.toEqual()`, `.toMatch()` compares types or types of expression,
+- `.toHaveProperty()` looks up keys on an object type,
+- `.toRaiseError()` captures the type error message or code,
+- `.toBeString()`, `.toBeNumber()`, `.toBeVoid()` and 9 more shorthand checks for primitive types.
 
 ## Runner
 

package/build/index.d.cts

@@ -133,6 +133,10 @@ interface Matchers {
          */
         (target: unknown): void;
     };
+    /**
+     * Checks if a property key exists on the source type.
+     */
+    toHaveProperty: (key: string | number | symbol) => void;
     /**
      * Checks if the target type is a subtype the source type.
      */

package/build/index.d.ts

@@ -133,6 +133,10 @@ interface Matchers {
          */
         (target: unknown): void;
     };
+    /**
+     * Checks if a property key exists on the source type.
+     */
+    toHaveProperty: (key: string | number | symbol) => void;
     /**
      * Checks if the target type is a subtype the source type.
      */

package/build/tstyche.js

@@ -1511,6 +1511,7 @@ class CollectService {
         "toBeUnknown",
         "toBeVoid",
         "toEqual",
+        "toHaveProperty",
         "toMatch",
         "toRaiseError",
     ];
@@ -1682,10 +1683,12 @@ class Checker {
     #assertNonNullishTypeChecker(assertion) {
         this.#assertNonNullish(assertion.typeChecker, "The 'typeChecker' was not provided.");
     }
+    #assertStringsOrNumber(expression) {
+        return (expression != null &&
+            (this.compiler.isStringLiteralLike(expression) || this.compiler.isNumericLiteral(expression)));
+    }
     #assertStringsOrNumbers(nodes) {
-        return nodes.every((expression) => this.compiler.isStringLiteral(expression) ||
-            this.compiler.isNumericLiteral(expression) ||
-            this.compiler.isNoSubstitutionTemplateLiteral(expression));
+        return nodes.every((expression) => this.#assertStringsOrNumber(expression));
     }
     explain(assertion) {
         this.#assertNonNullishTypeChecker(assertion);
@@ -1743,6 +1746,26 @@ class Checker {
                         : `Type '${targetTypeText}' is not identical to type '${sourceTypeText}'.`, origin),
                 ];
             }
+            case "toHaveProperty": {
+                this.#assertNonNullishSourceType(assertion);
+                this.#assertNonNullishTargetType(assertion);
+                const sourceText = assertion.typeChecker.typeToString(assertion.sourceType.type);
+                let targetArgumentText;
+                if (assertion.targetType.type.flags & this.compiler.TypeFlags.StringOrNumberLiteral) {
+                    targetArgumentText = String(assertion.targetType.type.value);
+                }
+                else if (assertion.targetType.type.flags & this.compiler.TypeFlags.UniqueESSymbol) {
+                    targetArgumentText = `[${this.compiler.unescapeLeadingUnderscores(assertion.targetType.type.symbol.escapedName)}]`;
+                }
+                else {
+                    throw new Error("An argument for 'key' must be of type 'string | number | symbol'.");
+                }
+                return [
+                    Diagnostic.error(assertion.isNot
+                        ? `Property '${targetArgumentText}' exists on type '${sourceText}'.`
+                        : `Property '${targetArgumentText}' does not exist on type '${sourceText}'.`, origin),
+                ];
+            }
             case "toMatch": {
                 this.#assertNonNullishSourceType(assertion);
                 this.#assertNonNullishTargetType(assertion);
@@ -1796,7 +1819,7 @@ class Checker {
                     }
                     const isMatch = this.#matchExpectedError(diagnostic, argument);
                     if (!assertion.isNot && !isMatch) {
-                        const expectedText = this.compiler.isStringLiteral(argument)
+                        const expectedText = this.compiler.isStringLiteralLike(argument)
                             ? `matching substring '${argument.text}'`
                             : `with code ${argument.text}`;
                         const related = [
@@ -1806,7 +1829,7 @@ class Checker {
                         diagnostics.push(Diagnostic.error(`${sourceText} did not raise a type error ${expectedText}.`, origin).add({ related }));
                     }
                     if (assertion.isNot && isMatch) {
-                        const expectedText = this.compiler.isStringLiteral(argument)
+                        const expectedText = this.compiler.isStringLiteralLike(argument)
                             ? `matching substring '${argument.text}'`
                             : `with code ${argument.text}`;
                         const related = [
@@ -1892,6 +1915,27 @@ class Checker {
                 this.#assertNonNullish(assertion.typeChecker?.isTypeIdenticalTo, "The 'isTypeIdenticalTo' method is missing in the provided type checker.");
                 return assertion.typeChecker.isTypeIdenticalTo(assertion.sourceType.type, assertion.targetType.type);
             }
+            case "toHaveProperty": {
+                this.#assertNonNullishSourceType(assertion);
+                this.#assertNonNullishTargetType(assertion);
+                if (!(assertion.sourceType.type.flags & this.compiler.TypeFlags.StructuredType)) {
+                    const receivedText = assertion.typeChecker?.typeToString(assertion.sourceType.type);
+                    throw new Error(`An argument for 'source' must be of object type, received: '${receivedText}'.`);
+                }
+                let targetArgumentText;
+                if (assertion.targetType.type.flags & this.compiler.TypeFlags.StringOrNumberLiteral) {
+                    targetArgumentText = String(assertion.targetType.type.value);
+                }
+                else if (assertion.targetType.type.flags & this.compiler.TypeFlags.UniqueESSymbol) {
+                    targetArgumentText = this.compiler.unescapeLeadingUnderscores(assertion.targetType.type.escapedName);
+                }
+                else {
+                    throw new Error("An argument for 'key' must be of type 'string | number | symbol'.");
+                }
+                return assertion.sourceType.type.getProperties().some((property) => {
+                    return this.compiler.unescapeLeadingUnderscores(property.escapedName) === targetArgumentText;
+                });
+            }
             case "toMatch": {
                 this.#assertNonNullishSourceType(assertion);
                 this.#assertNonNullishTargetType(assertion);
@@ -1909,7 +1953,7 @@ class Checker {
                     return false;
                 }
                 return assertion.targetArguments.every((expectedArgument, index) => {
-                    if (this.compiler.isStringLiteral(expectedArgument)) {
+                    if (this.compiler.isStringLiteralLike(expectedArgument)) {
                         return this.compiler
                             .flattenDiagnosticMessageText(assertion.diagnostics[index]?.messageText, " ", 0)
                             .includes(expectedArgument.text);
@@ -1925,7 +1969,7 @@ class Checker {
         }
     }
     #matchExpectedError(diagnostic, argument) {
-        if (this.compiler.isStringLiteral(argument)) {
+        if (this.compiler.isStringLiteralLike(argument)) {
             return this.compiler.flattenDiagnosticMessageText(diagnostic.messageText, " ", 0).includes(argument.text);
         }
         if (this.compiler.isNumericLiteral(argument)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tstyche",
-  "version": "1.0.0-beta.5",
+  "version": "1.0.0-beta.6",
   "description": "The Essential Type Testing Tool.",
   "keywords": [
     "typescript",
@@ -57,14 +57,14 @@
   "devDependencies": {
     "@jest/globals": "29.7.0",
     "@rollup/plugin-typescript": "11.1.5",
-    "@types/node": "20.10.0",
-    "@typescript-eslint/eslint-plugin": "6.12.0",
-    "@typescript-eslint/parser": "6.12.0",
+    "@types/node": "20.10.2",
+    "@typescript-eslint/eslint-plugin": "6.13.1",
+    "@typescript-eslint/parser": "6.13.1",
     "ajv": "8.12.0",
     "c8": "8.0.1",
-    "cspell": "8.0.0",
-    "eslint": "8.54.0",
-    "eslint-config-prettier": "9.0.0",
+    "cspell": "8.1.0",
+    "eslint": "8.55.0",
+    "eslint-config-prettier": "9.1.0",
     "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-import": "2.29.0",
     "eslint-plugin-jest": "27.6.0",
@@ -76,7 +76,7 @@
     "jest-serializer-ansi-escapes": "2.0.1",
     "magic-string": "0.30.5",
     "prettier": "3.1.0",
-    "rollup": "4.6.0",
+    "rollup": "4.6.1",
     "rollup-plugin-dts": "6.1.0",
     "rollup-plugin-tsconfig-paths": "1.5.2",
     "ts-node": "10.9.1",