;doc: changelogs

This commit is contained in:
Simon Michael 2024-12-06 18:05:28 -10:00
parent 972a2a066b
commit 917f03b828
5 changed files with 156 additions and 75 deletions

View File

@ -19,7 +19,7 @@ General changes in the hledger project.
For package-specific changes, see the hledger package changelogs. For package-specific changes, see the hledger package changelogs.
# 75fd38665 # 1af6e9c51
Docs Docs
@ -111,7 +111,6 @@ Docs
- drop unused BACKLOG, TODO pages - drop unused BACKLOG, TODO pages
# 1.32.3 2024-01-28 # 1.32.3 2024-01-28
Scripts/addons Scripts/addons

View File

@ -22,31 +22,37 @@ Internal/api/developer-ish changes in the hledger-lib (and hledger) packages.
For user-visible changes, see the hledger package changelog. For user-visible changes, see the hledger package changelog.
# 75fd38665 # f648903b3
Breaking changes Breaking changes
- When built with ghc 9.10.1, hledger error messages are displayed with an extra trailing newline. - New/refactored modules (Hledger.Write.*) and types (Spreadsheet) to help
abstract rendering in various output formats, eg HTML, FODS and beancount.
- New/refactored modules (Hledger.Write.*) and types (Spreadsheet) to help abstract rendering Spreadsheet is an abstraction for tabular reports, in addition to the
in various output formats, eg HTML, FODS and beancount. tabular package we already use; there may be some overlap.
(Henning Thielemann)
- Rename displayDepth/prrDepth to displayIndent/prrIndent, and make them - Rename displayDepth/prrDepth to displayIndent/prrIndent, and make them
correspond to the number of indentation steps. correspond to the number of indentation steps.
(These are about indentation for rendering, not account depth.) [#2246] (These are about indentation for rendering, not account depth.) [#2246]
Fixes
Improvements Improvements
- Add Hledger.Data.Currency, currencySymbolToCode, currencyCodeToSymbol - Add Hledger.Data.Currency, currencySymbolToCode, currencyCodeToSymbol
- AmountFormat: add displayQuotes flag to control enclosing quotes
- InputOpts: add `posting_account_tags_` flag to control account tags on postings
- Support ghc 9.10 and base 4.20.
Note, when built with ghc 9.10.1, hledger error messages are displayed with two extra trailing newlines.
- Added Spreadsheet abstraction for tabular reports (in addition to Other API/doc changes
the tabular package we already use; there may be some overlap).
- Support ghc 9.10 / base 4.20. - Hledger.Utils.IO: cleanup; rgb' now takes Float arguments instead of Word8
- rename jinferredcommodities to jinferredcommoditystyles
- rename jcommodities to jdeclaredcommodities
- move/rename nullsourcepos
- document isBlockActive, matcherMatches
- posting*AsLines: fix some docs
- dependency changes:
# 1.40 2024-09-09 # 1.40 2024-09-09

View File

@ -22,43 +22,51 @@ User-visible changes in hledger-ui.
See also the hledger changelog. See also the hledger changelog.
# 75fd38665 # 786f5dd72
Breaking changes Breaking changes
- When built with ghc 9.10.1, hledger error messages are displayed with two extra trailing newlines. - When built with ghc 9.10.1, error messages are displayed with two extra trailing newlines.
Fixes Fixes
- Bring bash shell completions up to date. - V (value) and C (cost) toggle keys once again reset each other as they should
[#986] (broken since 1.21).
(Gal Lakovnik Gorenec, [#2284])
- Bash shell completions are now up to date. [#986]
Features Features
- Added helix as a supported editor for the `e` key. (amano.kenji)
Improvements Improvements
- Allow clipping depth to be configured per account (until adjusted in app, at least).
(Stephen Morgan, [#2292])
- Added helix as a supported editor for the `e` key. (amano.kenji)
- Added --pager and --color options as in hledger, affecting command line help. - Added --pager and --color options as in hledger, affecting command line help.
Also --color=no forces use of the "terminal" theme. Also --color=no forces use of the "terminal" theme.
- Disabled the unused `ghcdebug` build flag and ghc-debug support, for now.
- Added a new `debug` build flag. Builds made with ghc 9.10+ and this flag - Added a new `debug` build flag. Builds made with ghc 9.10+ and this flag
will show some kind of partial stack trace if the program exits with an error. will show some kind of partial stack trace if the program exits with an error.
These will improve in future ghc versions. These will improve in future ghc versions.
- ghc 9.10 / base 4.20 are now supported. - Disabled the unused `ghcdebug` build flag and ghc-debug support, for now.
- Allow megaparsec 9.7.
- Allow brick 2.5, 2.6.
- Avoid brick 2.3.2, which doesn't build on windows. - Avoid brick 2.3.2, which doesn't build on windows.
- ghc 9.10 / base 4.20 are now supported.
Docs Docs
- Mention that period navigation uses standard periods [#2293]
- Install, manual: new shell completions doc. [#986] - Install, manual: new shell completions doc. [#986]
API
# 1.40 2024-09-09 # 1.40 2024-09-09

View File

@ -22,11 +22,11 @@ User-visible changes in hledger-web.
See also the hledger changelog. See also the hledger changelog.
# 75fd38665 # f648903b3
Breaking changes Breaking changes
- When built with ghc 9.10.1, hledger error messages are displayed with two extra trailing newlines. - When built with ghc 9.10.1, error messages are displayed with two extra trailing newlines.
Fixes Fixes
@ -40,20 +40,20 @@ Improvements
- Added --pager and --color options as in hledger, affecting command line help. - Added --pager and --color options as in hledger, affecting command line help.
- Disabled the unused `ghcdebug` build flag and ghc-debug support, for now.
- Added a new `debug` build flag. Builds made with ghc 9.10+ and this flag - Added a new `debug` build flag. Builds made with ghc 9.10+ and this flag
will show some kind of partial stack trace if the program exits with an error. will show some kind of partial stack trace if the program exits with an error.
These will improve in future ghc versions. These will improve in future ghc versions.
- Disabled the unused `ghcdebug` build flag and ghc-debug support, for now.
- allow megaparsec 9.7
- ghc 9.10 / base 4.20 are now supported. - ghc 9.10 / base 4.20 are now supported.
Docs Docs
- Install, manual: new shell completions doc. [#986] - Install, manual: new shell completions doc. [#986]
API
# 1.40 2024-09-09 # 1.40 2024-09-09

View File

@ -23,14 +23,24 @@ API
User-visible changes in the hledger command line tool and library. User-visible changes in the hledger command line tool and library.
# 75fd38665 # 972a2a066
Breaking changes Breaking changes
- (Not a breaking change, but a fix for a somewhat severe, though hopefully rare, bug:) - Accounts named "equity:conversion", "equity:trading", or "equity:trade(s)",
which are detected as type `V`/`Conversion`, will now revert to type `E`/`Equity` instead
if any other account has been declared as type `V`/`Conversion`.
- When built with ghc 9.10.1, hledger shows two extra newlines after any error message.
Fixes
- A somewhat severe, though hopefully rare, valuation bug has been fixed.
In certain circumstances, values could be calculated inaccurately, In certain circumstances, values could be calculated inaccurately,
because of inappropriate display-rounding during calculations. [#2254] because of display-rounding occurring inappropriately during calculations. [#2254]
Specifically, when there was no direct P price for the target commodity,
Specifically:
when there was no direct P price for the target commodity,
so that hledger had to convert via a chain of prices, so that hledger had to convert via a chain of prices,
and if all of those price amounts had too few decimal places, and if all of those price amounts had too few decimal places,
then the result could be inaccurate. then the result could be inaccurate.
@ -46,43 +56,45 @@ Breaking changes
2000-01-01 2000-01-01
(a) 105520 C ; wrong (a) 105520 C ; wrong
$ hledger print -X C $ hledger-1.41 print -X C
2000-01-01 2000-01-01
(a) 105525 C ; right (a) 105525 C ; right
- When built with ghc 9.10.1, hledger error messages are displayed with two extra trailing newlines.
Fixes
- `bs`/`bse`/`cf`/`is`'s HTML output no longer includes excess heading cells, - `bs`/`bse`/`cf`/`is`'s HTML output no longer includes excess heading cells,
and `bs`/`bse`'s HTML output no longer shows an inappropriate Total heading with -T. and `bs`/`bse`'s HTML output no longer shows an inappropriate Total heading with `-T`.
(balancesheet does not support -T.) (`balancesheet` does not support `-T`.)
(Henning Thielemann) (Henning Thielemann)
- Balance commands' HTML, CSV and FODS output now show tree mode properly indented - Balance commands' HTML, CSV and FODS output now show tree mode properly indented
(using no-break spaces). (using no-break spaces).
(Henning Thielemann) (Henning Thielemann)
- In a multi-line comment generated by csv rules, tags on all lines now work (ie, can be matched). - In the `roi` command, a division by zero error (when all assets were sold) has been fixed.
Posting dates in comments generated from csv also now [work](https://hledger.org/hledger.html#comment-field). [#2281] (Dmitry Astapov)
(#2241)
- In the HTML output of bs/bse/cf/is reports, Net amounts in the Net row are now formatted like the others. - In the HTML output of `bs`/`bse`/`cf`/`is` reports, Net amounts in the Net row are now formatted like the others.
(Bas van Dijk) (Bas van Dijk)
- In bs/bse/cf/is HTML output, fixed some extra TH cells generated unnecessarily. - In `bs`/`bse`/`cf`/`is` HTML output, some unnecessary TH cells have been fixed.
[#2225] (Henning Thielemann) [#2225] (Henning Thielemann)
- hledger's bash shell completions are now up to date with latest options. - In a multi-line comment generated by CSV rules, tags on all lines now work (ie, can be matched).
Posting dates in comments generated from CSV also now [work](https://hledger.org/hledger.html#comment-field).
(#2241)
- hledger's bash shell completions are now up to date with the latest CLI.
[#986] [#986]
- When showing output with a pager, if `$PAGER` is set to something not found in PATH, - When showing output with a pager, if `$PAGER` is set to something not found in PATH,
we now ignore it instead of raising an error. we now ignore it instead of raising an error.
- `hledger --color=yes | less -R` now shows bold headings as you'd expect.
Features Features
- `print`, `register` and `aregister` now support HTML and FODS output. - The `print`, `register` and `aregister` commands now support HTML and FODS output,
Now all of the "STANDARD REPORTS" commands, and the `balance` command, support text, HTML, CSV, TSV, or FODS output. and the `bs`/`bse`/`cf`/`is` commands now support FODS output.
This means all of the "STANDARD REPORTS" commands, and the `balance` command, now support text, HTML, CSV, TSV, or FODS output.
(Henning Thielemann) (Henning Thielemann)
- When generating HTML output with the register or balance commands, - When generating HTML output with the register or balance commands,
@ -90,35 +102,52 @@ Features
allowing you to view the detailed transactions if you have hledger-web running. allowing you to view the detailed transactions if you have hledger-web running.
(Henning Thielemann) (Henning Thielemann)
- Reports can now specify different display depths for certain accounts,
rather than showing all accounts with the same depth limit.
Multiple `--depth=ACCTREGEX=DEPTH` options (or `depth:ACCTREGEX=DEPTH` arguments can be used.
For example, this will clip all accounts matching "assets" to depth 3,
all accounts matching "expenses" to depth 2, and all other accounts to depth 1:
`--depth assets=3 --depth expenses=2 --depth 1`
(Stephen Morgan, #2292)
- In unix-like environments, hledger now uses a pager (`$PAGER`, `less`, or `more`) - In unix-like environments, hledger now uses a pager (`$PAGER`, `less`, or `more`)
for all large terminal output, not just for help. for all large terminal output, not just for help.
You can override this with the new `--pager` option. You can override this with the new `--pager` option.
Note, if you use a pager other than `less`, you might need to configure it to display ANSI colour. The pager is expected to handle hledger's ANSI colour output (unless you disable that).
If `less` is used, it will be configured automatically,
or you can override this by setting options in a `HLEDGER_LESS` environment variable.
- The `print` command's `beancount` output is now much more Beancount-compatible [#2295].
Other than using `--alias` to provide the top-level account names Beancount requires,
you should rarely have to do anything special to produce a journal that `bean-check` accepts.
hledger will automatically adjust problematic names, encode unsupported characters, and so on.
See [hledger: Beancount output](https://hledger.org/dev/hledger.html#beancount-output) for the full details.
This supersedes the `ledger2beancount` tool, and makes using Beancount tools,
especially Fava, practical for hledger users. In many cases this should just work:
```
hledger [ALIASES] print -o tmp.beancount; fava tmp.beancount
```
Improvements Improvements
- The `--color` option now works in config files. - `if` blocks in CSV rules now allow `& !` (AND NOT) on the same line.
(Except for debug output, currently.)
- The `--color` option's recommended values are now `yes`/`y`/`no`/`n`/`auto`/`a`. - When reading `.latest` files, whitespace is now ignored, and any date parse failure
The `always`/`never` spellings are no longer documented, though still supported. is reported with the file and line number.
- The `-NUM` shortcut for `--depth NUM` now works in config files. - In journal format, P directives now require a space after the first symbol,
preventing surprises like `P 2024-10-31 a0 1` parsed as `P 2024-10-31 a 01`.
[#2280]
- `aregister` now supports FODS output (Henning Thielemann) - `aregister` has a new `--heading=YN` option, for disabling the report heading. (Henning Thielemann)
- `aregister` has a new `--header=YN` option, for disabling the report heading. (Henning Thielemann)
- `aregister` now supports the `--invert` and `--cumulative` flags, like the `register` command. (Henning Thielemann) - `aregister` now supports the `--invert` and `--cumulative` flags, like the `register` command. (Henning Thielemann)
- `bs`/`bse`/`cf`/`is` now support FODS output. - The balance commands' HTML and FODS output now shows table borders consistently.
(Henning Thielemann) (Henning Thielemann)
- The balance commands' HTML and FODS output now show table borders consistently. - In the balance commands' HTML output, row headings now span multiple rows when appropriate, rather than being repeated.
(Henning Thielemann)
- In the balance commands' HTML output, row headings now span multiple rows when appropriate,
rather than being repeated.
(Henning Thielemann) (Henning Thielemann)
- Balance commands now support `--transpose` when generating HTML output. - Balance commands now support `--transpose` when generating HTML output.
@ -134,24 +163,61 @@ Improvements
- `bs`/`bse`/`cf`/`is` now support the `--count` (postings count) report type, like `balance`. - `bs`/`bse`/`cf`/`is` now support the `--count` (postings count) report type, like `balance`.
- Balance commands' options help has had some consistency/readability tweaks. - The balance commands' options help has had some cleanup.
- The "equity:conversion" account, and its variations "equity:trade(s)" and "equity:trading", - The error messages from `check accounts` and `check recentassertions` are now clearer.
which by default are detected as `V`/`Conversion` type, now revert to ordinary `E`/`Equity` accounts
if some other account is declared with the `V` type.
- The error message from `check accounts` was simplified a little. - The `check commodities` command now also checks commodities used in P directives. [#2280]
- The `commodities` command now also list commodities mentioned in P directives. [#2280]
- All of hledger's internal hidden (but searchable) tags can now be made visible
by `print --verbose-tags`, which is useful for troubleshooting `--infer-equity`,
`--infer-costs`, and the detection of redundant costs and conversion postings.
Also,
- Some hidden tags have been renamed for clarity:
`_modified` is now `_modified-transaction`,
`_cost-matched` is now `_cost-posting`,
`_conversion-matched` is now `_conversion-posting`.
- The `generated-posting:` tag added by `--infer-equity` is now valueless.
- The `modified-transaction:` tag added by `--auto` now appears on its own line.
- Using the `-NUM` shortcut (for `--depth NUM`) in a config file now works.
- Setting the `--color` option in a config file now works
(except it does not affect `--debug` output, currently).
- The `--color` option's suggested values are now `yes`/`y`, `no`/`n`, or `auto`/`a`.
`always` and `never` are no longer documented, though still supported.
- More compact and informative `--debug=2` output during valuation.
Market prices are now shown using one line each, the known prices
are listed, and the status of `--infer-market-prices` is shown.
[#2287]
- More informative `--debug=7` output from CSV rules.
- The hledger packages have a new `debug` build flag. Builds made with ghc 9.10+ and this flag
will show some kind of stack trace if the program exits with an error.
(These will improve in future ghc versions.)
- Disabled the unused `ghcdebug` build flag and ghc-debug support, for now. - Disabled the unused `ghcdebug` build flag and ghc-debug support, for now.
- Added a new `debug` build flag. Builds made with ghc 9.10+ and this flag - Allow megaparsec 9.7.
will show some kind of partial stack trace if the program exits with an error.
These will improve in future ghc versions.
- ghc 9.10 / base 4.20 are now supported. - ghc 9.10 / base 4.20 are now supported.
Docs Docs
- Windows: added tips for setting `LEDGER_FILE` (Amadeusz Wieczorek, hledger_site#119)
- csv: if blocks: explain matchers and field names better [#2289]
- import: rewrite; rename "date skipping" to "overlap detection"
- import: added tips for first import
- assertions: mention their behaviour with posting status
- journal: rewrite the Tags section
- pager: note that `help -p TOPIC` uses less; link to less FAQ
- query types: updates, add headings, mention tag:'s infix matching
- Regular expressions: note possible RTL/bidi limitation (?) - Regular expressions: note possible RTL/bidi limitation (?)
- Special characters: rewrite, more precision, mention some Windows differences - Special characters: rewrite, more precision, mention some Windows differences
- Output formats: expand, document beancount and FODS output - Output formats: expand, document beancount and FODS output
@ -170,10 +236,12 @@ Docs
Scripts/addons Scripts/addons
- examples/csv: add an example python converter script - examples/csv: add an example python-based CSV converter script
API API
- Hledger.Utils.IO's ansi color helpers now respect the --color option.
- Hledger.Utils.IO.rgb' now takes Float arguments instead of Word8.
- Hledger.Cli.Commands.Balance: export budgetReportAs* functions, for use in scripts. - Hledger.Cli.Commands.Balance: export budgetReportAs* functions, for use in scripts.
(Dmitry Astapov) (Dmitry Astapov)