awesome-emacs/doomemacs
1
0
Fork 0
mirror of https://github.com/doomemacs/doomemacs synced 2025-09-02 14:53:38 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs(beancount): flesh out module readme

Browse Source
This commit is contained in:
Henrik Lissner
2025-08-30 11:58:22 +02:00
parent 9e5e4cf78b
commit 6084404a07
1 changed files with 54 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
modules/lang/beancount/README.org
View File

@@ -14,15 +14,34 @@ you [[https://plaintextaccounting.org/][manage your money in plain text]].
** Module flags ** Module flags
- +lsp :: - +lsp ::
Enable LSP support for ~beancount-mode~. Requires [[doom-module::tools lsp]] and a langserver Enable LSP support for ~beancount-mode~. Requires [[doom-module::tools lsp]] and a
(supports [[https://github.com/polarmutex/beancount-language-server][beancount-language-server]]). langserver (supports [[https://github.com/polarmutex/beancount-language-server][beancount-language-server]]).
** Packages ** Packages
- [[doom-package:beancount]] - [[doom-package:beancount]]
** Hacks ** Hacks
- Associates the material =attach_money= icon with =*.beancount= files in the - Adds rudimentary syntax highlighting to ~custom~ directives, because
[[doom-package:nerd-icons]] package. ~beancount-mode~ doesn't out of the box.
- Fixes a bug in ~beancount-fava~ where the browser doesn't open after starting
Fava because of ANSI codes in Fava's output.
- Fixes syntax checker only operating on visible region in narrowed buffers
- Fixes file path resolution errors from syntax checker due to relative paths
(e.g. for ~include~ and ~document~ attributes/directives).
- Adds support for "meta lines"; beancount code that is visible only to the
syntax checker, so users can resolve false-positives in multi-file beancount
ledgers. E.g.
#+begin_src beancount
;# include "../config.beancount"
;# 2025-01-01 pad Assets:Bank Equity:Opening-Balances
#+end_src
- Adds code completion for:
- Event directives and values
- The payee field in transactions
- Currencies and commodities
- Fixes completion for ~#tags~ and ~^links~ when they're not on their own line.
- Adjusted code completion to scan not only the current file, but any included
files (recursively) for candidates.
** TODO Changelog ** TODO Changelog
# This section will be machine generated. Don't edit it by hand. # This section will be machine generated. Don't edit it by hand.
@@ -36,15 +55,38 @@ This module requires:
- [[https://beancount.github.io/fava/][fava]], for a web interface for your ledgers - [[https://beancount.github.io/fava/][fava]], for a web interface for your ledgers
- [[doom-executable:bean-format]], if [[doom-module::editor format]] - [[doom-executable:bean-format]], if [[doom-module::editor format]]
* TODO Usage * Usage
#+begin_quote This module provides ~beancount-mode~ for beancount ledger files. Opening any
󱌣 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]] ~*.beancount~ or ~*.bean~ will activate it.
#+end_quote
* TODO Configuration ** Keybinds
#+begin_quote | Binding | Description |
󱌣 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]] |-----------------------+--------------------------------------------------|
#+end_quote | [[kbd:<localleader> b]] | Display balance sheet in popup |
| [[kbd:<localleader> c]] | Run ~bean-check~ on current file |
| [[kbd:<localleader> l]] | Show all transactions linked to the one at point |
| [[kbd:<localleader> q]] | |
| [[kbd:<localleader> x]] | |
| [[kbd:<localleader> i c]] | Clone a transaction (select one from all files) |
| [[kbd:<localleader> i C]] | Clone transaction at point |
| [[kbd:<localleader> i a]] | Insert account |
| [[kbd:<localleader> i d]] | Insert date |
| [[kbd:<localleader> i p]] | Insert prices (requires ~bean-price~) |
| [[kbd:<localleader> s r]] | Sort transactions in selected region |
| [[kbd:<localleader> s b]] | Sort transactions in buffer |
* Configuration
Look up customizable variables for ~beancount-mode~ via [[kbd:C-h V]] and typing
~^beancount-~.
On top of those, this module exposes the following variable:
- +beancount-files (default: ~'auto~) ::
Controls what files to scan for code completion candidates. The default value,
~'auto~, causes it to scan the current file and any included files
(recursively). If set to ~nil~, only the current buffer is considered (much
faster for massive, multi-file ledgers). Can also be a list of file paths (can
be relative to the current file).
* Troubleshooting * Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]] /There are no known problems with this module./ [[doom-report:][Report one?]]