z-mitchell.bsky.social / ff
A swiss army knife for developing Flox
fork atom
Rust 27.7%
Other 72.3%
35 1 0

Clone this repository

https://tangled.org/z-mitchell.bsky.social/ff
git@tangled.org:z-mitchell.bsky.social/ff

For self-hosted knots, clone URLs may differ based on your setup.

Download tar.gz
README.md

ff#

This is a tool I wrote for working on flox.

Usage#

Usage: ff <COMMAND>

Commands:
  build  Build artifacts [aliases: b]
  test   Run (parts of) the test suite [aliases: t]
  clean  Remove build artifacts [aliases: c]
  bin    Prints the path to the flox binary
  help   Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

The ff build command takes shorthands for various components and will build any necessary dependencies e.g. ff b scripts will rebuild flox-activations as well:

pub fn build(args: &BuildArgs) -> Result<()> {
    match args.artifact.as_str() {
        "all" => build_all(args.nix),
        "scripts" => ActivationScripts.build(args.nix),
        "activations" | "act" => FloxActivations.build(args.nix),
        "flox" | "cli" => Flox.build(args.nix),
        "plugins" | "nix-plugins" => NixPlugin.build(args.nix),
        "buildenv" => Buildenv.build(args.nix),
        "package-builder" => PackageBuilder.build(args.nix),
        "watchdog" => Watchdog.build(args.nix),
        "nix" => build_nix_components(),
        _ => anyhow::bail!("unknown artifact: {}", args.artifact),
    }
}

The ff bin command prints out the absolute path to the flox binary in the current repo, which is useful when you want to call it from outside of the devshell or in another terminal tab.

The ff test command by default runs the unit tests and then the integration tests. By default tests are run without rebuilding anything in order to keep the feedback cycle short.

You can specify running only unit tests or only integration tests via the ff t -u or ff t -i flags. For the integration tests you can pass arguments to bats as long as those arguments don't look like arguments to ff (this is slightly broken), so ff t -i activate.bats works, but ff t -i --test-tags foo doesn't. You can also specify that you want the integration tests run with a Nix-built flox binary instead of the development build via the ff t -i -n flag. You can specify that you want a particular component built before running the tests via the ff t -b <component> flag. For instance, in order to rebuild the activation scripts before running integration tests, you would run ff t -i -b scripts.

License#

Licensed under either of

at your option.

Contribution#

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.