simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-19 10:17:35 +03:00
Code Issues Projects Releases Wiki Activity

;test: update command line help

Browse Source
This commit is contained in:
Simon Michael 2019-11-27 12:53:12 -08:00
parent b36f6df110
commit 91a3b03359
3 changed files with 34 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
hledger/Hledger/Cli/Commands.hs
View File

@ -258,12 +258,16 @@ testmode = hledgerCommandMode
[] []
[generalflagsgroup3] [generalflagsgroup3]
[] []
([], Just $ argsFlag "[TESTPATTERN] [SEED]") ([], Just $ argsFlag "[-- TASTYOPTS]")
-- | The test command. -- | The test command.
-- Unlike most hledger commands, this one does not read the user's journal. -- Unlike most hledger commands, this one does not read the user's journal.
-- A 'Journal' argument remains in the type signature, but it should -- A 'Journal' argument remains in the type signature, but it should
-- not be used (and would raise an error). -- not be used (and would raise an error).
--
-- This command also accepts tasty test runner options,
-- written after a -- (double hyphen).
--
testcmd :: CliOpts -> Journal -> IO () testcmd :: CliOpts -> Journal -> IO ()
testcmd opts _undefined = do testcmd opts _undefined = do
withArgs (words' $ query_ $ reportopts_ opts) $ withArgs (words' $ query_ $ reportopts_ opts) $

29
hledger/Hledger/Cli/Commands/Test.md
View File

@ -3,19 +3,20 @@ Run built-in unit tests.
_FLAGS_ _FLAGS_
This command runs the unit tests built in to hledger-lib and hledger, This command runs the unit tests built in to hledger and hledger-lib,
printing test names and results on stdout. If any test fails, the printing the results on stdout. If any test fails, the exit code will
exit code will be non-zero. be non-zero.
Test names include a group prefix. If a (exact, case sensitive) group This is mainly used by hledger developers, but you can also use it to
prefix, or a full test name is provided as the first argument, only sanity-check the installed hledger executable on your platform. All
that group or test is run. tests are expected to pass - if you ever see a failure, please report
as a bug!
If a numeric second argument is provided, it will set the randomness This command also accepts tasty test runner options, written after a
seed, for repeatable results from tests using randomness (currently -- (double hyphen). Eg to run only the tests in Hledger.Data.Amount,
none of them). with ANSI colour codes disabled:
```shell
This is mainly used by developers, but it's nice to be able to $ hledger test -- -pData.Amount --color=never
sanity-check your installed hledger executable at any time. All tests ```
are expected to pass - if you ever see otherwise, something has gone For help on these, see https://github.com/feuerbach/tasty#options
wrong, please report a bug! (`-- --help` currently doesn't show them).

27
hledger/Hledger/Cli/Commands/Test.txt
View File

@ -3,19 +3,20 @@ Run built-in unit tests.
_FLAGS_ _FLAGS_
This command runs the unit tests built in to hledger-lib and hledger, This command runs the unit tests built in to hledger and hledger-lib,
printing test names and results on stdout. If any test fails, the exit printing the results on stdout. If any test fails, the exit code will be
code will be non-zero. non-zero.
Test names include a group prefix. If a (exact, case sensitive) group This is mainly used by hledger developers, but you can also use it to
prefix, or a full test name is provided as the first argument, only that sanity-check the installed hledger executable on your platform. All
group or test is run. tests are expected to pass - if you ever see a failure, please report as
a bug!
If a numeric second argument is provided, it will set the randomness This command also accepts tasty test runner options, written after a --
seed, for repeatable results from tests using randomness (currently none (double hyphen). Eg to run only the tests in Hledger.Data.Amount, with
of them). ANSI colour codes disabled:
This is mainly used by developers, but it's nice to be able to $ hledger test -- -pData.Amount --color=never
sanity-check your installed hledger executable at any time. All tests
are expected to pass - if you ever see otherwise, something has gone For help on these, see https://github.com/feuerbach/tasty#options
wrong, please report a bug! (-- --help currently doesn't show them).