OrchidE definition file builder

A tool to generate parser and code definitions for the IntelliJ plugin OrchidE.

The tool generates meta-information from Ansible Galaxy collections to be used by OrchidE

• for parsing Ansible playbooks and roles
• for code completion suggestions
• for various inspections to check for valid code snippets.

Getting started - ready to use definitions

Compatiblity of releases

OrchidE-Builder packages for Ansible 4.4.0, 20210816 and newer require at least OrchidE plugin version 2020.1.5.

Installation

To use the latest definitions of Ansible Galaxy collections bundle with OrchidE:

1. Download the latest definition package from releases or a specific Ansible version
   • 9.2.0, 9.1.0, 9.0.1,
   • 8.7.0, 8.6.1, 8.5.0, 8.4.0, 8.3.0, 8.2.0, 8.1.0, 8.0.0,
   • 7.7.0, 7.3.0, 7.2.0, 7.1.0, 7.0.0,
   • 6.7.0, 6.6.0, 6.5.0, 6.1.0,
   • 5.10.0, 5.9.0, 5.7.0, 5.6.0, 5.5.0, 5.3.0, 5.0.1,
   • 4.9.0, 4.4.0, 4.0.0, 3.4.0.
2. Create a directory on your filesystem - p.e. ~/.orchide and put the downloaded .jar there.
3. Open IDE settings > Languages & Frameworks > OrchidE > Extension.
4. Add the path to your newly created directory.
5. Hit Apply.
6. Restart your IDE.

Getting started - create your own definition package

General information

To use Ansible collections that are not part of OrchidE, that are newer or that from other sources you can create your own package. Any collection that documents the meta-information as Ansible can be used as a source.

Pre-requisites

• WSL, Linux or MacOS
• Python 3 (tested with 3.9)
• Python pip3, pipenv
• Bash
• a Java (JDK) version 8 - 14
• Apache Ant
• Git (or download this repository)

Install CLI

1. Install Python 3, bash, java and Apache ant via your package manager
   • e.g for Fedora

     $ dnf install git ant pipenv 

2. Check out this repository
3. Run

   $ pipenv install 

   within the repository root folder

Usage

1. Configure the Ansible collection

   1. Create a new configuration file from an existing one in the res folder
      • for the latest version, copy a file with date version
      • for a list of collections with specific version, copy a file with Ansible version
   2. Add / remove collections you want

2. Run

   $ ./build.sh build-4release -a <version number> 
   $ ./build.sh build-4release -a 20210816 

3. Copy the built jar (./build/dist/orchide-definitions.jar) to the OrchidE's configured extension directory. (set in Settings > Languages & Frameworks > OrchidE > Extension)

Reporting Issues

If you're missing an Ansible Galaxy collection, experience a problem or have any other issue, please file an issue. You can also reach out to me via support@orchide.dev.

Acknowledgments

This repository uses code from the Ansible project.

Thank you for the awesome Ansible project.

License

GNU General Public License v3.0