JetBrains Rider 2019.2 Help

Pug (Jade) Template Engine

JetBrains Rider 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. Download and install Node.js.

  2. Install and enable the Pug (former Jade) repository plugin on the Plugins page as described in Managing plugins.

Also, if you need a file watcher, make sure that the File Watchers plugin is installed and enabled. The plugin is not bundled with JetBrains Rider, but it can be installed from the JetBrains plugin repository as described in Managing plugins.

Install Jade

In the embedded Terminal Ctrl+Alt+1, type:

npm install pug

To compile your code on the fly, you need to configure the template engine as a JetBrains Rider File Watcher.

Create a Pug/Jade file watcher

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Tools | File Watchers.

  2. Click the Add button or press Ctrl+N and choose the Pug/Jade predefined template from the list. Your code will be translated to 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.

When you open a file, JetBrains Rider checks whether an applicable file watcher is available in the current project. If such file watcher is configured but disabled, JetBrains Rider 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, JetBrains Rider starts it 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+Shift+S) or when you move focus from JetBrains Rider (upon frame deactivation).

Configuring syntax highlighting

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

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

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

Last modified: 20 August 2019

See Also