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

doc: errors: update status (#1436)

Browse Source
This commit is contained in:
Simon Michael 2022-04-22 12:59:32 -10:00
parent 792434ca7d
commit 1130ad1abd
1 changed files with 25 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -40,30 +40,29 @@ Some files contain extra declarations to ease flycheck testing.
## Current status ## Current status
Here is the current status Here is the current status
(hledger 1.25, flycheck 87b275b9): (hledger 1.25.99-gd278c4c71-20220422, flycheck 87b275b9):
| | std format | accurate line(s) | accurate column(s) | visual | flycheck detects | flycheck region | | | std format | line | column | excerpt | flycheck | flycheck region |
|--------------------------|------------|------------------|--------------------|--------|------------------|-----------------| |--------------------------|------------|------|------------|---------|----------|-----------------|
| parseable | Y | Y | Y | YY | Y | Y | | parseable | Y | Y | Y | YY | | |
| parseable-dates | Y | Y | Y | YY | Y | Y | | parseable-dates | Y | Y | Y | YY | | |
| parseable-regexps | Y | Y | Y | YY | Y | Y | | parseable-regexps | Y | Y | Y | YY | | |
| balanced | | Y | - | Y | Y | | | balanced | | Y | - | Y | | |
| balancednoautoconversion | | Y | - | Y | Y | | | balancednoautoconversion | | Y | - | Y | | |
| assertions | | Y | | Y | Y | Y | | assertions | | Y | | Y | | |
| accounts | Y | Y | Y | Y | Y | | | accounts | Y | Y | Y | YY | | |
| commodities | Y | Y | | Y | Y | | | commodities | Y | Y | Y (approx) | YY | | |
| payees | | | | Y | Y | Y | | payees | Y | Y | Y | YY | | |
| ordereddates | | | | Y | Y | Y | | ordereddates | | | | Y | | |
| uniqueleafnames | | | | Y | Y | | | uniqueleafnames | | | | Y | | |
Key: Key:
- std format - the error message follows a standard format - std format - the error message follows a standard format (location on first line, megaparsec-like excerpt, description).
(location on first line, megaparsec-like excerpt, description). - line - the optimal line(s) is(are) selected
- accurate line - the optimal line(s) is(are) selected - column - the optimal column(s) is(are) selected
- accurate column - the optimal column(s) is(are) selected - excerpt - a useful excerpt is shown (Y), ideally with the error highlighted (YY)
- visual - the CLI error message shows a relevant excerpt (Y), ideally with the error highlighted (YY) - flycheck - latest flycheck release recognises and reports the error, with no "suspicious state" 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 region containing the error
- flycheck region - flycheck highlights a reasonably accurate text region containing the error
## Preferred error format ## Preferred error format
@ -194,11 +193,11 @@ undeclared commodity "A"
### payees ### payees
``` ```
hledger: Error: undeclared payee "p" hledger: Error: /Users/simon/src/hledger/hledger/test/errors/payees.j:6:12:
at: /Users/simon/src/hledger/hledger/test/errors/./payees.j:6-7 6 | 2022-01-01 p
| ^
> 2022-01-01 p | (a) A 1
(a) A 1 undeclared payee "p"
``` ```