-
Notifications
You must be signed in to change notification settings - Fork 15
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
quint: Apply a standard formatting for .qnt
files
#582
Comments
I am tagging @bugarela here, in the hope that she can help us there. |
Issue on the Quint repo: informalsystems/quint#1419 Yesterday I explored doing something using Topiary which simplifies implementation since we can use the tree-sitter grammar to handle the hard part and then just tell it how formatting should look like. However, I wrote our tree-sitter grammar in a pi-week last year and it's not 100% complete, so I need to finish it and define formatting rules for everything. I'll aim to do this slowly (a few hours/week) and see where we can get by the end of the year. |
.qnt
files.qnt
files
While the Quint side of the solution is not implemented, we could establish a standard and I can apply it to all source code. @josef-widder, do you mind writing a list of standards to be applied? I can perform the boring work afterwards. |
Not sure I even know what I would have to specify for this list. I guess the two spaces and consistent documentation with "///" of functions (mentioned in the beginning of this issue) would be good to have. I guess @bugarela also doesn't like (and I agree with her)
Then there is the question of camel case vs. underscore. I think in Malachite we use camel case quite consistently, so I would stick to it, although @bugarela most likely would prefer we move away from that. |
At the moment, apparently we have the following standards:
///
are interpreted as documentation for the functionMost of the Quint files in the repository don't follow this standard.
And, unfortunately, we do not have a kind of
quint fmt
command to standardize formatting.The text was updated successfully, but these errors were encountered: