intellij-plugins

Ansible Role: IntelliJ Plugins

Role to download and install IntelliJ IDEA plugins.

Warning: this role relies on internal IntelliJ IDEA APIs and should be considered experimental at this time.

Requirements

Ansible >= 2.9
Linux Distribution
- Debian Family
  - Ubuntu
    - Bionic (18.04)
    - Focal (20.04)
- RedHat Family
  - Rocky Linux
    - 8
- Note: other versions are likely to work but have not been tested.

Role Variables

The following variables will change the behavior of this role (default values are shown below):

# Home directory of IntelliJ IDEA installation
intellij_plugins_intellij_home: '{{ ansible_local.intellij.general.home }}'

# Directory containing IntelliJ IDEA plugins (relative to user home)
intellij_plugins_intellij_user_plugins_dir: '{{ ansible_local.intellij.general.user_plugins_dir }}'

# Directory to store files downloaded for IntelliJ IDEA installation
intellij_plugins_download_dir: "{{ x_ansible_download_dir | default(ansible_env.HOME + '/.ansible/tmp/downloads') }}"

# URL for IntelliJ IDEA plugin manager web service
intellij_plugins_manager_url: 'https://plugins.jetbrains.com/pluginManager/'

# List of users to configure IntelliJ IDEA for
users: []

Users are configured as follows:

users:
  - username: # Unix user name
    intellij_plugins:
      - # Plugin ID of plugin to install

Example Playbooks

Minimal playbook:

- hosts: servers
  roles:
    - role: gantsign.intellij-plugins
      users:
        - username: vagrant
          intellij_plugins:
            - CheckStyle-IDEA

Playbook with IntelliJ home and user dirname specified:

- hosts: servers
  roles:
    - role: gantsign.intellij-plugins
      intellij_plugins_intellij_home: '/opt/idea/idea-community-2016.2.5'
      intellij_plugins_intellij_user_dirname: '.IdeaIC2016.2'
      users:
        - username: vagrant
          intellij_plugins:
            - CheckStyle-IDEA

More Roles From GantSign

You can find more roles from GantSign on Ansible Galaxy.

Development & Testing

This project uses Molecule to aid in the development and testing; the role is unit tested using Testinfra and pytest.

To develop or test you'll need to have installed the following:

Linux (e.g. Ubuntu)
Docker
Python (including python-pip)
Ansible
Molecule

Because the above can be tricky to install, this project includes Molecule Wrapper. Molecule Wrapper is a shell script that installs Molecule and it's dependencies (apart from Linux) and then executes Molecule with the command you pass it.

To test this role using Molecule Wrapper run the following command from the project root: