mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-28 09:17:50 +08:00
d8e83b57ea
* Add UI Guidelines to SDK docs * Add UI Guidelines to SDK docs * Fixing build errors * optimize PNGs * add UI guidelines landing page placeholder * IJ SDK Docs <-> UI guidelines crosslinks updated * split_button.md: remove reference to removed setting * use <ui-path> * use MD instead of <note> * use %gh-ic% links * drop_down.md: fix <control> * code samples: fix most obvious issues * remove obsolete `_defaults.md` * ijs.tree: UI cleanup * Delete "under construction" pages * Fix headers * Add link-summary * Remove invalid links * Delete unused files * Remove ''@2x' from image file names * Use Markdown syntax for some images and tables * Rename non-unique files to unique * Remove alpha in images where content is unreadable * align quotation marks * Controls: cleanup/fixes, add code links, edit * tooltip.md: fix HTML * misc fixes * typography.md: fix table contents * typography.md: fix table header * UI guidelines landing page + TOC fixes * remove unused icons_list.md * Normalize image paths * validation_errors.md: Fix broken tab * "correct"/"incorrect" labels styling * Resize images to 50% * button.topic: fixes * grammar, spelling, minor edits * remove ' ' * fix 99px * cleanup * UI_kit.md: minor * Fix "MRK058: Large image in paragraph rendered as a block element by default." * button.topic: Add img[alt] * mnemonics.md: Update "Contact Us" link to the IJSDK YouTrack * split_button.md: Use ui-path * UI landing: add feedback snippet * Improve code snippets formatting and naming * Fix code samples * Fix code samples * Add Kotlin variants for code samples * Add icons_list.md * crosslinks * Change external link to https://intellij-icons.jetbrains.design/ * icons list -> https://intellij-icons.jetbrains.design * Hide info about reducing split button to simple action button (now it is available through the registry only) * reformat * icons_style.md: Images in new line --------- Co-authored-by: marianna.kononenko <marianna.kononenko@jetbrains.com> Co-authored-by: Yann Cébron <yann.cebron@jetbrains.com>
71 lines
3.8 KiB
Markdown
71 lines
3.8 KiB
Markdown
<!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
|
|
|
# Intentions
|
|
|
|
<link-summary>Intention actions allowing to fix code issues or transform the code to a different form.</link-summary>
|
|
|
|
<tldr>
|
|
|
|
**Product Help:** [Intention Actions](https://www.jetbrains.com/help/idea/intention-actions.html)
|
|
|
|
**UI Guidelines:** [](inspections.md)
|
|
|
|
</tldr>
|
|
|
|
This topic describes the [conditional_operator_intention](%gh-sdk-samples-master%/conditional_operator_intention), a sample plugin that adds a new [intention action](https://www.jetbrains.com/help/idea/intention-actions.html) to the IDE Intentions list.
|
|
In addition, the sample plugin contains a JUnit-based test.
|
|
|
|
## About Intention Actions
|
|
|
|
The IntelliJ Platform 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.
|
|
|
|
See [Inspections](inspections.md) topic in UI Guidelines on naming, writing description, and message texts for inspections/intentions.
|
|
|
|
You can view a list of all available intention actions as well as enable/disable them using the [Intentions List](https://www.jetbrains.com/help/idea/intention-actions.html#intention-settings) in <ui-path>Settings | Editor | Intentions</ui-path>.
|
|
|
|
## Techniques Used
|
|
|
|
The [conditional_operator_intention](%gh-sdk-samples-master%/conditional_operator_intention) sample plugin illustrates the use of the following techniques:
|
|
|
|
- How to analyze a [PSI tree](psi_files.md).
|
|
- 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`](%gh-ic%/platform/lang-api/src/com/intellij/codeInsight/intention/PsiElementBaseIntentionAction.java) class.
|
|
- How to create a JUnit test for this plugin using the [`IdeaTestFixtureFactory`](%gh-ic%/platform/testFramework/src/com/intellij/testFramework/fixtures/IdeaTestFixtureFactory.java) class.
|
|
|
|
> In case of providing multiple intention actions for a single element, their ordering is indeterministic due to performance reasons.
|
|
> It is possible to push specific items up or down by implementing
|
|
> [`HighPriorityAction`](%gh-ic%/platform/analysis-api/src/com/intellij/codeInsight/intention/HighPriorityAction.java)
|
|
> or
|
|
> [`LowPriorityAction`](%gh-ic%/platform/analysis-api/src/com/intellij/codeInsight/intention/LowPriorityAction.java)
|
|
> respectively.
|
|
>
|
|
{style="note"}
|
|
|
|
## Sample Plugin
|
|
|
|
When launched, the sample plugin adds the <control>SDK: Convert ternary operator to if statement</control> item to the <control>SDK intentions</control> group in the <ui-path>Settings | Editor | Intentions</ui-path>.
|
|
|
|
#### Running the Plugin
|
|
|
|
See [Code Samples](code_samples.md) on how to set up and run the plugin.
|
|
|
|
#### 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, IntelliJ IDEA proposes to replace this conditional (ternary) operator with the "if-then-else" statement:
|
|
|
|
|
|
{width=675}
|
|
|
|
Invoking <control>SDK: Convert ternary operator to if statement</control> intention action will result in transforming expression to the form visible in the [preview](code_intentions_preview.md) popup (code fragment on the right).
|
|
|
|
#### Testing the Plugin
|
|
|
|
> Please note that running the test requires setting system property `idea.home.path` in the `test` task configuration of the Gradle build script.
|
|
>
|
|
{style="note"}
|
|
|
|
The sample plugin contains the `ConditionalOperatorConverterTest` Java class and the test data in the <path>test/testData/</path> directory.
|
|
To perform the plugin test, run the `ConditionalOperatorConverterTest.testIntention()` method.
|