-
Notifications
You must be signed in to change notification settings - Fork 2k
feat(fmt): rewrite formatter using Solar and a structured algorithm #10350
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
Draft
DaniPopes
wants to merge
58
commits into
master
Choose a base branch
from
dani/fmt-solar
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or 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
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.
Rewrite forge-fmt entirely to use Solar as the Solidity/Yul parser and AST, and using a structured pretty-printing algorithm.
The language-agnostic implementation of the pretty-printer (
src/pp
) is based onrustc_ast_pretty
andprettyplease
, both MIT and Apache licensed. Seeprettyplease
's README for algorithm notes.The goal of this PR is to make progress with #9317, and fixing existing issues with the formatter while trying to maintain compatibility as much as possible.
This PR will not be replacing the formatter yet, opting to create a separate crate
crates/fmt-2
to reduce unrelated changes and aid with review. A follow-up PR will replacecrates/fmt
and deal with fallout in-tree.WIP
Progress
Tests:
Implementation:
Other:
Configs:
line_length: usize
tab_width: usize
bracket_spacing: bool
int_types: IntTypes
multiline_func_header: MultilineFuncHeaderStyle
quote_style: QuoteStyle
number_underscore: NumberUnderscore
hex_underscore: HexUnderscore
single_line_statement_blocks: SingleLineBlockStyle
override_spacing: bool
wrap_comments: bool
ignore: Vec<String>
contract_new_lines: bool
sort_imports: bool
Issues
Issues that will be fixed with the new implementation. Not closed by this PR, but by the follow-up that will hook the new implementation up; see paragraph above.
line_length
to be a hard requirement #4450forge fmt
): sorting of imports adds newlines in groups #7944forge fmt
): ignoresforgefmt: disable-next-line
in argument lists #8557transient
keyword by moving to Solar #9088