Merge pull request #1192 from IntersectMBO/newhoggy/more-yaml-outputs

`yaml` output format for more commands

Author: newhoggy

cardano-cli/src/Cardano/CLI/EraBased/Genesis/Run.hs

@@ -205,7 +205,7 @@ runGenesisTxInCmd
         readFileTextEnvelope verificationKeyPath
     let txin = genesisUTxOPseudoTxIn network (verificationKeyHash vkey)
 
-    cioWriteTextOutput mOutFile (renderTxIn txin)
+    writeOutput mOutFile (renderTxIn txin)
 
 runGenesisAddrCmd
   :: GenesisAddrCmdArgs
@@ -226,7 +226,7 @@ runGenesisAddrCmd
             (PaymentCredentialByKey vkh)
             NoStakeAddress
 
-    cioWriteTextOutput mOutFile (serialiseAddress addr)
+    writeOutput mOutFile (serialiseAddress addr)
 
 --
 -- Create Genesis command implementation
@@ -1359,11 +1359,11 @@ runGenesisHashFileCmd (GenesisFile fpath) = do
       gh = Crypto.hashWith id content
   liftIO $ Text.putStrLn (Crypto.hashToTextAsHex gh)
 
-cioWriteTextOutput
+writeOutput
   :: Maybe (File content Out)
   -> Text
   -> CIO e ()
-cioWriteTextOutput mOutput t =
+writeOutput mOutput t =
   case mOutput of
     Just fp -> liftIO $ Text.writeFile (unFile fp) t
     Nothing -> liftIO $ Text.putStr t

cardano-cli/src/Cardano/CLI/EraBased/Query/Command.hs

@@ -115,14 +115,14 @@ data QueryTipCmdArgs = QueryTipCmdArgs
 
 data QueryStakePoolsCmdArgs = QueryStakePoolsCmdArgs
   { commons :: !QueryCommons
-  , outputFormat :: !(Vary [FormatJson, FormatText])
+  , outputFormat :: !(Vary [FormatJson, FormatText, FormatYaml])
   , mOutFile :: !(Maybe (File () Out))
   }
   deriving (Generic, Show)
 
 data QueryStakeDistributionCmdArgs = QueryStakeDistributionCmdArgs
   { commons :: !QueryCommons
-  , outputFormat :: !(Vary [FormatJson, FormatText])
+  , outputFormat :: !(Vary [FormatJson, FormatText, FormatYaml])
   , mOutFile :: !(Maybe (File () Out))
   }
   deriving (Generic, Show)
@@ -138,14 +138,14 @@ data QueryStakeAddressInfoCmdArgs = QueryStakeAddressInfoCmdArgs
 data QueryUTxOCmdArgs = QueryUTxOCmdArgs
   { commons :: !QueryCommons
   , queryFilter :: !QueryUTxOFilter
-  , outputFormat :: !(Vary [FormatCborBin, FormatCborHex, FormatJson, FormatText])
+  , outputFormat :: !(Vary [FormatCborBin, FormatCborHex, FormatJson, FormatText, FormatYaml])
   , mOutFile :: !(Maybe (File () Out))
   }
   deriving (Generic, Show)
 
 data QueryLedgerStateCmdArgs = QueryLedgerStateCmdArgs
   { commons :: !QueryCommons
-  , outputFormat :: !(Vary [FormatJson, FormatText])
+  , outputFormat :: !(Vary [FormatJson, FormatText, FormatYaml])
   , mOutFile :: !(Maybe (File () Out))
   }
   deriving (Generic, Show)
@@ -206,7 +206,7 @@ data QuerySlotNumberCmdArgs = QuerySlotNumberCmdArgs
 data QueryRefScriptSizeCmdArgs = QueryRefScriptSizeCmdArgs
   { commons :: !QueryCommons
   , transactionInputs :: !(Set TxIn)
-  , outputFormat :: !(Vary [FormatJson, FormatText])
+  , outputFormat :: !(Vary [FormatJson, FormatText, FormatYaml])
   , mOutFile :: !(Maybe (File () Out))
   }
   deriving (Generic, Show)

cardano-cli/src/Cardano/CLI/EraBased/Query/Option.hs

@@ -30,6 +30,7 @@ import Data.Function
 import GHC.Exts (IsList (..))
 import Options.Applicative hiding (help, str)
 import Options.Applicative qualified as Opt
+import Vary (Vary)
 
 pQueryCmdsTopLevel :: EnvCli -> Parser (QueryCmds ConwayEra)
 pQueryCmdsTopLevel envCli =
@@ -355,8 +356,8 @@ pQueryProtocolParametersCmd envCli =
               <*> pNetworkId envCli
               <*> pSocketPath envCli
           )
-      <*> pFormatFlags
-        "protocol-parameters query output"
+      <*> pFormatQueryOutputFlags
+        "protocol-parameters"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -367,8 +368,8 @@ pQueryTipCmd era envCli =
   fmap QueryTipCmd $
     QueryTipCmdArgs
       <$> pQueryCommons era envCli
-      <*> pFormatFlags
-        "tip query output"
+      <*> pFormatQueryOutputFlags
+        "tip"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -380,12 +381,13 @@ pQueryUTxOCmd era envCli =
     QueryUTxOCmdArgs
       <$> pQueryCommons era envCli
       <*> pQueryUTxOFilter
-      <*> pFormatFlags
-        "utxo query output"
+      <*> pFormatQueryOutputFlags
+        "utxo"
         [ flagFormatCborBin
         , flagFormatCborHex
         , flagFormatJson & setDefault
         , flagFormatText
+        , flagFormatYaml
         ]
       <*> pMaybeOutputFile
 
@@ -394,10 +396,11 @@ pQueryStakePoolsCmd era envCli =
   fmap QueryStakePoolsCmd $
     QueryStakePoolsCmdArgs
       <$> pQueryCommons era envCli
-      <*> pFormatFlags
-        "stake-pools query output"
+      <*> pFormatQueryOutputFlags
+        "stake-pools"
         [ flagFormatJson & setDefault
         , flagFormatText
+        , flagFormatYaml
         ]
       <*> pMaybeOutputFile
 
@@ -406,10 +409,11 @@ pQueryStakeDistributionCmd era envCli =
   fmap QueryStakeDistributionCmd $
     QueryStakeDistributionCmdArgs
       <$> pQueryCommons era envCli
-      <*> pFormatFlags
-        "stake-distribution query output"
+      <*> pFormatQueryOutputFlags
+        "stake-distribution"
         [ flagFormatJson & setDefault
         , flagFormatText
+        , flagFormatYaml
         ]
       <*> pMaybeOutputFile
 
@@ -419,8 +423,8 @@ pQueryStakeAddressInfoCmd era envCli =
     QueryStakeAddressInfoCmdArgs
       <$> pQueryCommons era envCli
       <*> pFilterByStakeAddress
-      <*> pFormatFlags
-        "stake-address-info query output"
+      <*> pFormatQueryOutputFlags
+        "stake-address-info"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -431,10 +435,11 @@ pQueryLedgerStateCmd era envCli =
   fmap QueryLedgerStateCmd $
     QueryLedgerStateCmdArgs
       <$> pQueryCommons era envCli
-      <*> pFormatFlags
-        "ledger-state query output"
+      <*> pFormatQueryOutputFlags
+        "ledger-state"
         [ flagFormatJson & setDefault
         , flagFormatText
+        , flagFormatYaml
         ]
       <*> pMaybeOutputFile
 
@@ -443,8 +448,8 @@ pQueryLedgerPeerSnapshotCmd era envCli =
   fmap QueryLedgerPeerSnapshotCmd $
     QueryLedgerPeerSnapshotCmdArgs
       <$> pQueryCommons era envCli
-      <*> pFormatFlags
-        "ledger-peer-snapshot query output"
+      <*> pFormatQueryOutputFlags
+        "ledger-peer-snapshot"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -455,8 +460,8 @@ pQueryProtocolStateCmd era envCli =
   fmap QueryProtocolStateCmd $
     QueryProtocolStateCmdArgs
       <$> pQueryCommons era envCli
-      <*> pFormatFlags
-        "protocol-state query output"
+      <*> pFormatQueryOutputFlags
+        "protocol-state"
         [ flagFormatCborBin
         , flagFormatCborHex
         , flagFormatJson & setDefault
@@ -483,8 +488,8 @@ pQueryStakeSnapshotCmd era envCli =
     QueryStakeSnapshotCmdArgs
       <$> pQueryCommons era envCli
       <*> pAllStakePoolsOrSome
-      <*> pFormatFlags
-        "stake-snapshot query output"
+      <*> pFormatQueryOutputFlags
+        "stake-snapshot"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -496,8 +501,8 @@ pQueryPoolStateCmd era envCli =
     QueryPoolStateCmdArgs
       <$> pQueryCommons era envCli
       <*> pAllStakePoolsOrSome
-      <*> pFormatFlags
-        "pool-state query output"
+      <*> pFormatQueryOutputFlags
+        "pool-state"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -513,8 +518,8 @@ pQueryTxMempoolCmd envCli =
               <*> pSocketPath envCli
           )
       <*> pTxMempoolQuery
-      <*> pFormatFlags
-        "tx-mempool query output"
+      <*> pFormatQueryOutputFlags
+        "tx-mempool"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -546,8 +551,8 @@ pLeadershipScheduleCmd era envCli =
       <*> pStakePoolVerificationKeyOrHashOrFile Nothing
       <*> pVrfSigningKeyFile
       <*> pWhichLeadershipSchedule
-      <*> pFormatFlags
-        "leadership-schedule query output"
+      <*> pFormatQueryOutputFlags
+        "leadership-schedule"
         [ flagFormatJson & setDefault
         , flagFormatText
         , flagFormatYaml
@@ -560,8 +565,8 @@ pKesPeriodInfoCmd era envCli =
     QueryKesPeriodInfoCmdArgs
       <$> pQueryCommons era envCli
       <*> pOperationalCertificateFile
-      <*> pFormatFlags
-        "kes-period-info query output"
+      <*> pFormatQueryOutputFlags
+        "kes-period-info"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -587,10 +592,11 @@ pQueryRefScriptSizeCmd era envCli =
     QueryRefScriptSizeCmdArgs
       <$> pQueryCommons era envCli
       <*> (fromList <$> some pByTxIn)
-      <*> pFormatFlags
-        "reference inputs query output"
+      <*> pFormatQueryOutputFlags
+        "reference-script-size"
         [ flagFormatJson & setDefault
         , flagFormatText
+        , flagFormatYaml
         ]
       <*> pMaybeOutputFile
  where
@@ -692,8 +698,8 @@ pQueryDRepStateCmd era envCli = do
                   ]
             ]
         )
-      <*> pFormatFlags
-        "drep-state query output"
+      <*> pFormatQueryOutputFlags
+        "drep-state"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -718,8 +724,8 @@ pQueryDRepStakeDistributionCmd era envCli = do
     QueryDRepStakeDistributionCmdArgs w
       <$> pQueryCommons era envCli
       <*> pAllOrOnlyDRepHashSource
-      <*> pFormatFlags
-        "drep-stake-distribution query output"
+      <*> pFormatQueryOutputFlags
+        "drep-stake-distribution"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -747,8 +753,8 @@ pQueryProposalsCmd era envCli = do
     QueryProposalsCmdArgs w
       <$> pQueryCommons (convert w) envCli
       <*> pAllOrOnlyGovActionIds
-      <*> pFormatFlags
-        "proposals query output"
+      <*> pFormatQueryOutputFlags
+        "proposals"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -773,8 +779,8 @@ pQuerySPOStakeDistributionCmd era envCli = do
     QuerySPOStakeDistributionCmdArgs w
       <$> pQueryCommons era envCli
       <*> pAllOrOnlySPOHashSource
-      <*> pFormatFlags
-        "spo-stake-distribution query output"
+      <*> pFormatQueryOutputFlags
+        "spo-stake-distribution"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -801,8 +807,8 @@ pQueryGetCommitteeStateCmd era envCli = do
       <*> many pCommitteeColdVerificationKeyOrHashOrFileOrScriptHash
       <*> many pCommitteeHotKeyOrHashOrFileOrScriptHash
       <*> many pMemberStatus
-      <*> pFormatFlags
-        "committee-state query output"
+      <*> pFormatQueryOutputFlags
+        "committee-state"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -889,8 +895,8 @@ pQueryStakePoolDefaultVote era envCli = do
     QueryStakePoolDefaultVoteCmdArgs w
       <$> pQueryCommons era envCli
       <*> pSPOHashSource
-      <*> pFormatFlags
-        "stake-pool-default-vote query output"
+      <*> pFormatQueryOutputFlags
+        "stake-pool-default-vote"
         [ flagFormatJson & setDefault
         , flagFormatYaml
         ]
@@ -906,8 +912,8 @@ pQueryNoArgCmdArgs
 pQueryNoArgCmdArgs w envCli name =
   QueryNoArgCmdArgs w
     <$> pQueryCommons (convert w) envCli
-    <*> pFormatFlags
-      (name <> " query output")
+    <*> pFormatQueryOutputFlags
+      name
       [ flagFormatJson & setDefault
       , flagFormatYaml
       ]
@@ -951,3 +957,10 @@ pQueryEraHistoryCmd envCli =
     QueryEraHistoryCmdArgs
       <$> pQueryCommons ShelleyBasedEraConway envCli
       <*> pMaybeOutputFile
+
+pFormatQueryOutputFlags
+  :: String
+  -> [Flag (Vary fs)]
+  -> Parser (Vary fs)
+pFormatQueryOutputFlags content =
+  pFormatFlags $ content <> " query output"