Skip to content

About

为IntelliJ IDEA设计的代码格式化插件,支持在Git提交时自动格式化Java代码。插件提供灵活的格式化选择,支持Maven fmt插件和IDEA内置格式化两种方式。

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

IntelliJ IDEA 代码格式化插件

ReadMe Views

📖 插件简介

一个专为IntelliJ IDEA设计的代码格式化插件,支持在Git提交时自动格式化Java代码。插件提供灵活的格式化选择,支持Maven fmt插件和IDEA内置格式化两种方式。

✨ 核心特性

🎯 智能格式化

  • 提交时自动格式化 - 在Git提交前自动格式化Java代码
  • 双重格式化支持 - 支持Maven fmt插件和IDEA内置格式化
  • 智能降级机制 - Maven格式化失败时自动切换到IDEA格式化
  • 仅格式化变更文件 - 可选择只格式化正在提交的文件

⚙️ 灵活配置

  • 格式化方式选择 - 用户可选择优先使用的格式化方式
  • 自定义Maven命令 - 支持指定自定义Maven可执行文件路径
  • 自定义Maven目标 - 支持自定义Maven格式化目标(默认:com.coveo:fmt-maven-plugin:format)
  • 完全中文界面 - 所有设置界面和提示信息均为中文显示

📋 功能设置

基础设置

  1. ✅ 启用提交时代码格式化

    • 开启/关闭自动格式化功能
  2. 🔧 格式化方式选择

    • ⚪ 优先使用Maven fmt插件格式化
    • ⚪ 优先使用IDEA内置格式化
  3. 📁 仅格式化已更改的文件

    • 只格式化正在提交的文件(推荐开启)

高级设置

  1. 🛠️ 自定义Maven命令

    • 指定自定义Maven可执行文件路径
    • 留空使用系统默认Maven或IDEA配置的Maven
  2. 🎯 自定义Maven目标

    • 自定义Maven格式化目标命令
    • 默认值:com.coveo:fmt-maven-plugin:format
    • 可根据项目需要修改为其他格式化插件

🚀 安装指南

方式一:从文件安装(推荐)

  1. 下载插件文件:commit-fmt-1.0.0.jar
  2. 打开IntelliJ IDEA
  3. 菜单:File → Settings → Plugins
  4. 点击齿轮图标 → Install Plugin from Disk
  5. 选择下载的jar文件
  6. 重启IDEA

方式二:从插件市场安装

  • 在IDEA插件市场搜索"Commit Format"(如已发布)

⚙️ 配置步骤

  1. 打开设置

    • 菜单:File → Settings → Tools → 提交时代码格式化
  2. 基础配置

    • 勾选"启用提交时代码格式化"
    • 选择优先的格式化方式
  3. 高级配置(可选)

    • 设置自定义Maven命令路径
    • 设置自定义Maven格式化目标

💡 使用场景

场景1:Maven项目 + fmt插件

推荐配置:

  • ✅ 启用提交时代码格式化
  • ⚪ 优先使用Maven fmt插件格式化
  • 自定义Maven目标:com.coveo:fmt-maven-plugin:format

工作流程: 提交时自动使用Maven fmt插件格式化代码,确保代码风格统一。

场景2:普通Java项目

推荐配置:

  • ✅ 启用提交时代码格式化
  • ⚪ 优先使用IDEA内置格式化

工作流程: 提交时使用IDEA默认格式化(等同于Ctrl+Alt+L),保持代码整洁。

场景3:特殊Maven插件项目

推荐配置:

  • ✅ 启用提交时代码格式化
  • ⚪ 优先使用Maven fmt插件格式化
  • 自定义Maven目标:其他格式化插件:goal

工作流程: 使用项目特定的Maven格式化插件进行代码格式化。

🔧 技术特性

兼容性

  • ✅ 支持版本:IntelliJ IDEA 2024及以后版本
  • ✅ 文件类型:Java文件(.java)
  • ✅ 构建工具:Maven项目
  • ✅ 版本控制:Git

性能优化

  • 同步执行 - 确保格式化完成后才进行提交
  • 进程监听 - 真实监听Maven进程状态和退出码
  • 智能降级 - 自动处理Maven格式化失败情况
  • 批量处理 - 高效处理多文件格式化

安全特性

  • 线程安全 - 正确处理EDT线程和后台线程
  • 中断支持 - 支持用户取消格式化操作
  • 错误恢复 - 格式化失败时提供恢复选项

🛠️ 故障排除

常见问题

Q: 为什么格式化没有生效? A:

  1. 检查是否启用了"启用提交时代码格式化"选项
  2. 确认正在提交的文件包含Java文件
  3. 检查Maven配置是否正确(如选择Maven格式化)

Q: Maven格式化失败怎么办? A:

  1. 插件会自动降级到IDEA内置格式化
  2. 检查自定义Maven命令路径是否正确
  3. 确认自定义Maven目标格式是否正确

Q: 如何使用自定义格式化插件? A: 在"自定义Maven目标"中输入对应插件的goal,例如:

  • com.coveo:fmt-maven-plugin:format
  • com.spotify:fmt-maven-plugin:format
  • net.revelc.code.formatter:formatter-maven-plugin:format

Q: 插件支持其他语言吗? A: 当前版本仅支持Java文件格式化,未来版本可能会支持更多语言。

Q: 如何确认插件正在工作? A: 提交时会显示"正在格式化X个文件..."的进度提示,可通过此提示确认插件运行状态。

调试信息

如果遇到问题,可以查看IDEA的日志文件:

  • Windows: %USER_HOME%/.IntelliJIdea/system/log/idea.log
  • macOS: ~/Library/Logs/IntelliJIdea/idea.log
  • Linux: ~/.IntelliJIdea/system/log/idea.log

搜索关键词:[COMMIT-FMT] 或 MavenFmtService

📄 许可证

本项目采用 MIT 许可证,详见 LICENSE 文件。

🤝 贡献

欢迎提交Issue和Pull Request来帮助改进这个插件!

📞 支持

如有问题或建议,请通过以下方式联系:

  • 提交GitHub Issue
  • 发送邮件至开发者

享受自动化的代码格式化体验! 🎉

About

为IntelliJ IDEA设计的代码格式化插件,支持在Git提交时自动格式化Java代码。插件提供灵活的格式化选择,支持Maven fmt插件和IDEA内置格式化两种方式。

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages