This document is a work in progress.
This topic describes the comparingReferences sample plugin that creates a custom inspection of Java code. In addition, the sample plugin contains a
JUnit-based test. Basing on this information, you can develop your own plugins using similar techniques.
IntelliJ IDEA provides tools designed for static code analysis (so called code inspections) that help you maintain and clean up your code without actually executing it. In IntelliJ IDEA you will find a set of built-in inspections that are grouped by their goals and sense. For more information about code inspections, see Inspecting Source Code in IntelliJ IDEA Web Help.
You can create custom inspections through the IntelliJ IDEA interface (see Creating Own Inspections ). Alternatively, you can develop a plugin to implement a custom inspection.
The comparingReferences sample plugin illustrates the use of the following techniques:
JUnittest for this plugin using the IdeaTestFixtureFactory class.
The comparingReferences sample plugin is available in the <%IDEA project folder%>/community/samples/comparingReferences> directory.
When launched, this plugin adds the '==' or '!=' instead of 'equals()' item to the Probable bugs node in the IDEA Inspections list .
To run the sample plugin
Once the plugin is launched, you can set the plugin options. You can specify the Java classes to be participated in the code inspection and the severity level of the found probable bugs.
To configure the sample plugin
The plugin inspects your code opened in the IntelliJ IDEA editor or the code you are typing. The plugin highlights the code fragments where two variables of the reference type are separated by == or != and proposes to replace this code fragment with .equals():
In this example, the s1 and s2 are variables of the
String type. Clicking Use equals() replaces
with the code:
The sample plugin contains the
TestThisPlugin Java class in the testSource/testPlugin package and the test data in the <plugin directory>/testData directory.
This test adds two test cases to this plugin project. To run test cases, run the
YourTest.test1() method, respectively.
For detailed information about testing and all related procedures, refer to Testing and Testing Support in the IntelliJ IDEA Web Help.