Skip to content
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

Apply stylish-haskell to project #69

Merged
merged 3 commits into from
Jul 11, 2023

Conversation

newhoggy
Copy link
Contributor

Changelog

- description: |
    Apply `stylish-haskell` to project
  compatibility: no-api-changes
  type: maintenance

Context

PRs tend to be a lot bigger than they need to be becausestylish-haskell rules as to fix imports and the code is full of imports that haven't been fixed yet.

We only use stylish-haskell to format imports. It's probably better to get all the pain out of the way by applying the stylish-haskell rules across the entire project so that future PRs can be smaller.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • roundtrip tests
    • integration tests
      See Runnings tests for more details
  • Any changes are noted in the CHANGELOG.md for affected package
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • Self-reviewed the diff

Note on CI

If your PR is from a fork, the necessary CI jobs won't trigger automatically for security reasons.
You will need to get someone with write privileges. Please contact IOG node developers to do this
for you.

@newhoggy newhoggy marked this pull request as ready for review July 10, 2023 12:53
@newhoggy newhoggy force-pushed the nehwoggy/apply-stylish-haskell-to-project branch from 0b0c704 to 862e299 Compare July 10, 2023 13:17
Copy link
Contributor

@carbolymer carbolymer left a comment

Choose a reason for hiding this comment

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

Thanks for that! I think you can make this job in the stylish workflow mandatory now: https://github.com/input-output-hk/cardano-cli/actions/runs/5508573193/workflow?pr=69#L51 (can be a part of this pr)
EDIT: or not, there seem to be some issues with CPP extension: haskell/stylish-haskell#178


import Control.Monad.Trans.Except.Exit (orDie)
Copy link
Contributor

Choose a reason for hiding this comment

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

Doesn't this break the #ifdef statement?

Copy link
Contributor

Choose a reason for hiding this comment

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

Good catch! Seems like a known issue with stylish haskell 😞 haskell/stylish-haskell#178

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. We can work around this with a proxy module.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Files that contain CPP will be skipped in the stylish-haskell check.

@newhoggy newhoggy force-pushed the nehwoggy/apply-stylish-haskell-to-project branch 4 times, most recently from fe05c4d to 5a93d23 Compare July 10, 2023 15:42
@newhoggy newhoggy requested review from a team as code owners July 11, 2023 11:46
@newhoggy newhoggy force-pushed the nehwoggy/apply-stylish-haskell-to-project branch 3 times, most recently from 1723170 to d355511 Compare July 11, 2023 14:28
@newhoggy newhoggy force-pushed the nehwoggy/apply-stylish-haskell-to-project branch from d355511 to e6a8612 Compare July 11, 2023 14:46
@newhoggy newhoggy added this pull request to the merge queue Jul 11, 2023
Merged via the queue into main with commit f6aae05 Jul 11, 2023
14 checks passed
@newhoggy newhoggy deleted the nehwoggy/apply-stylish-haskell-to-project branch July 11, 2023 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants