【亲测免费】 Verible 项目使用教程

1. 项目介绍

Verible 是一个由 Chips Alliance 开发的 SystemVerilog 开发者工具套件，包括解析器、风格检查器、格式化工具和语言服务器。Verible 的主要任务是解析 SystemVerilog（IEEE 1800-2017），适用于多种应用场景，如开发者工具。它支持解析未经预处理的源文件，适用于单文件应用，如风格检查和格式化。此外，Verible 还可以适应解析预处理的源文件，这是真实编译器和工具链所需要的。

2. 项目快速启动

安装

Verible 提供了适用于 Linux 和 Windows 的二进制版本，包括静态链接的二进制文件，适用于几乎所有 Linux 发行版。此外，Nix 提供了适用于 Linux x86 和 Arm 的二进制文件，Homebrew 提供了适用于 MacOS 的包。

如果你更喜欢本地构建和安装二进制文件，可以按照以下步骤操作：

1. 安装 Bazel（版本 >= 5.0 且 <= 7）和 C++17 兼容的编译器（如 g++ >= 10）以及 Python3。
2. 克隆 Verible 仓库：

   git clone https://github.com/chipsalliance/verible.git
   cd verible
   

3. 构建所有工具和库：

   bazel build -c opt //...
   

4. 生成的二进制文件位于 bazel-bin/ 目录下。例如，语法检查器位于 bazel-bin/verilog/tools/syntax/verible-verilog-syntax。

使用示例

以下是一个简单的使用示例，展示如何使用 Verible 的语法检查器：

# 检查单个文件的语法
bazel-bin/verilog/tools/syntax/verible-verilog-syntax path/to/your/file.sv

3. 应用案例和最佳实践

应用案例

Verible 广泛应用于 SystemVerilog 项目的开发和维护中，特别是在以下场景：

• 风格检查：使用 verible-verilog-lint 工具自动检查代码风格，确保代码符合项目风格指南。
• 代码格式化：使用 verible-verilog-format 工具自动格式化代码，减少手动调整代码格式的工作量。
• 语言服务器：使用 verible-verilog-ls 语言服务器，在编辑器中提供实时语法检查和格式化功能。

最佳实践

• 集成到 CI/CD 流程：将 Verible 工具集成到项目的 CI/CD 流程中，确保每次提交的代码都符合项目风格指南。
• 使用外部配置文件：通过配置文件自定义风格检查规则和格式化选项，以适应项目的特定需求。
• 定期更新：定期更新 Verible 工具，以利用最新的功能和修复的 bug。

4. 典型生态项目

Verible 作为 SystemVerilog 开发者工具套件，与以下生态项目紧密结合：

• SymbiFlow：一个开源的 FPGA 工具链，使用 Verible 进行 SystemVerilog 代码的解析和验证。
• Kythe：一个源代码索引系统，Verible 提供了 Kythe 索引器，用于增强 IDE 的代码导航功能。
• Homebrew 和 Nix：提供了 Verible 的二进制包，方便在 MacOS 和 Linux 上快速安装和使用。

通过这些生态项目的支持，Verible 能够更好地服务于 SystemVerilog 开发者，提升开发效率和代码质量。