Update nix flake, README, formatting.

Author: Unisay

README.md

@@ -1,17 +1,58 @@
 # Purescript Backend for Lua
 
-Status: (2023-07-05) the project is in the "*ready to be experimented with*" state (read: it likely contains bugs but is already usable).
+Status: (2023-07-05) the project is in the "_ready to be experimented with_" state (read: it likely contains bugs but is already usable).
 
 ## Features
 
 - [x] Lua code bundling: emits either a Lua module or "App".
-- [X] FFI with Lua.
+- [x] FFI with Lua.
 - [x] Dead Code Elimination (DCE).
 - [x] Code inlining.
 - [x] [Package Set](https://github.com/Unisay/purescript-lua-package-sets) for PureScript/Lua libs.
 - [x] All core libs added to the package set.
 
 ## Quick Start
 
-For the moment the best way to start is to use `nix` to intall `pslua`. 
+For the moment the best way to start is to use `nix` to intall `pslua`.
+
 Here is an [example](https://github.com/Unisay/purescript-lua-example) project.
+
+If you use [Spago](https://github.com/purescript/spago) to build your PureScript project, then you can configure `pslua` as a custom backend like this:
+
+<details> <summary>spago.dhall</summary>
+
+Assuming that `pslua` executable is already available on your PATH
+
+```dhall
+{ name = "acme-project"
+, dependencies = [ "effect", "prelude" ]
+, packages = ./packages.dhall
+, sources = [ "src/**/*.purs" ]
+, backend =
+    ''
+    pslua \
+    --foreign-path . \
+    --ps-output output \
+    --lua-output-file dist/acme.lua \
+    --entry Acme.Main
+    ''
+}
+```
+
+</details>
+
+### Using nix with flakes
+
+```
+nix run 'github:Unisay/purescript-lua' -- --help
+```
+
+## Installation
+
+### Using nix with flakes
+
+```
+nix profile install 'github:Unisay/purescript-lua'
+```
+
+will make `pslua` executable available for use.

cabal.project

@@ -1,2 +1,2 @@
 packages: *.cabal
-index-state: 2023-06-29T00:00:00Z
+index-state: 2023-07-04T00:00:00Z

flake.lock

@@ -25,22 +25,22 @@
               src = ./.;
               evalSystem = "x86_64-linux";
               # index-state = "2023-06-28T00:00:00Z";
-              modules =
-                let prof = false;
-                in [{
-                  doHaddock = false;
-                  doHoogle = false;
-                  enableProfiling = prof;
-                  enableLibraryProfiling = prof;
-                }];
+              modules = let prof = false;
+              in [{
+                doHaddock = false;
+                doHoogle = false;
+                enableProfiling = prof;
+                enableLibraryProfiling = prof;
+              }];
             };
           })
         ];
         flake = pkgs.hixProject.flake { };
-      in
-      flake // {
+      in flake // {
         legacyPackages = pkgs;
         packages.default = flake.packages."pslua:exe:pslua";
+        packages.static =
+          flake.ciJobs.x86_64-unknown-linux-musl.packages."pslua:exe:pslua";
       });
 
   # --- Flake Local Nix Configuration ----------------------------

flake.nix

@@ -1,4 +1,5 @@
 comma-style: leading
+column-limit: 80
 diff-friendly-import-export: true
 function-arrows: leading
 haddock-style: multi-line

fourmolu.yaml

@@ -5,24 +5,27 @@ module Language.PureScript.Backend.IR
 
 import Control.Monad.Error.Class (MonadError (throwError))
 import Control.Monad.Writer.Class (MonadWriter (..))
-import Data.Char qualified as Char
+import qualified Data.Char as Char
 import Data.Foldable (foldrM)
-import Data.List qualified as List
+import qualified Data.List as List
 import Data.List.NonEmpty ((<|))
-import Data.List.NonEmpty qualified as NE
-import Data.Map.Lazy qualified as Map
+import qualified Data.List.NonEmpty as NE
+import qualified Data.Map.Lazy as Map
 import Data.Tagged (Tagged (Tagged))
-import Data.Text qualified as Text
+import qualified Data.Text as Text
 import Data.Traversable (for)
 import Language.PureScript.Backend.IR.Types
-import Language.PureScript.CoreFn qualified as Cfn
+import qualified Language.PureScript.CoreFn as Cfn
 import Language.PureScript.CoreFn.Laziness (applyLazinessTransform)
 import Language.PureScript.Names (ModuleName)
-import Language.PureScript.Names qualified as PS
-import Language.PureScript.PSString (PSString, decodeStringEither)
+import qualified Language.PureScript.Names as PS
+import Language.PureScript.PSString
+  ( PSString
+  , decodeStringEither
+  )
 import Numeric (showHex)
 import Relude.Extra (toFst)
-import Relude.Unsafe qualified as Unsafe
+import qualified Relude.Unsafe as Unsafe
 import Prelude hiding (identity)
 
 data Context = Context
@@ -460,7 +463,8 @@ mkCaseClauses = mkClauses mempty
                     let qctor =
                           constructor
                             & fmap renderCtorName
-                            & literalString . \case
+                            & literalString
+                            . \case
                               Local name → name
                               Imported modname c →
                                 PS.runModuleName modname <> "." <> c

lib/Language/PureScript/Backend/IR.hs

@@ -1,36 +1,41 @@
 { pkgs, easy-ps, ... }: {
   name = "purescript-lua";
   compiler-nix-name = "ghc928";
-  # crossPlatforms = p:
-  #   pkgs.lib.optionals pkgs.stdenv.hostPlatform.isx86_64 ([ p.mingwW64 ]
-  #     ++ pkgs.lib.optionals pkgs.stdenv.hostPlatform.isLinux [ p.musl64 ]);
+  crossPlatforms = p:
+    pkgs.lib.optionals pkgs.stdenv.hostPlatform.isx86_64 ([ p.mingwW64 ]
+      ++ pkgs.lib.optionals pkgs.stdenv.hostPlatform.isLinux [ p.musl64 ]);
 
   shell = {
-    tools =
-      let index-state = "2023-06-29T00:00:00Z";
-      in {
-        cabal = {
-          inherit index-state;
-          version = "latest";
-        };
-        cabal-fmt = {
-          inherit index-state;
-          version = "latest";
-        };
-        hlint = {
-          inherit index-state;
-          version = "latest";
-        };
-        haskell-language-server = {
-          inherit index-state;
-          version = "latest";
-        };
+    tools = let index-state = "2023-07-04T00:00:00Z";
+    in {
+      cabal = {
+        inherit index-state;
+        version = "latest";
       };
+      cabal-fmt = {
+        inherit index-state;
+        version = "latest";
+      };
+      fourmolu = {
+        inherit index-state;
+        version = "0.13.0.0";
+      };
+      hlint = {
+        inherit index-state;
+        version = "latest";
+      };
+      haskell-language-server = {
+        inherit index-state;
+        version = "latest";
+      };
+      nixfmt = {
+        inherit index-state;
+        version = "latest";
+      };
+    };
     buildInputs = with pkgs; [
-      haskellPackages.fourmolu_0_12_0_0
       lua53Packages.lua
       lua53Packages.luacheck
-      nixpkgs-fmt
       purescript
       spago
       treefmt

nix/hix.nix

@@ -1 +1,2 @@
-(builtins.getFlake ("git+file://" + toString ./.)).devShells.${builtins.currentSystem}.default
+(builtins.getFlake
+  ("git+file://" + toString ./.)).devShells.${builtins.currentSystem}.default

shell.nix

@@ -90,8 +90,10 @@ spec = do
         let moduleName =
               parent corefn
                 & dirname
-                & FilePath.dropTrailingPathSeparator . toFilePath
-                & PS.ModuleName . toText
+                & FilePath.dropTrailingPathSeparator
+                . toFilePath
+                & PS.ModuleName
+                . toText
 
             modulePath = parent corefn
         -- IR golden

test/Language/PureScript/Backend/Lua/GoldenSpec.hs

@@ -30,13 +30,13 @@ assertEqual
   → Assertion
 assertEqual preface expected actual =
   unless (actual == expected) do
-    prefaceMsg `deepseq`
-      expectedMsg `deepseq`
-        actualMsg `deepseq`
-          throwIO
-            ( HUnitFailure location $
-                ExpectedButGot prefaceMsg expectedMsg actualMsg
-            )
+    prefaceMsg
+      `deepseq` expectedMsg
+      `deepseq` actualMsg
+      `deepseq` throwIO
+        ( HUnitFailure location $
+            ExpectedButGot prefaceMsg expectedMsg actualMsg
+        )
  where
   prefaceMsg
     | null preface = Nothing

test/Test/Hspec/Expectations/Pretty.hs

@@ -20,5 +20,5 @@ options = ["--inplace"]
 includes = ["*.cabal"]
 
 [formatter.nix]
-command = "nixpkgs-fmt"
+command = "nixfmt"
 includes = ["*.nix"]