https://github.com/tmr232/jb-function-graph-overview

Control-Flow Graph (CFG) Visualizer for JetBrains IDEs
https://github.com/tmr232/jb-function-graph-overview

clion-plugin control-flow-graph goland-plugin jetbrains-plugin pycharm-plugin visualization

Last synced: 4 months ago
JSON representation

Control-Flow Graph (CFG) Visualizer for JetBrains IDEs

• Host: GitHub
• URL: https://github.com/tmr232/jb-function-graph-overview
• Owner: tmr232
• License: mit
• Created: 2024-10-12T18:50:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-17T09:51:09.000Z (over 1 year ago)
• Last Synced: 2025-01-28T01:53:31.362Z (over 1 year ago)
• Topics: clion-plugin, control-flow-graph, goland-plugin, jetbrains-plugin, pycharm-plugin, visualization
• Language: Kotlin
• Homepage: https://tmr232.github.io/function-graph-overview/
• Size: 3.58 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Function Graph Overview (for JetBrains IDEs)

![Build](https://github.com/tmr232/jb-function-graph-overview/workflows/Build/badge.svg)

[![Version](https://img.shields.io/jetbrains/plugin/v/25676.svg)](https://plugins.jetbrains.com/plugin/25676)

[![Downloads](https://img.shields.io/jetbrains/plugin/d/25676.svg)](https://plugins.jetbrains.com/plugin/25676)

See live control-flow-graphs of your code!

This plugin adds a CFG ([Control-Flow-Graph](https://en.wikipedia.org/wiki/Control-flow_graph))

view for the current function.

Before installing, you can also try an [interactive demo](https://tmr232.github.io/function-graph-overview/).

The plugin currently supports Python, C, C++, C#, Java, Go, TypeScript & TSX, JavaScript & JSX.

| ![A docked CFG view](/media/screenshot-docked.png) | ![An undocked CFG view](/media/screenshot-undocked.png) |

|----------------------------------------------------|---------------------------------------------------------|

This is a port of the [Function-Graph-Overview](https://github.com/tmr232/function-graph-overview/) to JetBrains IDEs.

## Installation

- Using the IDE built-in plugin system:

  Settings/Preferences > Plugins > Marketplace > Search for "Function Graph

  Overview" >

  Install

- Using JetBrains Marketplace:

  Go to [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/25676) and install it by clicking the Install

  to ... button in case your IDE is running.

  You can also download the [latest release](https://plugins.jetbrains.com/plugin/25676/versions) from JetBrains

  Marketplace and install it manually using

  Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

## Getting Started

If the graph window doesn't shop up immediately after installation, then:

1. Go to the main menu and click `View -> Tool Windows -> Function Graph Overview`.

2. Or open the Search Everywhere popup (double-click Shift, or click the 🔍 icon at the top-right of the IDE

   window) and search for `Function Graph Overview`.

## Settings

### Color Scheme

To change the color scheme of the CFG, open the settings and go to `Tools -> Function Graph Overview`.

In the `Color scheme` field, you can choose between built-in color schemes, or make your own.

For a builtin scheme, use enter `light` or a color scheme matching the IDE's light theme,

or `dark` for a scheme matching the dark theme.

For a custom scheme:

1. Open the [interactive demo](https://tmr232.github.io/function-graph-overview/)

2. Enable the `Color Picker` above the graph

3. Select the colors you want for your color scheme  

   ![Color Picker](media/settings/color-picker.png)

4. Press the Copy button to copy the color scheme into the clipboard

5. Paste the config into the `Color scheme` field in the settings  

   ![Settings](media/settings/color-scheme-field.png)

### Flat Switch

Use the `Flat switch` setting to change between two rendering modes for switch-like statements:

| Flat Switch Enabled                       | Flat Switch Disabled                       |

|-------------------------------------------|--------------------------------------------|

| ![](media/settings/flatSwitchEnabled.png) | ![](media/settings/flatSwitchDisabled.png) |

---

Plugin based on the [IntelliJ Platform Plugin Template][template].

[template]: https://github.com/JetBrains/intellij-platform-plugin-template