# diff-coverage-idea-plugin

**Repository Path**: weikebing/diff-coverage-idea-plugin

## Basic Information

- **Project Name**: diff-coverage-idea-plugin
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-18
- **Last Updated**: 2024-09-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# diff-coverage-idea-plugin

![Build](https://github.com/SurpSG/diff-coverage-idea-plugin/workflows/Build/badge.svg)
[![Version](https://img.shields.io/jetbrains/plugin/v/16403-diff-coverage.svg)](https://plugins.jetbrains.com/plugin/16403-diff-coverage)
[![Downloads](https://img.shields.io/jetbrains/plugin/d/16403-diff-coverage.svg)](https://plugins.jetbrains.com/plugin/16403-diff-coverage)

## Installation

- Using IDE built-in plugin system:

  <kbd>Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "diff-coverage-idea-plugin"</kbd> >
  <kbd>Install Plugin</kbd>

- Manually:

  Download the [latest release](https://github.com/SurpSG/diff-coverage-idea-plugin/releases/latest) and install it manually using
  <kbd>Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>

## How to use
* Create or open gradle project
* Apply and setup [DiffCoverage Gradle plugin](https://github.com/form-com/diff-coverage-gradle)
* Make some changes to your code and run tests to collect coverage info
* Set up Diff Coverage run configuration
  
  ![Diff Coverage run configuration](imgs/diff-run-config.png)

<!-- Plugin description -->

<!-- Plugin description end -->

## How it works
Diff coverage IDEA plugin:
* detects a module to which [DiffCoverage Gradle plugin](https://github.com/form-com/diff-coverage-gradle) is applied and collects settings
* Analyzes coverage of uncommited code
* Displays coverage panel for uncommited code and shows a balloon with coverage stats
* Displays coverage for uncommited code in the project view and in code editor

  ![Diff Coverage report view](imgs/coverage-view.png)
  ![Diff Coverage project view](imgs/project-view.png)