Merge pull request #163 from ethdebug/imports

Add #-prefixed path aliases to format and pointers packages

Author: gnidan

.eslintrc.json

@@ -11,7 +11,36 @@
     "@typescript-eslint/no-namespace": "off",
     "@typescript-eslint/no-empty-object-type": "off",
     "no-console": "warn",
-    "require-yield": "off"
+    "require-yield": "off",
+    "no-restricted-imports": [
+      "error",
+      {
+        "patterns": [
+          {
+            "group": ["../types/*/index*", "../types/*/index"],
+            "message": "Use #types/* alias instead of relative imports"
+          },
+          {
+            "group": [
+              "../materials/*",
+              "../data/*",
+              "../pointer/*",
+              "../program/*",
+              "../type/*"
+            ],
+            "message": "Use #types/* alias instead of relative imports"
+          },
+          {
+            "group": ["../../test/*", "../../../test/*"],
+            "message": "Use #test/* alias instead of relative imports"
+          },
+          {
+            "group": ["../describe*"],
+            "message": "Use #describe alias instead of relative imports"
+          }
+        ]
+      }
+    ]
   },
   "env": {
     "node": true,

packages/format/package.json

@@ -9,6 +9,41 @@
   "files": [
     "dist"
   ],
+  "imports": {
+    "#describe": {
+      "types": "./src/describe.ts",
+      "default": "./dist/src/describe.js"
+    },
+    "#schemas": {
+      "types": "./src/schemas/index.ts",
+      "default": "./dist/src/schemas/index.js"
+    },
+    "#types": {
+      "types": "./src/types/index.ts",
+      "default": "./dist/src/types/index.js"
+    },
+    "#types/data": {
+      "types": "./src/types/data/index.ts",
+      "default": "./dist/src/types/data/index.js"
+    },
+    "#types/materials": {
+      "types": "./src/types/materials/index.ts",
+      "default": "./dist/src/types/materials/index.js"
+    },
+    "#types/pointer": {
+      "types": "./src/types/pointer/index.ts",
+      "default": "./dist/src/types/pointer/index.js"
+    },
+    "#types/program": {
+      "types": "./src/types/program/index.ts",
+      "default": "./dist/src/types/program/index.js"
+    },
+    "#types/type": {
+      "types": "./src/types/type/index.ts",
+      "default": "./dist/src/types/type/index.js"
+    },
+    "#test/*": "./test/*.ts"
+  },
   "scripts": {
     "prepare:yamls": "node ./bin/generate-schema-yamls.js",
     "prepare": "yarn prepare:yamls && tsc",

packages/format/src/index.ts

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

packages/format/src/schemas/examples.test.ts

@@ -1,11 +1,11 @@
 import { expect, describe, it } from "vitest";
 
-import { schemaExtensions } from "../../test/extensions.js";
+import { schemaExtensions } from "#test/extensions";
 import { schemas } from "./index.js";
-import type { JSONSchema } from "../describe.js";
+import type { JSONSchema } from "#describe";
 
 // loads schemas into global hyperjump json schema validator
-import "../../test/hyperjump.js";
+import "#test/hyperjump";
 
 const idsOfSchemasAllowedToOmitExamples = new Set([
   "schema:ethdebug/format/type",

packages/format/src/schemas/index.ts

@@ -1,4 +1,4 @@
-import { describeSchema } from "../describe.js";
+import { describeSchema } from "#describe";
 import { schemaYamls } from "./yamls.js";
 export type { Schema } from "./yamls.js";
 

packages/format/src/schemas/validity.test.ts

@@ -8,7 +8,7 @@ import {
 import { schemas } from "./index.js";
 
 // loads schemas into global hyperjump json schema validator
-import "../../test/hyperjump.js";
+import "#test/hyperjump";
 
 const printErrors = (output: { errors?: OutputUnit[] }): string =>
   output

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

@@ -1,4 +1,4 @@
-import { testSchemaGuards } from "../../../test/guards.js";
+import { testSchemaGuards } from "#test/guards";
 
 import { Data } from "./index.js";
 

packages/format/src/types/index.ts

@@ -1,5 +1,5 @@
-export * from "./data/index.js";
-export * from "./materials/index.js";
-export * from "./type/index.js";
-export * from "./pointer/index.js";
-export * from "./program/index.js";
+export * from "#types/data";
+export * from "#types/materials";
+export * from "#types/type";
+export * from "#types/pointer";
+export * from "#types/program";

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

@@ -1,4 +1,4 @@
-import { testSchemaGuards } from "../../../test/guards.js";
+import { testSchemaGuards } from "#test/guards";
 import { Materials } from "./index.js";
 
 testSchemaGuards("ethdebug/format/materials", [

packages/format/src/types/materials/index.ts

@@ -1,4 +1,4 @@
-import { Data } from "../data/index.js";
+import { Data } from "#types/data";
 
 export namespace Materials {
   export type Id = number | string;