Code cleanup to make the documentation more sensible

jared · jared · commit 6ce7e66d3451 · 2024-03-05T20:31:23.000-07:00
diff --git a/extras/lbf-nix/build.nix b/extras/lbf-nix/build.nix
@@ -1,4 +1,4 @@
-{ inputs, ... }: {
+{ lib, inputs, ... }: {
   perSystem = { pkgs, config, system, ... }:
     let
       lbg-haskell = "${config.packages.lbg-haskell}/bin/lbg-haskell";
@@ -23,23 +23,23 @@
         lbfTypescript = opts: import ./lbf-typescript.nix
           {
             inherit pkgs lbg-typescript;
-            inherit (config.packages) lbf;
+            inherit (config.packages) lbf-list-modules-typescript lbf;
             inherit (inputs.flake-lang.lib.${system}) typescriptFlake;
           }
           opts;
         lbfPreludeTypescript = opts:
           import ./lbf-prelude-typescript.nix
             {
               inherit pkgs lbg-typescript config;
-              inherit (config.packages) lbf;
+              inherit (config.packages) lbf-list-modules-typescript lbf;
               inherit (inputs.flake-lang.lib.${system}) typescriptFlake;
             }
             opts;
         lbfPlutusTypescript = opts:
           import ./lbf-plutus-typescript.nix
             {
               inherit pkgs lbg-typescript config;
-              inherit (config.packages) lbf;
+              inherit (config.packages) lbf-list-modules-typescript lbf;
               inherit (inputs.flake-lang.lib.${system}) typescriptFlake;
             }
             opts;
@@ -48,5 +48,18 @@
         lbfPlutusRust = import ./lbf-plutus-rust.nix pkgs config.packages.lbf lbg-rust;
       };
 
+      packages = {
+        lbf-list-modules-typescript = pkgs.stdenv.mkDerivation {
+          name = "lbf-list-modules-typescript";
+          buildInputs = [ pkgs.nodejs ];
+          dontUnpack = true;
+          src = ./lbf-list-modules-typescript;
+          installPhase = ''
+            mkdir -p "$out/bin"
+            cp "$src" "$out/bin/lbf-list-modules-typescript"
+          '';
+        };
+      };
+
     };
 }
diff --git a/extras/lbf-nix/lbf-list-modules-typescript b/extras/lbf-nix/lbf-list-modules-typescript
@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+
+const fs = require('node:fs/promises')
+const process = require('node:process')
+
+const help =`Usage: lbf-list-modules-typescript <package-name>=<directory>...
+
+Description:
+    Given a sequence of \`pkg-name1=dir1\`, ..., \`pkg-nameN=dirN\`, outputs
+    a JSON object on stdout of the form
+    \`\`\`
+    {
+        "pkg-name1": lbfs1,
+        ...
+        "pkg-nameN": lbfsN
+    }
+    \`\`\`
+    where for every \`i\`, each \`lbfi\` is a list of all paths ending with \`*.lbf\` in \`diri\`
+    except the \`*.lbf\` suffix is removed and all \`/\`s are replaced with \`.\`.
+
+    When there are no arguments, this returns the empty JSON object.
+
+Examples:
+    Suppose there is a directory as follows.
+        |-A.lbf
+        \`-Directory
+           |-B.lbf
+           \`-C.lbf
+    Then, \`lbf-list-modules-typescript .\` returns
+    \`\`\`
+    A
+    Directory.B
+    Directory.C
+    \`\`\``
+
+async function main() {
+    const argv = process.argv.slice(2);
+
+    const result = { }
+
+    for (const pkgDir of argv) {
+        const pkgDirMatches = pkgDir.match(/^(?<pkgName>[^=]*)=(?<dir>[^=]+)$/)
+        if (pkgDirMatches === null)
+            throw new Error("CLI argument not of the form \`<pkg-name>=<directory>\`\n" + help)
+
+        const { pkgName, dir } = pkgDirMatches.groups
+        const listings = await fs.readdir(dir, { recursive: true })
+
+        const filtered = []
+        for (const listing of listings) {
+            const listingMatch = listing.match(/^(?<moduleName>.*)\.lbf$/)
+            if (listingMatch === null)
+                continue
+            const { moduleName } = listingMatch.groups
+            filtered.push(moduleName.replace(/\//g, '.'))
+        }
+
+        if (result[pkgName] !== undefined)
+            console.error(`lbf-list-modules-typescript: warning: package name ${pkgName} is defined multiple times. Overwriting the first definition.`)
+
+        result[pkgName] = filtered
+    }
+
+    process.stdout.write(JSON.stringify(result));
+}
+
+main()
diff --git a/extras/lbf-nix/lbf-plutus-typescript.nix b/extras/lbf-nix/lbf-plutus-typescript.nix
@@ -4,12 +4,13 @@
 , lbg-typescript
 , config
 , typescriptFlake
+, lbf-list-modules-typescript
 }:
 lbfTypescriptOpts:
 let
   utils = import ./utils.nix pkgs;
 
-  lbfTypescript = import ./lbf-prelude-typescript.nix { inherit pkgs lbf lbg-typescript config typescriptFlake; };
+  lbfTypescript = import ./lbf-prelude-typescript.nix { inherit pkgs lbf lbg-typescript config lbf-list-modules-typescript typescriptFlake; };
   lbfTypescriptOptsForPlutus = utils.overrideAttrs
     {
       imports = {
diff --git a/extras/lbf-nix/lbf-prelude-typescript.nix b/extras/lbf-nix/lbf-prelude-typescript.nix
@@ -9,11 +9,12 @@
 , lbg-typescript
 , config
 , typescriptFlake
+, lbf-list-modules-typescript
 }: lbfTypeScriptOpts:
 let
   utils = import ./utils.nix pkgs;
 
-  lbfTs = import ./lbf-typescript.nix { inherit pkgs lbf lbg-typescript typescriptFlake; };
+  lbfTs = import ./lbf-typescript.nix { inherit pkgs lbf lbg-typescript typescriptFlake lbf-list-modules-typescript; };
   lbfTypeScriptOptsForPrelude = utils.overrideAttrs
     {
       imports = {
diff --git a/extras/lbf-nix/lbf-typescript.nix b/extras/lbf-nix/lbf-typescript.nix
@@ -8,6 +8,9 @@
 , lbg-typescript
   # Function to create typescript flakes
 , typescriptFlake
+  # Function to create a JSON file which maps package names to lists of
+  # LambdaBuffers names
+, lbf-list-modules-typescript
 }:
 
 
@@ -85,15 +88,20 @@ lbfTypescriptOpts@{
 let
   lbf-build = import ./lbf-build.nix pkgs lbf;
 
-  lbfListModules = pkgs.callPackage ./lbf-list-modules.nix { };
+  # lbfListModules = pkgs.callPackage ./lbf-list-modules.nix { };
 
-  packageSet =
-    pkgs.writeTextFile {
-      name = "lb-typescript-packages";
-      text =
-        builtins.toJSON
-          (builtins.mapAttrs (_name: lbfListModules) imports);
-    };
+  # packageSet =
+  #   pkgs.writeTextFile {
+  #     name = "lb-typescript-packages";
+  #     text =
+  #       builtins.toJSON
+  #         (builtins.mapAttrs (_name: lbfListModules) imports);
+  #   };
+  packageSet = pkgs.runCommand "lb-typescript-packages" { buildInputs = [ lbf-list-modules-typescript ]; }
+    ''
+      1>"$out" lbf-list-modules-typescript \
+          ${pkgs.lib.escapeShellArgs ( pkgs.lib.mapAttrsToList (name: value: "${name}=${value}") imports) }
+    '';
 
   lbfBuilt = with lbfTypescriptOpts;
     lbf-build.build
diff --git a/lambda-buffers-codegen/app/Main.hs b/lambda-buffers-codegen/app/Main.hs
@@ -119,7 +119,7 @@ typescriptGenOptsP =
       )
     <*> strOption
       ( long "packages"
-          <> short 'g'
+          <> short 'p'
           <> metavar "FILEPATH"
           <> help "JSON file containing the package-set and all of its modules (including current package) with schema `{ [index : PackageName]: ModuleName[] }`."
       )
diff --git a/lambda-buffers-frontend/build.nix b/lambda-buffers-frontend/build.nix
@@ -43,6 +43,9 @@
             config.packages.lbf-plutus-to-purescript
             config.packages.lbf-prelude-to-rust
             config.packages.lbf-plutus-to-rust
+            config.packages.lbf-list-modules-typescript
+            config.packages.lbf-prelude-to-typescript
+            config.packages.lbf-plutus-to-typescript
           ];
         };
       };

Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ typescriptGenOptsP =`
`119`	`119`	`)`
`120`	`120`	`<*> strOption`
`121`	`121`	`( long "packages"`
`122`		`- <> short 'g'`
	`122`	`+ <> short 'p'`
`123`	`123`	`<> metavar "FILEPATH"`
`124`	`124`	<> help "JSON file containing the package-set and all of its modules (including current package) with schema `{ [index : PackageName]: ModuleName[] }`."
`125`	`125`	`)`