基于GitHub模板创建公司多模块项目时如何自动重命名包名？

核心思路 #

JetBrains的IntelliJ插件模板通过setup脚本+占位符替换实现项目重命名，你需要修改模板内的占位符规则，固定com.companyname前缀，让脚本自动将templatename替换为新项目名。

具体操作步骤 #

1. 修改代码文件中的包名占位符

   • 遍历模板所有Java/Kotlin文件，将固定包名package com.companyname.templatename替换为package com.companyname.$PROJECT_NAME_LOWER$（$PROJECT_NAME_LOWER$代表转换为小写、符合Java包名规范的新项目名）。
   • 示例替换后模板代码：

     package com.companyname.$PROJECT_NAME_LOWER$
     

2. 调整源码目录结构

   • 将模板中src/main/kotlin/com/companyname/templatename目录重命名为src/main/kotlin/com/companyname/$PROJECT_NAME_LOWER$，保证目录名与包名占位符完全匹配。

3. 修改setup脚本的替换逻辑
   找到模板中的scripts/setup.py（或Gradle任务脚本），调整替换规则：

   • 替换原脚本中针对个人账号的包名匹配逻辑，改为识别com.companyname.templatename，将其替换为com.companyname.${NEW_PROJECT_NAME_LOWER}。
   • 添加目录重命名逻辑：将com/companyname/templatename目录批量重命名为com/companyname/${NEW_PROJECT_NAME_LOWER}。
   • 补充项目名格式转换：比如把GitHub项目名中的连字符-替换为下划线_或直接转为纯小写，确保符合Java包名规范。

4. 验证模板功能

   • 将修改后的模板推送到公司GitHub仓库并设置为Repository Template。
   • 用该模板创建新项目，检查包名是否自动更新为com.companyname.newprojectname，目录结构是否同步调整。

额外提示 #

• 如果模板用Gradle构建，可在gradle.properties中定义group=com.companyname、pluginName=${NEW_PROJECT_NAME}，让Gradle自动同步包名相关配置。
• 确保setup脚本拥有文件修改和目录重命名权限，避免因权限问题导致替换失败。

内容的提问来源于stack exchange，提问作者Vera Iureva