From 2d51cef88e73561ca04893b13419a271dc8c1d85 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 1 Dec 2018 16:29:54 -0800 Subject: [PATCH] doc: changelogs --- hledger-api/CHANGES | 3 +- hledger-lib/CHANGES | 52 +++++++++++++++++++++++- hledger-ui/CHANGES | 51 ++++++++++++++++++++++++ hledger-web/CHANGES | 7 ++++ hledger/CHANGES | 97 ++++++++++++++++++++++++++++++++++++++++++++- 5 files changed, 206 insertions(+), 4 deletions(-) diff --git a/hledger-api/CHANGES b/hledger-api/CHANGES index 21838457d..3f66626b7 100644 --- a/hledger-api/CHANGES +++ b/hledger-api/CHANGES @@ -2,8 +2,9 @@ User-visible changes in hledger-api. See also the hledger changelog. -# Unreleased +# 1.12 (2018/12/02) +* use hledger 1.12 # 1.11.1 (2018/10/06) diff --git a/hledger-lib/CHANGES b/hledger-lib/CHANGES index 3837531ae..7eb072925 100644 --- a/hledger-lib/CHANGES +++ b/hledger-lib/CHANGES @@ -1,5 +1,54 @@ Developer-ish changes in the hledger-lib package. -User-visible changes are noted in the hledger changelog, instead. +User-visible changes are noted in the hledger package changelog instead. + + +# 1.12 (2018/12/02) + +* switch to megaparsec 7 (Alex Chen) + We now track the stack of include files in Journal ourselves, since + megaparsec dropped this feature. + +* add 'ExceptT' layer to our parser monad again (Alex Chen) + We previously had a parser type, 'type ErroringJournalParser = ExceptT + String ...' for throwing parse errors without allowing further + backtracking. This parser type was removed under the assumption that it + would be possible to write our parser without this capability. However, + after a hairy backtracking bug, we would now prefer to have the option to + prevent backtracking. + + - Define a 'FinalParseError' type specifically for the 'ExceptT' layer + - Any parse error can be raised as a "final" parse error + - Tracks the stack of include files for parser errors, anticipating the + removal of the tracking of stacks of include files in megaparsec 7 + - Although a stack of include files is also tracked in the 'StateT + Journal' layer of the parser, it seems easier to guarantee correct + error messages in the 'ExceptT FinalParserError' layer + - This does not make the 'StateT Journal' stack redundant because the + 'ExceptT FinalParseError' stack cannot be used to detect cycles of + include files + +* more support for location-aware parse errors when re-parsing (Alex Chen) + +* make 'includedirectivep' an 'ErroringJournalParser' (Alex Chen) + +* drop Ord instance breaking GHC 8.6 build (Peter Simons) + +* flip the arguments of (divide|multiply)[Mixed]Amount + +* showTransaction: fix a case showing multiple missing amounts + showTransaction could sometimes hide the last posting's amount even if + one of the other posting amounts was already implcit, producing invalid + transaction output. + +* plog, plogAt: add missing newline + +* split up journalFinalise, reorder journal finalisation steps (#893) (Jesse Rosenthal) + The `journalFinalise` function has been split up, allowing more granular + control. + +* journalSetTime --> journalSetLastReadTime + +* journalSetFilePath has been removed, use journalAddFile instead # 1.11.1 (2018/10/06) @@ -7,7 +56,6 @@ User-visible changes are noted in the hledger changelog, instead. * add, lib: fix wrong transaction rendering in balance assertion errors and when using the add command - # 1.11 (2018/9/30) * compilation now works when locale is unset (#849) diff --git a/hledger-ui/CHANGES b/hledger-ui/CHANGES index f7040a5c2..4405330e1 100644 --- a/hledger-ui/CHANGES +++ b/hledger-ui/CHANGES @@ -2,6 +2,57 @@ User-visible changes in hledger-ui. See also the hledger changelog. +# 1.12 (2018/12/02) + +* fix "Any" build error with GHC < 8.4 + +* error screen: always show error position properly (#904) (Mykola Orliuk) + +* accounts screen: show correct balances when there's only periodic transactions + +* drop the --status-toggles flag + +* periodic transactions and transaction modifiers are always enabled. + Rule-based transactions and postings are always generated + (--forecast and --auto are always on). + Experimental. + +* escape key resets to flat mode. + Flat mode is the default at startup. Probably it should reset to tree + mode if --tree was used at startup. + +* tree mode tweaks: add --tree/-T/-F flags, make flat mode the default, + toggle tree mode with T, ensure a visible effect on register screen + +* hide future txns by default, add --future flag, toggle with F. + You may have transactions dated later than today, perhaps piped from + print --forecast or recorded in the journal, which you don't want to + see except when forecasting. + + By default, we now hide future transactions, showing "today's balance". + This can be toggled with the F key, which is easier than setting a + date query. --present and --future flags have been added to set the + initial mode. + + (Experimental. Interactions with date queries have not been explored.) + +* quick help tweaks; try to show most useful info first + +* reorganise help dialog, fit content into 80x25 again + +* styling tweaks; cyan/blue -> white/yellow + +* less noisy styling in horizontal borders (#838) + +* register screen: positive amounts: green -> black + The green/red scheme helped distinguish the changes column from the + black/red balance column, but the default green is hard to read on + the pale background in some terminals. Also the changes column is + non-bold now. + +* use hledger 1.12 + + # 1.11.1 (2018/10/06) * use hledger 1.11.1 diff --git a/hledger-web/CHANGES b/hledger-web/CHANGES index 0aaabf6b0..aa1f41ecf 100644 --- a/hledger-web/CHANGES +++ b/hledger-web/CHANGES @@ -2,6 +2,13 @@ User-visible changes in hledger-web. See also the hledger changelog. +# 1.12 (2018/12/02) + +* fix duplicate package.yaml keys warned about by hpack + +* use hledger 1.12 + + # 1.11.1 (2018/10/06) * use hledger 1.11.1 diff --git a/hledger/CHANGES b/hledger/CHANGES index 57c8cc4cf..274368897 100644 --- a/hledger/CHANGES +++ b/hledger/CHANGES @@ -1,6 +1,101 @@ -User-visible changes in the hledger command line tool. +User-visible changes in the hledger command line tool (and hledger-lib). +# 1.12 (2018/12/02) + +* build with GHC 8.6/base-4.12 (Peter Simons) + +* add required upper bound for statistics (Samuel May) + +* --anon anonymises more thoroughly (including linked original postings) (Moritz Kiefer) + +* unbalanced transaction errors now include location info (Mykola Orliuk) + +* accounts command: --drop also affects the default flat output, without needing an explicit --flat flag + +* accounts command: the --codes flag has been dropped + +* accounts command: filtering by non-account-name queries now works + +* add command: fix transaction rendering regression during data entry and in journal file + +* balance command: fix wrongful eliding of zero-balance parent accounts in tree mode (Dmitry Astapov) + +* journal format, bs/bse/cf/is commands: account directives can declare account types (#877) + Previously you had to use one of the standard english account names + (assets, liabilities..) for top-level accounts, if you wanted them to + appear in the right place in the balancesheet, balancesheetequity, + cashflow or incomestatement reports. + + Now you can use your preferred account names, and use account directives + to declare which accounting class (Asset, Liability, Equity, Revenue or + eXpense) an account (and its subaccounts) belongs to, by writing one of + the letters A, L, E, R, X after the account name, after two or more + spaces. This syntax may change (see issue). Experimental. + + Currently we allow unlimited account type declarations anywhere in the + account tree. So you could declare a liability account somewhere under + assets, and maybe a revenue account under that, and another asset account + even further down. In such cases you start to see oddities like accounts + appearing in multiple places in a tree-mode report. I have left it this + way for now in case it helps with, eg, modelling contra accounts, or + combining multiple files each with their own account type + declarations. (In that scenario, if we only allowed type declarations on + top-level accounts, or only allowed a single account of each type, + complications seem likely.) + +* journal format: periodic transaction rules now require a double space separator. + In periodic transaction rules which specify a transaction description or + same-line transaction comment, this must be separated from the period + expression by two or more spaces, to prevent ambiguous parsing. Eg + this will parse correctly as "monthly" thanks to the double space: + + ~ monthly In 2020 we'll end this monthly transaction. + +* journal format: exact/complete balance assertions (Samuel May). + A stronger kind of balance assertion, written with a double equals sign, + asserts an account's complete account balance, not just the balance in + one commodity. (But only if it is a single-commodity balance, for now.) + Eg: + + 1/1 + (a) A 1 + (a) B 1 + (a) 0 = A 1 ; commodity A balance assertion, succeeds + (a) 0 == A 1 ; complete balance assertion, fails + +* journal format: account directives now allow whitespace or a comment after the account name + +* journal format: using ~ for home directory in include directives now works (#896) (Mykola Orliuk) + +* journal format: prevent misleading parse error messages with cyclic include directives (#853) (Alex Chen) + +* journal format: transaction modifier multipliers handle total-priced amounts correctly (#928). + Multipliers (*N) in transaction modifier rules did not multiply + total-priced amounts properly. Now the total prices are also multiplied, + keeping the transaction balanced. + +* journal format: do amount inference/balance assignments/assertions before transaction modifiers (#893, #908) (Jesse Rosenthal) + Previously, transaction modifier (auto postings) rules were applied + before missing amounts were inferred. This meant amount multipliers could + generate too many missing-amount postings, making the transaction + unbalanceable (#893). + + Now, missing amount inference (and balance assignments, and balance + assertions, which are interdependent) are done earlier, before + transaction modifier rules are applied (#900, #903). + + Also, we now disallow the combination of balance assignments and + transaction modifier rules which both affect the same account, which + could otherwise cause confusing balance assertion failures (#912). + (Because assignments now generate amounts to satisfy balance assertions + before transaction modifier rules are applied (#908).) + +* journal format: periodic transaction rules are now aware of Y default year directives. (#892) + Ie when a default year Y is in effect, they resolve partial or relative + dates using Y/1/1 as the reference date, rather than today's date. + + # 1.11.1 (2018/10/06) * fix wrong transaction rendering in balance assertion errors and when