Vale项目中正则表达式和脚本动作的建议功能实现解析

在Vale 3.7.0版本中，一个重要的功能改进是关于正则表达式(regex)和脚本动作(script actions)的建议功能实现。这个改进解决了之前版本中存在的功能限制，使得CLI用户也能获得与语言服务器(LSP)相同的建议体验。

功能背景

Vale作为一个文本校验工具，其核心功能包括：

1. 通过规则定义检测文本问题
2. 提供修改建议
3. 支持自动修复

在早期版本中，使用正则表达式或脚本动作时，虽然可以定义复杂的匹配和替换规则，但这些建议信息只能通过语言服务器(LSP)展示给IDE用户，而CLI用户无法看到具体的修改建议。

技术实现解析

正则表达式动作

典型的正则表达式动作配置如下：

extends: existence
message: "'%s' should be in kebab-case."
level: error
action:
  name: edit
  params:
    - regex
    - '(\w+)_(\w+)'
    - "$1-$2"
tokens:
  - '\w+_\w+'

在3.7.0版本之前，这个配置虽然能正确匹配文本并生成替换方案，但CLI输出中不会显示具体的替换建议("$1-$2")。

脚本动作

脚本动作(Tengo脚本)也存在类似情况：

action:
  name: suggest
  params:
    - chicken.tengo

脚本可以返回复杂的建议列表，但这些建议之前无法通过CLI展示给用户。

版本改进内容

Vale 3.7.0的主要改进包括：

1. 统一了CLI和LSP的建议输出机制
2. 使所有类型的动作(regex/script)都能在CLI中显示具体建议
3. 保持了与现有规则的向后兼容性

最佳实践建议

对于需要复杂替换规则的场景，现在可以：

1. 使用正则表达式处理模式匹配和组引用
2. 使用脚本动作实现复杂逻辑
3. 在message字段中通过%s占位符展示具体建议

例如：

message: "'%s'应该改为'%s'"

总结

这个改进使得Vale的功能更加完整，特别是在持续集成(CI)等CLI环境中，用户现在可以获得与IDE相同的建议体验。对于需要复杂文本替换的场景，开发者现在可以放心使用正则表达式和脚本动作，而不用担心建议信息无法传达给最终用户。

对于升级到3.7.0版本的用户，建议检查现有规则，充分利用这个新特性来提升用户体验。对于简单的替换场景，substitution扩展仍然是最简洁的选择；而对于需要复杂逻辑的场景，现在可以自由选择regex或script动作。