Skip to content

zhensherlock/intellij-platform-git-stats-plugin

Repository files navigation

GitStats IntelliJ Platform plugin promotional poster

GitStats

Git contribution statistics for IntelliJ Platform IDEs.

GitStats helps you understand code-writing activity in the current IDE project by reading Git history, grouping source code changes within a selected time range, and presenting author-level statistics in a tool window. It shows commit count, added lines, deleted lines, and modified files so you can quickly review project contribution activity without leaving the IDE.

GitStats 通过读取当前 IDE 项目的 Git 历史,按所选时间范围统计源码变更,并在工具窗口中展示作者维度的数据。它会呈现提交数、添加行数、删除行数和修改文件数,让你无需离开 IDE 就能快速了解项目贡献活跃度。

Why GitStats?

  • Review Git contribution activity directly in the IDE.
  • Filter statistics by start date and end date.
  • Compare authors by commits, added lines, deleted lines, and modified files.
  • Use Fast Summary mode for a quick ranking view, or Detailed mode when commit count is needed.
  • Exclude noisy paths such as generated files, build outputs, or vendor directories.

Installation

  • Marketplace:

    Install from JetBrains Marketplace, or open Settings/Preferences > Plugins > Marketplace, search for GitStats, then install the plugin.

  • Manual installation:

    Download the latest release, then install it with Settings/Preferences > Plugins > Install plugin from disk...

Usage

  1. Open a Git-backed project in an IntelliJ Platform IDE.
  2. Open the Git Stats tool window.
  3. Pick the start and end dates for the reporting range.
  4. Click Refresh to calculate the table.
  5. Use the settings action to switch between Fast Summary and Detailed, or set excluded paths.

Roadmap

See ROADMAP.md for planned feature work and optimization areas.

Development

Requirements:

  • JDK 21
  • IntelliJ IDEA 2024.2+ for local plugin development
  • Gradle Wrapper from this repository

Useful commands:

./gradlew runIde
./gradlew check
./gradlew buildPlugin
./gradlew verifyPlugin

The current source configuration targets IntelliJ Platform builds 242 through 261.*. Release artifacts are produced as GitStats plugin ZIP files under build/distributions/.


Built with the IntelliJ Platform Plugin Template.

Contributing

Feel free to dive in. Open an issue or submit a pull request.

Standard Readme follows the Contributor Covenant Code of Conduct.

Contributors

This project exists thanks to all the people who contribute.

License

MIT © MichaelSun