Skip to content

README.md

Latest commit

 

History

History
57 lines (42 loc) · 1.85 KB

README.md

File metadata and controls

57 lines (42 loc) · 1.85 KB

🚀 Method Tracker Plugin

A lightweight IntelliJ IDEA plugin that extracts and exports Java method information from your project into a single JSON file.

✨ Features

This plugin is designed to provide a comprehensive, static snapshot of your project's Java methods, enabling powerful external analysis.

  • Method Detail Extraction: Automatically identifies all Java methods within the open project.

  • Method Body Tracking: Extracts the name and the body content for each identified method.

  • Automated JSON Export: Dumps all collected method data into a structured JSON file upon project opening.

📦 Run the project

Prerequisites

  • IntelliJ IDEA (Community or Ultimate Edition)
  • Java Development Kit (JDK) 21 or newer
  • Gradle

Run Steps

  1. Clone the repository:
   git clone <URL>
  1. Open in IntelliJ IDEA:
  • In the main IntelliJ welcome screen, select Open.
  • Navigate to and select the JBMethods2JSON directory.
  • IntelliJ IDEA will automatically detect the Gradle project and import necessary SDKs.
  1. Run the Sandbox Instance:
  • Locate the Gradle tool window (usually on the right side of the IDE).
  • Navigate to Tasks > intellij platform > runIde.
  • Double-click runIde to execute the task.

OR

  1. Clone the repository:
   git clone <URL>
  1. Navigate to the project's root directory:
  cd JBMethods2JSON/
  1. Run the snadbox:
  ./gradlew runIde       # Unix / macOS / Linux
  gradlew.bat runIde     # Windows

This will launch a new, separate IntelliJ IDEA instance known as the Sandbox, with the plugin already installed and active. After indexing finishes, methods.json file appears in the root directory with all the method names and bodies in JSON format.

Sample methods.json file for this project can be found in this repository.