Hledger.Cli.CompoundBalanceCommand

Common helpers for making multi-section balance report commands like balancesheet, cashflow, and incomestatement.

Documentation

data CompoundBalanceCommandSpec

Description of a compound balance report command, from which we generate the command's cmdargs mode and IO action. A compound balance report command shows one or more sections/subreports, each with its own title and subtotals row, in a certain order, plus a grand totals row if there's more than one section. Examples are the balancesheet, cashflow and incomestatement commands.

Constructors

CompoundBalanceCommandSpec

Fields

• cbcname :: String

  command name

• cbcaliases :: [String]

  command aliases

• cbchelp :: String

  command line help

• cbctitle :: String

  overall report title

• cbcqueries :: [(String, Journal -> Query, Maybe NormalBalance)]

  title, journal-parameterised query, and expected normal balance for each subreport. The normal balance helps --sort-amount know how to sort negative amounts.

• cbctype :: BalanceType

  the type of "balance" this report shows (overrides command line flags)

compoundBalanceCommandMode :: CompoundBalanceCommandSpec -> Mode RawOpts

Generate a cmdargs option-parsing mode from a compound balance command specification.

compoundBalanceCommand :: CompoundBalanceCommandSpec -> CliOpts -> Journal -> IO ()

Generate a runnable command from a compound balance command specification.