Full Moon 项目使用教程

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

Full Moon 是一个用 Rust 语言编写的 Lua 5.1 解析器，它能够将 Lua 代码转换成抽象语法树（AST），并且可以保留原始代码的样式、注释和空白字符。以下是项目的目录结构及介绍：

full-moon/
├── benches/                   # 性能测试相关文件
├── examples/                  # 示例代码
├── full-moon-derive/          # derive 宏相关文件
├── full-moon/                 # Full Moon 核心代码
├── editorconfig/              # Editor 配置文件
├── gitattributes/             # Git 属性配置文件
├── gitignore/                 # Git 忽略文件
├── Cargo.toml                 # Rust 项目配置文件
├── CHANGELOG.md               # 项目更新日志
├── GRAMMAR.md                 # 语法文档
├── LICENSE.md                 # 许可证文件
├── README.md                  # 项目说明文件
└── Rustfmt.toml               # Rustfmt 配置文件

• benches/: 包含性能测试代码，用于评估 Full Moon 的性能。
• examples/: 提供了一些如何使用 Full Moon 的示例代码。
• full-moon-derive/: 包含 derive 宏的实现，这些宏用于简化 AST 的创建。
• full-moon/: Full Moon 的核心代码，包括解析器和其他主要功能。
• editorconfig/: 用于定义编辑器设置的文件，以确保代码风格的一致性。
• gitattributes/: 用于配置 Git 如何处理文件和目录的属性。
• gitignore/: 指定 Git 应该忽略的文件和目录。
• Cargo.toml: Rust 项目配置文件，定义了项目的依赖、构建脚本等信息。
• CHANGELOG.md: 记录了项目的所有更新和更改历史。
• GRAMMAR.md: 描述了 Lua 语法和 Full Moon 如何处理这些语法的文档。
• LICENSE.md: 项目的许可证信息，本项目使用 MPL-2.0 许可证。
• README.md: 项目的说明文件，包含了项目的基本信息和如何使用。
• Rustfmt.toml: Rustfmt 配置文件，用于指定代码格式化的规则。

2. 项目的启动文件介绍

Full Moon 项目的启动主要是通过 Cargo.toml 文件中的配置来完成的。这个文件定义了项目的名称、版本、依赖库以及如何构建项目。以下是一个简化的 Cargo.toml 文件示例：

[package]
name = "full-moon"
version = "0.1.0"
edition = "2021"

[dependencies]

要启动项目，你需要确保安装了 Rust 和 Cargo，然后在项目根目录下运行以下命令：

cargo build

这会编译项目，生成可执行文件。然后你可以运行以下命令来启动项目：

cargo run

3. 项目的配置文件介绍

项目的配置主要是通过 Cargo.toml 文件进行的。在这个文件中，你可以添加依赖库、定义构建脚本、设置项目的元数据等。以下是一些常见的配置选项：

• name: 项目的名称。
• version: 项目的版本号。
• edition: Rust 语言的版本。
• [dependencies]: 项目的依赖库列表。

此外，项目还包含了一些其他配置文件，如 editorconfig、gitattributes 和 gitignore，它们分别用于配置编辑器行为、设置 Git 属性和定义 Git 忽略规则。

这些配置文件有助于维护代码风格的一致性，并确保构建和版本控制的流程顺畅。