From 1e1eb00e7d1345b848b6734426183006b7648aee Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Thu, 2 May 2024 00:13:40 -1000 Subject: [PATCH] ;doc: relnotes.github: 1.33.1 --- doc/relnotes.github.md | 319 ++++------------------------------------- 1 file changed, 27 insertions(+), 292 deletions(-) diff --git a/doc/relnotes.github.md b/doc/relnotes.github.md index 6c5cb2bcb97..16c7a7e950c 100644 --- a/doc/relnotes.github.md +++ b/doc/relnotes.github.md @@ -16,312 +16,47 @@ https://hledger.org/relnotes.html#2024-04-18-hledger-133 -### hledger 1.33 +### hledger 1.33.1 -Breaking changes +- process >=1.6.19.0 seems not strictly needed and is no longer required, + improving installability. + [#2149] -- `expr:` boolean queries, introduced in hledger 1.30 (2023), - no longer allow `date:` to be used within an `OR` expression, - avoiding unclear semantics which confuse our reports. - If you'd like to improve this, see #2178. [#2177] [#2178] +- `print` and `close` now show a trailing decimal mark on cost amounts also, + when needed to disambiguate a digit group mark. -- Some error messages (date parse errors, balance assertion failures) have changed, - which might affect error-parsing add-ons like flycheck-hledger. +- The balance commands' HTML output now includes digit group marks when + appropriate (fixes a regression in 1.25). + [#2196] +- The add command no longer shows ANSI escape codes in terminals that + don't support them. +- Doc updates: + - import: Skipping -> Date skipping, discuss commodity styles more + - csv: Amount decimal places: expand, note import behaviour -Fixes +### hledger-ui 1.33.1 -- `add`, `import`, `web`: - On MS Windows, don't allow writing to files whose name ends with a period, - since it can cause data loss; raise an error instead. - I made this change in hledger 1.15 (2019), but it never worked; now it does. - [#1056] +- Require vty-windows-0.2.0.2+ to avoid display problems in recent + MS Terminal on Windows. -- `balance --budget`: - The budget report in tree mode was omitting parent accounts with no actual or goal amounts - and a single child, instead of showing them as a prefix of the child's name. - Now it always shows them, on a line of their own (a bit like `--no-elide`). - It's not a perfect fix, but the budget report code is twisty. - [#2071] +- process >=1.6.19.0 seems not strictly needed and is no longer required, + improving installability. + [#2149] -- `check tags`: - The special `date` and `date2` tags, - and the `modified` and `_modified` tags generated by `--auto`, - are now also implicitly declared. - [#2148], [#2119] +### hledger-web 1.33.1 -- Regular expression match group references in CSV `if` rules, - added in hledger 1.32, did not work right when multiple if conditions matched a CSV record. - This is now fixed; match group references are now scoped to their local `if` block. - [#2158] (Jonathan Dowland) +- Support base64 >=1.0 -- `roi` now correctly interacts with `--value`. - [#2190] (Dmitry Astapov) +### credits 1.33.1 -- hledger now requires process-1.6.19.0+ to avoid any vulnerabilities on Windows from - [HSEC-2024-0003](https://haskell.github.io/security-advisories/advisory/HSEC-2024-0003.html). - - - -Features - -- `close` has had some enhancements for usability ([#2151]): - - - It now excludes equity accounts by default; and always excludes the balancing account. - - - It has new `--assert` and `--assign` modes, for generating transactions which - make balance assertions or balance assignments. - There is also a `--assertion-type` option for changing the assertion/assignment type. - - - It adds a tag to generated transactions, named `start`, `assert` or `retain` - depending on the mode. - - - The `start` tag's value will be a guess of the new file's name, - inferred by incrementing a year number in the current file name. - Eg, `hledger close --migrate` on `2024.journal` will add the tag - `start:2025.journal` to both transactions. - Tags like this can be helpful when reading multiple files, - for excluding closing and opening balances transactions - (eg with `not:tag:start=2025`). - - - You can set different tag values by writing the mode option with an argument. - Eg: `hledger close --migrate=NEWFILENAME`. - - - `close` now supports `--round` for controlling display of decimal places, like `print`. - - - `examples/multi-year/` is examples/tutorial for managing multiple files with the `close` command. - - - -Improvements - -- `stats` has had some improvements: - - - It now also shows some information about memory usage, when hledger is built or is running - with the GHC Run Time System available. (Try `hledger stats +RTS -T`.) - - - The default output is now more private, hiding file paths and commodity symbols. - Those can be added by the new `-v/--verbose` flag. - - - Output is now more compact and more likely to fit in 80-character lines. - - - When generating multiple outputs with a report interval, reports are now - separated by an empty line. - -- Several more kinds of Unicode space are allowed for separating digit groups in numbers. - We now support (my guess of the ones that might show up in real world CSV files): - space, - no-break space, - en space, - em space, - punctuation space, - thin space, - narrow no-break space, - medium mathematical space. - -- Glob patterns in `$LEDGER_FILE` are now respected. - Eg, setting it to `*.journal'` or `2???.journal` now works as expected. - -- When hledger is reading a symbolically-linked journal file, - relative paths in include directives are now evaluated - relative to the directory of the real linked file, - not the directory containing the symbolic link. - -- Date parse errors are now simpler and clearer. - They no longer try to repeat (a reconstruction of) the problem date, - since the actual problem date is already visible in the highlighted file excerpt. - -- Balance assertion error messages are clearer, - and show the difference between expected and actual balance again. - With --debug=2 they also show costs. - -- `tsv:` and `ssv:` file name prefixes are now supported in addition to `csv:`. - They force the file to be read as a .tsv (tab separated values) or .ssv (semicolon-separated values) file. - [#2164] (Michael Rees) - -- In CSV rules files, commented lines are now allowed within "if tables". (Dmitry Astapov) - -- `balance --budget`'s CSV and TSV output now shows zeroes instead of nothing when there's no amount. - -- `bs`,`bse`,`cf`,`is`: - Report sections which are empty now show zero as their subtotal. (aragaer) - -- `print` and `close` add a trailing decimal mark when needed to disambiguate a single digit group mark. - They now also do this for balance assertion and balance assignment amounts. - [#2176] - -- hledger can now be built with GHC 9.8. - -- hledger now requires safe >=0.3.20. - - - -Docs - -- add version annotations for features added in 1.32 (hamzashezad) -- add Text encoding section, mention UTF-8 BOM support [#2189] -- journal: note that `payee` and `tag` directives can't have tags in comments, unlike `account`. -- journal: clarify how auto postings work. -- journal: list built-in special tag names -- journal: description/payee/note: clarify -- journal: amounts/commodities/numbers: cleanups -- journal: move intro before cheatsheet -- journal: transactions: explain transaction balancing [#2135] -- journal: transactions: mention debits, credits and sign -- journal: commodity directive: clarify & fix scope of effects [#2135] -- journal: D directive: clarify scope [#2191] -- journal: split Decimal marks, Digit group marks -- journal: move complex commodity styles, lot notation topics later -- journal: drop redundant/wrong Querying with cost or value section -- journal: cheatsheet: cleanups -- journal: assertions and ordering/commodities/subaccounts: cleanups -- csv: matchers: clarify, mention !/& limitation [#2088] -- csv: if tables: explain comments and order of application (Dmitry Astapov) -- add: document the effect of D default commodity directive [#815] -- balance: cleanups -- balance: budget report: moved "Budgets and subaccounts" to the Cookbook. -- bs,bse,cf,is: update sample output -- bse: note requirements for checking the accounting equation -- close: rewrite, give a better technique for excluding opening/closing balance txns [#2151] -- import: rename "deduplication" to "skipping", and rewrite -- examples: expand READMEs, clarify status for examples -- examples: invoicing: cleanups, renames -- examples: invoicing: pandoc-make-invoice: don't write to $LEDGER_FILE; remove the REMOVE THIS LINE line -- examples: csv: daedalus-transactions: update for current daedalus [#2171] - - - -Scripts/addons - -- hledger-bar, hledger-simplebal: shellcheck fixes, cleanups (Colin Dean) - -- hledger-bar: Fix an error when NO_COLOR is not defined [#2159]. - Also, it's now more compliant with the no-color.org spec: - - Command-line software which adds ANSI color to its output by default - should check for a NO_COLOR environment variable that, when present - and not an empty string (regardless of its value), prevents the - addition of ANSI color. - - so one can now temporarily override $NO_COLOR=1 in the environment by - setting it empty: NO_COLOR= hledger ... - -- hledger-txnsbycat: added - - - -API - -- move readFileStrictly to hledger-lib:Hledger.Utils.IO - - - -[#815]: https://github.com/simonmichael/hledger/issues/815 -[#1056]: https://github.com/simonmichael/hledger/issues/1056 -[#2071]: https://github.com/simonmichael/hledger/issues/2071 -[#2088]: https://github.com/simonmichael/hledger/issues/2088 -[#2119]: https://github.com/simonmichael/hledger/issues/2119 -[#2135]: https://github.com/simonmichael/hledger/issues/2135 -[#2135]: https://github.com/simonmichael/hledger/issues/2135 -[#2148]: https://github.com/simonmichael/hledger/issues/2148 -[#2151]: https://github.com/simonmichael/hledger/issues/2151 -[#2151]: https://github.com/simonmichael/hledger/issues/2151 -[#2158]: https://github.com/simonmichael/hledger/issues/2158 -[#2159]: https://github.com/simonmichael/hledger/issues/2159 -[#2164]: https://github.com/simonmichael/hledger/issues/2164 -[#2171]: https://github.com/simonmichael/hledger/issues/2171 -[#2176]: https://github.com/simonmichael/hledger/issues/2176 -[#2177]: https://github.com/simonmichael/hledger/issues/2177 -[#2178]: https://github.com/simonmichael/hledger/issues/2178 -[#2189]: https://github.com/simonmichael/hledger/issues/2189 -[#2190]: https://github.com/simonmichael/hledger/issues/2190 -[#2191]: https://github.com/simonmichael/hledger/issues/2191 - - -### hledger-ui 1.33 - - -Fixes - -- Require process 1.6.19.0+ to avoid any vulnerabilities on Windows from - [HSEC-2024-0003](https://haskell.github.io/security-advisories/advisory/HSEC-2024-0003.html). - -Features - -- Add a `dark` theme. (Jonathan Dowland) - -Improvements - -- Allow building with GHC 9.8. - -- Require safe >=0.3.20. - - -### hledger-web 1.33 - - -Fixes - -- Exclude base64 >=1.0 to avoid compilation failure. [#2166] - -- Preserve line breaks when showing an error message. [#2163] (Martijn van der Ven) - -Improvements - -- Zero amounts are now shown with their commodity symbol. - This was mainly to make the sidebar more informative, - but also affects and hopefully helps amounts displayed elsewhere. - [#2140] - -- Amounts in the sidebar now also have the `amount` HTML class. - -- Allow building with GHC 9.8. - -- Require safe >=0.3.20. - -Docs - -- Mention the `-E/--empty` flag for hiding zeros, - the non-display of costs, - and non-zeros that look like zero because of hidden costs. - -[#2140]: https://github.com/simonmichael/hledger/issues/2140 -[#2163]: https://github.com/simonmichael/hledger/issues/2163 -[#2166]: https://github.com/simonmichael/hledger/issues/2166 - - -### project changes 1.33 - - -Misc - -- Apple ARM binaries are now included in github releases. - -Docs - -- REGRESSIONS: we now split the bounty between finder and fixer -- move Developer docs, MOCKUPS, investment-accounting-features to main repo -- merge LINKS into dev docs page; cleanup -- drop unused BACKLOG, TODO pages - - -### credits 1.33 - - -Simon Michael, -Jonathan Dowland, -Ilja Kocken, -Colin Dean, -Dmitry Astapov, -Vekhir, -ShrykeWindgrace, -Martijn van der Ven, -Michael Rees, -aragaer, -hamzashezad. +Simon Michael. +[#2149]: https://github.com/simonmichael/hledger/issues/2149 +[#2149]: https://github.com/simonmichael/hledger/issues/2149 +[#2196]: https://github.com/simonmichael/hledger/issues/2196