Ansible Role: Atom

Role to install the atom.io text editor by GitHub.

Requirements

• Ansible >= 2.9

• Linux Distribution

  • Debian Family

    • Ubuntu

      • Bionic (18.04)
      • Focal (20.04)

    • 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):

# Users to install packages for and/or write config.cson
users: []

Users are configured as follows:

users:
  - username: # Unix user name
    atom_packages:
      - # package 1
      - # package 2
    atom_config: # The config (in YAML not CSON)
    atom_config_overwrite: yes # By default the config file will not be overwritten

Example Playbooks

Minimal playbook:

- hosts: servers
  roles:
    - role: gantsign.atom

Playbook with packages installed and config:

- hosts: servers
  roles:
    - role: gantsign.atom
      users:
        - username: vagrant
          atom_packages:
            - minimap
            - linter
            - atom-beautify
            - file-icons
          atom_config:
            '*':
              core:
                projectHome: '/home/vagrant/workspace'
              editor:
                showIndentGuide: true
                showInvisibles: true

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:

./moleculew test

Note: some of the dependencies need sudo permission to install.

License

MIT

Author Information

John Freeman

GantSign Ltd. Company No. 06109112 (registered in England)