Introduce purs-tidy formatter #126
Conversation
src/Text/Parsing/Parser/Token.purs
Outdated
| @@ -77,52 +76,66 @@ type LanguageDef = GenLanguageDef String Identity | |||
| -- | features of the "Text.Parsec.Token" module. The module `Text.Parsec.Language` | |||
| -- | contains some default definitions. | |||
| newtype GenLanguageDef s m | |||
| = LanguageDef { | |||
| = LanguageDef | |||
There was a problem hiding this comment.
@natefaubion This one is a bit weird; ideally, the commas would be lined up with the values in the record themselves, though I understand that the original formatting with trailing commas is the cause of the issue.
There was a problem hiding this comment.
The formatter doesn’t relocate comments to other tokens. In fact, it tried to preserve it as much as possible. That’s why it keeps the newline after the comma, so that the comment is preserved as a leading comment on that token, and not relocated to a trailing comment on the comma.
|
|
||
| -- | Describes the end of a block comment. Use the empty string if the | ||
| -- | language doesn't support block comments. For example `*/`. | ||
| , commentEnd :: String |
There was a problem hiding this comment.
@natefaubion It'd be nice if the comments could align with the identifier, not the comma -- thoughts?
There was a problem hiding this comment.
Comments align to the token they are attached to.
There was a problem hiding this comment.
Due to the comma, will these constructors have documentation once docs are pushed to Pursuit?
Description of the change
Introduces the
purs-tidyformatter. This formatter is a lightly opinionated tool we use to maintain a consistent style in the contrib libraries.We ordinarily restrict to tools provided by the
coreorcontribprojects. This tool is not, but it was developed and is maintained by core team members, and because it's a formatter it can't block maintenance or release of this library even in the event something goes catastrophically wrong with it.Checklist: