bin: rename hledger-check* per "How to check for errors"
This commit is contained in:
		
							parent
							
								
									af15a5d0c8
								
							
						
					
					
						commit
						1b6f8e0b19
					
				| @ -14,14 +14,14 @@ ghc, if you take care of the dependencies yourself.) | |||||||
| 
 | 
 | ||||||
| Scripts overview, simplest first: | Scripts overview, simplest first: | ||||||
| 
 | 
 | ||||||
| - hledger-check-tag-files.hs        - check that all tag values containing / exist as file paths | - hledger-check-tagfiles.hs         - check that all tag values containing / exist as file paths | ||||||
| - hledger-check-tag-files.cabal.hs  - the above as a cabal script | - hledger-check-tagfiles.cabal.hs   - the above as a cabal script | ||||||
| - hledger-swap-dates.hs             - print transactions with their date and date2 fields swapped | - hledger-swap-dates.hs             - print transactions with their date and date2 fields swapped | ||||||
| - hledger-print-location.hs         - add file path/line number tags to the print command | - hledger-print-location.hs         - add file path/line number tags to the print command | ||||||
| - hledger-balance-as-budget.hs      - use one balance report as budget goals for another one | - hledger-balance-as-budget.hs      - use one balance report as budget goals for another one | ||||||
| - hledger-combine-balances.hs       - show balance reports for two different periods side by side | - hledger-combine-balances.hs       - show balance reports for two different periods side by side | ||||||
| - hledger-smooth.hs                 - incomplete attempt at automatically splitting infrequent/irregular transactions | - hledger-smooth.hs                 - incomplete attempt at automatically splitting infrequent/irregular transactions | ||||||
| - hledger-check.hs                  - check more complex account balance assertions | - hledger-check-fancyassertions.hs  - check more complex account balance assertions | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| [add-on commands]: http://hledger.org/hledger.html#add-on-commands | [add-on commands]: http://hledger.org/hledger.html#add-on-commands | ||||||
|  | |||||||
| @ -3,7 +3,8 @@ | |||||||
| 
 | 
 | ||||||
| {- | {- | ||||||
| ``` | ``` | ||||||
| Usage: hledger-check [-f|--file FILE] [--alias OLD=NEW] [--ignore-assertions] | Usage: hledger-check-fancyassertions | ||||||
|  |                      [-f|--file FILE] [--alias OLD=NEW] [--ignore-assertions] | ||||||
|                      [-b|--begin DATE] [-e|--end DATE] [-C|--cleared] |                      [-b|--begin DATE] [-e|--end DATE] [-C|--cleared] | ||||||
|                      [--pending] [-U|--unmarked] [-R|--real] [--sunday] |                      [--pending] [-U|--unmarked] [-R|--real] [--sunday] | ||||||
|                      [-D|--daily ASSERT] [-W|--weekly ASSERT] |                      [-D|--daily ASSERT] [-W|--weekly ASSERT] | ||||||
| @ -45,7 +46,7 @@ to the sum of the values in both that account and its subaccounts. | |||||||
| 
 | 
 | ||||||
| **Example:** | **Example:** | ||||||
| ``` | ``` | ||||||
| hledger-check -D "budget:books  >= £0" | hledger-check-fancyassertions -D "budget:books  >= £0" | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| "At the end of every day, the books budget is greater than or equal to | "At the end of every day, the books budget is greater than or equal to | ||||||
| @ -62,7 +63,7 @@ Assertions can also be wrapped inside parentheses. | |||||||
| 
 | 
 | ||||||
| **Example:** | **Example:** | ||||||
| ``` | ``` | ||||||
| hledger-check "(assets:overdraft  < £2000) ==> (*assets:checking  == £0)" | hledger-check-fancyassertions "(assets:overdraft  < £2000) ==> (*assets:checking  == £0)" | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| "If I have taken money from my overdraft, then I must have no money in | "If I have taken money from my overdraft, then I must have no money in | ||||||
| @ -3,16 +3,16 @@ | |||||||
| build-depends: base, directory, hledger, text | build-depends: base, directory, hledger, text | ||||||
| -} | -} | ||||||
| {- | {- | ||||||
| hledger-check-tag-files cabal script (requires cabal 3+). | hledger-check-tagfiles cabal script (requires cabal 3+). | ||||||
| Read the default journal and give an error if any tag values | Read the default journal and give an error if any tag values | ||||||
| containing '/' do not exist as file paths. | containing '/' do not exist as file paths. | ||||||
| Usage: | Usage: | ||||||
| 
 | 
 | ||||||
| $ hledger-check-tag-files.hs    # compiles every time (?) | $ hledger-check-tagfiles.hs    # compiles every time (?) | ||||||
| 
 | 
 | ||||||
| or: | or: | ||||||
| 
 | 
 | ||||||
| $ hledger check-tag-files       # compiles every time (?) | $ hledger check-tagfiles       # compiles every time (?) | ||||||
| -} | -} | ||||||
| 
 | 
 | ||||||
| import Control.Monad | import Control.Monad | ||||||
| @ -2,16 +2,16 @@ | |||||||
| -- stack script --compile --resolver lts-16.3 | -- stack script --compile --resolver lts-16.3 | ||||||
| 
 | 
 | ||||||
| {- | {- | ||||||
| hledger-check-tag-files stack script. | hledger-check-tagfiles stack script. | ||||||
| Read the default journal and give an error if any tag values | Read the default journal and give an error if any tag values | ||||||
| containing '/' do not exist as file paths. | containing '/' do not exist as file paths. | ||||||
| Usage: | Usage: | ||||||
| 
 | 
 | ||||||
| $ hledger-check-tag-files.hs    # compiles if needed | $ hledger-check-tagfiles.hs    # compiles if needed | ||||||
| 
 | 
 | ||||||
| or: | or: | ||||||
| 
 | 
 | ||||||
| $ hledger check-tag-files       # compiles if there's no compiled version | $ hledger check-tagfiles       # compiles if there's no compiled version | ||||||
| -} | -} | ||||||
| 
 | 
 | ||||||
| import Control.Monad | import Control.Monad | ||||||
		Loading…
	
		Reference in New Issue
	
	Block a user