Semgrep规则优化：如何精确匹配未添加文档字符串的Julia浮点常量

在Julia语言的静态代码分析实践中，我们经常需要检查代码是否符合特定的文档规范。本文将通过一个实际案例，深入探讨如何优化Semgrep规则，使其能够精确识别未添加文档字符串的浮点常量定义。

问题背景

在ASML的Julia编码规范中，要求所有浮点常量必须附带文档字符串说明。我们需要创建一个Semgrep规则来检查这一规范是否被遵守。原始测试代码包含两个模块：BadStyle（不符合规范）和GoodStyle（符合规范）。

初始规则设计

最初的规则尝试使用以下模式组合：

patterns:
  - pattern: $EXPR
  - pattern-not: |-
      "$DOCSTRING"
      $EXPR

这个设计意图是匹配所有常量表达式（$EXPR），但排除那些前面有文档字符串的情况。然而实际执行时，规则会错误地标记符合规范的常量定义。

问题分析

核心问题在于对pattern-not的理解偏差。pattern-not要求整个匹配结果不符合指定模式，而不是排除包含特定结构的匹配。在Julia中，常量定义本身（$EXPR）永远不会等于"文档字符串后跟常量定义"的模式，因此pattern-not实际上没有起到过滤作用。

解决方案

正确的做法是使用pattern-not-inside，它检查匹配结果是否不包含在指定模式中。修改后的规则如下：

patterns:
  - pattern: $EXPR
  - pattern-not-inside: |-
      "$DOCSTRING"
      $EXPR

这个改进后的规则会：

1. 首先匹配所有常量定义表达式
2. 然后排除那些被文档字符串包裹的常量定义

技术要点

1. 模式匹配范围：pattern-not检查整个匹配结果，而pattern-not-inside检查匹配结果是否出现在特定结构中
2. Julia语法特性：Julia的文档字符串位于被注释对象的上方，这种位置关系需要用"inside"语义来捕获
3. 浮点数识别：规则需要特别关注Float类型的常量，可以通过类型注解或数值格式来识别

最佳实践建议

1. 对于位置敏感的代码模式，优先考虑使用*-inside系列操作符
2. 编写规则时，应该创建包含各种边界条件的测试用例
3. 对于Julia这种灵活的语言，需要考虑多种常量定义方式（有/无类型注解、不同数值表示法等）

通过这个案例，我们不仅解决了具体的规则编写问题，更重要的是理解了Semgrep模式匹配操作符的细微差别，这对编写其他静态分析规则也有重要参考价值。