feat(build): Use RUSTFMT to find rustfmt binary#566
Merged
LucioFranco merged 1 commit intohyperium:masterfrom Mar 11, 2021
UebelAndre:env
Merged
feat(build): Use RUSTFMT to find rustfmt binary#566LucioFranco merged 1 commit intohyperium:masterfrom UebelAndre:env
RUSTFMT to find rustfmt binary#566LucioFranco merged 1 commit intohyperium:masterfrom
UebelAndre:env
Conversation
Contributor
Author
|
@LucioFranco Hey, sorry to ping but do you have a moment to take a look at this? 🙏 |
Contributor
Author
|
Hey @LucioFranco, just pining this PR one more time in hopes you have time for a quick review 😅 🙏 |
seanmonstar
reviewed
Mar 11, 2021
Member
seanmonstar
left a comment
There was a problem hiding this comment.
This looks fine in principle, is that the most common environment variable to check for rustfmt?
LucioFranco
approved these changes
Mar 11, 2021
rustfmt via a RUSTFMT environment variableRUSTFMT to find rustfmt binary
Contributor
Author
It's the same thing Cargo uses: https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-reads That was my primary goal here, was to have parity with cargo. |
This was referenced Mar 18, 2021
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The Rust Bazel rules (rules_rust) is looking to add some tools for building targets with Tonic. In development of bazelbuild/rules_rust#479 it was found that
tonic-buildcallsrustfmtand expects this to be in the user's PATH. This is generally not going to be the case when Building in Bazel. We're looking for a way to specify this binary without needing to rely on or modify PATH.Solution
Cargo already has a pattern for specifying environment variables to control what binaries are used during builds. The change here adopts the same functionality as Cargo and allows for an environment variable (
RUSTFMT) to optionally specify the location of therustfmtbinary.