RubyMine
 
2023.3
Shortcuts: Windows
Get RubyMine
You are viewing the documentation for an earlier version of RubyMine.
  1. Languages
  2. Puppet

Puppet

Last modified: 04 April 2024

RubyMine supports the Puppet language syntax and allows you to work with Puppet modules and environments.

The main supported features are:

Prerequisites

The following gems are required to work with Puppet modules and environments:

tip

Before working with Puppet in RubyMine, make sure that the Puppet plugin is enabled. See Install plugins to learn how to enable or disable plugins.

Create a Puppet module

To create a new Puppet module

  1. In the main menu, go to File | New Project.

  2. In the New Project dialog, choose Puppet Module on the left.

    New project dialog

  3. Then, specify the project location and select the required Ruby SDK. If the puppet gem is not installed in the selected SDK, RubyMine will suggest installing it.

    Install Puppet gem

  4. Finally, specify the Author username, Module name, and click Create. The created project comprises the Puppet module structure.

    Puppet project structure

    You can learn how to create Puppet modules from its documentation.

Open Puppet modules and environments

RubyMine automatically recognizes opened Puppet modules or environments (for instance, by availability of metadata.json or environment.conf files) and marks them with corresponding icons in the project tree.

Puppet project view

After opening a module or environment, you can install its dependencies.

Install dependencies

RubyMine allows you to install the module/environment dependencies specified in the following files:

  • If the module contains a .fixtures.yml file, RubyMine will install dependencies using rake tasks into the spec/fixtures/modules directory. In this case, the IDE does not check next sources.

  • If there is a Puppetfile, RubyMine installs dependencies using librarian-puppet into the .dependencies directory (or to modules for environments).

  • In case of a project contains metadata.json, RubyMine installs dependencies using librarian-puppet in the same way as from the Puppetfile.

To install the module/environment dependencies, right-click the module in the Project tool window and select Install dependencies for module <name> or Install dependencies for environment <name>.

Puppet install dependencies

If the project’s SDK does not have the librarian-puppet gem installed, RubyMine will suggest installing it.

librarian-puppet not available

Configure Puppet-related settings

The Settings dialog CtrlAlt0S allows you to configure the following settings related to Puppet:

  • The Language and Frameworks | Puppet page allows you to configure the Puppet language version and the path to librarian-puppet.

  • Editor | Code Style | Puppet contains code style settings for the Puppet language.

  • Editor | Inspections allows you to configure inspection settings.

  • On the Editor | Live templates page, you can create custom live templates for the Puppet language in the same way as for other languages.

    Puppet live templates

See also

External Links