PhpStorm 2024.1 Help

Pug (Jade)

PhpStorm integrates with the Pug (Jade) template engine that transforms Pug (Jade) files into HTML.

Pug files are marked with the Pug icon; Jade files are marked with the Jade icon.

Before you start

  1. Make sure you have Node.js on your computer.

  2. Install and enable the Pug (ex-Jade) plugin on the Settings | Plugins page, tab Marketplace, as described in Installing plugins from JetBrains Marketplace.

  3. Make sure the File Watchers plugin is enabled in the settings. Press Ctrl+Alt+S to open the IDE settings and then select Plugins. Click the Installed tab. In the search field, type File Watchers. For more information about plugins, refer to Managing plugins.

Installing Pug

  • In the embedded Terminal (Alt+F12) , type:

    npm install -g pug-cli

Compiling Pug

To compile your code automatically, you need to install the template engine and configure a Pug/Jade File Watcher which will track changes to your files and run the template engine.

When you open a file, PhpStorm checks whether an applicable File Watcher is available in the current project. If such File Watcher is configured but disabled, PhpStorm displays a popup that informs you about the configured File Watcher and suggests to enable it.

If an applicable File Watcher is configured and enabled in the current project, PhpStorm starts the compiler automatically upon the event specified in the New Watcher dialog.

  • If the Auto-save edited files to trigger the watcher checkbox is selected, the File Watcher is invoked as soon as any changes are made to the source code.

  • If the Auto-save edited files to trigger the watcher checkbox is cleared, the File Watcher is started upon save (File | Save All, Ctrl+S) or when you move focus from PhpStorm (upon frame deactivation).

Learn more from File Watchers.

Create a Pug/Jade File Watcher

  1. Open the Settings dialog (Ctrl+Alt+S) and go to Tools | File Watchers.

  2. Click the Add button or press Alt+Insert and choose the Pug/Jade predefined template from the list. Your code will be translated into JavaScript and supplied with generated source maps.

  3. In the Program field, specify the path to the pug or jade package. Type the path manually or click the Browse button and choose the file location in the dialog that opens.

  4. Proceed as described in File Watchers.

Configuring syntax highlighting

You can configure Pug/Jade-aware syntax highlighting according to your preferences and habits.

  1. In the Settings dialog (Ctrl+Alt+S) , go to Editor | Color Scheme | Pug/Jade.

  2. Select the color scheme, accept the highlighting settings inherited from the defaults or customize them as described in Colors and fonts.

Last modified: 11 February 2024