Refactored LambdaBuffers --> Prelude and associated prefixes

Author: jared

flake.nix

@@ -30,7 +30,7 @@
                   pname = packageJson.name;
                   version = packageJson.version;
                   src = ./.;
-                  npmDepsHash = "sha256-wSSYPXAfsoqghsYu5quUZCyimVHtWu+Cp7yee7qAi7E=";
+                  npmDepsHash = "sha256-0lKTLQwKeD0Smanjhnr7AMPCM8Am/l7zOyMwegMZVuA=";
                 };
 
               # Tarball created from `npm pack`

package.json

@@ -4,14 +4,14 @@
   "description": "A Prelude for TypeScript",
   "lockfileVersion": 2,
   "exports": {
-    ".": "./dist/LambdaBuffers/Prelude.js",
-    "./Map.js": "./dist/LambdaBuffers/Runtime/Map.js",
-    "./Set.js": "./dist/LambdaBuffers/Runtime/Set.js",
+    ".": "./dist/Prelude/Prelude.js",
+    "./Map.js": "./dist/Prelude/Runtime/Map.js",
+    "./Set.js": "./dist/Prelude/Runtime/Set.js",
     "./package.json": "./package.json"
   },
   "type": "module",
   "scripts": {
-    "build": "npx tsc -b src/LambdaBuffers",
+    "build": "npx tsc -b src/Prelude",
     "test": "npx tsc -b src/Tests && node --test"
   },
   "repository": {
@@ -24,6 +24,6 @@
     "typescript": "^5.2.2",
     "@types/node": "^20.8.10"
   },
-  "files": ["./dist/LambdaBuffers/**/*"],
+  "files": ["./dist/Prelude/**/*"],
   "dependencies": {}
 }

src/LambdaBuffers/Prelude.ts renamed to src/Prelude/Prelude.ts

@@ -4,7 +4,3 @@ export * from "./Runtime/Either.js";
 export * from "./Runtime/Json.js";
 export * from "./Runtime/Ord.js";
 export * from "./Runtime/Eq.js";
-
-export function and(l: boolean, r: boolean) {
-  return l && r;
-}

src/LambdaBuffers/Runtime/AvlTree.ts renamed to src/Prelude/Runtime/AvlTree.ts

@@ -1,4 +1,4 @@
-import * as LbJson from "./Json.js";
+import * as PJson from "./Json.js";
 import type { Eq } from "./Eq.js";
 import type { Ord } from "./Ord.js";
 import type { Json } from "./Json.js";
@@ -72,17 +72,17 @@ export function jsonEither<L, R>(
   return {
     toJson: (either) => {
       if (either.name === "Left") {
-        return LbJson.jsonConstructor("Left", [
+        return PJson.jsonConstructor("Left", [
           dict1.toJson(either.fields),
         ]);
       } else {
-        return LbJson.jsonConstructor("Right", [
+        return PJson.jsonConstructor("Right", [
           dict2.toJson(either.fields),
         ]);
       }
     },
     fromJson: (value) => {
-      return LbJson.caseJsonConstructor<Either<L, R>>("Prelude.Either", {
+      return PJson.caseJsonConstructor<Either<L, R>>("Prelude.Either", {
         "Left": (ctorFields) => {
           if (ctorFields.length === 1) {
             return {
@@ -92,7 +92,7 @@ export function jsonEither<L, R>(
           } else {
             throw new JsonError(
               "Expected JSON Array with 1 fields but got" +
-                LbJson.stringify(value),
+                PJson.stringify(value),
             );
           }
         },
@@ -105,7 +105,7 @@ export function jsonEither<L, R>(
           } else {
             throw new JsonError(
               "Expected JSON Array with 1 fields but got" +
-                LbJson.stringify(value),
+                PJson.stringify(value),
             );
           }
         },

src/LambdaBuffers/Runtime/Either.ts renamed to src/Prelude/Runtime/Either.ts

@@ -1,5 +1,5 @@
 import type { Ord } from "./Ord.js";
-import * as LbMap from "./Map.js";
+import * as PMap from "./Map.js";
 /**
  * `Json<A>` is a type class to provide `toJson` and `fromJson` instances for
  * type `A`.
@@ -295,9 +295,9 @@ export function caseJsonMap<K, V>(
   dictOrd: Ord<K>,
   parseElem: (arg: [Value, Value]) => [K, V],
   value: Readonly<Value>,
-): LbMap.Map<K, V> {
+): PMap.Map<K, V> {
   // TODO(jaredponn): actually use `title` in the error messages.
-  const map: LbMap.Map<K, V> = new LbMap.Map();
+  const map: PMap.Map<K, V> = new PMap.Map();
 
   if (!isJsonArray(value)) {
     throw new JsonError(`Expected JSON array`);
@@ -310,10 +310,10 @@ export function caseJsonMap<K, V>(
 
     const [k, v] = parseElem(kv as [Value, Value]);
 
-    LbMap.insert(dictOrd, k, v, map);
+    PMap.insert(dictOrd, k, v, map);
   }
 
-  if (LbMap.toList(map).length !== value.length) {
+  if (PMap.toList(map).length !== value.length) {
     throw new JsonError(`Map should have unique keys`);
   }
 

src/LambdaBuffers/Runtime/Eq.ts renamed to src/Prelude/Runtime/Eq.ts

@@ -1,5 +1,5 @@
 import type { Ord } from "./Ord.js";
-import * as LbAvlTree from "./AvlTree.js";
+import * as PAvlTree from "./AvlTree.js";
 import type { Node } from "./AvlTree.js";
 import type { Maybe } from "./Maybe.js";
 
@@ -8,19 +8,19 @@ import type { Maybe } from "./Maybe.js";
  *
  * @example
  * ```ts
- * import * as LbPrelude from "lbr-prelude"
+ * import * as Prelude from "lbr-prelude"
  *
  * let map : Map<string, string> = new Map();
- * insert(LbPrelude.ordString,  "a", "b", map)
- * lookup(LbPrelude.ordString,  "a", map) // returns `"b"`
+ * insert(Prelude.ordString,  "a", "b", map)
+ * lookup(Prelude.ordString,  "a", map) // returns `"b"`
  * map.length // is 1
  *
- * insert(LbPrelude.ordString. "a", "c", map)
- * lookup(LbPrelude.ordString,  "a", map) // returns `"c"`
+ * insert(Prelude.ordString. "a", "c", map)
+ * lookup(Prelude.ordString,  "a", map) // returns `"c"`
  * map.length // is 1
  *
- * remove(LbPrelude.ordString,  "a", map)
- * lookup(LbPrelude.ordString,  "a", map) // returns `undefined`
+ * remove(Prelude.ordString,  "a", map)
+ * lookup(Prelude.ordString,  "a", map) // returns `undefined`
  * map.length // is 0
  * ```
  */
@@ -66,7 +66,7 @@ export function insert<K, V>(
   value: V,
   map: Map<K, V>,
 ): void {
-  map.tree = LbAvlTree.alter(
+  map.tree = PAvlTree.alter(
     ordOnFst(ordDict),
     (arg) => {
       if (arg === undefined) {
@@ -88,7 +88,7 @@ export function insert<K, V>(
  * Complexity: `O(log n)`
  */
 export function remove<K, V>(ordDict: Ord<K>, key: K, map: Map<K, V>): void {
-  map.tree = LbAvlTree.alter(
+  map.tree = PAvlTree.alter(
     ordOnFst(ordDict),
     (arg) => {
       if (arg === undefined) {
@@ -114,7 +114,7 @@ export function lookup<K, V>(
   key: K,
   map: Readonly<Map<K, V>>,
 ): Maybe<V> {
-  const lkup: undefined | [K, V] = LbAvlTree.lookup(ordOnFst(ordDict), [
+  const lkup: undefined | [K, V] = PAvlTree.lookup(ordOnFst(ordDict), [
     key,
     null as V,
   ], map.tree);
@@ -131,7 +131,7 @@ export function lookup<K, V>(
  * Complexity: `O(n)`
  */
 export function toList<K, V>(map: Readonly<Map<K, V>>): [K, V][] {
-  return LbAvlTree.toList(map.tree);
+  return PAvlTree.toList(map.tree);
 }
 
 /**
@@ -143,5 +143,5 @@ export function checkInvariants<K, V>(
   ordDict: Ord<K>,
   map: Readonly<Map<K, V>>,
 ): void {
-  return LbAvlTree.checkInvariants(ordOnFst(ordDict), map.tree);
+  return PAvlTree.checkInvariants(ordOnFst(ordDict), map.tree);
 }

src/LambdaBuffers/Runtime/Json.ts renamed to src/Prelude/Runtime/Json.ts

@@ -1,4 +1,4 @@
-import * as LbJson from "./Json.js";
+import * as PJson from "./Json.js";
 import type { Eq } from "./Eq.js";
 import type { Ord } from "./Ord.js";
 import type { Json } from "./Json.js";
@@ -81,20 +81,20 @@ export function jsonMaybe<A>(dict: Json<A>): Json<Maybe<A>> {
   return {
     toJson: (maybe) => {
       if (maybe.name === "Nothing") {
-        return LbJson.jsonConstructor("Nothing", []);
+        return PJson.jsonConstructor("Nothing", []);
       } else {
-        return LbJson.jsonConstructor("Just", [dict.toJson(maybe.fields)]);
+        return PJson.jsonConstructor("Just", [dict.toJson(maybe.fields)]);
       }
     },
     fromJson: (value) => {
-      return LbJson.caseJsonConstructor<Maybe<A>>("Prelude.Maybe", {
+      return PJson.caseJsonConstructor<Maybe<A>>("Prelude.Maybe", {
         "Nothing": (ctorFields) => {
           if (ctorFields.length === 0) {
             return { name: "Nothing" };
           } else {
             throw new JsonError(
               "Expected JSON Array with 0 fields but got" +
-                LbJson.stringify(value),
+                PJson.stringify(value),
             );
           }
         },
@@ -104,7 +104,7 @@ export function jsonMaybe<A>(dict: Json<A>): Json<Maybe<A>> {
           } else {
             throw new JsonError(
               "Expected JSON Array with 1 fields but got" +
-                LbJson.stringify(value),
+                PJson.stringify(value),
             );
           }
         },