Merge branch 'main' of github.com:mlabs-haskell/lambda-buffers into szg251/darwin

Author: szg251

README.md

@@ -20,7 +20,7 @@ competitors if your project requires:
  1. _Parameterized Data Types_ (aka. type functions): Unlike ProtoBuffers or
     JSON Schema, LambdaBuffers allows users to define algebraic data types which
     take type variable arguments. If your project's domain is most accurately
-    represented by parameterized data types, LamdaBuffers may be a good choice
+    represented by parameterized data types, LambdaBuffers may be a good choice
     for your needs.
 
  2. _Opaque Types_: Almost every competing schema language provides users a
@@ -41,7 +41,7 @@ competitors if your project requires:
     productively make use of the generated types. While LambdaBuffers is still a
     work-in-progress, we expect that, upon completion, an extensive test suite
     will provide a high degree of assurance that the instances/methods generated
-    by the LamdaBuffers code generator behave identically.
+    by the LambdaBuffers code generator behave identically.
 
 ## Documentation
 

api/build.nix

@@ -1,56 +1,41 @@
 { inputs, ... }:
 {
-  perSystem = { pkgs, system, config, ... }:
+  perSystem = { pkgs, system, config, inputs', ... }:
     let
-      pbnix-lib = inputs.protobufs-nix.lib.${system};
+      proto-nix = inputs.proto-nix.lib.${system};
     in
     rec {
 
       devShells.dev-api = pkgs.mkShell {
         name = "protos-env";
-        buildInputs = [
-          pkgs.protobuf
-          pkgs.haskellPackages.proto-lens-protoc
-          pkgs.protoc-gen-doc
-        ] ++ config.settings.shell.tools;
-
+        inputsFrom = [ inputs'.proto-nix.devShells.dev-proto-nix ];
         shellHook = config.settings.shell.hook;
       };
 
       packages = {
-        lambda-buffers-lang-hs-pb = pbnix-lib.haskellProto {
-          inherit pkgs;
+        lambda-buffers-lang-hs-pb = proto-nix.haskellProto {
           src = ./.;
-          proto = "lang.proto";
+          protos = [ "lang.proto" ];
           cabalPackageName = "lambda-buffers-lang-pb";
         };
 
-        lambda-buffers-compiler-hs-pb = pbnix-lib.haskellProto {
-          inherit pkgs;
+        lambda-buffers-compiler-hs-pb = proto-nix.haskellProto {
           src = ./.;
-          proto = "compiler.proto";
+          protos = [ "compiler.proto" ];
           cabalBuildDepends = [ packages.lambda-buffers-lang-hs-pb ];
           cabalPackageName = "lambda-buffers-compiler-pb";
         };
 
-        lambda-buffers-codegen-hs-pb = pbnix-lib.haskellProto {
-          inherit pkgs;
+        lambda-buffers-codegen-hs-pb = proto-nix.haskellProto {
           src = ./.;
-          proto = "codegen.proto";
+          protos = [ "codegen.proto" ];
           cabalBuildDepends = [ packages.lambda-buffers-lang-hs-pb ];
           cabalPackageName = "lambda-buffers-codegen-pb";
         };
 
-        lambda-buffers-api-docs = pkgs.stdenv.mkDerivation {
+        lambda-buffers-api-docs = proto-nix.docProto {
           src = ./.;
-          name = "lambdabuffers-api-docs";
-          buildInputs = [
-            pkgs.protobuf
-          ];
-          buildPhase = ''
-            mkdir $out;
-            protoc --plugin=${pkgs.protoc-gen-doc}/bin/protoc-gen-doc lang.proto compiler.proto codegen.proto --doc_out=$out --doc_opt=markdown,api.md;
-          '';
+          protos = [ "lang.proto" "compiler.proto" "codegen.proto" ];
         };
       };
     };

api/lang.proto

@@ -27,7 +27,7 @@ message SourcePosition {
 
 /* Type term
 
-A type term that ocurrs in bodies of type definitions (message TyDef):
+A type term that occurs in bodies of type definitions (message TyDef):
 
 ```lbf
 sum Maybe a = Just a | Nothing
@@ -146,7 +146,7 @@ message TyName {
 
 /* Module name */
 message ModuleName {
-  // Parts of the module name denoting a hierarchichal namespace.
+  // Parts of the module name denoting a hierarchical namespace.
   repeated ModuleNamePart parts = 1;
   // Source information.
   SourceInfo source_info = 2;

docs/build.nix

@@ -4,7 +4,7 @@ _: {
       devShells.dev-docs = pkgs.mkShell {
         name = "docs-env";
         packages = [ pkgs.mdbook ];
-        shellHook = config.pre-commit.installationScript;
+        shellHook = config.settings.shell.hook;
       };
 
       packages.lambda-buffers-book = pkgs.stdenv.mkDerivation {

docs/feedback/interview-notes.md

@@ -46,7 +46,7 @@
         1. R. would like it to be seamless. R. mentions:
             1. Auto generate modules
             2. pre-commit hooks
-            3. itterate quickly
+            3. iterate quickly
             4. Nix integration is very important
             5. Not running commands.
             6. Watch function for the compiler.

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
@@ -108,7 +108,7 @@ $ ghc autogen/LambdaBuffers/Document.hs
 
 ## Sum types
 
-The types `Author`, `Reviewer`, and `RichContent` have been declared as sum types in the LamdaBuffers schema using the `sum` keyword.
+The types `Author`, `Reviewer`, and `RichContent` have been declared as sum types in the LambdaBuffers schema using the `sum` keyword.
 
 As we can see, nothing too surprising here, all the `sum` types become `data`
 in Haskell.
@@ -119,7 +119,7 @@ quote) to the defined constructor names as to make sure they are unique.
 ## Product types
 
 The type `RichDocument` have been declared as a product type in the
-LamdaBuffers schema using the `prod` keyword.
+LambdaBuffers schema using the `prod` keyword.
 
 They become Haskell `newtype` if they have a single type in their body, otherwise they are `data`.
 
@@ -128,7 +128,7 @@ Note that the constructor has the same name as the type.
 ## Record types
 
 The types `Document` and `Chapter` have been declared as record types in the
-LamdaBuffers schema using the `record` keyword.
+LambdaBuffers schema using the `record` keyword.
 
 Like with product types, they become Haskell `newtype` if they have a single
 type in their body, otherwise they are `data`.

docs/introduction.md

@@ -18,7 +18,7 @@ competitors if your project requires:
  1. _Parameterized Data Types_ (aka. type functions): Unlike ProtoBuffers or
     JSON Schema, LambdaBuffers allows users to define algebraic data types which
     take type variable arguments. If your project's domain is most accurately
-    represented by parameterized data types, LamdaBuffers may be a good choice
+    represented by parameterized data types, LambdaBuffers may be a good choice
     for your needs.
 
  2. _Opaque Types_: Almost every competing schema language provides users a
@@ -39,4 +39,4 @@ competitors if your project requires:
     productively make use of the generated types. While LambdaBuffers is still a
     work-in-progress, we expect that, upon completion, an extensive test suite
     will provide a high degree of assurance that the instances/methods generated
-    by the LamdaBuffers code generator behave identically.
+    by the LambdaBuffers code generator behave identically.

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/plutarch-example.cabal

@@ -20,7 +20,6 @@ common common-language
     ghc-options: -Werror
 
   default-extensions:
-    NoStarIsType
     BangPatterns
     BinaryLiterals
     ConstrainedClassMethods
@@ -57,6 +56,7 @@ common common-language
     MultiParamTypeClasses
     NamedFieldPuns
     NamedWildCards
+    NoStarIsType
     NumericUnderscores
     OverloadedLabels
     OverloadedStrings