PhpStorm 2017.3 Help

Pug (Jade) Template Engine

PhpStorm integrates with the Pug (Jade) template engine.

Before you start

  1. Install the Node.js runtime environment.
  2. Make sure the Pug (ex-Jade) plugin is installed and enabled. The plugin is not bundled with PhpStorm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

Also, if you need a file watcher, make sure that the File Watchers plugin is enabled. The plugin is activated by default. If the plugin is disabled, enable it on the Plugins settings page as described in Enabling and Disabling Plugins.

Changes to the UI

The Pug (ex-Jade) plugin introduces the following changes to the PhpStorm UI:

  • The Jade file item is added to the New menu.
  • The Pug files are marked with the icon pug; the Jade files are marked with the icon jade.
  • Coding assistance is provided in the Pug (Jade)-specific and HTML context:

Using Pug(Jade) templates in a Node.js application

At runtime, the Pug (Jade) files fill be transformed into HTML pages.

  1. Create a project from scratch, or around existing sources, or based on a NodeExpress template. See Creating New Project from Scratch, Generating a Project from a Framework Template for details.
  2. Create a Pug (Jade) file. Follow these steps:
    1. In the Project Tool Window, select the directory in which you want to create a new file. To do that, for example, choose File | New.
    2. On the context menu, choose Jade file and specify the file name in the dialog box that opens.
  3. Create a File Watcher to transform files with the extension .jade or .pug into .html pages:
    1. Click the Add Watcher link in the upper right-hand corner of the editor.
    2. In the New Watcher Dialog, accept the default predefined settings.

      Note that if the executable is in the PATH, then you should not specify it explicitly. Depending on the file extension (.jade or .pug), the corresponding executable is invoked.

      file watcher jade
  4. As you edit a .pug/.jade file, PhpStorm invokes the file watcher which creates an .html file with the name of the processed .pug/.jade file and stores the generated html code in it.

See Using File Watchers for details.

Last modified: 29 March 2018

See Also