Pretty-printing and auto-formatting Scheme code
Lassi Kortela 14 Feb 2020 13:34 UTC
> It's basically the pretty printer that hasn't been implemented yet.
How complex is the behavior of the pretty-printer?
It would be nice to have a SRFI that specifies a standard coding style
for Scheme. It could have quite rigid rules about indentation and line
breaking, specified so that an auto-formatter can enforce them without
human effort. Lots of people in the Go community love their "gofmt"
tool, which formats everything to the same rigid standard and has no
configuration options. That saves time for other debates :)
Scheme (and Lisp generally) are blessed in the coding style department
because people already agree about indenting with 2 spaces, where to put
the parentheses, etc. It would be quite a simple effort to write an
auto-formatter that applies the rules most people are already using anyway.
It would need a few special cases for things like indenting `define`,
`call-with-input-string`, R6RS `library` and R7RS `define-library`, etc.
There are not many of those exceptions and they are quite simple to
handle. For much of the other stuff we could simply copy the current
behavior of Emacs scheme-mode and add some heuristic line breaking to
avoid long lines.
If your pretty-printer is sophisticated, it could serve as a good
foundation for implementing such a formatter.
There are also projects to implement an auto-formatter using the Chez
Scheme pretty-printer: <https://github.com/iZarif/scmfmt>
And another more from-the-ground-up thing, which I inherited and am
ashamed to be procrastinating on:
<https://github.com/lispunion/code-formatter>
Papers about pretty-printing have been written for decades, so automatic
line-breaking should be a tractable problem. The guy who wrote the Dart
auto-formatter (dartfmt) says it was very hard to do well:
<http://journal.stuffwithstuff.com/2015/09/08/the-hardest-program-ive-ever-written/>.