TOML Toolkit - Tombi 项目启动与配置教程

1. 项目的目录结构及介绍

Tombi 项目是一个功能丰富的 TOML 工具包，包括格式化器、校验器和语言服务器。以下是项目的目录结构及各部分功能的简要介绍：

• crates: 存放项目的 Rust 库代码。
• docs: 项目文档。
• editors: 与编辑器相关的配置和插件。
• extensions: 扩展项目的代码和配置。
• python: 项目中的 Python 相关代码。
• rust: 项目中的 Rust 相关代码。
• schemas: 配置和模式定义。
• toml-test: TOML 测试文件。
• typescript: TypeScript 相关代码。
• xtask: 构建和任务执行脚本。
• .cargo: Cargo 的配置文件。
• .gitcommitrule: Git 提交信息规范。
• .gitignore: Git 忽略文件。
• .node-version: 指定项目使用的 Node.js 版本。
• .npmrc: npm 配置文件。
• .python-version: 指定项目使用的 Python 版本。
• Cargo.lock: Cargo 锁文件。
• Cargo.toml: Cargo 配置文件。
• DEVELOPMENT.md: 开发者指南。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• TODO.ja.md: 项目待办事项（日文）。
• biome.json: Biome 配置文件。
• clippy.toml: Clippy 配置文件。
• package.json: npm 包配置文件。
• pnpm-lock.yaml: pnpm 锁文件。
• pnpm-workspace.yaml: pnpm 工作区配置文件。
• pyproject.toml: Python 项目配置文件。
• sample.toml: 示例 TOML 文件。
• tombi.code-workspace: Visual Studio Code 工作区配置文件。
• tombi.schema.json: 语言服务器模式定义文件。
• tombi.toml: 语言服务器配置文件。
• toml.ungram: TOML 语法文件。
• type-test.toml: 类型测试文件。
• uv.lock: Python 虚拟环境锁文件。

2. 项目的启动文件介绍

项目的启动主要依赖于 Cargo.toml 文件，这是 Rust 项目的配置文件，其中定义了项目的依赖、构建脚本和元数据。

启动项目的基本步骤如下：

1. 克隆项目到本地：

   git clone https://github.com/tombi-toml/tombi.git
   

2. 进入项目目录：

   cd tombi
   

3. 构建项目：

   cargo build
   

4. 运行项目（如果存在可执行文件）：

   cargo run
   

3. 项目的配置文件介绍

项目的配置文件包括但不限于以下几项：

• Cargo.toml: Rust 项目配置文件，用于定义项目的名称、版本、作者、依赖等。
• .gitignore: 定义 Git 忽略的文件和目录。
• pyproject.toml: Python 项目配置文件，用于定义 Python 项目的依赖和构建脚本。
• tombi.schema.json: 语言服务器模式定义文件，用于定义语言服务器如何处理 TOML 文件。
• tombi.toml: 语言服务器配置文件，用于配置语言服务器的行为。

每个配置文件都有其特定的作用和配置方式，具体内容可以参考项目中的对应文件和官方文档。