Hledger.Cli.Add

A history-aware add command to help with data entry. |

Documentation

addmode :: Mode RawOpts

data EntryState

State used while entering transactions.

Constructors

EntryState

Fields

• esOpts :: CliOpts

  command line options

• esArgs :: [String]

  command line arguments remaining to be used as defaults

• esToday :: Day

  today's date

• esDefDate :: Day

  the default date for next transaction

• esJournal :: Journal

  the journal we are adding to

• esSimilarTransaction :: Maybe Transaction

  the most similar historical txn

• esPostings :: [Posting]

  postings entered so far in the current txn

Instances

Show EntryState

Methods

showsPrec :: Int -> EntryState -> ShowS

show :: EntryState -> String

showList :: [EntryState] -> ShowS

defEntryState :: EntryState

data RestartTransactionException

Constructors

RestartTransactionException

Instances

Show RestartTransactionException

Methods

showsPrec :: Int -> RestartTransactionException -> ShowS

show :: RestartTransactionException -> String

showList :: [RestartTransactionException] -> ShowS

Exception RestartTransactionException

Methods

toException :: RestartTransactionException -> SomeException

fromException :: SomeException -> Maybe RestartTransactionException

displayException :: RestartTransactionException -> String

add :: CliOpts -> Journal -> IO ()

Read multiple transactions from the console, prompting for each field, and append them to the journal file. If the journal came from stdin, this command has no effect.

showHelp :: IO ()

getAndAddTransactions :: EntryState -> IO ()

Loop reading transactions from the console, prompting, validating and appending each one to the journal file, until end of input or ctrl-c (then raise an EOF exception). If provided, command-line arguments are used as defaults; otherwise defaults come from the most similar recent transaction in the journal.

confirmedTransactionWizard :: EntryState -> Wizard Haskeline Transaction

transactionWizard :: EntryState -> Wizard Haskeline Transaction

similarTransaction :: EntryState -> String -> Maybe Transaction

dateAndCodeWizard :: EntryState -> Wizard Haskeline (Day, String)

descriptionAndCommentWizard :: EntryState -> Wizard Haskeline (String, String)

postingsWizard :: EntryState -> Wizard Haskeline [Posting]

postingWizard :: EntryState -> Wizard Haskeline (Maybe Posting)

postingsBalanced :: [Posting] -> Bool

accountWizard :: EntryState -> Wizard Haskeline [Char]

amountAndCommentWizard :: EntryState -> Wizard Haskeline (Amount, String)

maybeExit :: Wizard Haskeline [Char] -> Wizard Haskeline [Char]

maybeRestartTransaction :: Wizard Haskeline [Char] -> Wizard Haskeline [Char]

dateCompleter :: String -> CompletionFunc IO

descriptionCompleter :: Journal -> String -> CompletionFunc IO

accountCompleter :: Journal -> String -> CompletionFunc IO

amountCompleter :: String -> CompletionFunc IO

completer :: [String] -> String -> CompletionFunc IO

Generate a haskeline completion function from the given completions and default, that case insensitively completes with prefix matches, or infix matches above a minimum length, or completes the null string with the default.

defaultTo' :: a -> Wizard Haskeline a -> Wizard Haskeline a

withCompletion :: (:<:) WithSettings b => CompletionFunc IO -> Wizard b a -> Wizard b a

green :: [Char] -> [Char]

showDefault :: [Char] -> [Char]

journalAddTransaction :: Journal -> CliOpts -> Transaction -> IO Journal

Append this transaction to the journal's file and transaction list.

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

Append a string, typically one or more transactions, to a journal file, or if the file is "-", dump it to stdout. Tries to avoid excess whitespace.

ensureOneNewlineTerminated :: String -> String

Replace a string's 0 or more terminating newlines with exactly one.

registerFromString :: String -> IO String

Convert a string of journal data into a register report.

capitalize :: String -> String

transactionsSimilarTo :: Journal -> Query -> String -> [(Double, Transaction)]

Find the most similar and recent transactions matching the given transaction description and report query. Transactions are listed with their "relevancy" score, most relevant first.

compareDescriptions :: String -> String -> Double

Return a similarity measure, from 0 to 1, for two transaction descriptions. This is like compareStrings, but first strips out any numbers, to improve accuracy eg when there are bank transaction ids from imported data.

compareStrings :: String -> String -> Double

Return a similarity measure, from 0 to 1, for two strings. This was based on Simon White's string similarity algorithm (http:/www.catalysoft.comarticles/StrikeAMatch.html), later found to be https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient, modified to handle short strings better. Todo: check out http://nlp.fi.muni.cz/raslan/2008/raslan08.pdf#page=14 .

wordLetterPairs :: String -> [[Char]]

letterPairs :: [a] -> [[a]]