Fix generated mod.rs to pass cargo fmt -- --check #622
Conversation
This file contains 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
stepancheg
requested changes
May 5, 2022
protobuf-codegen/src/gen/mod_rs.rs
Outdated
| w.write_line(""); | ||
| w.comment(&format!( | ||
| "This file is generated by {} {}. Do not edit", | ||
| env!("CARGO_PKG_NAME"), |
There was a problem hiding this comment.
Code generator is not necessarily executed by cargo. See how similar code is inserted in other files.
protobuf-codegen/src/gen/mod_rs.rs
Outdated
| env!("CARGO_PKG_NAME"), | ||
| env!("CARGO_PKG_VERSION") | ||
| )); | ||
| w.comment("@generated"); |
There was a problem hiding this comment.
That was
w.comment(&format!("{}generated", "@"));
intentionally, so the generator is not considered to be generated.
stepancheg
requested changes
May 6, 2022
protobuf-codegen/src/gen/mod_rs.rs
Outdated
| for m in mods { | ||
| w.write_line(""); |
There was a problem hiding this comment.
Now it writes a line between mods? Doesn't look right.
There was a problem hiding this comment.
The formatter won't sort mods when they are empty line delimited
There was a problem hiding this comment.
Wouldn't it be better to just sort mods?
There was a problem hiding this comment.
Sure, if u prefer
|
Thanks! |
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.
Currently, the generated
mod.rsdoes not passcargo fmt -- --check, and this becomes a problem when ppl choose to include generated files as part of source code.This PR tries to make
rustfmthappy by adding an empty line after each 'pub mod' import. It also addsThis file is generated byline to makemod.rsconsistent with other files.This closes #621