;doc: update changelogs

This commit is contained in:
Simon Michael 2021-09-20 17:58:29 -10:00
parent 9cae7a076a
commit bb4f2ff34f
5 changed files with 117 additions and 31 deletions

View File

@ -9,7 +9,13 @@
General changes in the hledger project (and notable all-package releases). General changes in the hledger project (and notable all-package releases).
For package-specific changes and minor releases, see the hledger package changelogs. For package-specific changes and minor releases, see the hledger package changelogs.
# 092e9479f # c2e6a2931
- Added a public BACKLOG.org to the hledger repo and website.
- The bin/hledger-check-fancyassertions.hs addon script,
allowing more complex balance assertions, works again.
(#1464, Stephen Morgan)
- many code cleanups suggested by hlint (Stephen Morgan) - many code cleanups suggested by hlint (Stephen Morgan)

View File

@ -9,9 +9,55 @@
Internal/api/developer-ish changes in the hledger-lib (and hledger) packages. 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.
# c07ad29a8 # 378df7700
API changes - Require base >=4.11, prevent red squares on Hackage's build matrix.
Much code cleanup and reorganisation, such as:
- Introduce lenses for many types. (Stephen Morgan)
- The now-obsolete normaliseMixedAmount and
normaliseMixedAmountSquashPricesForDisplay functions have been
dropped. (Stephen Morgan)
- GenericSourcePos has been dropped, replaced by either SourcePos or
(SourcePos, SourcePos), simplifying module structure. (Stephen Morgan)
- Functions related to balancing (both transaction balancing and journal balancing)
have been moved to Hledger.Data.Balancing, reducing module size and reducing the risk
of import cycles.
(Stephen Morgan)
- `ReportOptions{infer_value_}` has been renamed to `infer_prices_`,
for more consistency with the corresponding CLI flag.
And `BalancingOpts{infer_prices_}` is now `infer_transaction_prices_`.
- JournalParser and ErroringJournalParser have moved to
Hledger.Data.Journal. (Stephen Morgan)
- MixedAmounts now have a more predictable Ord instance / sort order.
They are compared in each commodity in turn, with
alphabetically-first commodity symbols being most significant.
Missing commodities are assumed to be zero.
As a consequence, all the ways of representing zero with a MixedAmount ([],
[A 0], [A 0, B 0, ...]) are now Eq-ual (==), whereas before they were
not. We have not been able to find anything broken by this change.
([#1563](https://github.com/simonmichael/hledger/issues/1563),
[#1564](https://github.com/simonmichael/hledger/issues/1564),
Stephen Morgan)
- HUnit's testCase and testGroup are now used directly instead of
having test and tests aliases. (Stephen Morgan)
- The codebase now passes many hlint checks
- Dropped modules:
Hledger.Utils.Color,
Hledger.Data.Commodity,
Hledger.Utils.UTF8IOCompat,
Hledger.Utils.Tree module.
(Stephen Morgan)
- Drop the deprecated old-time lib. - Drop the deprecated old-time lib.
A small number type signatures have changed: A small number type signatures have changed:
@ -108,30 +154,6 @@ API changes
Hledger.Reports.ReportOptions: Hledger.Reports.ReportOptions:
balanceTypeOverride -> balanceAccumulationOverride balanceTypeOverride -> balanceAccumulationOverride
Improvements
- MixedAmounts now have a more predictable Ord instance / sort order.
They are compared in each commodity in turn, with
alphabetically-first commodity symbols being most significant.
Missing commodities are assumed to be zero.
([#1563](https://github.com/simonmichael/hledger/issues/1563),
[#1564](https://github.com/simonmichael/hledger/issues/1564),
Stephen Morgan)
As a consequence, all the ways of representing zero with a MixedAmount ([],
[A 0], [A 0, B 0, ...]) are now Eq-ual (==), whereas before they were
not. We have not been able to find anything broken by this change.
- Our pretty-printed JSON now orders object attributes alphabetically,
across all GHC and haskell lib versions.
- Our doctests are disabled with GHC 9 for now to work around an
upstream bug.
([#1503](https://github.com/simonmichael/hledger/issues/1503),
[#1615](https://github.com/simonmichael/hledger/issues/1615))
- Require base >=4.11, prevent red squares on Hackage's build matrix.
# 1.22.2 2021-08-07 # 1.22.2 2021-08-07
- forecast_ has moved from ReportOpts to InputOpts. (Stephen Morgan) - forecast_ has moved from ReportOpts to InputOpts. (Stephen Morgan)

View File

@ -9,7 +9,7 @@
User-visible changes in hledger-ui. User-visible changes in hledger-ui.
See also the hledger changelog. See also the hledger changelog.
# 16b4702dc # 9cae7a076
Improvements Improvements
@ -21,8 +21,11 @@ API changes
``` ```
version -> packageversion version -> packageversion
versiondescription -> versionStringFor versiondescription -> versionStringFor
UIOpts fields
``` ```
- Lenses are now available for UIState etc., saving a lot of boilerplate. (Stephen Morgan)
# 1.22.2 2021-08-07 # 1.22.2 2021-08-07
- Use hledger 1.22.2. - Use hledger 1.22.2.

View File

@ -9,7 +9,7 @@ __ _____| |__
User-visible changes in hledger-web. User-visible changes in hledger-web.
See also the hledger changelog. See also the hledger changelog.
# 093c30483 # 9cae7a076
Improvements Improvements
@ -19,6 +19,12 @@ Improvements
Fixes Fixes
- Toggle showing zero items properly even when called with --empty. (#1237) (Stephen Morgan)
- Do not hide empty accounts if they have non-empty subaccounts. (#1237) (Stephen Morgan)
- Allow unbalanced postings (parenthesised account name) in the add transaction form. (#1058) (Stephen Morgan)
- An XSS (cross-site scripting) vulnerability has been fixed. - An XSS (cross-site scripting) vulnerability has been fixed.
Previously (since hledger-web 0.24), javascript code could be added Previously (since hledger-web 0.24), javascript code could be added
to any autocompleteable field and could be executed automatically to any autocompleteable field and could be executed automatically

View File

@ -9,10 +9,15 @@
User-visible changes in the hledger command line tool and library. User-visible changes in the hledger command line tool and library.
# 405fdf7af # 9cae7a076
Features Features
- The new `--today=DATE` option allows overriding today's date. This
can be useful in tests and examples using relative dates, to make
them reproducible.
(#1674) (Stephen Morgan)
- The balance command has a new `--gain` report type, showing - The balance command has a new `--gain` report type, showing
unrealised capital gains/losses. Essentially, this is the difference unrealised capital gains/losses. Essentially, this is the difference
between the amounts' costs and their total present value. More between the amounts' costs and their total present value. More
@ -31,7 +36,7 @@ Features
per commodity and all amounts as bare numbers. per commodity and all amounts as bare numbers.
(#1559, #1626, #1654, Lawrence Wu, Simon Michael, Stephen Morgan) (#1559, #1626, #1654, Lawrence Wu, Simon Michael, Stephen Morgan)
- The balance command's --budget option can now take an argument, - The `balance --budget` option can now take an argument,
a case insensitive description substring which selects a subset of a case insensitive description substring which selects a subset of
the journal's periodic transactions for settinig budget goals. the journal's periodic transactions for settinig budget goals.
This makes it possible to keep multiple named budgets in one journal, This makes it possible to keep multiple named budgets in one journal,
@ -46,6 +51,34 @@ Features
Improvements Improvements
- Numbers in SQL output now always use decimal period (`.`),
independent of commodity display styles. (Stephen Morgan)
- Various incremental performance improvements have been made. (Stephen Morgan)
- In CSV rules, multi-line comments are now supported. Newlines in CSV
data are preserved, or newlines can be added by writing `\n` when
assigning to `comment`, `comment1` etc. (Malte Brandy)
- `--infer-market-price` has been renamed to `--infer-market-prices`.
(The old spelling still works, since we accept flag prefixes.)
- `register` no longer slows down when there are many report intervals.
(#1683) (Stephen Morgan)
- `--sort` now gives a more intuitive sort oder when there are
multiple commodities. Negative numbers in one commodity are always
less than positive numbers in another commodity.
(#1563, Stephen Morgan)
- Our pretty-printed JSON now orders object attributes alphabetically,
across all GHC and haskell lib versions.
- Our doctests are disabled with GHC 9 for now to work around an
upstream bug.
([#1503](https://github.com/simonmichael/hledger/issues/1503),
[#1615](https://github.com/simonmichael/hledger/issues/1615))
- register with a report interval starting on custom dates - register with a report interval starting on custom dates
(eg: `hledger reg -p "every 15th day of month") now makes the (eg: `hledger reg -p "every 15th day of month") now makes the
date column wide enough to show the start and end dates. date column wide enough to show the start and end dates.
@ -116,6 +149,22 @@ Improvements
Fixes Fixes
- A rare bug causing incorrect balances to be reported by the
cf/bs/bse/is commands, since hledger 1.19, has been fixed.
(cf/bs/bse/is with --tree --no-elide --begin DATE and certain
account directives could show wrong balances).
(#1698) (Stephen Morgan)
- The `roi` command no longer gives an ugly error in a certain case
with PnL applied on the first day of investment. (Dmitry Astapov)
- `balance -E` (and hledger-ui Z) now show zero parent accounts when they should,
fixing a bug introduced in hledger 1.19.
(#1688) (Stephen Morgan)
- Certain errors in CSV conversion, such as a failing balance assertion,
were always being reported as line 2.
- aregister now aligns multicommodity amounts properly (broken since 1.21). - aregister now aligns multicommodity amounts properly (broken since 1.21).
(#1656, Stephen Morgan) (#1656, Stephen Morgan)