sonar gherkin plugin

Sonarqube黄瓜小黄瓜分析仪

免责声明

我不想继续维护此插件。如果您想接管我，请随时使用我。

描述

此Sonarqube插件分析了黄瓜小黄瓜功能文件和：

• 计算指标：代码行，方案数量等。
• 检查各种指南，以通过40多次检查发现潜在的错误和代码气味
• 提供了写自己的支票的能力

用法

1. 下载并安装Sonarqube
2. 通过直接下载安装黄瓜小黄瓜插件。最新版本与Sonarqube 6.7+兼容。
3. 安装您最喜欢的扫描仪（Sonarqube扫描仪，Maven，Ant等）
4. 分析您的代码

小牛

您的功能文件可能不是位于源代码目录中，而是在测试目录中。默认情况下，Sonarqube没有分析这些测试目录。因此，您必须明确告诉Sonarqube还分析包含您功能文件的测试目录。

假设您项目的结构是：

 pom.xml
src
  |-- main
        |-- java
        |-- resources
  |-- test
        |-- java
        |-- resources
              |-- features
                    |-- my-feature.feature
                    |-- my-other-feature.feature
                                   
                

在您的POM文件中，您需要添加：

 <properties>
  <sonar.sources>pom.xml,src/main/java,src/main/resources,src/test/resources/features</sonar.sources>
</properties>  

自定义检查

您正在考虑新的有价值的规则吗？ 1.0版或更高版本提供了一个API来编写您自己的自定义检查。这里提供了带有详细说明的示例插件。如果您的自定义规则可能使社区受益，请随时创建一个拉动请求，以便使Cucumber Gherkin Analyzer中的规则可用。

您正在考虑可能使社区受益但没有时间或写作技巧的新规则？请随时创建一个问题，以考虑您的规则。

指标

语句

步骤数。

功能

场景和方案概述的数量。

课程

功能数量。

可用规则

• 应该处理“ FixMe”标签
• 应该处理“ todo”标签
• 所有评论应始终格式化
• 并且应使用前缀，而不是冗余给定/何时/然后使用前缀
• 字节订单标记（BOM）不应用于UTF-8文件
• 常见的给定步骤应添加到背景中
• 重复的步骤应删除
• 端线字符应保持一致
• 示例数据表应包含数据至少两个数据行
• 功能应以相同的语言编写
• 功能应具有描述
• 功能应该有名字
• 功能应该具有独特的名称
• 功能不应包含太多场景
• 不定义任何方案的功能应删除
• 文件名应该符合命名约定
• 文件应在结尾包含一个空的新线路
• 不定义任何功能的文件应删除
• 给定的步骤应遵循正则表达式
• 给定/何时/随时应按正确的顺序定义步骤
• 线不应以尾随空间结束
• 缺少数据表列应添加
• 非传递步骤应移出背景
• 仅使用白名单的标签
• 正则评论
• 方案应定义至少每个给定/时/何时/然后进行步骤类型
• 方案应该有名字
• 方案应该具有独特的名称
• 方案不应包含太多步骤
• 不定定义任何步骤的方案应删除
• 源代码应适当缩进
• 拼写错误应解决
• 星（*）步骤前缀不应使用
• 阶梯句子不应该太长
• 未知类型的步骤不应使用
• 制表字符不应使用
• 标签应在正确的级别定义
• 标签应遵守命名约定
• 标签不应设置在示例上
• 然后步骤应遵循正则表达式
• 每个情况时应该有一个单一
• 未使用的变量应删除
• 无用的标签应删除
• 何时应遵循正则表达式
• 措辞应保持业务层面