hledger/CHANGES.md

851 lines
27 KiB
Markdown
Raw Normal View History

2021-07-04 00:14:06 +03:00
<!--
2023-12-31 09:29:49 +03:00
_ _
_ __ _ __ ___ (_) ___ ___| |_
| '_ \| '__/ _ \| |/ _ \/ __| __|
2023-12-31 09:29:49 +03:00
| |_) | | | (_) | | __/ (__| |_
| .__/|_| \___// |\___|\___|\__|
2023-12-31 09:29:49 +03:00
|_| |__/
2023-04-08 00:31:25 +03:00
Scripts/addons
Examples
Docs
Infrastructure
2021-07-04 00:14:06 +03:00
-->
2022-02-06 03:57:53 +03:00
General changes in the hledger project.
For package-specific changes, see the hledger package changelogs.
# 1.32 2023-12-01
2023-12-02 06:11:24 +03:00
Scripts/addons
2023-12-02 06:11:24 +03:00
- hledger-install.sh: replaced hledger-stockquotes with pricehist
2023-12-02 06:11:24 +03:00
- added gsheet-csv.hs: fetch a google sheet as CSV
2023-12-02 06:11:24 +03:00
- added hledger-report1: an example custom compound report, with haskell and bash versions
2023-12-02 06:11:24 +03:00
- justfile: updated import, time report scripts
Examples
- New:
- Fidelity CSV rules
- Updated:
- roi-unrealised.ledger (Charlie Ambrose)
2023-12-02 06:11:24 +03:00
Docs
2023-12-02 06:11:24 +03:00
- New:
2023-12-02 06:11:24 +03:00
- Started a weekly This Week In Hledger news post, inspired by Matrix.
- There's now a News page, for This Week In Hledger etc.
- hledgermatic, an up-to-date, simple journal-first workflow
- How to record journal entries: added
- Reporting version control stats: added
- Moved regression bounty info from the issue tracker to Developer docs > REGRESSIONS.
2023-12-02 06:11:24 +03:00
- Updated:
2023-12-02 06:11:24 +03:00
- Checking for errors
- Common workflows
- Ledger
- Simon's old setup
- Videos
- All docs now use the `cli` class instead of `shell` for command-line examples,
avoiding inaccurate highlighting.
2023-12-02 06:11:24 +03:00
Infrastructure
2023-12-02 06:11:24 +03:00
- hledger.org website:
2023-12-02 06:11:24 +03:00
- Fixed the webhook that was not updating the site on git push.
- Fixed a problem with cloudflare authentication that was preventing
automatic TLS certificate renewal on hledger.org.
- Updated and committed hledger.org's caddy config and short urls (redirects)
- Enabled https for code.hledger.org and site.hledger.org short urls.
2023-12-02 06:11:24 +03:00
- Updated the stars.hledger.org redirect
(we have reached the top 30 github-starred Haskell projects 🌟 🎉).
- Set up a self-hosted Sandstorm server, and a public hledger-web
instance (sandbox.hledger.org) in it that is fully writable (until
spammers find it). Use it as a pastebin for examples, eg.
2023-12-02 06:11:24 +03:00
- Github CI (continuous integration) workflows have been optimised somewhat:
- Scheduled weekly builds have been disabled, as they were propagating
to forks and running wastefully there in some cases.
2023-12-02 06:11:24 +03:00
- Some repeated rebuilding of the hledger-lib and hledger packages
that seems unnecessary has been stopped.
2023-12-02 06:11:24 +03:00
- hledger-ui no longer builds its modules twice.
2023-12-02 06:11:24 +03:00
- Haddock testing now done only at release time.
2023-12-02 06:11:24 +03:00
- renamed main CI workflow and branch to "ci"
2023-12-02 06:11:24 +03:00
- Tools:
2023-12-02 06:11:24 +03:00
- .ghci: added an :rmain alias, which is like :main but reloads first -
saves typing, and is useful eg when changing --debug level.
2023-12-02 06:11:24 +03:00
- make haddock-watch is now fast
Finance
2023-12-02 06:11:24 +03:00
- Updated project finance scripts, regenerated the journal with consistent precisions.
- Updated reports with the last few months of data from Open Collective.
# 1.31 2023-09-03
2023-12-02 06:11:24 +03:00
2023-06-02 21:07:52 +03:00
Scripts/addons
2023-09-11 11:53:10 +03:00
- ft, tt shell scripts for collecting financial and time reports
- A justfile implementation of ft and tt
2023-06-02 21:07:52 +03:00
Examples
2023-09-11 11:53:10 +03:00
- self-tracking
2023-06-14 11:04:33 +03:00
- RPG ledger (Eric Mertens)
2023-06-02 21:07:52 +03:00
Docs
Infrastructure
2023-06-02 23:25:24 +03:00
- tools, CI: checkembeddedfiles, checkversions
2023-06-02 21:07:52 +03:00
2023-09-11 11:53:10 +03:00
- Shake: avoid making empty commits
- make functest-PAT: runs a subset of functional tests
- Provide a ghc-tags.yaml file to make use of ghc-tags with Hledger easy.
ghc-tags is a standalone tool to replace the formerly-built-in
":ctags" feature (and I presume ":etags") in GHCi. These walked over
the source and produced a TAGS file (in vim-compatible ctags or
Emacs-compatible etags format) that allows the relevant editors to
quickly navigate around function definitions.
ghc-tags trips over some of the CPP used in Hledger. The solution
is to provide ghc-tags with explicit CPP defines via a YAML file.
However, if a YAML file is provided, one also must specify the source
paths, as the tool XORs config file | paths-on-command-line.
See <https://github.com/arybczak/ghc-tags/issues/6> for more
information.
(Jonathan Dowland)
2023-06-02 05:29:35 +03:00
# 1.30 2023-06-01
2023-04-08 00:31:25 +03:00
Scripts/addons
2023-06-01 11:03:50 +03:00
- hledger-bar: new script for making simple bar charts in the terminal
- hledger-install: also list cabal, stack, pip tool versions
2023-04-08 00:31:25 +03:00
Examples
2023-06-01 11:03:50 +03:00
- examples/csv: added a more up-to-date CSV makefile
2023-04-08 00:31:25 +03:00
- examples/i18: Added sample top level account and type declarations in several languages
Docs
- A shorter, more example-heavy home page on the website.
- Simplified website and FAQ structure.
# 1.29.2 2023-04-07
Scripts/addons
- hledger-install: re-enable hledger-interest, hledger-iadd; add hledger-lots
2023-03-17 06:45:26 +03:00
# 1.29.1 2023-03-16
2023-03-17 03:44:50 +03:00
Scripts/addons
- hledger-install: slight output cleanups
Docs
Infrastructure
2023-03-17 05:04:49 +03:00
- RELEASING: new release process diagram
2023-03-17 03:44:50 +03:00
- update hie.yaml so HLS uses GHC 9.4
2023-03-12 02:26:30 +03:00
# 1.29 2023-03-11
Scripts/addons
- hledger-script-example.hs: rename/cleanup
- sortandmergepostings: new, sorts postings and merges duplicates (Caleb Maclennan, Murukesh Mohanan)
- hledger-register-max: new, prints the posting with largest historical balance
- hledger-git: record shows better error output, no longer force-adds ignored files
- hledger-git: status is fixed, also shows diffs
- hledger-git: add short command aliases r, s, l
- hledger-git: -h is fixed
- hledger-git: pass unrecognised commands to git
- hledger-install: also install hledger-edit, hledger-plot
- hledger-install: add support for installing python packages
- hledger-install: show quieter stack/cabal output
- hledger-install: align install status list
- hledger-install: don't list hledger-install.sh in PATH
- hledger-install: drop hledger-iadd for now https://github.com/hpdeifel/hledger-iadd/issues/71
Docs
- move most dev docs to doc/
- Scripting hledger: move plugin types table here
- Scripts: add hledger-plot, hledger-edit, hledger-fifo (Yann Büchau, Simon Michael)
- update lots mockups, move to Mockups page
- split Contributor Guide into Contributor Quick Start, LINKS, ISSUES
- add REPOS, FILES, DECISIONS
- CREDITS: updates, link to github contributors list
Infrastructure
- pr template: mention COMMITS page and prefix convention (#1997)
- make ghc 9.4 and current stackage nightly the default for dev builds
- require megaparsec 9.3+ in dev builds, for its useful dbg tool
- make site-watch: fix runaway recursion, be more verbose
- new make rules: man-watch
- new tools: ciwatch, push, pushdocs, gtree
- misc process updates
2022-12-01 23:21:09 +03:00
# 1.28 2022-12-01
2022-12-01 00:54:20 +03:00
Docs
- Miscellaneous improvements.
Examples
- Indian National Pension Service CSV rules (Pranesh Prakash)
Infrastructure
- make site-watch: switch from entr to watchexec.
- make hoogle-setup, hoogle-serve: run a local hoogle on hledger code.
- make man-watch-PROG: watch a hledger program's man page as source files change.
2022-09-18 21:28:03 +03:00
2022-09-02 02:00:50 +03:00
# 1.27 2022-09-01
2022-07-11 13:02:18 +03:00
2022-08-30 01:34:13 +03:00
Docs
2022-06-05 02:56:10 +03:00
2022-08-30 01:34:13 +03:00
- https://hledger.org/ERRORS.html - an overview of hledger's error messages.
2022-07-11 13:02:18 +03:00
2022-09-02 02:00:50 +03:00
- Rewrite/consolidate cost and conversion docs.
2022-08-30 01:34:13 +03:00
- New template for github releases, with improved install instructions for binaries.
2022-07-11 13:02:18 +03:00
2022-08-30 01:34:13 +03:00
- Add modern windows binary install instructions. (Lazar Lazarov, Simon Michael)
2022-07-11 13:02:18 +03:00
2022-08-30 01:34:13 +03:00
- Fix tables of contents in developer documentation. (Alex Hirzel)
2022-07-11 13:02:18 +03:00
2022-08-30 01:34:13 +03:00
- Update ACHIEVEMENTS. (Alex Hirzel)
2022-04-15 02:59:03 +03:00
2022-08-30 01:34:13 +03:00
- Corrected the extension for the CREDITS file. (Pranesh Prakash)
- Fix broken link in bin/README.md. (David D Lowe)
2022-07-11 13:02:18 +03:00
2022-06-05 02:59:36 +03:00
Examples
2022-06-05 02:56:10 +03:00
2022-08-30 01:34:13 +03:00
- Add example for capital one credit cards CSV. (max thomas)
2022-07-11 13:02:18 +03:00
2022-06-05 02:59:36 +03:00
Process
2022-06-05 02:56:10 +03:00
2022-08-30 01:34:13 +03:00
- Revive github projects, set up http://projects.hledger.org shortcut url
- Many cleanups and improvements to the CI test and binary-generating
github actions. The CI tests for master now also include
hledger-lib's doctests.
2022-07-11 13:02:18 +03:00
2022-08-30 01:34:13 +03:00
- All packages now disallow name shadowing in their code.
2022-07-11 13:02:18 +03:00
2022-08-30 01:34:13 +03:00
- make scc gives a modern report of code line counts.
2022-07-11 13:02:18 +03:00
2022-08-30 01:34:13 +03:00
- make ghci-unit-test loads hledger-lib unit tests in GHCI.
2022-06-05 02:56:10 +03:00
# 1.26 2022-06-04
2022-07-11 13:02:18 +03:00
2022-04-15 02:59:03 +03:00
Scripts/addons
2022-05-29 21:04:31 +03:00
- renamed hledger-number.sh to hledger-simplebal
- added hledger-git, hledger-pijul
2022-04-15 02:59:03 +03:00
- fin (and bin) scripts show available scripts and their help
2022-05-29 21:04:31 +03:00
- renamed aliases.sh to bashrc
2022-04-15 02:59:03 +03:00
- Get hledger-print-location working. (Stephen Morgan)
Docs
2022-03-11 05:55:46 +03:00
- README cleanup, inspired by feedback from README reviewer Lars Wirzenius.
2021-12-10 03:25:42 +03:00
2022-04-15 02:59:03 +03:00
- Clearer sponsoring info and more complete sponsor lists on website and README.
- The new <https://github.com/simonmichael/hledger_finance> repo
keeps track of our public finances (on Open Collective, Liberapay etc.)
Examples
- invoice: calculate dates accurately on last days of month
2022-05-29 21:04:31 +03:00
Process
- Stackage nightly and GHC 9.2 are now the default for dev builds.
- CI workflows:
2022-04-15 02:59:03 +03:00
2022-05-29 21:04:31 +03:00
- Workflows and binaries have more consistent naming, mentioning platform and architecture.
- The main test workflow is now `linux-x64-test`, replacing `push` and `pull`.
It runs for both pushes and pull requests, and generates binaries on every run.
- Pushes/merges to master, including Simon's, are required to have passed
`linux-x64-test` on another github branch first.
- Mac and Windows binaries are now stripped also (if applicable).
2022-04-15 02:59:03 +03:00
2022-05-29 21:04:31 +03:00
- `make buildtimes`, `make buildtimes-cabal` show GHC codegen times.
2022-04-15 02:59:03 +03:00
2022-03-05 06:49:26 +03:00
# 1.25 2022-03-04
2022-01-02 04:58:57 +03:00
2022-03-05 06:49:26 +03:00
Scripts/addons
2021-12-10 03:25:42 +03:00
2022-03-05 06:04:50 +03:00
- hledger-install.sh now also installs Pavan Rikhi's hledger-stockquotes tool.
2021-12-10 03:25:42 +03:00
2022-03-05 06:04:50 +03:00
- The bin/hledger-number addon was added.
2021-12-10 03:25:42 +03:00
2022-03-05 06:04:50 +03:00
- The bin/hledger-check-fancyassertions addon now shows docs in --help.
2022-01-05 21:07:51 +03:00
2022-03-05 06:04:50 +03:00
- A new invoice-making script was added: examples/invoicing/invoice-script/invoice
2022-01-05 21:07:51 +03:00
2022-03-05 06:04:50 +03:00
Process/tools
2022-01-06 19:42:34 +03:00
2022-03-05 06:04:50 +03:00
- The RELEASING doc and release process has been updated,
and a new helper script added: tools/releaseprep.
`make hackageupload` now only works from a branch named
VERSION-branch or VERSION-release. Ie, making releases from master
is no longer allowed, a release branch is always required,
2022-01-06 19:42:34 +03:00
2022-03-05 06:04:50 +03:00
- CI: The commitlint check is more robust, and now runs only in
the push to master and pull request workflows, and not eg when
building release binaries. linux-x64 binaries are now built
with ghc 9.0, not 8.10. Workflow, branch, and binary names
have been improved.
2021-12-11 01:50:21 +03:00
2022-03-05 06:04:50 +03:00
- `make ghci-ui`/`make ghcid-ui` now use older ghc 8.10 to avoid
ghc 9.0-triggered failures.
2021-12-11 01:50:21 +03:00
2022-03-05 06:04:50 +03:00
- hls support: The hie.yaml added to help hls work on mac m1
has been moved out of the way, since it probably makes things worse
on other architectures.
2021-12-10 03:25:42 +03:00
2021-12-11 01:30:42 +03:00
# 1.24.1 2021-12-10
2021-12-10 03:52:23 +03:00
Docs
- More platform notes for setting LEDGER_FILE.
- Clarify which commands support which output formats and data layouts.
- Note that hyphenated field names are allowed in CSV rules.
- Fix some table layouts in non-HTML docs.
2021-12-10 03:25:42 +03:00
# 1.24 2021-12-01
2021-12-10 03:52:23 +03:00
2021-12-02 06:58:17 +03:00
Software
2021-11-27 10:06:52 +03:00
2021-12-02 06:58:17 +03:00
- bin/hledger-check-fancyassertions.hs: fix ugly assertion parse errors.
(ShrykeWindgrace)
2021-11-27 10:06:52 +03:00
2021-12-02 06:58:17 +03:00
- bin/hledger-check-tagfiles.hs: Update description, clarify wording.
(Pranesh Prakash)
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
Docs
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- Account types: prioritise the short one-letter names, hide the deprecated
legacy syntax.
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- Directives: a more compact and accurate overview.
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- examples/templates/basic: A new starter file set, and a place to collect them.
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- Expose more developer docs as separate web pages:
CHANGELOGS, COMMITS, RELEASING, etc.
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- Fix a link to developer workflows. (Joaquin "Florius" Azcarate)
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
Process
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- PR template: Fix our github PR template to use proper comment syntax,
and link to more relevant docs.
(toonn)
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- cabal.project: Drop obsolete compatibility comment.
(#1365, toonn)
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- Bump default stackage snapshot to one avoiding buggy happy version.
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- bin/changelog: a new helper making changelog edits more pleasant.
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- make throughput{,-dev,-EXE}: reports transactions per second for a range of
file sizes with the hledger in PATH, hledger dev build, or named hledger
executable.
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- make install-as-FOO: build executables and save as bin/hledger*-FOO
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- perf: bench-ledger.sh for comparative benchmarking with Ledger.
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- CI: commitlint: be more forgiving when we can't figure out recent commits
(don't check any).
2021-11-27 01:02:36 +03:00
2021-12-02 06:58:17 +03:00
- CI: commitlint: recognise any commit starting with Merge as a merge commit
(and ignore it). (Stephen Morgan)
2021-11-27 01:02:36 +03:00
2021-09-22 05:28:07 +03:00
# 1.23 2021-09-21
2021-09-21 06:58:29 +03:00
2021-09-22 05:28:07 +03:00
Software:
2021-09-21 06:58:29 +03:00
- The bin/hledger-check-fancyassertions.hs addon script,
allowing more complex balance assertions, works again.
(#1464, Stephen Morgan)
2021-08-27 09:58:38 +03:00
2021-09-22 05:28:07 +03:00
- Many code cleanups suggested by hlint (Stephen Morgan)
2021-08-27 09:58:38 +03:00
2021-09-22 05:28:07 +03:00
Docs:
2021-08-06 13:16:20 +03:00
2021-09-22 05:28:07 +03:00
- Added a public BACKLOG.org to the hledger repo and website.
2021-08-03 22:50:57 +03:00
2021-09-22 05:28:07 +03:00
- Website updates:
2021-07-28 12:21:13 +03:00
2021-07-28 12:28:03 +03:00
- Reorganised site content.
2021-08-01 21:05:05 +03:00
- Improved page tables of contents.
2021-07-28 12:28:03 +03:00
- Content fixes.
- New docs:
Currency conversion.
hledger and Beancount/GnuCash/Ledger/Quicken.
2021-09-22 05:28:07 +03:00
- New examples: systemd and nginx configs for hledger-web (Alan Young)
Tools/process:
- `make site-watch` works again
- `make list-commits` and `make showauthors` show those things.
- `Shake cabalfiles` now uses (and requires) hpack in $PATH, to avoid building.
It should be the version that's in the current stack release, to avoid commit conflicts.
2021-07-28 12:21:13 +03:00
- shake: changelogs: A leading semicolon now means
"skip most CI steps", not "omit from changelog".
- ci: most steps are skipped if commit message begins with ;.
2021-07-21 11:22:35 +03:00
- hledger developers now use GHC 9.0/stackage nightly by default. (#1503)
2021-09-21 07:07:57 +03:00
- 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))
2021-07-21 11:22:35 +03:00
- bin/commitlint is a new tool for hledger developers which checks and
describes new commit conventions which simplify maintenance of
change docs and releasing. It can be run locally while developing,
manually or as a pre-commit hook
(`ln -sf ../../bin/commitling .git/hooks/commit-msg`),
and is also run by our CI workflows to check pull requests.
<https://hledger.org/CONTRIBUTING.html#commit-messages>,
<https://github.com/simonmichael/hledger/blob/master/bin/commitlint>
(#1602)
2021-07-14 07:29:59 +03:00
2021-07-04 00:14:06 +03:00
# 1.22 2021-07-03
2021-07-03 05:10:56 +03:00
Software:
- We now provide static executables for GNU/Linux on x64 (amd64) and arm32v7
architectures. These are more portable and more likely to work on your linux
2021-07-04 04:54:45 +03:00
system than the dynamic Ubuntu executables we have been providing.
These will also be useful for Nextcloud.com users. (#1571) (Garret McGraw)
2021-07-03 05:10:56 +03:00
2021-07-04 00:14:06 +03:00
- GHC 9.0 is now officially supported, and GHC 8.0, 8.2, 8.4 are not;
building hledger now requires GHC 8.6 or greater.
Docs:
- The info manuals now have the proper metadata so you or your
packager can install them with `install-info` and they will appear
in info's Directory. We also provide a `dir` file making it easy
for developers to see the latest dev manuals in their info Directory.
(#1585) (Damien Cassou, Simon Michael)
Chat:
2021-07-04 05:10:02 +03:00
- The hledger IRC channels (#hledger:libera.chat,
2021-07-03 05:10:56 +03:00
#hledger-bots:libera.chat) moved to Libera.chat.
- The hledger Matrix room (#hledger:matrix.org), is now on at least
2021-07-03 05:10:56 +03:00
equal "official" footing with the IRC channel.
- I upgraded the matrix room to a newer version of the Matrix
protocol. This effectively splits it into an old (read only) room
and a new room. If you are joined to the old room, you might not
have noticed; in your matrix client, please follow the link to the
new room, ie #hledger:matrix.org.
2021-07-03 05:10:56 +03:00
- I briefly bridged the IRC and matrix rooms, because having two chats
(four if we consider #plaintextaccounting) is a pain. I hope to try
the experiment again at some point.
2021-03-10 22:08:22 +03:00
# 1.21 2021-03-10
2021-03-09 20:31:28 +03:00
- roi has a new cookbook doc, and example files have been updated.
(Dmitry Astapov)
2021-03-09 20:31:28 +03:00
- Example CSV rules for the Daedalus wallet have been added.
2021-03-09 20:31:28 +03:00
- The default stackage resolver/GHC version has been bumped to
lts-17.4/ghc-8.10.4.
2021-03-09 20:31:28 +03:00
- tools/generatejournal now includes more commodities and prices in
generated journals. (Stephen Morgan)
2021-03-09 20:31:28 +03:00
- Our functional tests now also run on BSD. (#1434, Felix Van der Jeugt)
2021-03-09 20:31:28 +03:00
- Addon scripts in bin/ have been updated for latest hledger API (Stephen Morgan).
2021-03-09 20:31:28 +03:00
- Addon scripts are now compiled as part of our CI tests, and always
with the same version of hledger source they were shipped with. We
now require script users to check out the hledger source tree and
run the scripts (or, `bin/compile.sh`) from there. This keeps users
and tests in sync, making things more reliable for everyone. (#1453)
2021-03-09 20:31:28 +03:00
- Last but not least, hledger's bash completions (provided in ./shell-completions/)
have been thoroughly updated (#1404, #1410, Vladimir Zhelezov).
2021-03-09 20:31:28 +03:00
"This was supposed to be just a fix for #1404 but upon visiting the source
several issues became apparent and that is why the commit grew a bit more than
expected. A complete list of changes below:
- Fix #1404.
No more orphaned temporary directories. Commands, options, etc. that used to be
stored in there are included at build-time as here documents in the source.
- Fix artifacts in /tmp after build.
Upon fixing the above I became aware that the build itself was leaving behind a
heap of artifacts in /tmp that were not taken care of with a make clean.
Fixed by using temporary files and directories in the build directory. Makefile
and build scripts adjusted.
- Produce command aliases.
Regular expressions in build scripts changed to produce all command aliases
except single letter ones (see below)
- Do not propose single letters completions.
It is simply not useful and adds a lot of noise. It makes completion slower as
well because you need to hit yes on the prompt:
Display all 200 possibilities? (y or n)
output-options.sh now excludes those.
- Query filters simplified.
Keep only the prefix of the filter with the colon in query-filters.txt. This
change has two reasons:
- Single letter completions are not useful (see above).
It allows for completion suggestions specific to each
Bonus reason: it's a completion engine, not a user manual.
Fix completion impacts on global environment
The completion script was making a couple of changes to the global environment
which had an impact for the rest of the shell session.
- set -o pipefail: the change is hidden from the user and could lead to subtle
errors throughout the shell session.
COMP_WORDBREAKS=" ": this affects subsequent completions for us and other
programs too. I exclude the colon : from its value and use
compopt -o filenames to handle escaping of special characters for us. I would
like to find a solution without messing with COMP_WORDBREAKS but it is not
straight forward.
- Fix hiding of legit subcommands.
Completion was hiding all possibilities if a subcommand happens to be the prefix
of another. On typing balance, one should be proposed balancesheet and
balancesheetequity as well.
- Return early.
Try to complete depending on the current context and return immediately if
successful. Keep completion list relevant and as short as possible.
- Context aware completion
Add handlers for option parameter completion, see _hledger_compreply_optarg()
Add handlers for query filters:, see _hledger_compreply_query()
Use --file and --rules-file arguments when proposing completions for the
above, see _hledger()
2021-03-09 20:31:28 +03:00
Propose only top level accounts at first. Again, keep it short and focused.
Custom compgen wrapper
compgen is fairly complicated. There is no way to feed it a word list with
literals. It will mangle your input in so many ways that we cannot trust it. To
work around this several wrappers are used: _hledger_compgen() works with
_hledger_quote_by_ref() to process and escape newline separated input which is
then fed to compgen and finally in COMPREPLY through _hledger_compreply()
and _hledger_compreply_append(). It sounds messy and I guess it is, I would like
to find a more straight forward way to do it. I think it is still a way better
and safer interface with readline than trying to grep our way through.
- Replace declare with local.
Again, this script is sourced by the shell -- keep variable scopes as narrow as
possible. Oops, they are actually synonymous when used in a function but
local declares our intentions explicitly.
- Use compopt -o nosort.
Often I resort to using it to keep different groups of completions together.
Whether this is more ergonomic or not is subjective. But our input lists are
already sorted at build-time so why not. Sort manually query-filters.txt when
editing it.
- Remove irrelevant comments.
And add some new ones :)
I think that is all. Give it a spin, try to abuse it, in and outside of quotes,
with some funky accounts, payees, tags, whatever, and tell me where it breaks or
2021-03-09 20:31:28 +03:00
behaves unexpectedly."
# 1.20.4 2021-01-29
2020-12-29 21:21:27 +03:00
# 1.20.3 2021-01-14
2020-12-29 21:21:27 +03:00
- The run/compile instructions for add-on scripts in bin/ have been
updated. The scripts now use `stack runghc` and are tested (manually
with `make functest` for now) with the corresponding hledger source,
not the hledger on stackage.
2020-12-06 04:32:56 +03:00
# 1.20 2020-12-05
2020-12-29 21:21:27 +03:00
2020-11-24 20:39:05 +03:00
- examples: clean up & add more budgeting examples
2020-11-17 21:51:57 +03:00
- examples: stripe csv
2020-11-04 07:08:47 +03:00
2020-11-17 21:51:57 +03:00
- The functional tests in tests/ have been moved into the respective
packages, eg hledger/test/ and hledger-ui/test/.
2020-11-04 07:08:47 +03:00
2020-11-17 21:51:57 +03:00
- Shake cabalfiles: now gives an error when it fails
2020-11-04 07:08:47 +03:00
2020-11-17 21:51:57 +03:00
- make bench: add some large tabular reports;
run just the slowest commands by default;
run after make (func)test
2020-11-03 21:18:14 +03:00
2020-11-17 21:51:57 +03:00
- a hie.yaml file has been added, so hledger source loads
easily in IDEs supporting haskell-language-server
2020-09-08 02:17:58 +03:00
# 2020-09-07
2020-09-07 22:30:24 +03:00
- Update shell completions (Jakob Schöttl)
2020-09-04 03:05:52 +03:00
2020-09-02 06:28:04 +03:00
# 1.19 2020-09-01
2020-07-05 19:24:16 +03:00
2020-09-02 06:23:30 +03:00
- example scripts:
2020-07-05 19:24:16 +03:00
2020-09-02 06:23:30 +03:00
- stack scripts now use stack's script command consistently
- stack scripts no longer have explicit --package lists, stack
infers them from the imports
- hledger-print-location: new script
2020-06-22 22:24:01 +03:00
2020-09-02 06:23:30 +03:00
- CI:
- always recompile all modules for robustness
- generate optimised binaries, which can be downloaded
- build a single different GHC version with each workflow, reducing
total building and carbon footprint a bit
- stop building with GHC 8.0
- the default stack file now uses lts 16.12 (ghc 8.8.4)
2020-06-22 22:24:01 +03:00
2020-06-21 17:25:51 +03:00
# 1.18.1 2020-06-21
2020-06-21 04:24:15 +03:00
- provide CI binaries for windows, mac & gnu/linux
2020-06-07 22:45:55 +03:00
# 1.18 2020-06-07
2020-04-20 00:45:07 +03:00
2020-06-07 02:53:41 +03:00
- new example scripts:
2020-04-20 00:45:07 +03:00
2020-06-07 02:53:41 +03:00
- hledger-combine-balances.hs, hledger-balance-as-budget.hs (Dmitry Astapov)
- hledger-check-tag-files.hs, hledger-check-tag-files2.hs
2020-04-07 04:38:38 +03:00
2020-06-07 02:53:41 +03:00
- more CSV rule examples: coinbase, waveapp
2020-06-06 01:18:23 +03:00
2020-06-07 02:53:41 +03:00
- new CI (continuous integration) system using Github Actions.
2020-03-19 02:17:13 +03:00
Thanks to Travis and Appveyor for their service to date.
Improvements:
- one CI service instead of several
- more closely integrated with code repo
- tests run on the three main platforms (linux, mac, windows)
- harmless commits are ignored automatically ([ci skip] no longer needed for doc commits)
2020-03-19 02:20:41 +03:00
- scheduled and on-demand testing (push to master, push to ci-* branches, pull request, weekly)
- now tested: all GHC versions, doctests, haddock building
2020-06-07 02:53:41 +03:00
- new shortcut url: http://ci.hledger.org
2020-03-19 02:17:13 +03:00
# 1.17 2020-03-01
2020-02-07 21:47:55 +03:00
2020-03-02 03:44:28 +03:00
- hledger-install: re-enable installation of hledger-iadd & hledger-interest.
2020-02-07 21:47:55 +03:00
2020-03-02 03:44:28 +03:00
- hledger-install: bump minimum stack version to 1.9.1
1.7.1 fails with deps using newer cabal file syntax I believe.
2020-02-07 21:47:55 +03:00
2020-03-02 03:44:28 +03:00
- hledger-install: always do stack update, to help ensure we get the latest packages.
https://github.com/commercialhaskell/stack/issues/5112
2020-01-14 21:08:50 +03:00
2020-03-02 03:44:28 +03:00
- examples: Add a basic example of rule parsing for the output of csb2format. (Evilham)
2020-01-14 21:08:50 +03:00
csb2format deals with the CSB43/AEB43 format, which all banks operating in
Spain must support.
Having these example rules enables easens bootstraping for users with a
Spanish bank account.
2020-03-02 03:44:28 +03:00
- doc: simpler, clearer structure in the manuals and hledger.org sidebar
2020-01-14 21:08:50 +03:00
2020-03-02 03:44:28 +03:00
- doc: a new [Quick Start](https://hledger.org/start.html) page
- doc: a new [Common Tasks](https://hledger.org/hledger.html#common-tasks) section in the hledger manual
2020-01-14 21:08:50 +03:00
2020-03-02 03:44:28 +03:00
- doc: a new invoicing how-to: https://hledger.org/invoicing.html
2020-01-14 21:08:50 +03:00
2020-03-02 03:44:28 +03:00
- doc: Fix dead pointer in contributing (Aleksandar Dimitrov)
2020-01-14 21:08:50 +03:00
2020-03-02 03:44:28 +03:00
- doc: Fix build badges for Travis and AppVeyor (Rui Chen)
2020-01-14 21:08:50 +03:00
2019-12-01 20:59:01 +03:00
# 1.16 2019-12-01
2019-12-01 20:59:01 +03:00
- add support for GHC 8.8, base-compat 0.11 (#1090)
2019-12-01 20:59:01 +03:00
- drop support for GHC 7.10
2019-09-13 18:31:54 +03:00
- add descriptions to most issue tracker labels
2019-12-01 20:59:01 +03:00
- matrix.hledger.org now redirects to a more readable/useful url
2019-09-01 18:41:33 +03:00
# 1.15 2019-09-01
2019-08-31 07:26:23 +03:00
2019-09-01 18:40:05 +03:00
- install: bump to lts-14.4, hledger 1.15, drop hledger-api
2019-08-31 07:26:23 +03:00
2019-09-01 18:40:05 +03:00
- bump versions to 1.15
2019-07-11 09:22:04 +03:00
2019-09-01 18:40:05 +03:00
- api: drop from Shake scripts
2019-08-19 14:03:54 +03:00
- new unified website: hledger.org now has its own git repo, has
absorbed the github wiki, and is generated with Sphinx.
2019-07-11 09:22:04 +03:00
2019-09-01 18:40:05 +03:00
- hledger-api's functionality is now included in hledger-web,
and the hledger-api package is mothballed.
2019-07-11 09:22:04 +03:00
2019-09-01 18:40:05 +03:00
- hledger-install.sh: updated, now also works on FreeBSD 12 (zieone)
2019-07-11 09:22:04 +03:00
2019-09-01 18:40:05 +03:00
- bin/ addon scripts: hledger-swap-dates added; hledger-check,
hledger-smooth updated. (#1072)
2019-07-11 09:22:04 +03:00
2019-09-01 18:40:05 +03:00
- shell-completion/ scripts: updated (Jakob Schöttl)
2019-07-11 09:22:04 +03:00
2019-09-01 18:40:05 +03:00
- github: FUNDING.yml / sponsor button configured
2019-07-25 10:45:56 +03:00
2019-09-01 18:40:05 +03:00
- site: Wine option added to download page
2019-07-11 09:22:04 +03:00
2019-09-01 18:40:05 +03:00
- tools: generatejournal updates: vary amount, make reports with fewer
zeroes, start from a fixed year to keep tests stable, also generate
P records. (#999)
2019-03-21 02:09:25 +03:00
2019-09-01 18:40:05 +03:00
- tools: make, shake, CI: misc. updates
2019-03-21 02:09:25 +03:00
2019-05-04 00:59:12 +03:00
- doc: add a README for the functional tests, linked from contrib guide
2019-03-21 02:09:25 +03:00
2019-09-01 18:40:05 +03:00
- hledger-makeitso has been renamed to hledger-flow (Andreas Pauley)
2019-03-21 02:09:25 +03:00
2019-09-01 18:40:05 +03:00
- The hledger docker image is now based on the "haskell" image (Dmitry Astapov)
2019-03-21 02:09:25 +03:00
2019-03-02 04:43:27 +03:00
# 1.14 2019-03-01
- hledger.org website: now uses https, home page updates,
download page improved package list with status badges.
Also the github wiki pages are now rendered as part of hledger.org,
like the main site pages (with pandoc markdown and tables of contents).
Building the site now requires that a copy of the wiki is checked out
under wiki/.
- bash completion support: removed duplicate options, added new
options, stopped listing -h as a command, added some completion for
external addon commands.
- release automation improvements
- makefile cleanups; make site-liverender helps with local site preview
2019-02-02 03:57:52 +03:00
# 1.13 (2019/01/02)
2019-01-28 21:45:25 +03:00
2019-02-02 03:57:52 +03:00
- packaging: A docker image providing the main hledger tools is now
linked on the download page. This is another way to get up-to-date
hledger tools without building them yourself (and, a way to run
hledger-ui on windows ?) (Dmitry Astapov, Simon Michael)
2019-02-01 02:43:08 +03:00
2019-02-02 03:57:52 +03:00
- hledger-install.sh: fix installation of stack when .local/bin is not
in PATH (Dmitry Astapov)
2019-02-01 02:43:08 +03:00
2019-02-02 03:57:52 +03:00
- doc: fixed pandoc typography conversion in web manuals. Eg `--` was
being rendered as en-dash. (#954).
2019-02-01 02:43:08 +03:00
2019-02-02 03:57:52 +03:00
Developers:
2019-02-01 02:43:08 +03:00
2019-02-02 03:57:52 +03:00
- developer docs have moved from the wiki into CONTRIBUTING.md (#920)
2019-02-02 03:57:52 +03:00
- new streamlined changelog update process. Shake targets:
./Shake changelogs
./Shake CHANGES.md
./Shake CHANGES.md-dry
./Shake PKG/CHANGES.md
./Shake PKG/CHANGES.md-dry
2019-01-26 22:30:54 +03:00
2019-02-02 03:57:52 +03:00
update the project-wide and/or package changelogs, inserting new
commits (touching the respective directory, since the tag version or
commit hash which is the first word in the changelog's previous top
heading) at the top, formatted as changelog entries.
2019-01-26 22:30:54 +03:00
2019-02-02 03:57:52 +03:00
- ./Shake PKG - builds a package plus its embedded docs.
./Shake build - builds all the packages and their embedded docs.
("stack build PKG" does not notice changes in embedded doc files.)
2019-01-26 22:30:54 +03:00
2019-02-02 03:57:52 +03:00
- make ghci-shake - loads Shake.hs in ghci
2019-01-26 22:30:54 +03:00
2019-02-02 03:57:52 +03:00
- make tags - includes doc source files, hpack/cabal files, Shake.hs
2019-01-26 22:30:54 +03:00
- make site-livereload - opens a reloading browser view on the website html
(requires `livereloadx`)
2019-02-02 03:57:52 +03:00
- added a Dockerfile and helper scripts (Dmitry Astapov)
- doc files and hpack/cabal files are included in TAGS again
2019-01-26 22:30:54 +03:00
# 1.12 (2018/12/02)