vsg 0.39

概述

vsg是在参与代码评审之后创建的。 代码中的一个真正问题被一个编码样式问题掩盖了。 为样式问题创建了一个查找，而忽略了真正的问题。 当重新检查代码时，发现了真正的问题。

根据您的流程，样式问题可能需要很长时间才能解决。

1. 创建查找/票据/问题
2. 处理查找/票据/问题
3. 修复
4. 验证修复程序

在样式问题上花费更少的时间会留下更多的时间来分析代码的实质。 这最终减少了执行代码检查的时间。 它还允许审阅者关注代码的实质内容。 这将产生更高质量的代码库。

主要优点

• 定义vhdl编码标准
• 使每个人都能看到编码标准
• 改进代码评审
• 快速使代码达到当前标准

vsg允许在部分或整个代码基上定义和强制代码的样式。 配置允许多个编码标准。

主要功能

• 命令行工具
  • 集成到连续集成流中
• 报告并修复发现的问题
  • 空白
    • 水平
    • 垂直
  • 大写和小写
  • 关键字对齐
  • 等等……
• 通过json或yaml配置文件完全可配置的规则
  • 禁用规则
  • 更改现有规则
  的行为
  • 变更执行阶段
• 本地化规则集
  • 使用python创建自己的规则
  使用现有规则作为模板
  • 完全集成到基本规则集中

安装

您可以通过pip获得最新版本的vsg。

pip install vsg

最新的开发版本可以克隆…

git clone https://github.com/jeremiah-c-leary/vhdl-style-guide.git

…然后在本地安装…

python setup.py install