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

Move legacy errors out of legacy command structure modules #192

Merged
merged 17 commits into from
Aug 21, 2023

Conversation

newhoggy
Copy link
Contributor

@newhoggy newhoggy commented Aug 20, 2023

Changelog

- description: |
    Move legacy errors out of legacy command structure modules
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

Having error types defined in command structure modules makes it difficult to move command structure code and prevents re-use. See earlier merged PR for explanation.

#188

Having the error types defined outside of the command structure is a pre-requisite to sharing code between era-based and legacy command structure code.

For example one of the things I want do to do is move runTxBuildCmd into era-based and then create a runLegacyTxBuildCmd function that delegates to it, but to do that both functions should return the same error type so the error types have to be in a location that is sharable and does not obstruct this kind of refactoring.

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
    • round trip tests
    • integration tests
      See Running tests for more details
  • 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
  • The changelog section in the PR is updated to describe the change
  • Self-reviewed the diff

@newhoggy newhoggy marked this pull request as ready for review August 20, 2023 15:41
@newhoggy newhoggy added this pull request to the merge queue Aug 21, 2023
Merged via the queue into main with commit 4b13e9e Aug 21, 2023
20 checks passed
@newhoggy newhoggy deleted the newhoggy/move-legacy-errors branch August 21, 2023 13:41
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.

None yet

3 participants