Beancount Language Server 项目教程

Beancount Language Server 项目教程

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

1. 项目目录结构及介绍

Beancount Language Server 项目的目录结构如下：

beancount-language-server/
├── crates/
│   └── lsp/
├── python/
├── vscode/
├── envrc
├── gitignore
├── gitmodules
├── release-please-manifest.json
├── vscodeignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── README.md
├── SECURITY.md
├── cliff.toml
├── flake.lock
├── flake.nix
├── rust-toolchain.toml
├── rustfmt.toml

目录结构介绍

• crates/: 包含与语言服务器相关的 Rust 代码。
  • lsp/: 语言服务器协议的实现代码。
• python/: 包含与 Beancount 相关的 Python 代码。
• vscode/: 包含与 Visual Studio Code 扩展相关的代码。
• envrc: 环境配置文件。
• gitignore: Git 忽略文件配置。
• gitmodules: Git 子模块配置。
• release-please-manifest.json: 发布相关配置文件。
• vscodeignore: Visual Studio Code 忽略文件配置。
• CHANGELOG.md: 项目变更日志。
• CONTRIBUTING.md: 贡献指南。
• Cargo.lock: Rust 项目依赖锁定文件。
• Cargo.toml: Rust 项目配置文件。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• SECURITY.md: 安全相关说明。
• cliff.toml: 发布工具配置文件。
• flake.lock: Nix 依赖锁定文件。
• flake.nix: Nix 配置文件。
• rust-toolchain.toml: Rust 工具链配置文件。
• rustfmt.toml: Rust 格式化配置文件。

2. 项目启动文件介绍

项目的启动文件主要是 crates/lsp/src/main.rs，这是 Beancount Language Server 的主入口文件。该文件负责初始化语言服务器并启动服务。

启动文件功能

• 初始化语言服务器: 加载配置并启动 LSP 服务。
• 处理客户端请求: 处理来自编辑器的各种请求，如代码补全、格式化、诊断等。
• 与 Beancount 集成: 调用 Beancount 的相关功能，如语法检查、账户建议等。

3. 项目配置文件介绍

项目的配置文件主要包括以下几个：

3.1 Cargo.toml

Rust 项目的配置文件，定义了项目的依赖、构建选项等。

[package]
name = "beancount-language-server"
version = "0.1.0"
edition = "2021"

[dependencies]
lsp-types = "0.92.0"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
tokio = { version = "1", features = ["full"] }

3.2 rust-toolchain.toml

Rust 工具链配置文件，指定了使用的 Rust 版本。

[toolchain]
channel = "stable"

3.3 rustfmt.toml

Rust 代码格式化配置文件，定义了代码格式化的规则。

max_width = 100
edition = "2021"

3.4 flake.nix

Nix 配置文件，用于定义项目的开发环境。

{
  description = "Beancount Language Server";

  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
  };

  outputs = { self, nixpkgs }: {
    devShell = nixpkgs.mkShell {
      buildInputs = [
        nixpkgs.rustup
        nixpkgs.cargo
      ];
    };
  };
}

3.5 release-please-manifest.json

发布相关配置文件，定义了发布流程和版本管理规则。

{
  "release-type": "rust",
  "bump-minor-pre-major": true,
  "bump-patch-for-minor-pre-major": true,
  "draft": false,
  "prerelease": false
}

通过以上配置文件，可以对 Beancount Language Server 项目进行构建、测试和发布。

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