Skip to content

Address PR comments #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 21, 2023
Merged

Address PR comments #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae5bacd
Add 'rustVersion' to rust flake
szg251 Dec 21, 2023
98d8c03
Improve rust-nix documentation
szg251 Dec 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions extras/flake-rust.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
pkgs:

{ crane, src, crateName, extraSources ? [ ], extraSourcesDir ? ".extras", data ? [ ], dataDir ? "data", devShellHook ? "", devShellTools ? [ ], testTools ? [ ] }:
{ crane, src, crateName, rustVersion ? "latest", extraSources ? [ ], extraSourcesDir ? ".extras", data ? [ ], dataDir ? "data", devShellHook ? "", devShellTools ? [ ], testTools ? [ ] }:
let
rustWithTools = pkgs.rust-bin.stable.latest.default.override {
rustWithTools = pkgs.rust-bin.stable.${rustVersion}.default.override {
extensions = [ "rustfmt" "rust-analyzer" "clippy" "rust-src" ];
};
craneLib = crane.lib.${pkgs.system}.overrideToolchain rustWithTools;

cleanSrc = craneLib.cleanCargoSource (craneLib.path src);

# Library source code with extra dependencies attached
fullSrc =
# Library source code with extra dependencies copied
buildEnv =
pkgs.stdenv.mkDerivation
{
src = cleanSrc;
Expand All @@ -24,6 +24,9 @@ let
'';
};

# Library source code, intended to be in extra-sources (inside the `.extras` directory)
# The main difference is that dependencies are not copied, to `.extras`
# but they are referenced from the parent directory (`../`).
vendoredSrc =
pkgs.stdenv.mkDerivation
{
Expand All @@ -38,7 +41,7 @@ let
};

commonArgs = {
src = fullSrc;
src = buildEnv;
pname = crateName;
strictDeps = true;
};
Expand Down Expand Up @@ -89,6 +92,8 @@ in

packages."${crateName}-rust-src" = vendoredSrc;

packages."${crateName}-rust-build-env" = buildEnv;

checks."${crateName}-rust-test" = craneLib.cargoNextest (commonArgs // {
inherit cargoArtifacts;
nativeBuildInputs = testTools;
Expand Down
20 changes: 15 additions & 5 deletions extras/lbf-nix/lbf-rust.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ let
files
# Classes for which to generate implementations for (default lbf-prelude classes).
, classes ? [ ]
, # Dependencies to include in the Cabal's `build-depends` stanza.
, # Dependencies to include in the Cargo's `dependencies` section.
# examples: dependencies = [ "lbf-prelude" ]
dependencies ? [ ]
, configs ? [ ]
, # Name of the package and also the name of the Cabal package.
, # Name of the package and also the name of the Cargo crate.
# Examples: name = "lbf-myproject"
name
, # Version of the package and also the version of the Cabal package.
, # Version of the package and also the version of the Cargo crate.
# Examples: version = "0.1.0.0"
version ? "0.1.0"
}: { inherit src imports files classes dependencies configs name version; };
Expand Down Expand Up @@ -67,7 +67,7 @@ let

cargoTemplate = opts: with (lbfRustOpts opts);
pkgs.writeTextFile {
name = "lambda-buffers-cabal-template";
name = "lambda-buffers-cargo-template";
text = ''
[package]
name = "${name}"
Expand All @@ -78,7 +78,9 @@ let
'';
};

#
# This is a lookup table of default crate versions used by lamba-buffers modules
# Based on the contents of `build.json` a subset of these will be attached to the
# Cargo.toml file
crateVersions = pkgs.writeTextFile {
name = "lambda-buffers-crate-versions";
text = ''
Expand Down Expand Up @@ -108,6 +110,10 @@ let
DEPS=$(echo ${builtins.concatStringsSep " " dependencies} $(cat build.json | jq -r ".[]" | sort -u));
echo "Gathered Cargo deps $DEPS";
cat ${cargoTemplate opts} > Cargo.toml;
# Using the lookup table `crateVersions`, filling in the library version.
# If no version is found, we default to a local path dependency, pointing to
# a sibling directory (directory in extra-sources or .extras)
# e.g.: for `lbr-prelude` we print `lbr-prelude = { path = "../lbr-prelude" }
for DEP in $DEPS; do
if [ $DEP != "std" ]; then
echo "$(cat ${crateVersions} | grep "$DEP" || echo "$DEP = { path = \"../$DEP\" }")" >> Cargo.toml
Expand All @@ -128,6 +134,10 @@ let
chmod -R u+w $out/src
pushd $out/src

# Collecting modules of the library and attaching a module declaration
# to parent modules. Any directory in the path must also
# be considered as a module (e.g. for `foo/bar/baz.rs` we have to create
# `lib.rs`, `foo.rs`and `foo/bar.rs`)
MODS=$(find . -type f -name "*.rs")
MODS+=" "
MODS+=$(find . -type d)
Expand Down