CSC305 Lecture 18

Individual Software Design and Development
Final Project
(202605)

Transcript

1. Dr. Javier Gonzalez-Sanchez javiergs@calpoly.edu www.javiergs.info o ffi ce: 14 -227 CSC 305 Individual Software Design and Development Lecture 18. Final Project
2. From this … 2 1
3. To this 3
4. Assignment 04
5. What will you build? 5 1. Project open in IDE 2. Scanner .java files 3. Analyzer metrics + model 4. Viewer 3 tabs 4.1. Grid tab one tile per Java file; color = metric level 4.2. Metrics tab plot each class or package in 2D space 4.3.Diagram tab PlantUML text or rendered diagram
6. Features 6 The plugin runs inside IntelliJ No URL input is needed for version 1. It reads the opened project Use IntelliJ project files and PSI instead of GitHub scraping. It shows results in tabs Grid, Metrics, and Diagram are regular Swing panels. It opens files on click Each visualization item can navigate back to source. 3
7. Getting Started
8. Prepare the development environment 8 Install IntelliJ IDEA Use the latest version available to you. Use JDK 21 Recommended for recent IntelliJ Platform targets. Enable Gradle The plugin project is Gradle- based. Enable Plugin DevKit Install from Marketplace if missing. 4
9. Create a new plugin project 9 In IntelliJ File → New → Project Choose IDE Plugin Name it CodeVisualizerPlugin Recommended values: Name: CodeVisualizerPlugin Group: edu.calpoly.csc Artifact: code-visualizer-plugin Language: Java JDK: 21 Build system: Gradle Important for Java-based students If the wizard creates src/main/kotlin only, create src/main/ java manually. Expected first success The project loads, Gradle sync finishes, and a Run IDE with Plugin configuration appears. 5
13. Understanding the plugin project f iles 13 CodeVisualizerPlugin/ ├─ build.gradle.kts ├─ settings.gradle.kts ├─ gradle.properties └─ src/main/ ├─ java/ │ └─ edu/calpoly/csc/... └─ resources/META-INF/ ├─ plugin.xml └─ pluginIcon.svg build.gradle.kts How the plugin is built and run. plugin.xml How the plugin is registered in IntelliJ. src/main/java Your ToolWindowFactory and panels. resources Icons and metadata. Rule: Gradle makes it build. plugin.xml makes it appear in the IDE. 6
14. Add the Tool Window entry 14 <idea-plugin> <id>edu.calpoly.csc.codevisualizer</id> <name>Code Visualizer</name> <depends>com.intellij.modules.platform</depends> <depends>com.intellij.modules.java</depends> <extensions defaultExtensionNs="com.intellij"> <toolWindow id="Code Visualizer" anchor="right" factoryClass=“javiergs.CVis<..>WindowFactory” /> </extensions> </idea-plugin> What this does It adds a button on the IDE side bar and tells IntelliJ which class creates the UI. Why com.intellij.modules.java? The analyzer will read Java classes, methods, fields, imports, inheritance, and interfaces. First test Run the plugin. The tool window button should appear, even if the panels are empty. 7
15. Create three tabs in the Tool Window 15 public final class CodeVisualizerToolWindowFactory implements ToolWindowFactory { @Override public void createToolWindowContent(Project project, ToolWindow toolWindow) { JTabbedPane tabs = new JTabbedPane(); tabs.add("Grid", new GridPanel(project)); tabs.add("Metrics", new MetricsPanel(project)); tabs.add("Diagram", new DiagramPanel(project)); Content content = ContentFactory.getInstance() .createContent(tabs, "", false); toolWindow.getContentManager().addContent(content); } } 8
16. Open the Plugin 16
21. Disclaimer • These a re dr a ft for a STARTING POINT • Tr a nsform your J a v a Desktop App in a “be a tiful” a nd function a l plugin 21
22. References 22 JetBrains Plugin SDK Developing a Plugin; Creating a Plugin Gradle Project. Tool Windows documentation Tool windows are registered with plugin.xml and a ToolWindowFactory. Gradle plugin documentation IntelliJ Platform Gradle Plugin 2.x is recommended for modern targets. Plugin dependencies Use Java module dependency when reading Java PSI. http://plugins.jetbrains.com/docs/intellij https://plugins.jetbrains.com/docs/intellij/psi.html 18
23. Lab
24. Code https://github.com/j a viergs/codeviz-plugin 24
25. CSC 305 Individual Software Design and Development Javier Gonzalez-Sanchez, Ph.D. javiergs@calpoly.edu Fall 2025 Copyright. These slides can only be used as study material for the class CSC305 at Cal Poly. They cannot be distributed or used for another purpose.