Merge pull request #130 from ethdebug/packages

Use @ethdebug/format as home package for TypeScript types and type predicates

Author: gnidan

package.json

@@ -15,7 +15,6 @@
   "devDependencies": {
     "@hyperjump/json-schema": "1.6.7",
     "@types/jest": "^29.5.14",
-    "chalk": "^5.4.1",
     "concurrently": "^8.2.2",
     "jest": "^29.7.0",
     "lerna": "^8.0.2",

packages/format/jest.config.ts

@@ -0,0 +1,18 @@
+import type { Config } from "jest";
+
+const config: Config = {
+  displayName: "@ethdebug/format",
+  preset: "ts-jest",
+  testEnvironment: "node",
+  moduleFileExtensions: ["ts", "js"],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  modulePathIgnorePatterns: ["<rootDir>/dist/"],
+  setupFilesAfterEnv: ["<rootDir>/jest.setup.ts"],
+  transform: {
+    '^.+\\.tsx?$': "ts-jest"
+  },
+};
+
+export default config;

jest.d.ts packages/format/jest.d.tsjest.d.ts renamed to packages/format/jest.d.ts

@@ -12,6 +12,7 @@
     "prepare:yamls": "node ./bin/generate-schema-yamls.js > yamls.ts",
     "prepare": "yarn prepare:yamls && tsc",
     "clean": "rm -rf dist && rm yamls.ts",
+    "test": "node --experimental-vm-modules $(yarn bin jest)",
     "watch:typescript": "tsc --watch",
     "watch:schemas": "nodemon --watch ../../schemas -e 'yaml' --exec 'yarn prepare:yamls'",
     "watch": "concurrently --names=tsc,schemas \"yarn watch:typescript\" \"yarn watch:schemas\""
@@ -21,8 +22,14 @@
     "yaml": "^2.3.4"
   },
   "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "chalk": "^4.1.0",
     "concurrently": "^8.2.2",
-    "nodemon": "^3.0.2"
+    "jest": "^29.7.0",
+    "nodemon": "^3.0.2",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
   },
   "publishConfig": {
     "access": "public"

jest.setup.ts packages/format/jest.setup.tsjest.setup.ts renamed to packages/format/jest.setup.ts

@@ -35,10 +35,10 @@ export function describeSchema({
   }
 
   return referencesId(schema)
-    ? describeSchemaById({ schema, pointer })
+    ? describeSchemaById({ schema, ...(pointer ? { pointer } : {}) })
     : referencesYaml(schema)
-      ? describeSchemaByYaml({ schema, pointer })
-      : describeSchemaByObject({ schema, pointer });
+      ? describeSchemaByYaml({ schema, ...(pointer ? { pointer } : {}) })
+      : describeSchemaByObject({ schema, ...(pointer ? { pointer } : {}) });
 }
 
 function describeSchemaById({
@@ -65,7 +65,7 @@ function describeSchemaById({
 
   return {
     id,
-    pointer,
+    ...(pointer ? { pointer } : {}),
     yaml,
     schema,
     rootSchema
@@ -86,14 +86,14 @@ function describeSchemaByYaml({
   if (id) {
     return {
       id,
-      pointer,
+      ...(pointer ? { pointer } : {}),
       yaml,
       schema,
       rootSchema
     }
   } else {
     return {
-      pointer,
+      ...(pointer ? { pointer } : {}),
       yaml,
       schema,
       rootSchema
@@ -116,14 +116,14 @@ function describeSchemaByObject({
   if (id) {
     return {
       id,
-      pointer,
+      ...(pointer ? { pointer } : {}),
       yaml,
       schema,
       rootSchema
     }
   } else {
     return {
-      pointer,
+      ...(pointer ? { pointer } : {}),
       yaml,
       schema,
       rootSchema

packages/format/package.json

@@ -1,2 +1,4 @@
 export * from "./describe";
 export { schemas, schemaIds, type Schema } from "./schemas";
+
+export * from "./types";

packages/format/src/describe.ts

@@ -0,0 +1,37 @@
+import { expect, describe, it } from "@jest/globals";
+
+import { describeSchema } from "../../describe";
+
+import { Data } from "./index.js";
+
+describe("type guards", () => {
+  const schemaGuards = [
+    {
+      schema: {
+        id: "schema:ethdebug/format/data/value"
+      },
+      guard: Data.isValue
+    },
+    {
+      schema: {
+        id: "schema:ethdebug/format/data/unsigned"
+      },
+      guard: Data.isUnsigned
+    },
+    {
+      schema: {
+        id: "schema:ethdebug/format/data/hex"
+      },
+      guard: Data.isHex
+    },
+  ] as const;
+
+  it.each(schemaGuards)("matches its examples", ({
+    guard,
+    ...describeSchemaOptions
+  }) => {
+    const { schema: { examples = [] } } = describeSchema(describeSchemaOptions);
+
+    expect(guard).toSatisfyAll(examples);
+  });
+});

packages/format/src/index.ts

@@ -0,0 +1,20 @@
+export namespace Data {
+  export type Value =
+    | Unsigned
+    | Hex;
+
+  export const isValue = (value: unknown): value is Value =>
+    [isUnsigned, isHex].some(guard => guard(value));
+
+  export type Unsigned = number;
+
+  export const isUnsigned = (value: unknown): value is Unsigned =>
+    typeof value === "number" && value >= 0;
+
+  export type Hex = string;
+
+  const hexPattern = new RegExp(/^0x[0-9a-fA-F]{1,}$/);
+
+  export const isHex = (value: unknown): value is Hex =>
+    typeof value === "string" && hexPattern.test(value);
+}

packages/format/src/types/data/index.test.ts

@@ -0,0 +1,5 @@
+export * from "./data";
+export * from "./materials";
+export * from "./type";
+export * from "./pointer";
+export * from "./program";