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, usage of LESS and CoffeeScript, are out of scope of this tutorial.
Make sure that:
You are working with Professional edition ofPyCharm.
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 the File Watchers plugin is enabled. The plugin is bundled with PyCharm and is activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings/Preferences dialog Ctrl+Alt+S as described in Managing plugins.
If you are using Docker for Windows, enable the Expose daemon on tcp://localhost:2375 without TLS option in the General section of your Docker settings.
It is advisable to familiarize yourself with the matter in advance. Please read the section File Watchers.
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 on the main toolbar, remember ?) and look for this plugin in the Jetbrains repository:
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 Ctrl+Alt+S - Node.js and NPM.
Installing LESS and CoffeeScript compilers
Open Settings/Preferences, and open then the pageNode.js and NPM.On this page, specify the Node interpreter (its version is determined automatically), and then click - one time to install less, and the other time to install coffee-script.
As you've noticed already, LESS and CoffeeScript are installed locally, so the corresponding compiler files are written under the project root:
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:
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:
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:
Again, click Add watcher and specify the file watcher settings, in particular, the CoffeeScript executable:
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
@Color, and change its value. The file watcher immediately processes the changed source file, and produces an output file with the extension css:
Note that in either case PyCharm shows generated files in the Project Tool Window under the source files.
Troubleshooting, or if an error occurs?
If a command line tool executed by the File Watcher fails, PyCharm shows its output in the Run tool window:
Helpful for troubleshooting, isn't it?