Herb 项目使用教程

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

Herb 项目是一个强大的 HTML 感知 ERB 解析和工具项目。以下是项目的目录结构及其简要介绍：

• bin/: 存放可执行脚本。
• docs/: 项目文档。
• examples/: 包含 Herb 使用的示例文件。
• ext/: 存放与 Herb 相关的扩展。
• lib/: Herb 的 Ruby 库代码。
• playground/: 供开发者测试和实验的代码。
• rakelib/: Rake 任务定义。
• src/: Herb 的源代码。
• templates/: HTML 和 ERB 模板文件。
• test/: 存放测试代码。
• wasm/: Herb 的 WebAssembly 相关文件。
• .clang-format, .clang-format-ignore, .clang-tidy: Clang 格式化配置文件。
• .gitattributes, .gitignore: Git 配置文件。
• .node-version, .ruby-version: 指定项目使用的 Node.js 和 Ruby 版本。
• Aptfile, Brewfile: 包含项目依赖的 Linux 和 macOS 包管理器文件。
• Doxyfile: Doxygen 文档生成配置。
• Gemfile, Gemfile.lock: Ruby 依赖管理文件。
• LICENSE.txt: 项目许可证。
• Makefile: 编译和构建项目的指令。
• Procfile: 用于部署应用的进程文件。
• README.md: 项目介绍和说明文件。
• Rakefile: Rake 任务文件。
• config.yml: 配置文件。
• herb.gemspec: Ruby 包的规范文件。
• nx.json, package.json, project.json, workspace.json: JavaScript 项目配置文件。
• yarn.lock: JavaScript 依赖锁定文件。

2. 项目的启动文件介绍

项目的启动主要通过 bin/ 目录下的脚本进行，例如 bin/integration 脚本。这个脚本用于清理目录，从零开始构建源代码，并运行所有的检查，包括 C 测试、Ruby 测试、语法检查和示例。

bin/integration

运行这个脚本后，如果看到输出 "Integration successful!"，则表示项目构建和测试成功。

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

• config.yml: 这是项目的核心配置文件，可以在这里配置项目相关的参数。
• .clang-format, .clang-format-ignore, .clang-tidy: 这些文件用于配置 Clang 格式化工具，对项目的 C/C++ 代码进行格式化和风格检查。
• .ruby-version: 指定项目所使用的 Ruby 版本，这对于确保 Ruby 代码兼容性至关重要。
• Gemfile: 用于配置 Ruby 的依赖包，Gemfile.lock 文件则用于锁定这些依赖的版本。

确保在开始工作前，根据项目需要调整这些配置文件。