PhpStorm
 
2023.2
Shortcuts: Windows
Get PhpStorm
You are viewing the documentation for an earlier version of PhpStorm.
  1. Web technologies
  2. Style sheets
  3. Stylus

Stylus

Last modified: 11 July 2023

Required plugins:

Stylus -  Install the plugin on the Settings | Plugins page, tab Marketplace.

File Watchers -  The plugin is bundled with PhpStorm and enabled by default.

PhpStorm lets you translate your Stylus code into CSS on the fly.

Before you start

Installing Stylus

Compiling the Stylus code

To compile your code automatically, you need to install a compiler and configure a Stylus File Watcher which will track changes to your files and run the compiler.

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, Ctrl0S) or when you move focus from PhpStorm (upon frame deactivation).

Learn more from File Watchers.

PhpStorm creates a separate file with the generated output. The file has the name of the source Stylus file and the extension .css. The location of the generated files is defined in the Output paths to refresh field of the New Watcher dialog. However, in the Project Tree, they are shown under the source file which is now displayed as a node.

Create a File Watcher

  1. In the Settings dialog (CtrlAlt0S), click File Watchers under Tools. The File Watchers page that opens shows the list of already configured File Watchers.

  2. Click the Add button or press AltInsert and choose the Stylus predefined template from the list.

  3. In the Program field, specify the path to the executable file:

    • stylus for macOS and Unix.

    • stylus.bat for Windows.

    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 Stylus-aware syntax highlighting according to your preferences and habits.

See also

Procedures

Reference