cli: restore --aux-date and --effective as --date2 aliases (#1034)

These Ledger-ish spellings were dropped over the years, to improve --help's layout. Now they work again, but are considered hidden flags so --help doesn't show them automatically (but I decided to mention them manually in --date2's description).
2024-09-19 10:17:35 +03:00 · 2019-06-02 08:44:47 -07:00 · 2019-06-02 08:44:47 -07:00 · faf85d91e3
commit faf85d91e3
parent 41fecde188
20 changed files with 31 additions and 22 deletions
--- a/hledger-ui/Hledger/UI/UIOptions.hs
+++ b/hledger-ui/Hledger/UI/UIOptions.hs
@ -51,7 +51,7 @@ uimode =  (mode "hledger-ui" [("command","ui")]
            (argsFlag "[PATTERNS]") []){
              modeGroupFlags = Group {
                                groupUnnamed = uiflags
-                               ,groupHidden = []
+                               ,groupHidden = hiddenflags
                               ,groupNamed = [(generalflagsgroup1)]
                               }
             ,modeHelpSuffix=[
--- a/hledger-web/Hledger/Web/WebOptions.hs
+++ b/hledger-web/Hledger/Web/WebOptions.hs
@ -75,6 +75,7 @@ webmode =
      Group
      { groupUnnamed = webflags
      , groupHidden =
+          hiddenflags ++
          [ flagNone
              ["binary-filename"]
              (setboolopt "binary-filename")
--- a/hledger/Hledger/Cli/CliOptions.hs
+++ b/hledger/Hledger/Cli/CliOptions.hs
@ -12,6 +12,7 @@ module Hledger.Cli.CliOptions (
  -- * cmdargs flags & modes
  helpflags,
  detailedversionflag,
+  hiddenflags,
  inputflags,
  reportflags,
  outputflags,
@ -112,7 +113,7 @@ helpflags = [
 ,flagNone ["version"] (setboolopt "version") "show version information"
 ]

-- | A hidden flag, just for the hledger executable.
+-- | A hidden flag just for the hledger executable.
 detailedversionflag :: Flag RawOpts
 detailedversionflag = flagNone ["version+"] (setboolopt "version+") "show version information with extra detail"

@ -141,7 +142,7 @@ reportflags = [
 ,flagNone ["quarterly","Q"] (setboolopt "quarterly") "multiperiod/multicolumn report by quarter"
 ,flagNone ["yearly","Y"]    (setboolopt "yearly") "multiperiod/multicolumn report by year"
 ,flagReq  ["period","p"]    (\s opts -> Right $ setopt "period" s opts) "PERIODEXP" "set start date, end date, and/or report interval all at once (overrides the flags above)"
- ,flagNone ["date2"]         (setboolopt "date2") "match the secondary date instead (see command help for other effects)"
+ ,flagNone ["date2"]         (setboolopt "date2") "match the secondary date instead. See command help for other effects. (--effective, --aux-date also accepted)"  -- see also hiddenflags

  -- status/realness/depth/zero filters
 ,flagNone ["unmarked","U"]  (setboolopt "unmarked") "include only unmarked postings/txns (can combine with -P or -C)"
@ -184,6 +185,13 @@ reportflags = [

 ]

+-- | Common flags that are accepted but not shown in --help,
+-- such as --effective, --aux-date.
+hiddenflags :: [Flag RawOpts]
+hiddenflags = [
+  flagNone ["effective","aux-date"] (setboolopt "date2") "Ledger-compatible aliases for --date2"
+ ]
+
 -- | Common output-related flags: --output-file, --output-format...
 outputflags = [outputFormatFlag, outputFileFlag]
 outputFormatFlag = flagReq  ["output-format","O"] (\s opts -> Right $ setopt "output-format" s opts) "FMT" "select the output format. Supported formats:\ntxt, csv, html."
@ -262,8 +270,8 @@ addonCommandMode name = (defCommandMode [name]) {
     --  ]
  ,modeGroupFlags = Group {
      groupUnnamed = []
-     ,groupHidden = []
-     ,groupNamed = [generalflagsgroup1]
+     ,groupHidden  = hiddenflags
+     ,groupNamed   = [generalflagsgroup1]
     }
  }

--- a/hledger/Hledger/Cli/Commands/Accounts.hs
+++ b/hledger/Hledger/Cli/Commands/Accounts.hs
@ -43,7 +43,7 @@ accountsmode = hledgerCommandMode
  ,flagReq  ["drop"] (\s opts -> Right $ setopt "drop" s opts) "N" "flat mode: omit N leading account name parts"
  ]
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[QUERY]")

 -- | The accounts command.
--- a/hledger/Hledger/Cli/Commands/Activity.hs
+++ b/hledger/Hledger/Cli/Commands/Activity.hs
@ -22,7 +22,7 @@ activitymode = hledgerCommandMode
  $(embedFileRelative "Hledger/Cli/Commands/Activity.txt")
  []
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[QUERY]")

 barchar :: Char
--- a/hledger/Hledger/Cli/Commands/Balance.hs
+++ b/hledger/Hledger/Cli/Commands/Balance.hs
@ -296,7 +296,7 @@ balancemode = hledgerCommandMode
   ++ outputflags
  )
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[QUERY]")

 -- | The balance command, prints a balance report.
--- a/hledger/Hledger/Cli/Commands/Checkdates.hs
+++ b/hledger/Hledger/Cli/Commands/Checkdates.hs
@ -16,7 +16,7 @@ checkdatesmode = hledgerCommandMode
  $(embedFileRelative "Hledger/Cli/Commands/Checkdates.txt")
  [flagNone ["strict"] (setboolopt "strict") "makes date comparing strict"]
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[QUERY]")

 checkdates :: CliOpts -> Journal -> IO ()
--- a/hledger/Hledger/Cli/Commands/Checkdupes.hs
+++ b/hledger/Hledger/Cli/Commands/Checkdupes.hs
@ -19,7 +19,7 @@ checkdupesmode = hledgerCommandMode
  $(embedFileRelative "Hledger/Cli/Commands/Checkdupes.txt")
  []
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Nothing)

 checkdupes _opts j = mapM_ render $ checkdupes' $ accountsNames j
--- a/hledger/Hledger/Cli/Commands/Close.hs
+++ b/hledger/Hledger/Cli/Commands/Close.hs
@ -21,7 +21,7 @@ closemode = hledgerCommandMode
  ,flagNone ["closing"] (setboolopt "closing") "show just closing transaction"
  ]
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[QUERY]")

 close CliOpts{rawopts_=rawopts, reportopts_=ropts} j = do
--- a/hledger/Hledger/Cli/Commands/Import.hs
+++ b/hledger/Hledger/Cli/Commands/Import.hs
@ -20,7 +20,7 @@ importmode = hledgerCommandMode
  $(embedFileRelative "Hledger/Cli/Commands/Import.txt")
  [flagNone ["dry-run"] (setboolopt "dry-run") "just show the transactions to be imported"] 
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "FILE [...]")

 importcmd opts@CliOpts{rawopts_=rawopts,inputopts_=iopts} j = do
--- a/hledger/Hledger/Cli/Commands/Prices.hs
+++ b/hledger/Hledger/Cli/Commands/Prices.hs
@ -19,7 +19,7 @@ pricesmode = hledgerCommandMode
  [flagNone ["costs"] (setboolopt "costs") "print transaction prices from postings"
  ,flagNone ["inverted-costs"] (setboolopt "inverted-costs") "print transaction inverted prices from postings also"]
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[QUERY]")

 -- XXX the original hledger-prices script always ignored assertions 
--- a/hledger/Hledger/Cli/Commands/Print.hs
+++ b/hledger/Hledger/Cli/Commands/Print.hs
@ -37,7 +37,7 @@ printmode = hledgerCommandMode
    "show only newer-dated transactions added in each file since last run"
  ] ++ outputflags)
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[QUERY]")

 -- | Print journal transactions in standard format.
--- a/hledger/Hledger/Cli/Commands/Printunique.hs
+++ b/hledger/Hledger/Cli/Commands/Printunique.hs
@ -15,7 +15,7 @@ printuniquemode = hledgerCommandMode
  $(embedFileRelative "Hledger/Cli/Commands/Printunique.txt")
  []
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Nothing)

 printunique opts j@Journal{jtxns=ts} = do
--- a/hledger/Hledger/Cli/Commands/Register.hs
+++ b/hledger/Hledger/Cli/Commands/Register.hs
@ -50,7 +50,7 @@ registermode = hledgerCommandMode
     )
  ] ++ outputflags)
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[QUERY]")

 -- | Print a (posting) register report.
--- a/hledger/Hledger/Cli/Commands/Registermatch.hs
+++ b/hledger/Hledger/Cli/Commands/Registermatch.hs
@ -18,7 +18,7 @@ registermatchmode = hledgerCommandMode
  $(embedFileRelative "Hledger/Cli/Commands/Registermatch.txt")
  []
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "DESC")

 registermatch :: CliOpts -> Journal -> IO ()
--- a/hledger/Hledger/Cli/Commands/Rewrite.hs
+++ b/hledger/Hledger/Cli/Commands/Rewrite.hs
@ -29,7 +29,7 @@ rewritemode = hledgerCommandMode
  ,flagNone ["diff"] (setboolopt "diff") "generate diff suitable as an input for patch tool"
  ]
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[QUERY] --add-posting \"ACCT  AMTEXPR\" ...")

 -- TODO regex matching and interpolating matched name in replacement
--- a/hledger/Hledger/Cli/Commands/Roi.hs
+++ b/hledger/Hledger/Cli/Commands/Roi.hs
@ -37,7 +37,7 @@ roimode = hledgerCommandMode
    "query to select profit-and-loss or appreciation/valuation transactions"
  ]
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[QUERY]")

 -- One reporting span, 
--- a/hledger/Hledger/Cli/Commands/Stats.hs
+++ b/hledger/Hledger/Cli/Commands/Stats.hs
@ -35,7 +35,7 @@ statsmode = hledgerCommandMode
  [flagReq  ["output-file","o"]   (\s opts -> Right $ setopt "output-file" s opts) "FILE" "write output to FILE."
  ]
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[QUERY]")

 -- like Register.summarisePostings
--- a/hledger/Hledger/Cli/Commands/Tags.hs
+++ b/hledger/Hledger/Cli/Commands/Tags.hs
@ -17,7 +17,7 @@ tagsmode = hledgerCommandMode
  $(embedFileRelative "Hledger/Cli/Commands/Tags.txt")
  [] -- [flagNone ["strict"] (setboolopt "strict") "makes date comparing strict"] -- 
  [generalflagsgroup1]
-  []
+  hiddenflags
  ([], Just $ argsFlag "[TAGREGEX [QUERY...]]")

 tags CliOpts{rawopts_=rawopts,reportopts_=ropts} j = do
--- a/hledger/Hledger/Cli/CompoundBalanceCommand.hs
+++ b/hledger/Hledger/Cli/CompoundBalanceCommand.hs
@ -108,7 +108,7 @@ compoundBalanceCommandMode CompoundBalanceCommandSpec{..} =
    ,outputFileFlag
    ]
    [generalflagsgroup1]
-    []
+    hiddenflags
    ([], Just $ argsFlag "[QUERY]")
 where
   defType :: BalanceType -> String