consulo.dev

Appearance

This topic describes the conditional_operator_intention, a sample plugin that adds a new intention action to the Consulo Intentions list. In addition, the sample plugin contains a JUnit-based test.

About Intention Actions ​

The Consulo analyzes your code and helps handle situations that may result in errors. When a possible problem is suspected, the IDE suggests an appropriate intention action, denoted with special icons.

You can view a list of all available intention actions using the Intention List provided by the IDE.

To display Intention List

  1. Open the Settings dialog box.
  2. Under IDE Settings, click Intentions. This displays the list of all intention actions currently available in Consulo.
  • The intention actions are grouped according to the areas of their use.
  • To enable/disable an intention action, select/deselect the check box to its left.

Techniques Used ​

The conditional_operator_intention sample plugin illustrates the use of the following techniques:

  • How to analyze a PSI tree.
  • How to find a Java token of interest in the PSI tree.
  • How to invoke a quick fix action for a token element under cursor using the PsiElementBaseIntentionAction class.
  • How to create a JUnit test for this plugin using the IdeaTestFixtureFactory class.

Sample Plugin ​

The ConditionalOperatorConverter sample plugin is available in the code_samples/conditional_operator_intention directory. When launched, this plugin adds the Convert ternary operator if statement item to the Conditional Operator node in the Consulo Intentions list:

Running the Plugin ​

To run the sample plugin

  1. Start Consulo and open the conditionalOperatorConvertor plugin project saved into the code_samples/conditional_operator_intention directory.
  2. Open the Project Structure dialog and ensure that the project settings are valid for your environment.
  3. If necessary, modify the Run/Debug Configurations and Run the plugin by choosing the Run on the main menu.

How does it work? ​

The plugin analyzes symbols under the cursor in your code opened in the editor. If the cursor is positioned on the "?" conditional operator, Consulo proposes to replace this conditional (ternary) operator with the "if-then-else" statement:

In this example, the code:

java
return (n>=0) ? n : -n;

will be replaced with the code:

java
if ((n>=0)) {
    return n;
} else {
    return -n;
}
Testing the Plugin ​

INFO

Please note that running the test requires setting the system property idea.home.path. In a Maven project, this can be configured via the maven-surefire-plugin configuration in your pom.xml.

The sample plugin contains the ConditionalOperatorConverterTest Java class and the test data in the test/testData/ directory. To perform the plugin test, run the ConditionalOperatorConverterTest.testIntention() method.

For detailed information about testing and all related procedures, refer to the Testing section of the Consulo documentation.