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

forc-fmt associated_const_trait_default results in panic #5008

Closed
sdankel opened this issue Aug 23, 2023 · 1 comment · Fixed by #5009
Closed

forc-fmt associated_const_trait_default results in panic #5008

sdankel opened this issue Aug 23, 2023 · 1 comment · Fixed by #5009
Assignees
@sdankel
Labels
bug Something isn't working formatter

Comments

@sdankel
Copy link
Member

sdankel commented Aug 23, 2023 •
edited
Loading 

forc fmt ./test/src/e2e_vm_tests/test_programs/should_pass/language/associated_const_trait_default/src/main.sw 

thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: ParseFileError([Parse { error: ParseError { span: Span { src (ptr): 0x7fb023f0bde0, source_id: None, start: 41, end: 42, as_str(): ";" }, kind: ExpectedAnItem } }])', swayfmt/src/comments.rs:160:10
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

This file builds, so the formatter should definitely be able to format it.
@sdankel sdankel added bug Something isn't working formatter labels Aug 23, 2023
@sdankel sdankel self-assigned this Aug 23, 2023
@sdankel
Copy link
Member Author

sdankel commented Aug 23, 2023

Related #5006

@sdankel sdankel mentioned this issue Aug 23, 2023
Merged
7 tasks
sdankel added a commit that referenced this issue Aug 24, 2023
@sdankel
Fix fmt panic for const inside trait (#5009)
a7da1f2 
## Description

Closes #5008

The panic happened because the formatter was adding two `;`s after a
constant declaration inside of a trait.

I'm working toward the goal of making it so the formatter never panics,
even for sway files that do not compile.

I made it so, when a sway file does not compile, it does not cause the
formatter to panic. Now it prints an error message and returns that it
did not format anything with exit code 0.

I'm checking in this simple bash script that runs the formatter against
every sway project in the repo. Fixing this bug brought the # of panics
from ~35 down to 23.

I verified that the CI step that checks the formatting of sway docs is
still working.

## Checklist

- [x] I have linked to any relevant issues.
- [ ] I have commented my code, particularly in hard-to-understand
areas.
- [ ] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [ ] I have added tests that prove my fix is effective or that my
feature works.
- [ ] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [ ] I have requested a review from the relevant team or maintainers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sdankel sdankel

Labels
bug Something isn't working formatter
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix fmt panic for const inside trait and abi FuelLabs/sway
1 participant
@sdankel