PolyglotPiranha社区贡献指南：如何添加新的清理规则
项目地址: https://gitcode.com/gh_mirrors/pi/piranha PolyglotPiranha是一款专注于特性标志API代码重构的强大工具，它能够帮助开发者高效地清理代码中与特性标志相关的冗余部分。本指南将详细介绍如何为PolyglotPiranha添加新的清理规则，让你轻松成为社区贡献者。
了解清理规则的基本结构
在开始添加新的清理规则之前，首先需要了解PolyglotPiranha中清理规则的基本结构。清理规则主要由规则定义和边缘定义两部分组成，它们通常以TOML格式存储在项目的特定目录中。
规则定义文件（rules.toml）包含了具体的匹配模式和替换操作，而边缘定义文件（edges.toml）则用于指定规则之间的依赖关系和执行顺序。这些文件的存放路径因编程语言而异，例如Java的清理规则存放在crates/core/src/cleanup_rules/java/目录下。
准备工作：环境搭建与仓库克隆
要为PolyglotPiranha贡献新的清理规则，首先需要搭建开发环境并克隆项目仓库。
- 克隆仓库：
git clone https://gitcode.com/gh_mirrors/pi/piranha
- 进入项目目录：
cd piranha
- 根据项目的Cargo.toml文件安装所需的依赖。
创建新的清理规则文件
根据你要支持的编程语言，在相应的清理规则目录下创建新的规则文件。例如，如果你要添加Go语言的清理规则，可以在crates/core/src/cleanup_rules/go/目录下创建新的rules.toml和edges.toml文件。
规则定义（rules.toml）
在rules.toml文件中，你需要定义规则的名称、匹配模式、替换内容以及其他相关属性。以下是一个简单的规则示例：
[[rules]]
name = "remove_unused_feature_flag"
match = "if (featureFlag.isEnabled(\"{flag_name}\"))"
replace = ""
scope = "function"
边缘定义（edges.toml）
edges.toml文件用于定义规则之间的执行顺序和依赖关系。例如：
[[edges]]
from = "detect_feature_flag"
to = "remove_unused_feature_flag"
编写规则逻辑
编写规则逻辑是添加新清理规则的核心步骤。你需要根据具体的代码模式和清理需求，设计合适的匹配模式和替换操作。
匹配模式
匹配模式可以使用正则表达式或结构化模式。对于简单的代码模式，正则表达式可能足够；而对于复杂的代码结构，建议使用结构化模式，以提高匹配的准确性。
替换操作
替换操作可以是简单的文本替换，也可以是更复杂的代码转换。你可以使用捕获组来引用匹配到的内容，并在替换文本中进行灵活的处理。
测试新的清理规则
添加新的清理规则后，必须进行充分的测试以确保其正确性和有效性。
-
在crates/core/test-resources/目录下为新规则创建测试用例，包括输入文件和预期输出文件。
-
运行测试命令，验证新规则的执行效果：
cargo test
提交贡献
完成新规则的编写和测试后，就可以提交你的贡献了。
- 将你的修改提交到本地仓库：
git add .
git commit -m "Add new cleanup rule for {language}: {rule_name}"
- 推送到远程仓库并创建Pull Request，等待社区审核。
通过以上步骤，你就可以成功为PolyglotPiranha添加新的清理规则，为项目的发展贡献自己的力量。希望本指南对你有所帮助，期待你的精彩贡献！ 🚀
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
