View vote file

[carlhammann]

Changelog

- description: |
    Added a command to inspect a vote file: `cardano-cli conway governance vote view`
# 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

This PR closes #11.

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]

We should output JSON by default. I like the idea of supporting YAML as an option.

[newhoggy]

Should we drop the anchor field if its value is missing?

[carlhammann]

We should output JSON by default. I like the idea of supporting YAML as an option.

Got it. I was taking inspiration from the cardano-cli * transaction view commands, which output YAML as well.

Should we drop the anchor field if its value is missing?

I'm not sure. My "role model" transaction view commands don't. Dropping the field might make parsing the output back into types of suitable shapes harder for third parties.

[carlhammann]

@newhoggy I've now added a --yaml option to switch to YAML output. Without that, the output is JSON.

As this is my first PR here: how do we proceed to merging this? I'm unsure about the "commit sequence broadly makes sense" requirement -- what are your customs there? (I'd say the PR is simple enough to get squashed.)

[newhoggy]

In the Change log section of the PR description, mark compatible because you have a change to the CLI parser, but it adds a new command which is a non-breaking change.

[Jimbo4350]

Nice, some changes needed.

[carlhammann]

I think this is ready, barring the YAML issue. @Jimbo4350 did I understand you correctly yesterday that we'll keep the YAML option, and adapt the other commands that currently output only YAML to also output JSON by default, with a switch like the one on this command?

Comments addressed.

[newhoggy]

I rebased and updated for cardano-api-8.25.0.1.