jonchan51/vscode-beancount

VSCode extension for Beancount

VSCode-Beancount

VSCode extension for the text-based double-entry accounting tool Beancount

Features

1. Syntax highlight (syntax file from draug3n/sublime-beancount)
2. Decimal point alignment
3. Auto-completion of account names, payees, and narrations
4. Auto balance checking after saving files
5. Hovers with account balances.
6. Code snippets (@vlamacko)
7. Region folding - use indentation (#5), or special comments (#11). For org-mode style folding see vscode-org-fold
8. (Experimental) Use Pinyin initial letters to input existing Chinese narrations and payees quickly. 使用拼音首字母快速输入现有的中文受款人和描述 。See details.

Extension Settings

This extension contributes the following settings:

• beancount.separatorColumn: specify the column of the decimal separator.
• beancount.instantAlignment: Set it to true to align the amount (like 1.00 BTC) once a decimal point is inserted.
• beancount.completePayeeNarration: Controls whether the auto completion list should include payee and narration fields.
• beancount.mainBeanFile: If you are splitting beancount files into multiple files, set this value to either the full path or the relative path to your main bean file so that this extension can get all account information. If it is left blank, the extension will consider the file in the current window as the main file.
• beancount.runFavaOnActivate: If it is set to true, fava will run once this extension is activated.
• beancount.favaPath: Specify the path of Fava if Fava is not installed in the main Python installation.
• beancount.python3Path: Specify the path of Python if beancount is not installed in the main Python installation.
• beancount.fixedCJKWidth: Set to true to treat CJK aka East Asian characters as two letters width on alignment.
• beancount.inputMethods: List the input methods for auto-completion of payees and narrations with CJK characters. Currently only pinyin is supported. See details.

Recommended practices

0. Make sure you installed Python3 and beancount. Set beancount.python3Path to the correct path.
1. Split your ledger into several .bean files according to time and put all your open/close in a main file.
2. Include all other files in the main file by the include command in the main bean file.
3. Open BeanFolder with VSCode and set beancount.mainBeanFile to the full path of main.bean in the current Workspace Settings.

For example, the file structure of your directory looks like this

BeanFolder
├── .vscode
│   └── settings.json
├── main.bean
├── before2017.bean
├── 2017-01.bean
└── 2017-02.bean

If you open .vscode/settings.json, you should see something like this:

{
  "beancount.mainBeanFile": "main.bean"
}

Now once BeanFolder is opened as a workspace in VSCode, this extension will be able to invoke beancount to check errors and calculate balances.

Known Issues

see GitHub issue page

Release Notes

0.11.0

• Allow syntax highlight in markdown @hotshotxwl
• Support opening files from 'include' directive by adding DocumentLinkProvider @mengqi92
• Add org-mode-fold to README.md @dumbPy
• oneliner version syntx with file suffix .beancount.oneline or .bean.oneline. @Akuukis

0.10.0

• New icon @pluwen

0.9.1

• "Input Method" Support on Account Name @zinc0x1E
• Do not create fava terminal as default, fix #77