Sqlfluff自定义规则L100未被识别，求助配置方法及插件疑问

核心排查与修复步骤 #

• 确认规则类的命名与注册规范
  你的L100.py必须包含符合Sqlfluff要求的规则类：

  from sqlfluff.core.rules import BaseRule, LintResult, RuleContext
  from sqlfluff.core.rules.crawlers import SegmentSeekerCrawler
  
  class Rule_L100(BaseRule):
      """自定义规则的描述信息"""
      name = "L100"
      groups = ("custom",)
      # 根据你的规则检测目标调整crawler，比如检测select语句就用下面的配置
      crawler = SegmentSeekerCrawler({"select_statement"})
  
      def _eval(self, context: RuleContext) -> LintResult:
          # 这里写你的规则逻辑
          # 示例：如果需要标记某个段，返回LintResult(context.segment)
          return LintResult()
  

  关键要求：类名必须是Rule_<规则ID>（这里就是Rule_L100），name字段要和规则ID完全一致。

• 修正.sqlfluff配置
  确保配置文件中正确指定自定义规则路径并启用规则：

  [sqlfluff]
  # 指向自定义规则所在的目录，确保是当前工作目录下的相对路径或绝对路径
  custom_rules_path = sqlfluff_custom_rules
  # 明确启用你的规则
  rules = L100
  
  [sqlfluff:rules]
  L100 = enable
  

• 验证规则加载状态
  运行lint命令时添加--verbose参数，查看日志中是否扫描到了你的规则目录：

  sqlfluff lint models/intermediate/any_model.sql --dialect redshift --rules L100 --verbose
  

  如果日志里没有出现sqlfluff_custom_rules的扫描记录，说明路径配置错误，需要调整custom_rules_path为正确的路径。

关于插件的疑问 #

不需要必须实现为插件。本地自定义规则只要路径配置正确、规则类符合Sqlfluff的规范，就能被直接加载。插件只是用于打包共享规则的场景，本地团队内部使用直接配置custom_rules_path即可。

额外排查点 #

• 确保规则文件名与规则ID匹配：L100.py对应规则IDL100，Sqlfluff会自动扫描目录下以规则ID命名的文件。
• 检查Python环境：如果自定义规则目录不在当前工作目录，可临时将父目录加入PYTHONPATH：

  export PYTHONPATH=$PYTHONPATH:/path/to/the/folder-containing-sqlfluff_custom_rules
  

  再重新运行lint命令测试。

内容的提问来源于stack exchange，提问作者Deison Osorio