TurboBean

An implementation of Beancount with a focus on speed and ease of use.

Features

Speed (processes huge files instantly)
LSP Server
Jump to account open
Hover account (before + after balance)
Auto completion (accounts, tags, links)
Highlight account
Syntax highlighting via semantic tokens
Rename account
Web Viewer
File Watcher (reloads instantly)
Journal
Balance Sheet
Income Statement
Lua Plugins
Formatter
Protobuf Output

Not Planned (for now)

• Query Language

Compatibility

Mostly compatible with Beancount, but follows some ideas from Beancount Vnext: Goals & Design, notably Beancount - Vnext: Booking Rules Redesign. This is currently implemented in a non-backwards-compatible way.

Todos

Lexer

Parser

• Validate accounts
• Number expressions
• KeyValue
  • Value = Amount
• Custom
• Commodity directive

Renderer

LSP

Highlight

• Tags
• Links

Sem Tokens

• Range

Beancount

UI

• Display more while there are still errors

Bugs

• Balancing algo doesn't see ambiguity (only substitutes EUR): Foo 1 EUR @ Bar
• Segfault when two sse connections and watch triggers

Editor Setup

neovim

Put this into your nvim-lspconfig's config function:

    local lspconfig = require 'lspconfig'
    require('lspconfig.configs').turbobean = {
      default_config = {
        cmd = {
          'bash',
          '-c',
          '/Users/moritz/code/turbobean/zig-out/bin/turbobean --lsp 2> >(tee turbobean.log >&2)',
        },
        filetypes = { 'beancount', 'bean' },
        root_dir = require('lspconfig.util').root_pattern 'turbobean.config',
      },
    }
    lspconfig.turbobean.setup {}

Disable treesitter:

return {
  'nvim-treesitter/nvim-treesitter',
  opts = {
    highlight = {
      enable = true,
      disable = { 'beancount' },
    },
  },
}

VSCode

Use extension in this repo.

cd vscode
npm i
code .

Then press F5, or go to debugging and click "Run Extension".

Testing

npm i
npm run test

Scratch

Pipeline

File:

• Balance (tx level)

Project:

• Sort (project level)
• Check:
  • Accounts properly opened/not closed (project level)
  • Insert pads (project level)
  • Can only post to currencies defined at account open (project level)
  • Booking rules followed

Process:

• Insert PnL postings (project level)

Query:

• Inventory until posting