PhpStorm 2017.3 Help

Meteor

PhpStorm provides integration with the Meteor framework. Meteor support in PhpStorm involves:

  • Automatic recognition of Meteor projects by detecting the .meteor folder and excluding the .meteor/local folder from project. See Hiding excluded files for details.
  • Attaching the predefine Meteor library to the project automatically. This enables syntax highlighting, resolving references, and code completion. See Configuring JavaScript Libraries for details.
  • Coding assistance: syntax highlighting, code completion, resolving references.
  • Support of Spacebars via Handlebars with completion for if and each directives. PhpStorm recognizes Spacebars templates, but as a side effect marks HTML files in Meteor projects with the Handlebars/Mustache icon fileTypeHandlebars. PhpStorm provides navigation between JavaScript source code and templates with go to Declaration (Ctrl+B).
  • Running and debugging the server and the client sides of applications.

Before you start

Make sure the Meteor and the Handlebars/Mustache plugins are activated. The plugins are not bundled with PhpStorm, but they can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins. Once enabled, the plugins are available at the IDE level, that is, you can use them in all your PhpStorm projects.

Installing Meteor

The installation procedure depends on the operating system you are using:

  • To install Meteor on Windows
    Download the LaunchMeteor.exe installer at the Meteor Official website.
  • To install Meteor on macOS or Linux
    Open the built-in PhpStorm Terminal (Alt+F12) and type $ curl https://install.meteor.com | /bin/sh at the command prompt.
Learn more from the Meteor Official website.

Creating a new Meteor application

If you have no application yet, you can generate a PhpStorm project with Meteor-specific structure from a Meteor boilerplate template. Alternatively, create an empty PhpStorm project and configure Meteor support in it as described in Starting with an existing Meteor application below.

To create a Meteor project from a boilerplate template

  1. In the left-hand pane, choose Meteor App.
  2. In the right-hand pane:
    1. Specify the path to the folder where the project-related files will be stored.
    2. Specify the location of the Meteor executable file (see Installing Meteor).
    3. From the Template drop-down list, choose the sample to generate. To have a basic project structure generated, choose the Default option.
    4. In the Filename text box, type the name for the mutually related .js, .html, and .css files that will be generated. The text box is available only if the Default sample type is selected from the Template drop-dow list.

To create an empty PhpStorm project

  1. Choose File | New Project on the main menu or click Create New Project on the Welcome screen. The Create New Project Dialog opens.
  2. In the left-hand pane, choose PHP Empty Project. In the right-hand pane, specify the application folder and click Create.

Starting with an existing Meteor application

If you are going to continue developing an existing Meteor application, open it in PhpStorm, configure Meteor in it, and download the required dependencies as described in Downloading Meteor dependencies below.

If the application sources are already on your machine
Click Open on the Welcome screen or choose File | Open Directory on the main menu. In the dialog that opens, select the folder where your sources are stored.

If the application sources are under version control

  1. Click Check out from Version Control on the Welcome screen or choose VCS | Check out from Version Control on the main menu.
  2. Select your version control system from the list.
  3. In the VCS-specific dialog that opens, type your credentials and the repository to check out the application sources from.

To configure Meteor support in an existing project

  1. In Settings/Preferences dialog (Ctrl+Alt+S), choose JavaScript under Languages and Frameworks, then choose Meteor. The Meteor page opens.
  2. Check the location of the Meteor executable file or specify the path to it if PhpStorm has not detected the executable file automatically.
  3. To involve the .meteor/local folder and its contents in indexing, clear the Automatically exclude ".meteor/local" directory on open project checkbox. By default, the checkbox is selected. For details, see Hiding excluded files below.
  4. Make sure the Automatically import Meteor packages as external library checkbox is selected.
    • When the checkbox is selected, PhpStorm automatically imports the external packages from the meteor/packages file. As a result, PhpStorm provides full range coding assistance: resolves references to Meteor built-in functions, for example, check(true), and to functions from third-party packages, provides proper syntax and error highlighting, supports debugging with source maps, etc.
    • When this checkbox is cleared, PhpStorm does not automatically import the external packages from the meteor/packages file. As a result no coding assistance is provided. To improve the situation, open the meteor/packages file in the editor and click the Import packages as library link or run the meteor --update command.
    By default, the checkbox is selected.
  5. Make sure PhpStorm has attached the Meteor library to the project.
    In the Settings/Preferences dialog (Ctrl+Alt+S), choose JavaScript under Languages and Frameworks, then choose Libraries. On the JavaScript. Libraries page opens, make sure the checkbox next to the Meteor project library in the Libraries list is selected.

Importing Meteor packages

Besides the predefined Meteor library that ensures basic Meteor-specific coding assistance, you can download additional packages that are defined in the .meteor/local/packages file.

To download additional Meteor packages

  1. Open the .meteor/local/packages file in the editor.
  2. Click the Import Meteor Packages link in the upper right-hand corner of the screen.
  3. In the dialog box that opens, specify the packages to download depending on the type of the application you are going to develop in your project.
    • Client
    • Server
    • Cordova: choose this option to import the packages that support development of Meteor applications for iOS and Android, see Meteor Cordova Phonegap Integration for details.

Hiding excluded files

the .meteor/local folder, which is intended for storing the built application, is automatically marked as excluded and is not involved in indexing. By default, excluded files are shown in the project tree. To have the .meteor/local folder hidden, click the icon viewMode button on the toolbar of the Project tool window and remove a tick next to the Show Excluded Files option.

Running a Meteor application

PhpStorm runs Meteor applications according to a run configuration of the type Meteor. If you created your application from a boilerplate template, PhpStorm generates a Meteor run configuration for you.

To create a Meteor run configuration

  1. On the main menu, choose Run | Edit Configurations, click add.png and choose Meteor from the list. The Run/Debug Configuration: Meteor opens.
  2. In the Configuration tab, specify the path to the Meteor executable file according to the installation (see Installing Meteor).
  3. Specify the folder under which the application files to run are stored. This folder must have a .meteor subfolder in the root so PhpStorm recognizes your application as a Meteor project. By default, the working directory is the project root folder.

Optionally

  1. In the Program Arguments field, specify the command line additional parameters to be passed to the executable file on start up, if applicable. These can be, for example, --dev, --test, or --prod to indicate the environment in which the application is running (development, test, or production environments) so different resources are loaded on start up.
  2. By default, PhpStorm shows the application output in the Run tool window. To view the results of the client-side code execution, in the Browser / Live Edit tab select the After Launch checkbox and choose the browser to open from the drop-down list. In the text box below, specify the URL address to open the application at. The default value is http://localhost:3000.

To run a Meteor application

  1. Select the required run configuration from the list on the main tool bar and then choose Run | Run <configuration name> on the main menu or click the Run toolbar button run.png.
  2. View the application output in the Run tool window.
    If you configured the browser to open automatically on the application start as described above, the browser shows the result of application execution.

Debugging a Meteor application

With PhpStorm built-in debugger, you can debug both the client-side and the server-side of Meteor JavaScript code within one debugging session. A debugging session is initiated only through a dedicated Meteor run configuration.

Technically, several Meteor projects that implement different applications can be combined within one single PhpStorm project. To run and debug these applications independently, create a separate run configuration for each of them with the relevant working directory. To avoid port conflicts, these run configurations should use different ports. In the Program Arguments field, specify a separate port for each run configuration in the format --port=<port_number>.

To debug a Meteor application

  1. Set the breakpoints in the code where necessary.
  2. Create a Meteor run/debug configuration as described above. In the Browse / Live Edit tab, select the After launch checkbox, choose Chrome from the list, and select the with JavaScript debugger checkbox.
  3. To initiate a debugging session, select the required debug configuration from the list on the main tool bar and click debug.png next to the list or choose Run | Debug <configuration name>. The Debug tool window opens showing two tabs: one for debugging the server-side code marked with icon meteor and the other one for debugging the client-side code marked with icon javascript.
  4. Explore the suspended program and step through the program.
  5. Optionally, preview the changes to the application on the fly as described below.

Previewing changes in the browser

During a debugging session, you can preview the changes to your HTML, CSS, or JavaScript code on the fly. The live contents of the page you edit are shown in the Elements tab of the Debug tool window. The update policy depends on which part of your application you are editing.

To preview the changes to the client-side code

  • Switch to the <Configuration name> JavaScript icon javascript tab and click update icon on the toolbar.
  • Alternatively, select the Enable Meteor Hot code push checkbox on the Meteor page to configure automatic upload of updates. Learn more from the Meteor Official website.

To preview the changes to the server-side code

  • Switch to the <Configuration name> icon meteor tab and click update icon on the toolbar.
  • Alternatively, configure automatic upload with the Live Edit functionality as described in Live Edit in HTML, CSS, and JavaScript. It is recommended that you select the Restart if hotswap fails checkbox on the Live Edit page, then PhpStorm will attempt to restart the server when automatic upload fails.

Last modified: 3 November 2017

See Also