imp: add, close, import, rewrite: support --layout, like print

The other print-like commands — import, close, rewrite, add — can now
also have their layout customised, like print.

Author: simonmichael

hledger/Hledger/Cli/Commands/Add.hs

@@ -52,13 +52,16 @@ import Text.Printf
 
 import Hledger
 import Hledger.Cli.CliOptions
+import Hledger.Cli.Commands.Print (layoutFlag, layoutFromRawOpts)
 import Hledger.Cli.Commands.Register (postingsReportAsText)
 import Hledger.Cli.Utils (journalSimilarTransaction)
 
 
 addmode = hledgerCommandMode
   $(embedFileRelative "Hledger/Cli/Commands/Add.txt")
-  [flagNone ["no-new-accounts"]  (setboolopt "no-new-accounts") "don't allow creating new accounts"]
+  [flagNone ["no-new-accounts"]  (setboolopt "no-new-accounts") "don't allow creating new accounts"
+  ,layoutFlag
+  ]
   [generalflagsgroup2]
   confflags
   ([], Just $ argsFlag "[-f JOURNALFILE] [DATE [DESCRIPTION [ACCOUNT1 [ETC..]]]]]")
@@ -195,7 +198,7 @@ transactionWizard previnput state@AddState{..} stack@(currentStage : _) = case c
           previnput' = previnput{prevDescAndCmnt=Just descAndCommentString}
       when (isJust mbaset) . liftIO $ do
           hPutStrLn stderr "Using this similar transaction for defaults:"
-          T.hPutStr stderr $ showTransaction (fromJust mbaset)
+          T.hPutStr stderr $ showTransactionWithLayout (layoutFromRawOpts $ rawopts_ asOpts) (fromJust mbaset)
       transactionWizard previnput' state' ((GetPosting TxnData{txnDate=date, txnCode=code, txnDesc=desc, txnCmnt=comment} Nothing) : stack)
     Nothing ->
       transactionWizard previnput state (drop 1 stack)
@@ -280,7 +283,7 @@ transactionWizard previnput state@AddState{..} stack@(currentStage : _) = case c
     Nothing -> transactionWizard previnput state (drop 1 stack)
 
   Confirm t -> do
-    output . T.unpack $ showTransaction t
+    output . T.unpack $ showTransactionWithLayout (layoutFromRawOpts $ rawopts_ asOpts) t
     y <- let def = "y" in
          retryMsg "Please enter y or n." $
           parser ((fmap (\c -> if c == '<' then Nothing else Just c)) . headMay . map toLower . strip) $
@@ -510,11 +513,12 @@ postingsAreBalanced j ps = isRight $ balanceSingleTransaction bopts nulltransact
 journalAddTransaction :: Journal -> CliOpts -> Transaction -> IO Journal
 journalAddTransaction j@Journal{jtxns=ts} opts t = do
   let f = journalFilePath j
-  appendToJournalFileOrStdout f $ showTransaction t
+      showtxn = showTransactionWithLayout (layoutFromRawOpts $ rawopts_ opts)
+  appendToJournalFileOrStdout f $ showtxn t
     -- unelided shows all amounts explicitly, in case there's a price, cf #283
   when (debug_ opts > 0) $ do
     putStrLn $ printf "\nAdded transaction to %s:" f
-    TL.putStrLn =<< registerFromString (showTransaction t)
+    TL.putStrLn =<< registerFromString (showtxn t)
   return j{jtxns=ts++[t]}
 
 -- | Append a string, typically one or more transactions, to a journal

hledger/Hledger/Cli/Commands/Add.md

@@ -5,6 +5,10 @@ Add new transactions to a journal file, with interactive prompting.
 ```flags
 Flags:
      --no-new-accounts      don't allow creating new accounts
+     --layout=hledger1|COL  how should posting amounts be aligned ?
+                            hledger1 - right-align amounts, as in hledger 1
+                            COL      - align decimal marks at column COL
+                            (default: 53)
 ```
 
 Many hledger users edit their journals directly with a text editor, or generate them from CSV.

hledger/Hledger/Cli/Commands/Close.hs

@@ -22,7 +22,7 @@ import Safe (lastDef, readMay, readDef)
 import System.FilePath (takeBaseName)
 import Data.Char (isDigit)
 import Hledger.Read.RulesReader (parseBalanceAssertionType)
-import Hledger.Cli.Commands.Print (roundFlag, amountStylesSetRoundingFromRawOpts)
+import Hledger.Cli.Commands.Print (roundFlag, amountStylesSetRoundingFromRawOpts, layoutFlag, layoutFromRawOpts)
 
 defclosedesc  = "closing balances"
 defopendesc   = "opening balances"
@@ -48,6 +48,7 @@ closemode = hledgerCommandMode
   ,flagReq  ["open-desc"]    (\s opts -> Right $ setopt "open-desc"  s opts) "DESC" "set opening transaction's description"
   ,flagReq  ["open-acct"]    (\s opts -> Right $ setopt "open-acct"  s opts) "ACCT" "set opening transaction's source account"
   ,roundFlag
+  ,layoutFlag
   ]
   cligeneralflagsgroups1
   (hiddenflags
@@ -264,6 +265,8 @@ close CliOpts{rawopts_=rawopts, reportspec_=rspec0} j = do
   -- print them
   -- allow user-specified rounding with --round, like print
   let styles = amountStylesSetRoundingFromRawOpts rawopts $ journalCommodityStyles j
-  maybe (pure ()) (T.putStr . showTransaction . styleAmounts styles) mclosetxn
-  maybe (pure ()) (T.putStr . showTransaction . styleAmounts styles) mopentxn
+      postinglayout = layoutFromRawOpts rawopts
+      showtxn = showTransactionWithLayout postinglayout . styleAmounts styles
+  maybe (pure ()) (T.putStr . showtxn) mclosetxn
+  maybe (pure ()) (T.putStr . showtxn) mopentxn
 

hledger/Hledger/Cli/Commands/Close.md

@@ -35,6 +35,10 @@ Flags:
                                    (can unbalance transactions)
                             all  - also round cost amounts to precision
                                    (can unbalance transactions)
+     --layout=hledger1|COL  how should posting amounts be aligned ?
+                            hledger1 - right-align amounts, as in hledger 1
+                            COL      - align decimal marks at column COL
+                            (default: 53)
 ```
 
 `close` has six modes, selected by choosing one of the mode flags:

hledger/Hledger/Cli/Commands/Import.hs

@@ -18,13 +18,15 @@ import Text.Printf
 import Hledger
 import Hledger.Cli.CliOptions
 import Hledger.Cli.Commands.Add (journalAddTransaction)
+import Hledger.Cli.Commands.Print (layoutFlag, layoutFromRawOpts)
 import System.IO (stderr)
 import System.FilePath (takeFileName)
 
 importmode = hledgerCommandMode
   $(embedFileRelative "Hledger/Cli/Commands/Import.txt")
   [flagNone ["catchup"] (setboolopt "catchup") "just mark all transactions as already imported"
   ,flagNone ["dry-run"] (setboolopt "dry-run") "just show the transactions to be imported"
+  ,layoutFlag
   ]
   cligeneralflagsgroups1
   hiddenflags
@@ -37,6 +39,7 @@ importcmd opts@CliOpts{rawopts_=rawopts,inputopts_=iopts} j = do
     inputstr = intercalate ", " $ map (quoteIfNeeded.takeFileName) inputfiles
     catchup = boolopt "catchup" rawopts
     dryrun = boolopt "dry-run" rawopts
+    postinglayout = layoutFromRawOpts rawopts
     combinedStyles = 
       let
         maybeInputStyles = commodity_styles_ . balancingopts_ $ iopts
@@ -75,7 +78,7 @@ importcmd opts@CliOpts{rawopts_=rawopts,inputopts_=iopts} j = do
               then do
                 -- show txns to be imported
                 hPrintf stderr "would import %d new transactions from %s:\n\n" (length newts) inputstr
-                mapM_ (T.putStr . showTransaction) newts
+                mapM_ (T.putStr . showTransactionWithLayout postinglayout) newts
 
                 -- then check the whole journal with them added, if in strict mode
                 when (strict_ iopts) $ strictChecks

hledger/Hledger/Cli/Commands/Import.md

@@ -6,6 +6,10 @@ Import new transactions from one or more data files to the main journal.
 Flags:
      --catchup              just mark all transactions as already imported
      --dry-run              just show the transactions to be imported
+     --layout=hledger1|COL  how should posting amounts be aligned ?
+                            hledger1 - right-align amounts, as in hledger 1
+                            COL      - align decimal marks at column COL
+                            (default: 53)
 ```
 
 This command detects new transactions in one or more data files specified as arguments,

hledger/Hledger/Cli/Commands/Print.md

@@ -106,12 +106,7 @@ If you want to change the default, put something like this in `~/.hledger.conf`:
 --layout=hledger1
 ```
 
-Other print-like commands (close, import, rewrite, add..) use print's default layout.
-But they don't have a --layout option for customisation, currently. 
-If you need that, you could pipe them through print. Eg:
-```
-hledger import *.rules --dry | hledger -I -f- print --layout 40
-```
+Other print-like commands (close, import, rewrite, add) also accept `--layout`.
 
 ### print amount style
 

hledger/Hledger/Cli/Commands/Rewrite.hs

@@ -33,6 +33,7 @@ rewritemode = hledgerCommandMode
            "add a posting to ACCT, which may be parenthesised. AMTEXPR is either a literal amount, or *N which means the transaction's first matched amount multiplied by N (a decimal number). Two spaces separate ACCT and AMTEXPR."
   ,flagNone ["diff"] (setboolopt "diff") "generate diff suitable as an input for patch tool"
   ,flagNone ["verbose-tags"] (setboolopt "verbose-tags") "add tags indicating generated/modified data"
+  ,layoutFlag
   ]
   cligeneralflagsgroups1
   hiddenflags
@@ -67,13 +68,13 @@ transactionModifierFromOpts CliOpts{rawopts_=rawopts} =
 
 printOrDiff :: RawOpts -> (CliOpts -> Journal -> Journal -> IO ())
 printOrDiff opts
-    | boolopt "diff" opts = const diffOutput
+    | boolopt "diff" opts = const (diffOutput (layoutFromRawOpts opts))
     | otherwise = flip (const print')
 
-diffOutput :: Journal -> Journal -> IO ()
-diffOutput j j' = do
+diffOutput :: PostingLayout -> Journal -> Journal -> IO ()
+diffOutput postinglayout j j' = do
     let changed = [(transactionWithMostlyOriginalPostings t, transactionWithMostlyOriginalPostings t') | (t, t') <- zip (jtxns j) (jtxns j'), t /= t']
-    T.putStr $ renderPatch $ map (uncurry $ diffTxn j) changed
+    T.putStr $ renderPatch $ map (uncurry $ diffTxn postinglayout j) changed
 
 type Chunk = (SourcePos, [DiffLine Text])
 
@@ -125,8 +126,8 @@ renderPatch = go Nothing . sortOn fst where
         Add s -> "+" <> s <> "\n"
         Ctx s -> " " <> s <> "\n"
 
-diffTxn :: Journal -> Transaction -> Transaction -> Chunk
-diffTxn j t t' = case tsourcepos t of
+diffTxn :: PostingLayout -> Journal -> Transaction -> Transaction -> Chunk
+diffTxn postinglayout j t t' = case tsourcepos t of
     (pos1@(SourcePos fp line col), pos2) | pos1 == pos2 -> (SourcePos fp (line <> mkPos 1) col, diffs) where
         -- TODO: use range and produce two chunks: one removes part of
         --       original file, other adds transaction to new file with
@@ -140,7 +141,7 @@ diffTxn j t t' = case tsourcepos t of
         diffs = map mapDiff $ D.getDiff source changed'
         source | Just contents <- lookup fp $ jfiles j = drop (unPos line-1) . take (unPos line' - 1) $ T.lines contents
                | otherwise = []
-        changed = T.lines $ showTransaction t'
+        changed = T.lines $ showTransactionWithLayout postinglayout t'
         changed' | null changed = changed
                  | T.null $ last changed = init changed
                  | otherwise = changed

hledger/Hledger/Cli/Commands/Rewrite.md

@@ -15,6 +15,11 @@ Flags:
                                     patch tool
      --verbose-tags                 add tags indicating generated/modified
                                     data
+     --layout=hledger1|COL          how should posting amounts be aligned ?
+                                    hledger1 - right-align amounts, as in
+                                    hledger 1
+                                    COL      - align decimal marks at column
+                                    COL (default: 53)
 ```
 
 This is a start at a generic rewriter of transaction entries.

hledger/test/add.test

@@ -283,6 +283,23 @@ $  cp add-2478.j add-2478.$$.j; hledger -f add-2478.$$.j add >/dev/null 2>&1; rm
 $  printf '2025-01-01\n  (a)  1\n' >t$$.j; hledger -f t$$.j add 2>&1; rm -f t$$.j
 > /^ +\(a\) +4 = 5/
 
+# ** 21. add supports --layout, controlling the layout of appended transactions.
+<
+2026-01-01
+
+a
+100
+b
+
+.
+
+$  printf '' >t$$.j; hledger -f t$$.j add 2026-01-01 --layout=hledger1 >/dev/null 2>&1; cat t$$.j; rm -f t$$.j
+
+2026-01-01
+    a             100
+    b            -100
+>=
+
 # ** . shouldn't add decimals if there aren't any
 # printf '\n\na\n1\nb\n' | hledger -f /dev/null add
 # <