Hledger.Cli.Utils

Utilities for top-level modules and ghci. See also Hledger.Read and Hledger.Data.Utils.

Documentation

withJournalDo :: [Opt] -> [String] -> String -> ([Opt] -> [String] -> Journal -> IO ()) -> IO ()

Parse the user's specified journal file and run a hledger command on it, or throw an error.

readJournalWithOpts :: [Opt] -> String -> IO Journal

Get a journal from the given string and options, or throw an error.

journalReload :: Journal -> IO (Either String Journal)

Re-read a journal from its data file, or return an error string.

journalReloadIfChanged :: [Opt] -> Journal -> IO (Either String Journal, Bool)

Re-read a journal from its data file mostly, only if the file has changed since last read (or if there is no file, ie data read from stdin). The provided options are mostly ignored. Return a journal or the error message while reading it, and a flag indicating whether it was re-read or not.

journalFileIsNewer :: Journal -> IO Bool

Has the journal's data file changed since last parsed ?

journalFileModificationTime :: Journal -> IO ClockTime

Get the last modified time of the journal's data file (or if there is no file, the current time).

openBrowserOn :: String -> IO ExitCode

Attempt to open a web browser on the given url, all platforms.

writeFileWithBackup :: FilePath -> String -> IO ()

Back up this file with a (incrementing) numbered suffix, then overwrite it with this new text, or give an error.

writeFileWithBackupIfChanged :: FilePath -> String -> IO Bool

Back up this file with a (incrementing) numbered suffix then overwrite it with this new text, or give an error, but only if the text is different from the current file contents, and return a flag indicating whether we did anything.