OrchidE 2025.1.1 adds

• partial support for full qualified role names and Ansible Playbook projects, and
• improved quick documentation for return values.

Support for full qualified role names

Based on the playbook project structure proposed by Ansible Creator, this version provides initial support, for

• code completion in playbooks for FQRN,
• navigation in playbooks for FQRN,
• correct recognition of the ansible_collections path as a folder for roles, and
• for the role annotation in inventory files (code completion of the annotation, navigation to the role, code completion of the role variables, navigation to the role variables in argument_specs)

Currently, the following features are not supported for FQRN:
- Ansible Structure View
- Custom OrchidE ‘New File’ actions
- Detection of non-Ansible YAML files (can be configured via Ansible Folder Mapping)

Improved quick documentation for return values

The quick documentation has been expanded and now also displays information about sub options of return values.

Changes

• New quick documentation for return value sub-options.
• Basic new support for fully qualified role names (based on Ansible creator’s playbook project structure).
• New annotation showing an error when using Jinja2 template conditions (when, failed_when, etc.).
• Change: Quick documentation is now available for Jinja2 variables in the argument specifications or comments of the role defaults/vars variables.
• Change: Quick documentation is now available in the roles section of playbooks for vars keyword entries, using the description from argument specs.
• Change: Quick documentation is now available for Jinja2 variables referencing the register keyword of a module.
• Change: The quick documentation for keywords now includes information on the type and what it applies to.
• Bugfix: A parser error occurs when a collection uses an Ansible keyword as the name of its task.
• Bugfix: Various improvements have been made to the “Create Variable” quick fix when using undefined variables.
• Bugfix: Exception when using a Jinja2 template in conditions (when, failed_when, etc.).
• Bugfix: The Ansible structure project view doesn’t show folder names starting with a dot.
• Bugfix: If a key uses the flow style to define values, the Jinja curly braces will not be quoted during code completion.
• Bugfix: The include_tasks task would show an ‘unresolved include file’ error when Ansible-supported fact variables were used to resolve the default values.
• Bugfix: Top-level group variable files are not detected in the structure view.
• Bugfix: An exception occurs when trying to create a file with the ‘Ansible file’ action that already exists.
• Bugfix: NullPointerException when copying and pasting from a Jupyter playbook.
• Removed: Deprecated setting: File Type Patterns.

Deprecation

• Support for IntelliJ platform 2024.1 is deprecated and will end with the launch of the EAP for IntelliJ version 2026.1.
• Support for the OrchidE builder format V1 is deprecated.

OrchidE 2025.1.0 brings contextual code completion in roles, various new “Go to Declaration” functions for the inventory and two new inspections.

Context-related code completion in roles

In roles, only variables are used for code completion, inlay display and the inspection “Undefined Variables” that

• are defined in the same role, and
• from the inventory when the role is referenced in the playbook hosts entry.

In the settings the previous behavior can be configured if necessary (Settings ➞ Editor ➞ OrchidE). This is recommended, for example, if variables from other roles are used.

Note: Role dependencies, defined in the meta file, are not supported by OrchidE.

New Go to Declarations

The annotations @role:: and @alias:: in inventory files now support the “Go to Declaration” action.

Using “Go to Declaration” on @role:: navigates to the corresponding tasks/main.yml file of the role. Using “Go to Declaration” on @alias:: navigates to the corresponding meta/argument_specs.yml file.

In inventory files, you can now navigate between the inventory group entries and to the group variables.

New Inspections

The inspection “Wrong usage of ‘item’” warns against the use of ‘item’ in loop if ‘loop_var’ is specified.

The inspection “Missing quote before Jinja template” checks whether Jinja templates {{ are quoted after a key or the start of a list.

Changes

• New code completion for alias annotation within inventory variable files.
• Code completion for role annotation within inventory variable files is now also available at the start of the line.
• Bugfix: Ansible module documentation could not be read if the description was available as a map (SAP collection).
• Bugfix: Files in the inventory folder host_vars are not recognized as inventory files.
• Bugfix: When opening Shell Jinja2 Ansible templates with the BashSupport Pro plugin, IntelliJ may freeze when saving.

Deprecation

• Support for IntelliJ platform 2024.1 is deprecated and will end with the launch of the EAP for IntelliJ version 2026.1.
• Support for the OrchidE builder format V1 is deprecated.

OrchidE 2024.1.6 brings an improved Inspection ‘Missing File’.

In the copy and template task, missing files are now better recognized in the src attribute when a loop is used. Both the loop keyword with loop_control/loop_var and with_items with the placeholder item are supported.

Jinja templates in the file name are resolved as long as they are simple references to variables.

Changes

• New: Support for IntelliJ platform 2025.3 EAP.
• Change: Improved resolving of Jinja templates used in loop variable ‘item’.
• Change: Improved code completion in inventory files if an ‘alias annotation’ exists.
• Bugfix: Clear caches of inspection ‘Undefined Variable’ immediately when the variable name is renamed.
• Bugfix: When using the enter key for code completion of argument_spec variables, and the variable has a description, the indentation is incorrect.

Deprecation

• Support for IntelliJ platform 2023.3 is deprecated and will end with the launch of the EAP for IntelliJ version 2025.3.
• Support for the OrchidE builder format V1 is deprecated.

OrchidE 2024.1.5 brings better support for the meta files ‘main’ and ‘argument_specs’, extended support for the src attribute of the copy task and various changes and bug fixes.

Meta/Argument_specs-Files

OrchidE now supports code completion and quick documentation for the meta and argument_specs files of an Ansible role and checks the syntax against the JSON schema. This function requires a current definition package of the OrchidE Builder, which contains extended JSON schema files (from Ansible 11.5 and 20250703).

Alternatively, IntelliJ’s built-in function for JSON schema can be used.

Differences between JSON schema of OrchidE Builder and IntelliJ:

• OrchidE automatically finds JSON schemas from the OrchidE Builder package. In IntelliJ, the schema must be configured manually for the meta files.
• Schemas from the OrchidE Builder package contain more detailed descriptions of the attributes.
• Newer schemas are available earlier with IntelliJ.
• With schemas from the OrchidE Builder package, some quick fixes are not available as long as OrchidE supports older IntelliJ versions. (<= IntelliJ version 2024.1)

Copy Task

OrchidE now supports code completion and verification for the ‘src’ attribute of the copy task identically to the template task. You can also navigate to the source file (go to declaration, Ctrl + B, ⌘ + B)

Changes

• New: New quick fix for module arguments with the wrong type.
• New: The quick documentation section “See Also” now supports external links.
• New: Support for code completion of variables defined by the vars keyword in the ‘include_tasks’ and ‘import_tasks’ tasks.
• Change: Jinja closing braces will now be added after typing second ‘{‘ immediately.
• Change: Jinja closing braces will now be added in Jinja templates files.
• Bugfix: Quick Documentation generates an error if no description is available for type.
• Bugfix: Action new Ansible file don’t use file extension from editor settings.

Deprecation

• Support for IntelliJ platform 2023.3 is deprecated and will end with the launch of the EAP for IntelliJ version 2025.3.
• Support for the OrchidE builder format V1 is deprecated.

OrchidE 2024.1.4 brings minor bug fixes and support for IntelliJ platform EAP version 2025.2.

Changes

• Bugfix: Recognition of playbooks in root folders of roles.
• Bugfix: Exception occurred when a file or folder was deleted from within the Ansible structure project view.
• Bugfix: Exception when loading a collection with tasks for which no description is available (i.e. oracle.oci) from an OrchidE builder package V2.
• Bugfix: Minor fixes to error handling.

Deprecation

• Support for IntelliJ platform 2023.3 is deprecated and will end with the launch of the EAP for IntelliJ version 2025.3.
• Support for the OrchidE builder format V1 is deprecated.

OrchidE 2024.1.3 brings support for the OrchidE Builder format in version 2.

OrchidE Builder Format V2 is completely based on the output of ansible-doc, which makes it much easier to create your own package. With that, OrchidE provides improved quick documentation:

• Links to other modules
• ‘See also’ documentation is now included in quick documentation
• More detailed information in the deprecated section

Changes

• Change: OrchidE now recognizes playbooks in role folders.
• Bugfix: Fix java.lang.ArrayIndexOutOfBoundsException in OrchideInspectionUndefinedVariableFilterAndTestUtil.getAllBuiltInNames

Deprecation

• Support for IntelliJ platform 2023.2 is deprecated and will end with the launch of the EAP for IntelliJ version 2025.2.
• Support for the OrchidE builder format V1 is deprecated.

OrchidE 2024.1.2 brings code completion and quick documentation support for the ‘args’ keyword.

Changes

• Bugfix: Error ‘com.intellij.psi.PsiInvalidElementAccessException: Element: class com.taff.plugin.orchide.psi.element.impl.AnsibleDictEntryImpl’.
• Bugfix: IntelliJ 2025.1 EAP 4 compatibility fixes.

Deprecation

Support for IntelliJ platform 2023.2 is deprecated and will end with the launch of the EAP for IntelliJ version 2025.2.

OrchidE 2024.1.1 brings Jinja2 template support for shell files.

Shell scripts used as Ansible templates (.sh.j2) now support the IntelliJ plugin Shell Script.

Changes

• Change: The Inspection Undefined Variable now considers if/else keywords.
• Change: New syntax highlighting for OrchidE’s alias annotation.
• Change: When configuring OrchidE, a warning is now displayed if the project folder is used for an inventory. The project folder may only be configured for playbooks.
• Change: Improved recognition of inventories in the IntelliJ project folder.
• Change: In the configuration for Ansible Folder Mapping, individual playbook and inventory files/patterns for playbooks/inventories can now also be specified in the project folder.
• Change: Performance improvement for code completion.
• Bugfix: Path specifications for include*-tasks do not support subfolders.
• Bugfix: Jinja2 templates for XML files are not recognized.
• Bugfix: If Jinja2 templates are incomplete and a tooltip is displayed at the same time, an exception occurs.

Deprecation

Support for IntelliJ platform 2023.2 is deprecated and will end with the launch of the EAP for IntelliJ version 2025.2.

OrchidE 2024.1.0 brings language injection support for the Ansible shell module, editor functions for arguments of Ansible test functions, and an aliasing function for variables to associate the variable with a role argument spec definition.

Language injection for shell module

For script code in the Ansible shell module, it is now possible to edit the code in OrchidE with the corresponding plugin.

The plugins for Shell, PowerShell, and Python are currently supported.

OrchidE can recognize the language by means of an annotation, the keyword executable or a shebang line.

If there is more than one entry, the entry with the highest priority is used:

• 1) Annotation
• 2) Keyword executable
• 3) Shebang

Support for test arguments

Code completion, syntax highlighting, and quick documentation are now available for Ansible test plugin arguments.

Alias for inventory variables

With the alias annotation of OrchidE you get Quick Documentation, Code Completion and Navigation for Argument-spec variables that are used indirectly.

If you want to install a role on a node several times, you can do this in the playbook, for example:

- name: Sample Aliases
  roles:
    - role: service-instance
      vars:
        install_folder: ""

    - role: service-instance
      vars:
        install_folder: ""

However, auxiliary variables must now be used to maintain the install_folder variable in the inventory. To continue using editor functions such as quick documentation, navigation and code completion for variables from the argument-spec definition, the alias annotation of OrchidE is used.

With the alias annotation, the auxiliary variables can be mapped to the argument spec definition:

#@alias::install_folder
alias_sample_instance_1: /opt/service_1

Deprecation

Support for IntelliJ platform 2023.1 is deprecated and will end with the launch of the EAP for IntelliJ version 2025.1.

OrchidE 2023.1.7 brings some improvements for the configuration of OrchidE and syntax highlighting for Ansible test plugins.

Global setting for code completion of collections

The code completion mode for collections can now be set for all collections at once.

Individual changes can be made subsequently set certain collections differently.

Global pattern for playbook file names

File names or file name patterns can now also be used to recognize playbooks. These patterns are used to search the entire IntelliJ project for files that match the pattern.

The exact file name can be specified, or alternatively, a pattern with wildcards can be used.

Syntax highlighting for Ansible test arguments

Quick Documentation for Ansible Test Plugins

For Ansible test plugins ‘Quick Documentation’ is now supported in the editor with shortcut or mouse-over.

Changes

• Change: Support for inserting closing quotes similar to other IntelliJ editors with some Ansible yaml specific extensions.
• Change: Improved support of Ansible test plugins for the ‘Undefined Variable’ inspection.
• Change: Some more defaults in ‘Ansible Folder Mapping’ (docker-compose, gitlab, files/*)
• Change: Some minor changes for IntelliJ EAP version 2024.3

Deprecation

Support for IntelliJ platform 2023.1 is deprecated and will end with the launch of the EAP for IntelliJ version 2025.1.