address issues from clj-commons/formatter

[oakmac]

We should address / have an answer to the issues on the clj-commons/formatter repo:

• [x] file encoding / UTF-8 support
• [x] remove extra whitespace
• [x] re-order ns forms
• [ ] space after #_ comments
• [ ] semicolon comments treatment
• [ ] reader conditionals
• [ ] map literals
• [ ] let bindings
• [ ] indentation
• [ ] empty lines between forms
• [ ] misc project thoughts

[oakmac]

Issue

file encoding / UTF-8 support

Decision

I think we should only support UTF-8.

Reason

UTF-8 is the dominant standard for text-encoding in 2024. It is near universally adopted and is quite future-proof.

[oakmac]

Issue

remove extra whitespace

Decision

• remove all trailing whitespace on non-empty lines
• ensure one trailing empty line at the end of every file

Reason

Applying these rules will prevent unnecessary diffs between changes. These rules are easy to implement and understand. I cannot think of a meaningful reason to allow trailing whitespace in a codebase.

[oakmac]

Issue

re-order ns forms

Decision

• yes - follow the rules from "how to ns"

Reason

"how to ns" is the de-facto standard for Clojure namespaces. The rules it suggests are reasonable and explained / justified well.