plugin_configuration.md

Plugin Configuration

• Configuration file diffs with the IntelliJ Platform Plugin Template
• XML tag folding in plugin descriptor files
  • Supported tags
    • extensions.localInspection / extensions.globalInspection
    • extensions.intentionAction
• Extension icon line marker icons
• Line marker for updating the Gradle Wrapper version

Configuration file diffs with the IntelliJ Platform Plugin Template

This action is registered in editor and Project View context menus of certain plugin configuration files, and it opens a two-sided diff view comparing the local version of the file with its IntelliJ Platform Plugin Template version on GitHub.

Project view context menu	Editor context menu

The action is available for the following configuration files:

• build.gradle.kts
• gradle.properties
• qodana.yml
• .github/dependabot.yml
• .github/workflows/build.yml
• .github/workflows/release.yml
• .github/workflows/run-ui-tests.yml
• gradle/libs.versions.toml

The contents from GitHub are downloaded from the main branch of the template repository, directly from https://raw.githubusercontent.com/JetBrains/intellij-platform-plugin-template/main/...

If the remote contents cannot be downloaded, a balloon is displayed, and a log entry is logged with the reason of it.

XML tag folding in plugin descriptor files

There are certain extensions, and XML tags in general, in plugin.xml and other plugin descriptor files that can hold a lot of information. Having many such tags can make it more difficult for users to parse them, find the one they are looking for, or just scroll through them.

To improve these aspects, code folding is put in place to simplify the displayed information. They can be enabled/disabled under Settings > Editor > General > Code Folding > Just Kitting section.

Supported tags

extensions.localInspection / extensions.globalInspection

The <localInspection> and <globalInspection> tags within <extensions defaultExtensionNs="com.intellij"> fold in the form of 'for [language] at [path]', and support the following attributes for folding:

Attribute	Attribute value example	Placeholder text
language	JAVA	for JAVA
groupPath	Group Group,Path	Group Group / Path
groupPathKey	group.path.key	{group.path.key} (when not resolved)
groupName	Group Name	Group Name
groupKey	group.name.key	{group.name.key} (when not resolved)
displayName	Looks for invalid things	'Looks for invalid things'
key	display.name.key	{display.name.key} (when not resolved)

Resource bundle keys are resolved according to their resolution fallback chain:

• key: bundle attribute -> <resource-bundle> tag
• groupPathKey: groupBundle attribute -> bundle attribute -> <resource-bundle> tag
• groupKey: groupBundle attribute -> bundle attribute -> <resource-bundle> tag

Notes:

• group path comma delimiters are replaced with forward-slashes for better visuals
• the placeholder text for keys show the keys themselves enclosed in { and }.

Example:

extensions.intentionAction

The <intentionAction> tags within <extensions defaultExtensionNs="com.intellij"> fold in the form of for [language] at [category] / [family name or class name] ....

The <intentionAction> tags are folded regardless of what subtags of them are present and in what order.

If the language is not configured (e.g. not available in earlier platform versions) the tag folds without the language as at [category] / [family name or class name] ...

Class names:

The <className> tag is resolved to the short name of the class, or if the plugin, whose project is currently open, is also installed in the IDE, thus it has the intention action classes registered, it evaluates their getFamilyName() methods to provide a better placeholder text.

For now, the plugin cannot evaluate the family name of IntentionAction classes in the currently open project.

Example:

Extension icon line marker icons

In order to improve the comprehension of extension and action registrations in plugin descriptor files, the following two tag attributes are extended with a line marker to show the referenced icons:

• idea-plugin.actions.action@icon
• idea-plugin.actions.group.action@icon
• idea-plugin.extensions.toolWindow@icon

Currently, icons in com.intellij.icons.AllIcons as well as in any class residing in the icons package are supported, and it works on plugin descriptor files in the intellij-community project too. Icons specified by relative path within the current project, or by fully qualified names are not supported.

The line marker is enabled by default and can be disabled under Settings > Editor > General > Gutter Icons > Just Kitting > Extension and action icons in IDE plugin descriptor files.

Line marker for updating the Gradle Wrapper version

For plugin projects built on the intellij-platform-plugin-template this line marker can be useful to easily update the Gradle wrapper.

It is displayed on the gradleVersion property in gradle.properties when the version specified there differs from the one in the distributionUrl property of /gradle/wrapper/gradle-wrapper.properties.

Upon clicking the line marker, it creates a new Gradle run configuration (or reuses the existing one) with the following command, and executes it:

wrapper --gradle-version=<value of gradleVersion> --distribution-type=<type, i.e. bin or all, from distributionUrl>