BeanCount 语言服务器安装与配置指南

BeanCount 语言服务器安装与配置指南

beancount-language-serverA Language Server Protocol (LSP) for beancount files项目地址:https://gitcode.com/gh_mirrors/be/beancount-language-server

项目目录结构及介绍

在克隆下来的 beancount-language-server 仓库中，典型的目录结构大致如下：

• src: 核心源代码目录，包含了实现 Language Server Protocol (LSP) 的 Rust 代码。
• Cargo.toml: Rust 项目的元数据文件，定义了依赖项、版本信息以及构建指令。
• .gitignore: 指定了 Git 应忽略的文件或目录，以避免不必要的文件被纳入版本控制。
• README.md: 项目的主要文档，提供了快速入门指导、安装步骤和其他重要信息。
• LICENSE: 许可证文件，声明了项目遵循的 MIT 开源许可证。

这个项目是一个为 Beancount 文件提供支持的语言服务器，通过 LSP 协议与其他编辑器集成，提供语法高亮、诊断、格式化等功能。

项目启动文件介绍

主要的启动脚本是通过 Rust 编程语言编译得到的可执行文件，通常命名为 beancount-language-server。这一程序是由 src/main.rs 主入口点编译而来。用户无需直接操作源代码来启动服务，而是通过以下命令来运行它：

beancount-language-server

要使该服务器工作，你需要先通过 Cargo 安装它：

cargo install beancount-language-server

或者，如果你使用的是 macOS，可以利用 Homebrew 进行安装：

brew install beancount-language-server

项目的配置文件介绍

全局配置

对于编辑器集成来说，配置通常不是直接在 beancount-language-server 端进行的，而是需要在你的编辑器配置文件中指定如何与之交互。例如，在 Neovim 中，你可能需要通过 LSP 配置插件（如 lspconfig）设置以下内容：

local lspconfig = require 'lspconfig'
lspconfig.beancount_rs.setup({
    cmd = { "beancount-language-server" },
    filetypes = { "beancount" },
    root_dir = lspconfig.util.find_git_ancestor,
})

语言服务器特定配置

在某些场景下，你可能需要配置语言服务器本身的行为，比如指向你的 Beancount 日记文件路径。这通常不在 beancount-language-server 的启动命令直接完成，而是在编辑器的配置中指定，或者使用特定于编辑器的方式处理。例如，通过 .toml 配置文件指定 journal_file：

[language-server]
command = "beancount-language-server"
args = ["--stdio"]
config
    journal_file = "<path to journal file>"
[[language]]
name = "beancount"
language-servers = [
    { name = "beancount-language-server" }
]

请依据你所使用的编辑器和相关的 LSP 插件文档，适当调整这些配置项。

beancount-language-serverA Language Server Protocol (LSP) for beancount files项目地址:https://gitcode.com/gh_mirrors/be/beancount-language-server