beancount-langserver

A Language Server Protocol (LSP) for beancount files

Table of Contents

Installation
- Alternative: Compile and install from source
Requirements
Configuration
Features
Server Settings
Editor Support
- 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

Feature	Description
diagnostics	Provided via `beancoubt`
formatting	Should generate edits silimar to `bean-format`
completions	Show completions for Payees, Accounts, Date
definitions	Planned for future release
folding	Planned for future release
hover	Planned for future release
rename	Planned for future release

Server Settings

This server contributes the following settings:

Settings may need a restart to be applied.

Editor Support

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 :)