Puppet Extension for Visual Studio Code is moving!

We are proud to announce that Official Puppet VS Code Extension is moving to the Puppetlabs namespace in the VS Code Marketplace!

The new extension will live at Puppet VS Code with the ID puppet.puppet-vscode. In order to use the new extension, you can install it using the normal installation methods: the Extension Manager in VS Code, the VS Code command line, or any of the other methods of installing VS Code extensions.

All of the Github repos for the Puppet VS Code Extension will be transferred from the Lingua Pupuli Github Organization to the Puppet Github Organization. The repository links will automatically forward and all documentation will be updated with the new links. For the most part, this move will be transparent to users of the extension.

This means the existing extension jpogran.puppet-vscode will no longer be maintained after the transition and will be eventually deprecated in the marketplace. The new extension puppet.puppet-vscode will be maintained and will receive all new features going forward. Once you have added the new extension, it is safe to remove the jpogran.puppet-vscode extension

Puppet VSCode Website

We are proud to announce the new Puppet VSCode website https://puppet-vscode.github.io/! This website contains all of the documenation previously held in this README, simplified and organinzed. There is also new content that shows off all the current features in greater detail, as well as new ways to use the Puppet VSCode Extension with other technologies like the Microsoft Remote Development Extension Pack. This README retains some quick information on how to get started and where to get help if things go wrong.

Table of Contents

• Quick Start
• Features
• Requirements
• Platform Support
• Usage
  • Syntax highlighting
  • Auto completion
  • Hover Support
  • Outline View
  • Breadcrumbs
  • Go to Symbol Open Symbol by Name
  • Code Snippets
  • Linting
  • Live Workspace Intellisense
  • Puppet Commands
    • Puppet Resource
    • Puppet Node Graph
  • Puppet Development Kit Support
    • PDK Supported Versions
    • PDK New Module
    • PDK New Class
    • PDK Validate
    • PDK Test Unit
  • Puppet Bolt Support
  • Debugging Puppet manifests
• Installing the Extension
• Configuration
• Experience a Problem?
  • Puppet Agent Install
  • Reloading the Puppet VSCode extension
• Reporting Problems
• Maintainers
• Telemetry
• License

Quick start

For a more detailed walkthrough see the official documentation

• Step 1: Install a supported version of the Puppet Development Kit on your system (see Requirements for more information).
• Step 2: Install the Puppet extension for Visual Studio Code.
• Step 3: Open or create a Puppet manifest file (a file with a .pp or .epp extension or named Puppetfile) and start automating!

Features

A Visual Studio Code extension that provides rich support for the Puppet language, including features such as syntax highlighting, linting, debugging, IntelliSense and more.

This extension provides full Puppet Language support for Visual Studio Code.

• Syntax highlighting
• IntelliSense for resources, parameters and more
• Outline View
• Breadcrumbs
• Go to Symbol
• Open Symbol by Name
• Linting
• Live Workspace Intellisense
• Code snippets
• Go to Definition of functions, types and classes
• Validation of metadata.json files
• Import from puppet resource directly into manifests
• Node graph preview
• Puppet Development Kit integration
• (Experimental) Local debugging of Puppet manifests
• DEPRECATED Docker Language Server support

It is currently in technical preview, so that we can gather bug reports and find out what new features to add.

Supported Puppet Versions

The Puppet Extension for VSCode works with Puppet 4 or higher. Some features will be slower or not work on Puppet 4, and are noted in the section for that feature. See open source Puppet and Puppet Enterprise lifecycle pages for version support details.

Requirements

You will need to have the Puppet Development Kit (PDK) or Puppet Agent installed in order to fully use this extension.

Note: When using PDK, version 1.5.0 or higher is required.

You can find instructions and installation links here:

PDK

• Download page

Puppet-Agent

• Windows
• MacOSX
• Linux

Platform support

• Microsoft Windows
• MacOSX
• Linux

Installing the Extension

You can install the official release of the Puppet extension by following the steps in the Visual Studio Code documentation. In the Extensions pane, search for "puppet-vscode" extension and install it there. You will get notified automatically about any future extension updates!

You can also install the extension without access to the internet by following these instructions

Experience a Problem?

Puppet Agent Install

A commonly encountered problem is not having the PDK or Puppet Agent installed on the computer you are running VSCode on. As noted in the Requirements section, you will need to have the PDK or Puppet Agent installed in order to fully use this extension, as the extension uses the Puppet binaries and the Ruby language bundled into the PDK or agent install in order to function.

If you are receiving an error right after opening a Puppet file saying that a Puppet Agent install could not be found, ensure that Puppet is installed on the system. The VSCode extension attempts to find a valid Puppet install if a path is not configured in puppet.installDirectory in User Settings, so if Puppet is installed but not in a default path please check that your setting points to the correct path.

Reloading the Puppet VSCode extension

If you haven't see the Problems Pane update in awhile, or hover and intellisense doesn't seem to showing up, and you might not know what to do. Sometimes the Puppet extension can experience problems which cause the language server to crash or not respond. The extension has a way of logging the crash, but there is something you can do to get right back to working: reload the Puppet Language Server.

You can reload the Puppet Lanuguage Server by opening the command palette and starting to type Reload. A list of commands will appear, select Reload Window. This will reload the Visual Studio Code window without closing down the enitre edtior, and without losing any work currently open in the editor.

Reporting Problems

If you're having trouble with the Puppet extension, please follow these instructions to file an issue on our GitHub repository:

1. File an issue on our Issues Page

Make sure to fill in the information that is requested in the issue template as it will help us investigate the problem more quickly.

2. Capture verbose logs and send them to us

If you're having an issue with crashing or other erratic behavior, add the following line to your User Settings in Visual Studio Code:

    "puppet.editorService.loglevel": "debug",
    "puppet.editorService.debugFilePath": "C:\\Some\\file\\path.txt"

Restart Visual Studio Code and try to reproduce the problem, then examine the log. If the issue persists please open an issue and add both the content of the Output pane as well as the content in the log file. Please inspect the log and be sure to redact any information you would not want posted publicly.

Maintainers

• James Pogran - @ender2025
• Glenn Sarti - @glennsarti
• Michael T Lombardi - @barbariankb
• Austin Blatt

Telemetry

This extension collects telemetry data to help us build a better experience for writing manifest and modules with Puppet and VS Code. We only collect data on which commands are executed. We do not collect any information about files, paths, etc. The extension respects the telemetry.enableTelemetry setting which you can learn more about in our FAQ.

License

This extension is licensed under the Apache-2.0 License.