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

test: errors: doc updates

Browse Source
This commit is contained in:
Simon Michael 2022-03-18 12:31:28 -10:00
parent 726978d1c5
commit 81c7f91202
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
hledger/test/errors/README.md
View File

@ -26,27 +26,29 @@ brings immediate practical benefits.
Here is the current status Here is the current status
(hledger 1.25, flycheck + [PR#10][flycheck-hledger-10]): (hledger 1.25, flycheck + [PR#10][flycheck-hledger-10]):
| | consistent | accurate line(s) | accurate column(s) | visual | flycheck detects | flycheck region | | | format | accurate line(s) | accurate column(s) | visual | flycheck detects | flycheck region |
|--------------------------|------------|------------------|--------------------|--------|------------------|-----------------| |--------------------------|----------|------------------|--------------------|--------|------------------|-----------------|
| parseable | | Y | Y | YY | Y | Y | | parseable | format 1 | Y | Y | YY | Y | Y |
| parseable-dates | | Y | Y | YY | Y | Y | | parseable-dates | format 1 | Y | Y | YY | Y | Y |
| parseable-regexps | | Y | Y | YY | Y | Y | | parseable-regexps | format 1 | Y | Y | YY | Y | Y |
| balanced | | Y | - | Y | Y | | | balanced | | Y | - | Y | Y | |
| balancednoautoconversion | | Y | - | Y | Y | | | balancednoautoconversion | | Y | - | Y | Y | |
| assertions | | Y | | Y | Y | Y | | assertions | | Y | | Y | Y | Y |
| accounts | | | | Y | Y | | | accounts | format 2 | | | Y | Y | |
| commodities | | | | Y | Y | | | commodities | format 2 | | | Y | Y | |
| payees | | | | Y | Y | Y | | payees | format 2 | | | Y | Y | Y |
| ordereddates | | | | Y | Y | Y | | ordereddates | format 2 | | | Y | Y | Y |
| uniqueleafnames | | | | Y | Y | | | uniqueleafnames | | | | Y | Y | |
Key: Key:
- consistent: the error message follows a standard format - format: the error message follows a standard format
- accurate line - the optimal line(s) is(are) selected - accurate line - the optimal line(s) is(are) selected
- accurate column - the optimal column(s) is(are) selected - accurate column - the optimal column(s) is(are) selected
- visual - the CLI error message shows a relevant excerpt (Y), ideally with the error highlighted (YY) - visual - the CLI error message shows a relevant excerpt (Y), ideally with the error highlighted (YY)
- flycheck detects - flycheck recognises the error output, reports the error and doesn't give a "suspicious" warning - flycheck detects - flycheck recognises the error output, reports the error and doesn't give a "suspicious" warning
- flycheck region - flycheck highlights a reasonably accurate text region containing the error - flycheck region - flycheck highlights a reasonably accurate text region containing the error
- format 1 - location on first line
- format 2 - summary on first line, location on second line
## Goals ## Goals
@ -57,7 +59,7 @@ Key:
- [ ] phase 5: implement accurate lines for all - [ ] phase 5: implement accurate lines for all
- [ ] phase 6: implement accurate columns for all - [ ] phase 6: implement accurate columns for all
- [ ] phase 7: implement useful highlighted excerpts for all - [ ] phase 7: implement useful highlighted excerpts for all
- [ ] phase 8: implement accurate flycheck-highlighted region for all - [ ] phase 8: implement accurate flycheck region for all
- [ ] phase 9: do likewise for timeclock errors - [ ] phase 9: do likewise for timeclock errors
- [ ] phase 10: do likewise for timedot errors - [ ] phase 10: do likewise for timedot errors
- [ ] phase 11: do likewise for csv errors - [ ] phase 11: do likewise for csv errors