-
-
Notifications
You must be signed in to change notification settings - Fork 235
style: update formatting rules #1184
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.
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
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1184 +/- ##
==========================================
- Coverage 43.00% 41.34% -1.66%
==========================================
Files 22 22
Lines 2056 1921 -135
==========================================
- Hits 884 794 -90
+ Misses 1172 1127 -45
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
hard_tabs = true | ||
tab_spaces = 4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the main change. Everything else is automatic formatting.
I was thinking of creating a patch release for these formatting changes after I'm done with the current reviews. Otherwise it might be a bit annoying to rebase this on other PRs. I always forget to do this though... |
Fixing PRs should fairly simple: git checkout main -- rustfmt.toml
cargo +nightly fmt
git commit -am 'formatting
git push If you're squashing merges then this shouldn't really be too much of a problem |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To actually apply this, I'd suggest grabbing rustfmt.toml, discarding everything else and rerunning cargo +nightly fmt
git reset --hard main
git reset fdf857422158338c9ec461270b1aabd31a375049 rustfmt.toml
cargo +nightly fmt
git commit -aC fdf857422158338c9ec461270b1aabd31a375049
git push
git reset 541aa64f4e60738b0ff24895b358c3f05a4b841e .git-blame-ignore-revs
# edit the file with the correct hash
yes pls do itt |
Use spaces instead of tabs for indentation, wrap at 100 characters, and remove the setting that aligns struct fields vertically as this generally harms readability. These changes make the code more consistent with the Rust community's conventions and improve readability by not truncating lines too early.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed the rev ignore file - do this in a followup PR
channel = "nightly" | ||
channel = "stable" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that this was only required to make rustfmt use nightly. Nothing in git-cliff seems to require the nightly compiler to work afaik (I may be wrong there)
chore: update formatting rules
Use spaces instead of tabs for indentation, wrap at 100 characters, and
remove the setting that aligns struct fields vertically as this
generally harms readability.
These changes make the code more consistent with the Rust community's
conventions and improve readability by not truncating lines too early.
Justification:
https://www.youtube.com/watch\?v\=V7PLxL8jIl8
This brings things more in line with pretty much every rust project out there. Hard tabs are used in around 0.1% of rust projects:
hard_tabs = true
: https://github.com/search?q=path%3A%22rustfmt.toml%22+%22hard_tabs+%3D+true%22+AND+%28NOT+is%3Afork%29&type=code (1.9k results)