Adds ts-runtime-checks

Author: mmamedel

.eslintignore

@@ -1,3 +1,4 @@
 **/node_modules
 docs/dist
 cases/spectypes/build
+cases/ts-runtime-checks/build

.gitignore

@@ -102,3 +102,6 @@ docs/dist/app.js.map
 
 # spectype build artifacts
 cases/spectypes/build
+
+# ts-runtime-checks build artifacts
+cases/ts-runtime-checks/build

README.md

@@ -35,6 +35,7 @@
 * [toi](https://github.com/hf/toi)
 * [ts-interface-checker](https://github.com/gristlabs/ts-interface-checker)
 * [ts-json-validator](https://github.com/ostrowr/ts-json-validator)
+* [ts-runtime-checks](https://github.com/GoogleFeud/ts-runtime-checks)
 * [tson](https://github.com/skarab42/tson)
 * [ts-utils](https://github.com/ai-labs-team/ts-utils)
 * [@typeofweb/schema](https://github.com/typeofweb/schema)

cases/index.ts

@@ -23,6 +23,7 @@ export const cases = [
   'toi',
   'ts-interface-checker',
   'ts-json-validator',
+  'ts-runtime-checks',
   'ts-utils',
   'tson',
   'typeofweb-schema',

cases/ts-runtime-checks/index.ts

@@ -0,0 +1,8 @@
+import { parseStrict, assertLoose } from './build';
+import { addCase } from '../../benchmarks';
+
+addCase('ts-runtime-checks', 'parseStrict', parseStrict);
+
+addCase('ts-runtime-checks', 'assertLoose', assertLoose);
+
+addCase('ts-runtime-checks', 'assertStrict', parseStrict);

cases/ts-runtime-checks/src/index.ts

@@ -0,0 +1,18 @@
+import type { Assert, ExactProps } from 'ts-runtime-checks';
+
+interface ToBeChecked {
+  number: number;
+  negNumber: number;
+  maxNumber: number;
+  string: string;
+  longString: string;
+  boolean: boolean;
+  deeplyNested: {
+    foo: string;
+    num: number;
+    bool: boolean;
+  };
+}
+
+export const parseStrict = (value: Assert<ExactProps<ToBeChecked>>) => value;
+export const assertLoose = (value: Assert<ToBeChecked>) => value;

cases/ts-runtime-checks/src/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../../tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "../build",
+    "plugins": [{ "transform": "ts-runtime-checks" }]
+  },
+  "include": ["index.ts"]
+}

index.ts

@@ -18,14 +18,19 @@ async function main() {
         const caseNames = args.length ? args : cases.cases;
 
         for (const c of caseNames) {
+          // hack: manually run the spectypes and ts-runtime-checks compilation step - avoids
+          // having to run it before any other benchmark, esp when working
+          // locally and checking against a few selected ones.
           if (c === 'spectypes') {
-            // hack: manually run the spectypes compilation step - avoids
-            // having to run it before any other benchmark, esp when working
-            // locally and checking against a few selected ones.
             childProcess.execSync('npm run compile:spectypes', {
               stdio: 'inherit',
             });
           }
+          if (c === 'ts-runtime-checks') {
+            childProcess.execSync('npm run compile:ts-runtime-checks', {
+              stdio: 'inherit',
+            });
+          }
 
           const cmd = [...process.argv.slice(0, 2), 'run-internal', c];
 

package-lock.json

@@ -11,13 +11,14 @@
   "scripts": {
     "lint": "gts check",
     "lint:fix": "gts fix",
-    "start": "ts-node index.ts",
-    "test:build": "npm run compile:spectypes && tsc --noEmit",
-    "test": "npm run compile:spectypes && jest",
+    "start": "ts-node --compiler ttypescript index.ts",
+    "test:build": "npm run compile:spectypes && npm run compile:ts-runtime-checks && tsc --noEmit",
+    "test": "npm run compile:spectypes && npm run compile:ts-runtime-checks && jest",
     "docs:serve": "serve docs",
     "docs:watch": "tsc --project tsconfig.docs.json --watch --preserveWatchOutput & serve docs",
     "docs:build": "tsc --project tsconfig.docs.json",
-    "compile:spectypes": "rimraf cases/spectypes/build && tsc -p cases/spectypes/src && babel cases/spectypes/src --out-dir cases/spectypes/build --extensions \".ts\""
+    "compile:spectypes": "rimraf cases/spectypes/build && tsc -p cases/spectypes/src && babel cases/spectypes/src --out-dir cases/spectypes/build --extensions \".ts\"",
+    "compile:ts-runtime-checks": "rimraf cases/ts-runtime-checks/build && ttsc -p cases/ts-runtime-checks/src"
   },
   "dependencies": {
     "@ailabs/ts-utils": "1.4.0",
@@ -60,7 +61,9 @@
     "ts-interface-checker": "1.0.2",
     "ts-json-validator": "0.7.1",
     "ts-node": "10.9.1",
-    "typescript": "4.5.5",
+    "ts-runtime-checks": "^0.1.1",
+    "ttypescript": "^1.5.13",
+    "typescript": "^4.6.2",
     "vega": "5.22.1",
     "vega-lite": "4.11.0",
     "yup": "0.32.11",