Merge branch 'main' into jared/typescript-runtime

Author: jared

docs/getting-started.md

@@ -69,4 +69,4 @@ shellcheck...........................................(no files to check)Skipped
 typos....................................................................Passed
 ```
 
-To run all the code quality tooling specified in the [pre-commit-check config file](../pre-commit.nix)
+To run all the code quality tooling specified in the [pre-commit-check config file](https://github.com/mlabs-haskell/lambda-buffers/blob/main/pre-commit.nix)

docs/haskell.md

@@ -19,7 +19,7 @@ github:mlabs-haskell/lambda-buffers#lbf-prelude-to-haskell`.
 
 In this chapter, we're going to use the latter option.
 
-Let's now use `lbf-prelude-to-haskell` to process the [Document.lbf](examples/Document.lbf) schema.
+Let's now use `lbf-prelude-to-haskell` to process the [Document.lbf](https://github.com/mlabs-haskell/lambda-buffers/tree/main/docs/examples/Document.lbf) schema.
 
 ```purescript
 module Document

docs/plutarch.md

@@ -43,21 +43,21 @@ For a full example see [Example](#example).
 
 Writing .lbf schemas with API types intended for Plutarch backend will typically use the following LambdaBuffers schema modules:
 
-1. [Prelude](../libs/lbf-prelude/Prelude.lbf),
-2. [Plutus.V1](../libs/lbf-plutus/Plutus/V1.lbf),
-3. [Plutus.V2](../libs/lbf-plutus/Plutus/V2.lbf).
+1. [Prelude](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-prelude/Prelude.lbf),
+2. [Plutus.V1](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-plutus/Plutus/V1.lbf),
+3. [Plutus.V2](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-plutus/Plutus/V2.lbf).
 
-Take a look at [Example.lbf](./plutarch/api/Example.lbf) schema as an example.
+Take a look at [Example.lbf](https://github.com/mlabs-haskell/lambda-buffers/tree/main/docs/plutarch/api/Example.lbf) schema as an example.
 
 ## Haskell libraries
 
 The necessary LambdaBuffers runtime libraries a typical Plutarch project needs when working with LambdaBuffers:
 
-1. [lbr-plutarch](../runtimes/haskell/lbr-plutarch) a Haskell runtime library necessary for working with `lbf-xyz` libraries.
-2. [lbf-prelude-plutarch](../libs/lbf-prelude) that contains the [LambdaBuffers Prelude](../libs/lbf-prelude) schema library generated by LambdaBuffers.
-3. [lbf-plutus-plutarch](../libs/lbf-plutus) that contains the [LambdaBuffers Plutus](../libs/lbf-plutus) schema library generated by LambdaBuffers.
+1. [lbr-plutarch](https://github.com/mlabs-haskell/lambda-buffers/tree/main/runtimes/haskell/lbr-plutarch) a Haskell runtime library necessary for working with `lbf-xyz` libraries.
+2. [lbf-prelude-plutarch](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-prelude) that contains the [LambdaBuffers Prelude](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-prelude) schema library generated by LambdaBuffers.
+3. [lbf-plutus-plutarch](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-plutus) that contains the [LambdaBuffers Plutus](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-plutus) schema library generated by LambdaBuffers.
 
-Of course, additional imports for Plutarch libraries are also necessary [plutarch](https://github.com/Plutonomicon/plutarch-plutus) and optionally [plutarch-extra](https://github.com/Plutonomicon/plutarch-plutus/plutarch-extra).
+Of course, additional imports for Plutarch libraries are also necessary [plutarch](https://github.com/Plutonomicon/plutarch-plutus) and optionally [plutarch-extra](https://github.com/Plutonomicon/plutarch-plutus/tree/master/plutarch-extra).
 
 For a full example see [Example](#example).
 
@@ -99,10 +99,10 @@ import Plutarch.Api.V1 ()
 import Plutarch.Api.V2 ()
 ```
 
-1. LambdaBuffers.Plutus.V1.Plutarch is a module generated from [Plutus.V1](../libs/lbf-plutus/Plutus/V1.lbf) LambdaBuffers schema and provided by the [lbf-plutus-plutarch](../libs/lbf-plutus) runtime library.
-2. LambdaBuffers.Plutus.V2.Plutarch is a module generated from [Plutus.V2](../libs/lbf-plutus/Plutus/V2.lbf) LambdaBuffers schema and provided by the [lbf-plutus-plutarch](../libs/lbf-plutus) runtime library.
-3. LambdaBuffers.Prelude.Plutarch is a module generated from [Prelude](../libs/lbf-prelude/Prelude.lbf) LambdaBuffers schema and provided by the [lbf-prelude-plutarch](../libs/lbf-prelude) runtime library.
-4. LambdaBuffers.Runtime.Plutarch is a module provided by the [lbr-plutarch](../runtimes/haskell/lbr-plutarch) runtime library.
+1. LambdaBuffers.Plutus.V1.Plutarch is a module generated from [Plutus.V1](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-plutus/Plutus/V1.lbf) LambdaBuffers schema and provided by the [lbf-plutus-plutarch](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-plutus) runtime library.
+2. LambdaBuffers.Plutus.V2.Plutarch is a module generated from [Plutus.V2](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-plutus/Plutus/V2.lbf) LambdaBuffers schema and provided by the [lbf-plutus-plutarch](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-plutus) runtime library.
+3. LambdaBuffers.Prelude.Plutarch is a module generated from [Prelude](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-prelude/Prelude.lbf) LambdaBuffers schema and provided by the [lbf-prelude-plutarch](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-prelude) runtime library.
+4. LambdaBuffers.Runtime.Plutarch is a module provided by the [lbr-plutarch](https://github.com/mlabs-haskell/lambda-buffers/tree/main/runtimes/haskell/lbr-plutarch) runtime library.
 
 > Generated Plutarch module for a LambdaBuffers schema `Foo/Bar.lbf` (ie. `Foo.Bar`) is stored at `Foo/Bar/Plutarch.hs`
 
@@ -147,15 +147,15 @@ For example the `Foo` record defined above would have no difference in Plutarch
 prod Foo = Integer Bool
 ```
 
-The Plutarch backend doesn't support the use of `Char`, `Text`, `Bytes` (there's a Plutus.V1.Bytes), `Set` and `Map` (there's a Plutus.V1.Map) from [LambdaBuffers Prelude](../libs/lbf-prelude/Prelude.lbf) module.
+The Plutarch backend doesn't support the use of `Char`, `Text`, `Bytes` (there's a Plutus.V1.Bytes), `Set` and `Map` (there's a Plutus.V1.Map) from [LambdaBuffers Prelude](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-prelude/Prelude.lbf) module.
 
 ## Plutarch
 
 ### Type definition mapping
 
-Plutarch backend supports all types from the [LambdaBuffers Plutus](../libs/lbf-plutus) schema library, as to enable full featured Plutus script development.
+Plutarch backend supports all types from the [LambdaBuffers Plutus](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-plutus) schema library, as to enable full featured Plutus script development.
 
-Additionally, it also supports some types from the [LambdaBuffers Prelude](../libs/lbf-prelude) schema library, namely `Bool`, `Integer`, `Maybe`, `Either` and `List`.
+Additionally, it also supports some types from the [LambdaBuffers Prelude](https://github.com/mlabs-haskell/lambda-buffers/tree/main/libs/lbf-prelude) schema library, namely `Bool`, `Integer`, `Maybe`, `Either` and `List`.
 
 ```lbf
 module Foo
@@ -318,7 +318,7 @@ All generated types have a PShow instance derived using the internal Plutarch de
 
 ## Example
 
-Let work through the [Plutarch example](./plutarch) available in the repo.
+Let work through the [Plutarch example](https://github.com/mlabs-haskell/lambda-buffers/tree/main/docs/plutarch) available in the repo.
 
 First, please check the [Getting started](getting-started.md) guide on how to prepare to work with the repo and setup Nix.
 
@@ -340,8 +340,8 @@ lambda-buffers/docs/plutarch ❯ find
 
 The salient bits we should focus on are:
 
-1. The LambdaBuffers .lbf schema in [./api/Example.lbf](./plutarch/api/Example.lbf) that describes the API types used by our little program,
-2. The Haskell Plutarch program in [./app/Example.hs](./plutarch/app/Example.hs) that works with the API types.
+1. The LambdaBuffers .lbf schema in [./api/Example.lbf](https://github.com/mlabs-haskell/lambda-buffers/tree/main/docs/plutarch/api/Example.lbf) that describes the API types used by our little program,
+2. The Haskell Plutarch program in [./app/Example.hs](https://github.com/mlabs-haskell/lambda-buffers/tree/main/docs/plutarch/app/Example.hs) that works with the API types.
 
 To inspect the generated library:
 
@@ -359,7 +359,7 @@ autogen/LambdaBuffers/Example/Plutarch.hs
 
 However, it's not expected for users to need to do this. If you have any issue please reach out.
 
-Inspecting the [Cabal file](./plutarch/plutarch-example.cabal) shows the standard runtime libraries we need:
+Inspecting the [Cabal file](https://github.com/mlabs-haskell/lambda-buffers/tree/main/docs/plutarch/plutarch-example.cabal) shows the standard runtime libraries we need:
 
 ```shell
 lambda-buffers/docs/plutarch ❯ cabal info .
@@ -388,4 +388,4 @@ lambda-buffers/docs/plutarch ❯ cabal run
 "Friends, peace and love!!!"
 ```
 
-Take a look at the [Example.hs](./plutarch/app/Example.hs) to see how generated types are used, namely how they are constructed with `pcon` and deconstructed with `pmatch` (or `pmatchC`).
+Take a look at the [Example.hs](https://github.com/mlabs-haskell/lambda-buffers/tree/main/docs/plutarch/app/Example.hs) to see how generated types are used, namely how they are constructed with `pcon` and deconstructed with `pmatch` (or `pmatchC`).

docs/plutarch/build.nix

@@ -1,15 +1,15 @@
 { inputs, ... }:
 {
-  perSystem = { pkgs, config, ... }:
+  perSystem = { config, ... }:
     let
-      project = { lib, ... }: {
+      hsFlake = config.lbf-nix.haskellPlutusFlake {
         src = ./.;
 
         name = "plutarch-example";
 
         inherit (config.settings.haskell) index-state compiler-nix-name;
 
-        extraHackage = [
+        dependencies = [
           # Load Plutarch support
           "${config.packages.lbf-prelude-plutarch}"
           "${config.packages.lbf-plutus-plutarch}"
@@ -22,49 +22,18 @@
           "${inputs.plutarch}/plutarch-extra"
         ];
 
-        modules = [
-          (_: {
-            packages = {
-              allComponent.doHoogle = true;
-              allComponent.doHaddock = true;
-
-              # Enable strict compilation
-              plutarch-example.configureFlags = [ "-f-dev" ];
-            };
-          })
-        ];
-
-        shell = {
-
-          withHoogle = true;
-
-          exactDeps = true;
-
-          nativeBuildInputs = config.settings.shell.tools ++ [ config.packages.lbf-plutus-to-plutarch ];
-
-          tools = {
-            cabal = { };
-            haskell-language-server = { };
-          };
-
-          shellHook = lib.mkForce config.settings.shell.hook;
-        };
+        devShellTools = config.settings.shell.tools;
+        devShellHook = config.settings.shell.hook;
       };
-      hsNixFlake = (pkgs.haskell-nix.cabalProject' [
-        inputs.mlabs-tooling.lib.mkHackageMod
-        inputs.mlabs-tooling.lib.moduleMod
-        project
-      ]).flake { };
-
     in
 
     {
-      devShells.dev-plutarch-example = hsNixFlake.devShell;
+      devShells.dev-plutarch-example = hsFlake.devShell;
 
       packages = {
-        plutarch-example-cli = hsNixFlake.packages."plutarch-example:exe:plutarch-example";
+        plutarch-example-cli = hsFlake.packages."plutarch-example:exe:plutarch-example";
 
-        lbf-plutarch-example-api = config.overlayAttrs.lbf-nix.lbfPlutarch {
+        lbf-plutarch-example-api = config.lbf-nix.lbfPlutarch {
           name = "lbf-plutarch-example-api";
           src = ./api;
           files = [ "Example.lbf" ];

docs/purescript.md

@@ -19,7 +19,7 @@ github:mlabs-haskell/lambda-buffers#lbf-prelude-to-purescript`.
 
 In this chapter, we're going to use the latter option.
 
-Let's now use `lbf-prelude-to-purescript` to process the [Document.lbf](examples/Document.lbf) schema
+Let's now use `lbf-prelude-to-purescript` to process the [Document.lbf](https://github.com/mlabs-haskell/lambda-buffers/blob/main/docs/examples/Document.lbf) schema
 
 ```purescript
 module Document

extras/build.nix

@@ -1,19 +1,53 @@
-# TODO(bladyjoker): Using overlayAttrs here as a hack to share functions -.- Do this properly.
-{ inputs, ... }: {
-  imports = [
-    inputs.flake-parts.flakeModules.easyOverlay # Adds perSystem.overlayAttrs
-  ];
-  perSystem = { pkgs, ... }:
-    {
-
-      overlayAttrs = {
-        extras = {
-          purescriptFlake = import ./flake-purescript.nix pkgs;
-          rustFlake = import ./flake-rust.nix pkgs;
-          typescriptFlake = import ./flake-typescript.nix pkgs;
-          haskellData = import ./haskell-data.nix pkgs;
+{ config, inputs, flake-parts-lib, lib, ... }: {
+
+  # Makes a system agnostic option (dunno why I needed this).
+  options.lbf-nix = lib.mkOption {
+    type = lib.types.anything; # probably not the best type
+    default = { };
+  };
+
+  # Makes it available in the system agnostic `lib` argument.
+  config._module.args.lib = config.flake.lib // {
+    inherit (config) lbf-nix;
+  };
+
+  # Sets the above set option to system ones.
+  config.lbf-nix = lib.genAttrs config.systems (system: (config.perSystem system).lbf-nix);
+
+  # Makes `lib.x86_64-linux.xyz` available
+  config.flake.lib = config.lbf-nix;
+
+  options = {
+
+    # Makes a per system `lbf-nix` option.
+    perSystem = flake-parts-lib.mkPerSystemOption
+      ({ pkgs, config, ... }: {
+
+        options.lbf-nix = lib.mkOption {
+          type = lib.types.anything;
+          default = { };
+        };
+
+        # Sets a per system `lbf-nix` option.
+        config = {
+          lbf-nix = {
+            # NOTE(bladyjoker): If you need to add a function the export externally and use internally via config.lbf-nix, add it here.
+            purescriptFlake = import ./flake-purescript.nix pkgs;
+            rustFlake = import ./flake-rust.nix pkgs;
+            haskellData = import ./haskell-data.nix pkgs;
+            haskellFlake = import ./flake-haskell.nix pkgs;
+            haskellPlutusFlake = import ./flake-haskell-plutus.nix inputs.cardano-haskell-packages pkgs;
+            typescriptFlake = import ./flake-typescript.nix pkgs;
+          };
+
+          # Makes it available in the per system `lib` argument.
+          _module.args.lib = lib // {
+            inherit (config) lbf-nix;
+          };
+
         };
-      };
 
-    };
+      });
+
+  };
 }

extras/editor/emacs/lambda-buffers-mode.el

@@ -0,0 +1,16 @@
+;;; lambda-buffers-mode.el --- SUMMARY -*- lexical-binding: t -*-
+
+(require 'haskell-mode)
+
+(define-derived-mode lambda-buffers-mode haskell-mode "lambda-buffers"
+  "haskell-mode pretending to be lambda-buffers-mode"
+  (haskell-indent-mode)
+  (font-lock-add-keywords
+   nil
+   '(("\\<\\(record\\|sum\\|derive\\|opaque\\|prod\\)\\>" . 'font-lock-keyword-face)))
+  (setq lsp-warn-no-matched-clients nil))
+
+(add-to-list 'auto-mode-alist '("\\.lbf$" . lambda-buffers-mode))
+
+(provide 'lambda-buffers-mode)
+;;; lambda-buffers-mode.el ends here

extras/flake-haskell-plutus.nix

@@ -0,0 +1,11 @@
+# Makes a Haskell Flake using haskell.nix with a simplified interface with support for Plutus development.
+cardano-haskell-packages: pkgs: opts:
+let
+  plutusMod = (import ./haskell.nix/plutus.nix) opts.compiler-nix-name cardano-haskell-packages;
+  opts' =
+    if "modules" ? opts then opts // {
+      modules = opts.modules ++ [ plutusMod ];
+    }
+    else opts // { modules = [ plutusMod ]; };
+in
+(import ./flake-haskell.nix pkgs) opts'

extras/flake-haskell.nix

@@ -0,0 +1,63 @@
+# Makes a Haskell Flake using haskell.nix with a simplified interface.
+pkgs:
+let
+  haskellNixOpts =
+    { src
+    , name
+    , dependencies ? [ ]
+    , devShellTools ? [ ]
+    , devShellHook
+    , devShellAdditionalPackages ? _: [ ]
+    , index-state
+    , compiler-nix-name
+    , modules ? [ ]
+    }: {
+      inherit src name dependencies devShellTools devShellHook index-state compiler-nix-name modules devShellAdditionalPackages;
+    };
+
+  hsNixProj = opts: with (haskellNixOpts opts);
+    let
+      proj = { lib, ... }: {
+        inherit src name index-state compiler-nix-name;
+        extraHackage = dependencies;
+        modules = [
+          (_: {
+            packages = {
+              allComponent.doHoogle = true;
+              allComponent.doHaddock = true;
+
+              # Enable strict compilation
+              "${name}".configureFlags = [ "-f-dev" ];
+            };
+          })
+        ];
+
+        shell = {
+          withHoogle = true;
+          exactDeps = true;
+          nativeBuildInputs = devShellTools;
+          additional = devShellAdditionalPackages;
+
+          tools = {
+            cabal = { };
+            haskell-language-server = { };
+          };
+
+          shellHook = lib.mkForce devShellHook;
+        };
+
+      };
+    in
+    proj;
+
+  hsNixFlake = opts: with (haskellNixOpts opts);
+    (pkgs.haskell-nix.cabalProject' ([
+      ((import ./haskell.nix/extra-hackage.nix) compiler-nix-name)
+      (hsNixProj opts)
+    ]
+    ++ modules
+    )
+    ).flake { };
+
+in
+hsNixFlake