Add cargo-flux binary

[cole-k]

Edit: Usage and installation details are now in flux-docs

Testing locally

Change https://github.com/liquid-rust/flux/pull/305/files#diff-e3670cdab561aaacb93c3521ffc0db64aa666949dcfc0e5e7f0148fd595ef5afR18 to your flux binary path.

cargo install --path flux/bin

Note that this will clobber a pre-existing binary, so if you put your cargo-flux shell script there, you'll need to copy it elsewhere if you don't want it to disappear.

[ranjitjhala]

Nice! Can you update the relevant bit in the docs?

[cole-k]

Haven't updated the docs yet but you should now be able to just do

cargo install --path flux
cargo install --path flux-bin

I'd love to just be able to do cargo install, but seems that isn't possible with the way things are set up.

@nilehmann any suggestions on how we might be able to reconfigure? Should I add a [package] and containing [[bin]]s to the main Cargo.toml?

I'm also content with leaving it as-is though, it seems like a significant improvement in the install experience.

[cole-k]

We could also add a binary that generates the vscode plugin json.

{
  "rust-analyzer.checkOnSave.extraEnv": {
    "RUSTC_WRAPPER": "/path/to/flux/target/release/flux",
    "RUSTUP_TOOLCHAIN": "nightly-2022-10-11",
    "LD_LIBRARY_PATH": "/path/to/.rustup/toolchains/nightly-2022-10-11-x86_64-apple-darwin/lib"
  }
}

Although personally I feel like it would make more sense to have this be generated when you run cargo build. Not sure how to do that or where to put it, though.

With some more investment, we could also add a script that would modify the existing plugin json, but I'm not sure whether it's woth it.

[nilehmann]

I think this is good enough. You can do cargo build --release that will put all the binaries in /path/to/flux/target/release and then you can set up your vscode as

{
  "rust-analyzer.checkOnSave.overrideCommand": [
    "/path/to/flux/target/release/cargo-flux",
    "check",
    "--workspace",
    "--message-format=json"
  ]
}

[nilehmann]

This should be called something that's not macos specific.

[cole-k]

I picked the linux name (ld_library_path) since it seems the most descriptive, but I'm open to suggestions.

[cole-k]

I think this is good enough. You can do cargo build --release that will put all the binaries in /path/to/flux/target/release and then you can set up your vscode as

{
  "rust-analyzer.checkOnSave.overrideCommand": [
    "/path/to/flux/target/release/cargo-flux",
    "check",
    "--workspace",
    "--message-format=json"
  ]
}

If you ran cargo install --path flux/bin && cargo install --path flux would you be able to even write it as below?

{
  "rust-analyzer.checkOnSave.overrideCommand": [
    "cargo-flux",
    "check",
    "--workspace",
    "--message-format=json"
  ]
}

[nilehmann]

If cargo-flux is in your path and flux is in the same directory then yes you would be able to write it like that.

But what is this cargo install --lib? It doesn't work for me. I can do cargo install --path flux-bin and cargo install --path flux.

[cole-k]

If cargo-flux is in your path and flux is in the same directory then yes you would be able to write it like that.

But what is this cargo install --lib? It doesn't work for me. I can do cargo install --path flux-bin and cargo install --path flux.

Yeah sorry, I meant cargo install --path. Fixed.

[cole-k]

I've updated the readme with the new instructions. I tried to follow them myself but it would help if one of you could confirm that it works.

I also added a FLUX_PATH env variable so you can run a different version of flux if desired. I feel like there isn't really a difference between running

cargo install --lib flux

and

cargo build

but maybe if you have the muscle memory for the latter, you will find that env variable helpful.

[nilehmann]

@cole-k the code looks good. Just left you some small stylistics suggestions.

@ranjitjhala made this page https://liquid-rust.github.io/flux/. We you should add the changes to the docs there. The page can be edited here https://github.com/liquid-rust/flux/tree/main/flux-docs/src. We should also probably remove most of the text from the README and just put links to the doc

[nilehmann]

👍🏽

[cole-k]

Moved the readme's contents to flux-docs.

[nilehmann]

@cole-k I think this is ready to go as soon as you resolve the conflict