feat: add support for trunk

[Trunk](https://trunkrs.dev) is a tool that allow you to build web apps using Rust and webassembly, including compiling scss, and distributing other assets. Adds `craneLib.buildTrunkPackage`, a function that builds a Trunk project returning a directory with the resulting dist files for that project
ipetkov · Apr 27, 2023 · cc2f119 · cc2f119
1 parent 54b63c8
commit cc2f119
Show file tree

Hide file tree

Showing 32 changed files with 3,175 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+### Added
+* Added support for the [Trunk](https://trunkrs.dev) wasm app build tool
+
 ### [0.12.1] - 2023-04-10
 
 ### Changed

diff --git a/README.md b/README.md
@@ -23,6 +23,7 @@ A [Nix] library for building [cargo] projects.
 * [cargo-audit] for vulnerability scanning
 * [cargo-nextest] a next-generation test runner
 * [cargo-tarpaulin] for code coverage
+* [trunk] for wasm frontend apps
 
 ## Getting Started
 
@@ -72,3 +73,4 @@ conditions.
 [Nix]: https://nixos.org/
 [rustfmt]: https://github.com/rust-lang/rustfmt
 [Semantic Versioning]: http://semver.org/spec/v2.0.0.html
+[Trunk]: https://trunkrs.dev/
diff --git a/checks/default.nix b/checks/default.nix
@@ -414,6 +414,10 @@ in
   smokeWorkspace = self.smoke [ "print" ] self.workspace;
   smokeWorkspaceRoot = self.smoke [ "print" ] self.workspaceRoot;
 
+  trunk = callPackage ./trunk.nix {
+    inherit myLib;
+  };
+
   vendorCargoDeps =
     let
       src = ./workspace;

diff --git a/checks/trunk.nix b/checks/trunk.nix
@@ -0,0 +1,46 @@
+{ pkgs
+, myLib
+, runCommand
+}:
+
+let
+  wasmToolchain = pkgs.rust-bin.stable.latest.default.override {
+    targets = [ "wasm32-unknown-unknown" ];
+  };
+
+  myLibWasm = myLib.overrideToolchain wasmToolchain;
+
+  defaultArgs = {
+    src = ./trunk;
+    doCheck = false;
+  };
+
+  # default build
+  cargoArtifacts = myLibWasm.buildDepsOnly (defaultArgs // {
+    cargoExtraArgs = "--target=wasm32-unknown-unknown";
+  });
+  trunkSimple = myLibWasm.buildTrunkPackage (defaultArgs // {
+    inherit cargoArtifacts;
+    pname = "trunk-simple";
+  });
+
+  # Trying to build when cargoArtifacts does not contain
+  # the wasm32-unknown-unknown target should throw an exception
+  cargoArtifactsIncorrectArgs = myLibWasm.buildDepsOnly defaultArgs;
+  trunkSimpleIncorrectArgs = myLibWasm.buildTrunkPackage (defaultArgs // {
+    cargoArtifacts = cargoArtifactsIncorrectArgs;
+    pname = "trunk-simple-incorrect-args";
+  });
+
+  trunkSimpleNoArtifacts = myLibWasm.buildTrunkPackage (defaultArgs // {
+    pname = "trunk-simple-no-artifacts";
+  });
+in
+
+assert (builtins.tryEval trunkSimpleIncorrectArgs).success == false;
+
+runCommand "trunkTests" { } ''
+  test -f ${trunkSimple}/*.wasm
+  test -f ${trunkSimpleNoArtifacts}/*.wasm
+  mkdir -p $out
+''
diff --git a/checks/trunk/Cargo.lock b/checks/trunk/Cargo.lock
diff --git a/checks/trunk/Cargo.toml b/checks/trunk/Cargo.toml
@@ -0,0 +1,8 @@
+[package]
+name = "trunk"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+console_log = "1.0.0"
+log = "0.4.17"
diff --git a/checks/trunk/index.html b/checks/trunk/index.html
@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Trunk App</title>
+  </head>
+</html>
diff --git a/checks/trunk/src/main.rs b/checks/trunk/src/main.rs
@@ -0,0 +1,4 @@
+fn main() {
+    console_log::init().unwrap();
+    log::debug!("Hi, this can run on the browser");
+}
diff --git a/docs/API.md b/docs/API.md
@@ -226,6 +226,25 @@ The following hooks are automatically added as native build inputs:
 * `jq`
 * `removeReferencesToVendoredSourcesHook`
 
+### `craneLib.buildTrunkPackage`
+`buildTrunkPackage :: set -> drv`
+
+Create a derivation which will build a distributable directory for a WASM application.
+
+Except where noted below, all derivation attributes are delegated to
+`mkCargoDerivation`, and can be used to influence its behavior.
+* `cargoArtifactsWasm`: A path (or derivation) which contains an existing cargo
+  `target` directory, which will be reused at the start of the derivation.
+  Useful for caching incremental cargo builds.
+  - This can be prepared via `buildDepsOnly`
+  - Alternatively, any cargo-based derivation which was built with
+    `doInstallCargoArtifacts = true` will work as well
+  - For this to be usefull it must have the dependencies
+    built for the `wasm32-unknown-unknown` target
+* `indexPath` A path to the index.html of your trunk project
+* `trunkExtraArgs` pass additional arguments to `trunk`, empty by default
+* `trunkExtraBuildArgs` pass additional arguments to `trunk build`, empty by default
+
 ### `craneLib.cargoAudit`
 `cargoAudit :: set -> drv`
 

diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -16,6 +16,8 @@
   * [Cross compiling](./examples/cross-rust-overlay.md)
   * [Cross compiling with musl](./examples/cross-musl.md)
   * [Cross compiling to windows](./examples/cross-windows.md)
+  * [Building Trunk projects](./examples/trunk.md)
+  * [Workspace with Trunk](./examples/trunk-workspace.md)
 * [Source filtering](./source-filtering.md)
 * [Local development](./local_development.md)
 * [Custom cargo commands](./custom_cargo_commands.md)

diff --git a/docs/examples/trunk-workspace.md b/docs/examples/trunk-workspace.md
@@ -0,0 +1,20 @@
+[Trunk](https://trunkrs.dev) is a tool that allow you to build web apps using Rust and webassembly, including compiling scss, and distributing other assets.
+It can be used in conjunction with any of Rust's web frameworks for the development of full stack web applications.
+
+In this example we have a workspace with three members:
+
+* client: a Yew application compiled using Trunk
+* server: a Axum server built using Cargo
+* shared: a library that contains types to be imported in both the client and server
+
+Quick-start a Trunk+Server project with
+
+```sh
+nix flake init -t github:ipetkov/crane#trunk-workspace
+```
+
+Alternatively, copy and paste the following `flake.nix` and modify it to build your workspace's packages:
+
+```nix
+{{#include ../../examples/trunk-workspace/flake.nix}}
+```
diff --git a/docs/examples/trunk.md b/docs/examples/trunk.md
@@ -0,0 +1,19 @@
+[Trunk](https://trunkrs.dev) is a tool that allow you to build web apps using Rust and webassembly, including compiling scss, and distributing other assets.
+
+Being a more specialized tool, it comes with some constraints that must be noted when using it in combination with crane:
+
+* Your Toolchain must have the `wasm32-unknown-unknown` target installed (See: [Custom toolchain](../custom-toolchain.md))
+* For `craneLib.buildDepsOnly` to work you will need to set the build target (See: [API Reference](../API.md#libbuilddepsonly))
+* `craneLib.filterCargoSources` will remove html, css, your assets folder, so you need to modify the source filtering function (See: [Source filtering](../source-filtering.md))
+
+Quick-start a Trunk project with
+
+```sh
+nix flake init -t github:ipetkov/crane#trunk
+```
+
+Alternatively, copy and paste the following `flake.nix`:
+
+```nix
+{{#include ../../examples/trunk/flake.nix}}
+```
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -20,6 +20,12 @@ nix flake init -t github:ipetkov/crane#cross-rust-overlay
 
 # For statically linked binaries using musl
 nix flake init -t github:ipetkov/crane#cross-musl
+
+# If you are building a WASM webapp with trunk
+nix flake init -t github:ipetkov/crane#trunk
+
+# If you are building a workspace with trunk member
+nix flake init -t github:ipetkov/crane#trunk-workspace
 ```
 
 For an even more lean, no frills set up, create a `flake.nix` file with the

diff --git a/examples/trunk-workspace/.gitignore b/examples/trunk-workspace/.gitignore
@@ -0,0 +1 @@
+client/dist