All Lisp indentation schemes are ugly
104 comments
·January 19, 2025lihaoyi
davvid
> This post misses the IMO best indentation scheme for lisp [...]
Likewise, a lispier(?) and more compact compromise?:
(define (match:element variable restrictions)
(define (ok? datum)
(every
(lambda (restriction)
(restriction datum))
restrictions))
(define (element-match data dictionary succeed)
(and
(ok? data)
(let ((vcell (match:lookup variable dictionary)))
(if vcell
(and
(equal? (match:value vcell) data)
(succeed dictionary))
(succeed (match:bind variable data dictionary))))))
element-match)
nine_k
It becomes much harder to notice if you have closed all the right matching parens, and hence where a token after the closing paren belongs. When the closing paren is exactly below the opening paren, on the same column, it becomes much easier to see the structure. It's a very good thing for students who just learn Lisp.
ludston
But all the cool kids are using paredit or parinfer which means you don't actually ever write the closing parens yourself.
Counting parens is silly when the editor can do it for you.
donio
For Lisp users this is 35% extra vertical space for zero readability benefit. Or negative readability rather. When I see this formatting style I have to fix it before I can read it. It's like trying to read C code with an extra blank line after every single closing brace.
nine_k
Lisp users are a diverse crowd. I won't be so bold as to sign off for all of them.
pasc1878
The main reason to use it is not for reading it is to work with version control which is all line orientated.
The reading is not that bad as the indentation tells you where the brackets are and you don't really notice them.
null
n8henrie
As a hobbyist that keeps trying to break into lisp, I think the absence of an obviously good formatter for lisps has made things much harder.
This looks like how I've naively tried to format things, and having started with python kind of makes sense.
But trying to read / edit code with 5 parentheses bunched together, I have the hardest time telling if they are matched or where. Thank goodness for vim / helix auto-matching.
skydhash
The way to have a good time with lisp is using Emacs and Slime/Sly. And if you like shortcuts, you can try Paredit for structural editing.
I just use the Tab key for indenting and it always work for me (there's a logic on where to break line to get correct indenting, and it makes it easy to see if you misplaced a parenthesis. Also, both Emacs and Vim, highlight the matched parenthesis, so I never wonder about if I have the correct number of closing parenthesis.
JBiserkov
You can also try "rainbow parens" color scheme that makes nesting much easier to see.
kazinator
You are looking at the wrong thing. Nobody looks at bunched parentheses for any reason, unless they are investigating a suspicion that the code's indentation is wrong. In that situation, all that matters is whether the bunch contains the correct number of parentheses, not which specific closers match which specific openers.
(foo
(bar
(baz (xyzzy arg))
(bar arg))
We know from the indentation that this is supposed to be a closed unit: (bar
(baz (xyzzy arg))
But it needs three closing parens ))) not just )).If this problem is not accidentally compensated by a ) in the wrong place elsewhere, this code will error out.
One simple thing you can do is just automatically reindent the whole block. The indentation will then match the incorrect parentheses and the problem will be clear. Undo the temporary reformatting and fix it.
n8henrie
> One simple thing you can do is just automatically reindent the whole block.
This is exactly the point of my comment -- the absence of an obvious / reasonable automatic formatter is the problem I'm pointing to.
rayiner
That is blasphemy.
simplify
You may not like it, but this is what peak lisp indentation looks like :)
Honestly though, this style for ending parenthesis of block-type nodes makes a lot of sense to me. And you still retain the benefit of macro-ing your own syntax when you need it.
shawn_w
The uncuddled closing parens are a sure sign of a sick mind; probably corrupted by C or the like.
andriamanitra
They make line-by-line diffs nicer. And it's quite nice to be able to swap/move lines without messing up the closing paren, especially when not using a structural editor.
varjag
To be fair in C they don't put semicolon on its own line either.
null
DonHopkins
Nicely indented easy to read blasphemy is the most dangerous kind!
JBiserkov
One thing I dislike about the compact style is how adding/removing a let block causes a diff line that is just adding/removing a parent.
kazinator
Do you really think it's just a matter of style whether or not you must add or remove a parenthesis? Or whether that change shows up in a diff?
nine_k
A blasphemy is a very useful thing in cases when a discipline turns into a religion. (Yes, I know about jokes.)
acheron
Exactly what I was thinking.
aartaka
That is
Avshalom
More of an allman Lisp guy myself
(
define (match:element variable restrictions)
(
define (ok? datum)
(
every
(
lambda (restriction)
(restriction datum)
)
restrictions
)
)
(
define (element-match data dictionary succeed)
(
and
(ok? data)
(
let ((vcell (match:lookup variable dictionary)))
(
if vcell
(
and
(equal? (match:value vcell) data)
(succeed dictionary)
)
(succeed (match:bind variable data dictionary))
)
)
)
)
element-match
)
maiar
I’ve been in too many arguments about Lisp indentation but that actually comes close to decent with a couple of changes: move the singleton closing parens up, and reduce to, say, 2 spaces.
EFreethought
I am sure there are some Emacs modes or plugins for other editors that could go back and forth between this and the more commonly-seen style.
fn-mote
I love a Lisp-themed article, but this is such a yawn in 2025.
It seems pretty clear that a threading macro which allows the user to place the "hole" being filled wherever they want is the answer.
Example: cl-arrows
kleiba
(tree-transform-if predicate
transformer
(second tree)
depth)
> A problematic function indentation> Nineteen! Nineteen spaces of indentation! It's getting unruly.
Why, is there a shortage of whitespace these days??
> Such an indent, when used in deeply nested code, makes it too wide and unreadable.
Ah, I see! Well, I would argue the problem is not the indentation style. What makes your code unreadable is that it's too deply nested, and I would bet that no indentation style can help with that.
aartaka
That's a point too!
RedNifre
Are there any formatters that detect related things and put them in the same column? Here's a Pie example:
(claim Tuple3 (-> U U U U))
(define Tuple3 (lambda ( a b c )
(Pair a (Pair b c) )))
(claim tuple3Of (Pi ( (A U) (B U) (C U))
(-> A B C
(Tuple3 A B C ))))
(define tuple3Of (lambda ( A B C )
(lambda ( a b c )
(the (Tuple3 A B C )
(cons a (cons b c)) ))))
(claim Tuple5 (-> U U U U U U))
(define Tuple5 (lambda ( a b c d e )
(Pair a (Pair b (Pair c (Pair d e))))))
(claim tuple5Of (Pi ((A U) (B U) (C U) (D U) (E U))
(-> A B C D E
(Tuple5 A B C D E ))))
(define tuple5Of (lambda ( A B C D E )
(lambda ( a b c d e )
(the (Tuple5 A B C D E )
(cons a (cons b (cons c (cons d e))))))))
phoe-krk
> Common Lisp in particular is extremely unfriendly to threading macros. Arrows imply a consistent thread-first or thread-last functions. But CL's standard lib is too inconsistent for that to work. So we're left with picking an indentation style we don't necessarily like.
Diamond arrows exist, you know.
(-<> foo
bar
(baz)
(quux 1 2 3)
(fred 4 5 6 <>)
(frob 7 <> 8 <> 9))
All in all, this post reads like a rant, and I realized that upon reading "now what I'm about to suggest is likely not to your taste". That style of indentation is something I use often when writing calls to long-named functions like COMPUTE-APPLICABLE-METHODS and I haven't ever thought of it being not to my taste, or even of it being ugly as the author suggests.aartaka
Well, it's all based on my experience. In two Lisp companies I worked in, colleagues complained or even were trying to fix how I indent things. So it's not just some anxiety whatever, it's experience that needs explanation and justification.
I'm aware of arrow-macros/diamond wands, and am using them myself. But I often have to write dependency-less libraries for moderately complicated algos, and that's where indentation style is the only thing I can rely on.
behnamoh
> (tree-transform-if predicate
> transformer
> (second tree)
> depth)
> A problematic function indentation
> Nineteen! Nineteen spaces of indentation! It's getting unruly. Such an indent, when used in deeply nested code, makes it too wide and unreadable. If you add the strict one-per-line alignment of arguments, it's also painfully long line-wise.I think this is more a problem with languages that encourage (or don't discourage) deeply nested function calls. I face the same issue in Python, although Python kinda discourages me to do:
foo(
bar(
baz(
far(
faz(...)))))
Instead, Python and Pythonic idioms encourage a "step by step" approach: a = faz(...)
b = far(a)
...
I don't know which is "better"—the first approach requires thinking ahead about the chain of functions we're about to call while the second one is more like a gradual development of the solution, albeit being more verbose than the former.UltraSane
The second Python method that uses intermediary variable is what I use because it works much better with a debugger
I also like this trick to avoid nested for loops:
import itertools
names = ['Bob', 'Sam']
nums = [1,2]
letters = ['A','B']
for name,num,letter in itertools.product(names,nums,letters):
print(f"{name} {num} {letter}")
Bob 1 A
Bob 1 B
Bob 2 A
Bob 2 B
Sam 1 A
Sam 1 B
Sam 2 A
Sam 2 B
phoe-krk
You can have the same step-by-step in Lisp via LET*. The problem outlined by the author happens when you have a function call where 1) the operator has a long name, 2) there are many arguments. The TREE-TRANSFORM-IF is such a case and you can't solve it by just "going step by step".
behnamoh
Yes, I think for whatever reason, Lisp languages tend to use long names for funcs and vars whereas Haskell and other FP languages prefer symbols like >>=, <$>, etc. Personally, I prefer somewhere in the middle.
> The TREE-TRANSFORM-IF is such a case and you can't solve it by just "going step by step".
Yes, this is a good point.
Pxtl
That deep nest of function calls is why I love languages that have bash-style pipelining as a built in feature, either with explicit shell piping features, or where everything Function(myObj) is also implicitly myObj.Method()
Then it becomes (eg PowerShell, a language I hate but use constantly)
Faz |
Far |
Baz |
Bar |
Foo
Or (more C++/Java/C#-ish) Faz()
.Far()
.Baz()
.Bar()
.Foo()
In this way the data and execution flows forwards instead of backwards and you don't have a pyramid of indentation.I don't know why we're so stuck on prefix notation for function calls. Postfix is just easier to read in long chains.
sitkack
In Python you have the wonderful https://github.com/pytoolz/toolz
from toolz import pipe
pipe('hello',lambda w: ( "foo", w ), lambda y: [ 0, y, 1 ])
[0, ('foo', 'hello'), 1]
You can used named functions, but they would need to be define above in upper scope def h(x):
return ( "foo", x )
def g(x):
return [ 0, x, 1]
pipe('hello', h, g)
behnamoh
thanks, I'll check this out. I've seen similar libs before, like "pipes" which also does piping through the "|" symbol.
aartaka
This is a good style indeed, and I'm using it a lot in JavaScript, but you have to admit that it's never as consistent as that—there are basic functions mixed into it, and some lambdas, and whatever.
martin-t
I prefer a third approach - chaining method calls via `.method()`. C#'s LINQ extension methods and Rust's iterator methods do it and I find it to be the best of both worlds most of the time.
behnamoh
So the "fluent design" approach? I like that too, and many OO languages allow for that, but I haven't seen that approach in functional programming.
3836293648
Really?
Iterator methods are the only part of Rust/C# that feel like normal decent function composition. Except Haskell is backwards.
kazinator
It's clear that the blogger is a wide-eyed newbie, who is enamored of Lisp and trying to attract any kind of attention and clicks to it. Obviously, it worked; he got on the front page of HN.
I predict that in another five years, he will write an article disparaging Lisp and purge it from his CV, and that will be that.
aartaka
I literally program in Lisp for five years now, and I ain't going anywhere.
kazinator
I just skipped to the bottom of this crap to find the real gem: it's produced with the help of ed.
Yeah, someone working with ed its not going to like 19 repeated leading spaces across lines for vertical alignment. They will like that less than even somebody working with Notepad.
juped
...the author is using ed scripts as a static site generator, in a way completely unrelated to the post content. People are allowed to do oddball things.
lgrapenthin
> Once you get used to Lisp, you stop noticing the parentheses and rely on indentation instead.
Who does that? LISP has a datastructured syntax, textformat has no meaning in it.
aartaka
Humans read code. I'd like to become a machine someday, but alas, I still am human and I need to read mine/others' code. Lisp code too.
agumonkey
never had any real issue using emacs indentation engine (not even sure lisp modes use smie..)
wegfawefgawefg
idk i always just put a newline before every single open parens and that worked for me
swayvil
Surely one could do it with different background colors instead. Any examples of that?
el_memorioso
For matching parentheses, Emacs users can use a package called rainbow-delimiters that colors matching delimiters. Different levels of enclosure use different colors. I've found this to be too much visual noise -- I am usually just interested on the delimiters for the current s-expressions. In this vein, having multiple different colored backgrounds would be garish and distracting for me.
tmtvl
I have seen it done with foreground colours: https://github.com/alphapapa/prism.el
I think I once saw a project turning Scheme into a visual block-based representation, but I can't find it again.
This post misses the IMO best indentation scheme for lisp, which I used for my college class where we had to use MIT scheme:
It may not be densest or most compact indentation scheme, but damn is it readable for someone without a lisp/scheme background!