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

;check: doc: wording

Browse Source
This commit is contained in:
Simon Michael 2020-12-31 12:40:46 -08:00
parent f8afb94d09
commit 3898a66dda
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -13,7 +13,7 @@ Some examples:
```shell ```shell
hledger check # basic checks hledger check # basic checks
hledger check -s # basic + strict checks hledger check -s # basic + strict checks
hledger check ordereddates uniqueleafnames # basic + specified checks hledger check ordereddates payees # basic + two other checks
``` ```
Here are the checks currently available: Here are the checks currently available:
@ -36,7 +36,7 @@ including `check`:
### Strict checks ### Strict checks
These additional checks are run when the `-s`/`--strict` ([strict mode]) flag is used. These additional checks are run when the `-s`/`--strict` ([strict mode]) flag is used.
They can also be run by specifying their names as arguments to `check`: Or, they can be run by giving their names as arguments to `check`:
- **accounts** - all account names used by transactions - **accounts** - all account names used by transactions
[have been declared](hledger.html#account-error-checking) [have been declared](hledger.html#account-error-checking)
@ -46,25 +46,26 @@ They can also be run by specifying their names as arguments to `check`:
### Other checks ### Other checks
These checks can be run only by specifying their names as arguments to `check`: These checks can be run only by giving their names as arguments to `check`.
They are more specialised and not desirable for everyone, therefore optional:
- **ordereddates** - transactions are ordered by date (similar to the old `check-dates` command) - **ordereddates** - transactions are ordered by date (similar to the old `check-dates` command)
- **payees** - all payees used by transactions have been declared - **payees** - all payees used by transactions have been declared
- **uniqueleafnames** - all account leaf names are unique (similar to the old `check-dupes` command) - **uniqueleafnames** - all account leaf names are unique (similar to the old `check-dupes` command).
### Add-on checks ### Custom checks
These checks are not yet integrated with `check`, but are available as A few more checks are are available as separate [add-on commands],
[add-on commands] in <https://github.com/simonmichael/hledger/tree/master/bin>: in <https://github.com/simonmichael/hledger/tree/master/bin>:
- **hledger-check-tagfiles** - all tag values containing / (a forward slash) exist as file paths - **hledger-check-tagfiles** - all tag values containing / (a forward slash) exist as file paths
- **hledger-check-fancyassertions** - more complex balance assertions are passing - **hledger-check-fancyassertions** - more complex balance assertions are passing
You could make your own similar scripts to perform custom checks; You could make similar scripts to perform your own custom checks.
Cookbook -> [Scripting](scripting.html) may be helpful. See: Cookbook -> [Scripting](scripting.html).
[transaction prices]: hledger.html#transaction-prices [transaction prices]: hledger.html#transaction-prices