PyCharm 2016.2 Help

Tutorial: File Watchers in PyCharm

In this section:

What this tutorial is about

This tutorial aims to walk you step by step through using file watchers in PyCharm.

The basics of file watchers, in particular, LESS and CoffeeScript are out of scope of this tutorial.

Prerequisites

Make sure that:

  • You are working with Professional edition of PyCharm version 5.0 or higher
  • Node.js is downloaded and installed. It is advisable, depending on your particular operating system, to add the path to Node.js executable to the Path environment variable.
  • Before you start working with file watchers, make sure that File Watchers plugin is enabled. The plugin is bundled with PyCharm and activated by default. If it is not, enable the plugin as described in the section Enabling and Disabling Plugins.

    .
  • It is advisable to familiarize yourself with the matter in advance. Please read the section Using File Watchers.
  • In this tutorial, we'll work with Less and CoffeeScript files. So, before you start your workout, perform some preliminary steps.

Installing Node.js plugin

First, download and install Node.js plugin. It is not bundled; so to have it installed, open the Plugins page (click settings on the main toolbar, remember ?) and look for this plugin in the Jetbrains repository:

py_nodejs_plugin

For the changes to take effect, restart PyCharm. After restart, you will notice a new page under the Languages and Frameworks node in the settings/preferences dialog - Node.js and NPM.

Installing LESS and CoffeeScript compilers

Open settings/preferences(settings), and open the page Node.js and NPM. On this page, specify the Node interpreter (its version is determined automatically), and then click add - one time to install less, and the other time to install coffee-script:

py_nodejs_npm

As you've noticed already, LESS and CoffeeScript are installed locally, so the corresponding compiler files are written under the project root:

py_nodejs_project_view

These files will be required a little bit later. Now, it's time to start!

Configuring file watchers

When PyCharm detects that you are working with a file it can "watch," it prompts to set up a File Watcher.

Configuring file watcher for LESS files

For example, when you open for editing a LESS file, PyCharm shows a notification banner:

py_nodejs_less_watcher

Click the link Add watcher. PyCharm shows the following dialog box, where you have to specify your file watcher type (Less here), executable (lessc.cmd here), and select the option to generate output from stdout:

py_nodejs_less_watcher_new

Looking at this configuration, you can easily figure out what the file watcher actually does:

  • Watches for changes on all Less files within your project.
  • Compiles files with the extension .less into the files with the extension .css, using the compiler lessc.cmd, specified in the field Program.

Configuring file watcher for CoffeeScript

Next, open for editing a CoffeeScript file. PyCharm immediately prompts you to configure a file watcher for it:

py_nodejs_coffeescript_watcher

Again, click Add watcher and specify the file watcher settings, in particular, the CoffeeScript executable:

py_nodejs_coffeescript_watcher_new

What does this file watcher do?

  • It also tracks changes in all CoffeeScript files in your project.
  • If compiles files with the extension .coffee into the files with the extension .js, using the compiler coffee.cmd, specified in the field Program.
  • It compiles files with the extension .coffee into the files with the extension .map, using the compiler coffee.cmd, specified in the field Program.

Editing file watchers

OK, here we are. Open for editing the file my.less, and change something, for example, rename the variable @myColor to @Color, and change its value. The file watcher immediately processes the changed source file, and produces an output file with the extension .css:

py_nodejs_less_watcher_edit

Next, open for editing a CoffeeScript file and change something there. The configured file watcher generates a JavaScript file and a source mapping file:

py_nodejs_coffeescript_watcher_edit

Note that in either case PyCharm shows generated files in the Project Tool Window under the source files.

Troubleshooting

If a command line tool executed by the File Watcher fails, PyCharm shows its output in the Run tool window:

py_nodejs_error

Helpful for troubleshooting, isn't it?

See Also

Last modified: 10 June 2016