Skip to content

Commit a7cac06

Browse files
committed
Bootstrap rustfmt project description
1 parent a3de931 commit a7cac06

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

posts/2024-11-01-gsoc-2024-results.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,14 @@ The vast majority of `run-make` tests [now use the Rust-based test infrastructur
120120
- Mentor: [Yacin Tmimi](https://github.com/ytmimi)
121121
- [Final report](https://ding-young.github.io/posts/gsoc-final/)
122122

123+
[rustfmt] is a Rust code formatter that is widely used across the Rust ecosystem thanks to its direct integration within Cargo. Usually, you just run `cargo fmt` and you can immediately enjoy a properly formatted Rust project. However, there are edge cases in which `rustfmt` can fail to format your code. That is not such an issue on its own, but it becomes more problematic when it fails *silently*, without giving the user any context about what went wrong. This is what sometimes happens in `rustfmt`, due to technical debt that made it difficult to add proper error reporting in all situations.
124+
125+
The goal of SeoYoung's project was to perform a large internal refactoring of `rustfmt` that would allow tracking context about what went wrong during reformatting. In turn, this would enable turning silent failures into proper error messages that could help users examine and debug what went wrong. It could even allow `rustfmt` to retry formatting in more situations.
126+
123127
TODO
124128

129+
[rustfmt]: https://github.com/rust-lang/rustfmt
130+
125131
### Rust to .NET compiler - add support for compiling & running cargo tests
126132

127133
- Contributor: [Fractal Fir](https://github.com/FractalFir)

0 commit comments

Comments
 (0)