Rust Sitter 项目教程

Rust Sitter 项目教程

1. 项目目录结构及介绍

Rust Sitter 项目的目录结构如下：

rust-sitter/
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── README.md
├── release.toml
├── src/
│   ├── common/
│   ├── example/
│   ├── macro/
│   ├── runtime/
│   └── tool/
└── github/
    └── workflows/

目录结构介绍

• Cargo.lock: 这是 Cargo 工具生成的文件，用于锁定依赖库的版本。
• Cargo.toml: 这是 Rust 项目的配置文件，包含了项目的元数据和依赖项。
• LICENSE: 项目的许可证文件，本项目使用 MIT 许可证。
• README.md: 项目的说明文档，包含了项目的概述、安装和使用说明。
• release.toml: 项目的发布配置文件，可能包含了一些发布相关的配置。
• src/: 这是项目的源代码目录，包含了项目的核心代码。
  • common/: 包含了一些通用的代码模块。
  • example/: 包含了一些示例代码，展示了如何使用 Rust Sitter。
  • macro/: 包含了一些宏定义，用于生成解析器和类型安全的绑定。
  • runtime/: 包含了运行时相关的代码，可能是解析器的运行时支持。
  • tool/: 包含了一些工具代码，可能是用于构建解析器的工具。
• github/workflows/: 包含了 GitHub Actions 的工作流配置文件，用于自动化 CI/CD。

2. 项目启动文件介绍

Rust Sitter 项目的启动文件是 src/main.rs。这个文件是项目的入口点，负责初始化项目并启动解析器。

src/main.rs 文件内容

fn main() {
    println!("cargo:rerun-if-changed=src");
    rust_sitter_tool::build_parsers(&PathBuf::from("src/main.rs"));
}

启动文件介绍

• main 函数: 这是 Rust 项目的入口函数，负责打印一条消息并调用 rust_sitter_tool::build_parsers 函数来构建解析器。
• build_parsers 函数: 这个函数用于编译和链接生成的 Tree Sitter 解析器。

3. 项目的配置文件介绍

Rust Sitter 项目的主要配置文件是 Cargo.toml。这个文件包含了项目的元数据、依赖项和其他配置信息。

Cargo.toml 文件内容

[package]
name = "rust-sitter"
version = "0.4.3"
authors = ["Your Name <your.email@example.com>"]
edition = "2018"

[dependencies]
rust-sitter = "0.4.3"

[build-dependencies]
rust-sitter-tool = "0.4.3"

配置文件介绍

• [package]: 这部分定义了项目的元数据，包括项目名称、版本号、作者和 Rust 版本。
• [dependencies]: 这部分定义了项目的依赖项，rust-sitter 是项目的主要依赖。
• [build-dependencies]: 这部分定义了构建时依赖项，rust-sitter-tool 是用于构建解析器的工具。

通过这些配置，Rust Sitter 项目能够正确地构建和运行，生成高效的解析器。