Skip to content
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

Jump to bottom

Add a rustfmt.toml file to the repository #2934

Closed
silwol opened this issue Jun 6, 2022 · 0 comments · Fixed by #2982
Closed

Add a rustfmt.toml file to the repository #2934

silwol opened this issue Jun 6, 2022 · 0 comments · Fixed by #2982
Assignees
@silwol
Labels
🎉 enhancement New feature! priority-low Low priority issue

Comments

@silwol
Copy link
Contributor

silwol commented Jun 6, 2022 •
edited
Loading

Motivation

Contributing to many different Rust projects, of which some use rustfmt and some don't. Therefore I configured my editor to only execute cargo fmt when it finds a .rustfmt.toml or a rustfmt.toml file in the workspace or the project, otherwise it would increase size of simple diffs, making it difficult to spot the actual code change.

Proposed solution

I propose to add either a .rustfmt.toml or a rustfmt.toml file (no hard feelings which of these would be better), even if it is empty in the beginning, in order to indicate to developers that the project uses rustfmt and allow automatic formatting by editors which depend on its presence.
@silwol silwol added the 🎉 enhancement New feature! label Jun 6, 2022
@epilys epilys added the priority-low Low priority issue label Jun 21, 2022
silwol added a commit that referenced this issue Jun 28, 2022
@silwol
Add a rustfmt.toml file to the repository
983c002 
Closes: #2934
@silwol silwol mentioned this issue Jun 28, 2022
Merged
1 task
silwol added a commit that referenced this issue Jun 28, 2022
@silwol
Add a rustfmt.toml file to the repository
0eb9154 
Closes: #2934
bors bot added a commit that referenced this issue Jun 28, 2022
@bors @silwol
Merge #2982
a2d1c9e 
2982: Add a `rustfmt.toml` file to the repository r=epilys a=silwol

Closes: #2934

<!-- 
Prior to submitting a PR, review the CONTRIBUTING.md document for recommendations on how to test:
https://github.com/wasmerio/wasmer/blob/master/CONTRIBUTING.md#pull-requests

-->

# Description
Add a `rustfmt.toml` file to the repository, indicating to developers and tools that we use `rustfmt`. For now, it just contains a comment explaining what the file is for, and that the comment itself can be removed in case real settings are added.

# Review

- [ ] Add a short description of the change to the CHANGELOG.md file


Co-authored-by: Wolfgang Silbermayr <[email protected]>
@bors bors bot closed this as completed in 46d7417 Jun 28, 2022
epilys pushed a commit that referenced this issue Jul 20, 2022
@silwol @epilys
Add a rustfmt.toml file to the repository
530a961 
Closes: #2934
ptitSeb pushed a commit that referenced this issue Oct 20, 2022
@silwol @ptitSeb
Add a rustfmt.toml file to the repository
efd8bc5 
Closes: #2934
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@silwol silwol

Labels
🎉 enhancement New feature! priority-low Low priority issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add a rustfmt.toml file to the repository wasmerio/wasmer
2 participants
@silwol @epilys