Skip to content

Introduce purs-tidy formatter #85

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

Merged
merged 3 commits into from
Nov 19, 2021
Merged

Introduce purs-tidy formatter #85

merged 3 commits into from
Nov 19, 2021

Conversation

thomashoneyman
Copy link
Contributor

Description of the change
Introduces the purs-tidy formatter. 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 core or contrib projects. 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:

  • Added the change to the changelog's "Unreleased" section with a link to this PR and your username
  • Linked any existing issues or proposals that this pull request should close
  • Updated or added relevant documentation in the README and/or documentation directory
  • Added a test for the contribution (if applicable)

Copy link
Contributor

@JordanMartinez JordanMartinez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM other than the comments.

| KeyNotFound String
-- custom fail
-- custom fail
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like these are meant to be doc comments before they were supported at the constructor level. Should we add them here while we're at it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO we should remove these comments altogether, because the constructors themselves appear to tell you as much as the comments do (like expected end as a comment for the ExpectedEnd constructor)

pathParts str =
let
parts = L.fromFoldable $ map (Path <<< decoder) (S.split (S.Pattern "/") str)
in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do let here?

@thomashoneyman thomashoneyman merged commit 6f90298 into main Nov 19, 2021
@thomashoneyman thomashoneyman deleted the trh/purs-tidy branch November 19, 2021 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants