Skip to content

Commit fa30514

Browse files
committed
languages/beancount: init
Create the `vim.languages.beancount` module using `bean-format` and `beancount-language-server`.
1 parent 8b98f07 commit fa30514

File tree

4 files changed

+107
-0
lines changed

4 files changed

+107
-0
lines changed

configuration.nix

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ isMaximal: {
7575
# Language modules that are not as common.
7676
assembly.enable = false;
7777
astro.enable = false;
78+
beancount.enable = false;
7879
nu.enable = false;
7980
csharp.enable = false;
8081
julia.enable = false;

docs/release-notes/rl-0.8.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -538,8 +538,11 @@
538538
[gmvar](https://github.com/gmvar):
539539

540540
[harper-ls]: https://github.com/Automattic/harper
541+
[beancount-language-server]: https://github.com/polarmutex/beancount-language-server
542+
[bean-format]: https://github.com/beancount/beancount
541543

542544
- Add [harper-ls] to the `vim.lsp` module.
545+
- Add beancount support under `vim.languages.beancount` using [beancount-language-server] and [bean-format].
543546

544547
[derethil](https://github.com/derethil):
545548

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
{
2+
config,
3+
pkgs,
4+
lib,
5+
...
6+
}: let
7+
inherit (builtins) attrNames;
8+
inherit (lib.options) mkOption mkEnableOption;
9+
inherit (lib.meta) getExe';
10+
inherit (lib.modules) mkIf mkMerge;
11+
inherit (lib.types) enum package ;
12+
inherit (lib.nvim.types) mkGrammarOption singleOrListOf;
13+
inherit (lib.nvim.attrsets) mapListToAttrs;
14+
15+
cfg = config.vim.languages.beancount;
16+
17+
defaultServers = "beancount-language-server";
18+
servers = {
19+
beancount-language-server = {
20+
rootmarkers = [".git"];
21+
filetypes = ["beancount" "bean"];
22+
cmd = [(getExe' pkgs.beancount-language-server "beancount-language-server")];
23+
};
24+
};
25+
26+
defaultFormat = "bean-format";
27+
formats = {
28+
bean-format = {
29+
package = pkgs.beancount;
30+
};
31+
};
32+
in {
33+
options.vim.languages.beancount = {
34+
enable = mkEnableOption "Beancount language support";
35+
36+
treesitter = {
37+
enable = mkEnableOption "Beancount treesitter support" // {default = config.vim.languages.enableTreesitter;};
38+
package = mkGrammarOption pkgs "beancount";
39+
};
40+
41+
lsp = {
42+
enable = mkEnableOption "Beancount LSP support" // {default = config.vim.lsp.enable;};
43+
44+
servers = mkOption {
45+
type = singleOrListOf (enum (attrNames servers));
46+
default = defaultServers;
47+
description = ''
48+
Beancount LSP server to use.
49+
50+
::: {.note}
51+
'beancount-language-server' requires 'bean-check' and 'bean-format'.
52+
Both are provided by 'pkgs.beancount'. These binaries must be in
53+
your PATH or in 'vim.extraPackages'. There are no additional checks
54+
to verify if this requirement is met.
55+
:::
56+
'';
57+
};
58+
};
59+
60+
format = {
61+
enable = mkEnableOption "Beancount formatting" // {default = config.vim.languages.enableFormat;};
62+
63+
type = mkOption {
64+
type = enum (attrNames formats);
65+
default = defaultFormat;
66+
description = "Beancount formatter to use";
67+
};
68+
69+
package = mkOption {
70+
type = package;
71+
default = formats.${cfg.format.type}.package;
72+
description = "Beancount formatter package";
73+
};
74+
};
75+
};
76+
77+
config = mkIf cfg.enable (mkMerge [
78+
(mkIf cfg.treesitter.enable {
79+
vim.treesitter.enable = true;
80+
vim.treesitter.grammars = [cfg.treesitter.package];
81+
})
82+
83+
(mkIf cfg.lsp.enable {
84+
vim.lsp.servers =
85+
mapListToAttrs (n: {
86+
name = n;
87+
value = servers.${n};
88+
})
89+
cfg.lsp.servers;
90+
})
91+
92+
(mkIf cfg.format.enable {
93+
vim.formatter.conform-nvim = {
94+
enable = true;
95+
setupOpts.formatters_by_ft.beancount = [cfg.format.type];
96+
setupOpts.formatters.${cfg.format.type} = {
97+
command = getExe' cfg.format.package cfg.format.type;
98+
};
99+
};
100+
})
101+
]);
102+
}

modules/plugins/languages/default.nix

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ in {
66
./asm.nix
77
./astro.nix
88
./bash.nix
9+
./beancount.nix
910
./cue.nix
1011
./dart.nix
1112
./clang.nix

0 commit comments

Comments
 (0)