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.

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

Auto-format all files #142

Merged
merged 3 commits into from
Dec 12, 2023
Merged

Auto-format all files #142

merged 3 commits into from
Dec 12, 2023

Conversation

aabounegm
Copy link
Member

This PR runs the new auto-formatter for Rzk that implements the style guide. It is currently still under work in rzk-lang/rzk#144, so before it is merged and released, I'd like to make sure that it works as expected, so I ran it on all files in this project (using rzk format --write). This should help find implementation mistakes in the formatter and/or inconsistencies in the style guide (the hopeful best-case scenario would be that it aligns all formalizations with the current style guide 🙂).

Please review these changes and point out any problems or possible improvements.

@fredrik-bakke
Copy link
Contributor

Awesome! I will take the time to review this later this week.

@aabounegm aabounegm marked this pull request as ready for review December 5, 2023 14:50
Copy link
Contributor

@fredrik-bakke fredrik-bakke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I've reviewed about half the files now and pointed out different issues I saw. Although the autoformatter isn't perfect yet, I think it is a great improvement over no autoformatter, and so would be happy to have it deployed even in its current revision. Thanks for taking the initiative on this! And let me know if/when you want further input :)

@aabounegm
Copy link
Member Author

@fredrik-bakke Thank you very much for the constructive feedback! I hope that most of the issues have been addressed now. It seems to me that the remaining unresolved conversations are about either inserting line breaks or fixing indentation, both of which are planned for the future as they are not straightforward to implement with the current architecture (opened issues rzk-lang/rzk#147 and rzk-lang/rzk#148).
I do not have any other changes planned for this PR, so if you think it is ready to be merged then please approve it so I can merge 😁

Copy link
Contributor

@fredrik-bakke fredrik-bakke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent! Looks good to me :) Thanks again for doing this.

@aabounegm aabounegm merged commit 296a11b into main Dec 12, 2023
2 checks passed
@aabounegm aabounegm deleted the formatting branch December 12, 2023 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants