beancount-language-server 0.1.0

Table of Contents

• Installation
  • Alternative: Compile and install from source
• Requirements
• Configuration
• Features
• Server Settings
• Editor Support
  • Neovim
    • Troubleshooting
    • beancount file type not detected
  • VS Code
  • Vim
  • Emacs
• Contributing

Installation

TODO: create VS Code extension to run this language server

The server can be installed via npm (or from source).

npm install -g @bryall/beancount-langserver

Then, you should be able to run the language server with the following command:

beancount-langserver

Follow the instructions below to integrate the language server into your editor.

Alternative: Compile and install from source

First, clone this repo and compile it. npm link will add beancount-langserver to the PATH.

git clone git@github.com:bryall/beancount-langserver.git
cd beancount-langserver
npm install
npm run compile
npm link

Requirements

You will need to install beancount to get all diagnostics.

pip install -g beancount

Configuration

TODO

Features

Supports Beancount v2

Server Settings

This server contributes the following settings:

Settings may need a restart to be applied.

Editor Support

Neovim

The settings for the language server are in the lspconfig repo

1. Install the beancount language server

   npm install -g beancount-langserver
   

   However you install it, you need to remember how to access the binary

2. Create a lua lspconfig for the beancount LSP example in my dotfiles

   • add the following code to your lspconfig

   local lspconfig = require 'lspconfig'
   lspconfig.beancount.setup= {
       init_options = {
           journal_file = "<path to journal file>",
       };
   };
   

3. Open a beancount file and verify LSP connected with the LSPInfo command

Troubleshooting

beancount file type not detected

If you notice beancount files not having the "beancount" type, you need a neovim v0.5 or master built after Feb 17, 2021

If not the following in a file named beancount.vim in the ftdetect folder

function! s:setf(filetype) abort
    if &filetype !=# a:filetype
        let &filetype = a:filetype
    endif
endfunction

au BufNewFile,BufRead *.bean,*.beancount call s:setf('beancount')

VS Code

Plan to make a VS Code extesion in the future

Vim

Tested and Developed on Neovim v0.5 (master branch)

SETUP TODO

Emacs

TODO

Contributing

Please do :)