slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: check: add more details about recentassertions

Browse Source
This commit is contained in:
Simon Michael 2022-07-31 08:57:48 +01:00
parent 2fc74b6eab
commit c025d228a1
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
hledger/Hledger/Cli/Commands/Check.md
View File

@ -18,6 +18,9 @@ hledger check -s # basic + strict checks
hledger check ordereddates payees # basic + two other checks hledger check ordereddates payees # basic + two other checks
``` ```
If you are an Emacs user, you can also configure flycheck-hledger to run these checks,
providing instant feedback as you edit the journal.
Here are the checks currently available: Here are the checks currently available:
### Basic checks ### Basic checks
@ -75,6 +78,17 @@ in <https://github.com/simonmichael/hledger/tree/master/bin>:
You could make similar scripts to perform your own custom checks. You could make similar scripts to perform your own custom checks.
See: Cookbook -> [Scripting](scripting.html). See: Cookbook -> [Scripting](scripting.html).
### More about specific checks
`hledger check recentassertions` will complain if any balance-asserted account does not have
a (cleared) balance assertion within 7 days before its latest posting.
This aims to prevent the situation where you are regularly updating your journal,
but forgetting to check your balances against the real world,
then one day must dig back through months of data to find an error.
It assumes that adding a balance assertion requires/reminds you to check the real-world balance.
This won't be true if you auto-generate balance assertions when importing bank data,
but hopefully your auto-generated transactions are uncleared, and before manually marking them
cleared you will remember to check the latest assertions against the real-world balances.
[add-on commands]: #add-on-commands [add-on commands]: #add-on-commands
[balance assertions]: #balance-assertions [balance assertions]: #balance-assertions