Run/Debug Configuration: NPMProfessional

Last modified: 08 March 2021

Run | Edit Configurations | Add New Configuration | NPM

In this dialog, create configurations for running npm and Yarn scripts locally. "Locally" in the current context means that PyCharm itself starts Node.js installed on your computer, whereupon initiates script execution.

Learn more from npm, pnpm, and Yarn.

Before you start

Configuration tab

Item

Description

package.jsonIn this field, specify the package.json file to run the scripts from. Choose the file from the drop-down list which shows all the package.json files detected in the current project or click the Browse button and choose the required package.json in the dialog box that opens.
CommandFrom this list, choose the npm CLI command to execute, by default run-script is selected. Learn more at npm documentation, under the section CLI Commands.
ScriptsFrom this drop-down list, choose the script to which the chosen command will be applied. The list contains all the scripts defined within the scripts property in the package.json file.
ArgumentsIn this field, specify the command-line arguments to execute a script with. Learn more from the npm official website.
Node interpreter

In this field, specify the Node.js interpreter to use. This can be a local Node.js interpreter or a Node.js on Windows Subsystem for Linux.

Node Options

In this text box, type the Node.js-specific command-line options to be passed to the Node.js executable file. The acceptable options are:

  • Use --require coffeescript/register to have CoffeeScript files compiled into JavaScript on the fly during run.

    This mode requires that the register.js file, which is a part of the coffeescript package, is located inside your project. Therefore make sure you have the coffeescript package installed locally as described in Install the CoffeeScript compiler.

  • Use --inspect or --inspect-brk parameter when you are using Node.js v7 for Chrome Debugging Protocol support. Otherwise, by default the debug process will use V8 Debugging Protocol.

Package managerIn this field. specify the package manager to use. If you choose the Project alias, PyCharm will use the default project package manager from the Node.js page. You can also choose the relevant package alias (npm or yarn) or specify an explicit path to a custom installation of a package manager.
Environment Variables In this field, specify the environment variables for the Node.js executable file, if applicable. Click Browse the Browse button to the right of the field and configure a list of variables in the Environment Variables dialog, that opens:

  • To define a new variable, click the Add button and specify the variable name and value.

  • To discard a variable definition, select it in the list and click the Remove button.

  • Click OK, when ready

The definitions of variables are displayed in the Environment variables read-only field with semicolons as separators, for example:

  • NODE_PATH: A : -separated list of directories prefixed to the module search path.

  • NODE_MODULE_CONTEXTS: Set to 1 to load modules in their own global contexts.

  • NODE_DISABLE_COLORS: Set to 1 to disable colors in the REPL.

Common

When you edit a run configuration (but not a run configuration template), you can specify the following options:

Item

Description

Name

Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.

Allow parallel run

Select to allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, PyCharm suggests to stop the running instance and start another one. This is helpful when a run/debug configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and PyCharm stores run configuration settings in .idea/workspace.xml.

Toolbar

The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.

ItemShortcutDescription
the Add buttonAlt+InsertCreate a run/debug configuration.
the Remove buttonAlt+DeleteDelete the selected run/debug configuration. Note that you cannot delete default configurations.
CopyCtrl+DCreate a copy of the selected run/debug configuration. Note that you create copies of default configurations.
Save configurationThe button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
Edit TemplatesView and edit the template (that is, the default run/debug configuration settings). The templates are displayed under the Templates node and used for newly created configurations.
Method up/ Method downAlt+Up/ Alt+Down

Move the selected run/debug configuration up and down in the list.

The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.

Default templates of run/debug configurations are always sorted alphabetically.

Move into new folder / Create new folder

Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category, click Folder, and specify the folder name. If only a category is in focus, an empty folder is created.

Then, to move a configuration into a folder, between the folders or out of a folder, use drag or Move Up and Move Down buttons.

To remove grouping, select a folder and click Remove Configuration.

Sort configurations Click this button to sort configurations in the alphabetical order.

Before Launch

In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

ItemShortcutDescription
the Add buttonAlt+Insert

Click this icon to add one of the following available tasks:

  • Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in PyCharm yet, add its definition. For more information, see External tools and External Tools.

  • Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.

  • Launch Web Browser: select this option to have a browser started. In the dialog that opens, select the type of the browser and provide the start URL. Also, specify if you want the browser be launched with JavaScript debugger.

  • Run File Watchers: select this option to have PyCharm apply all the currently active File Watchers.

  • Run Grunt task: select this option to run a Grunt task.

    In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package.

  • Run Gulp task: select this option to run a Gulp task.

    In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package.

  • Run npm Script: select this option to execute an npm script.

    In the NPM Script dialog that opens, specify the npm run/debug configuration settings.

  • Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:

    • If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.

    • If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched.

  • Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.

  • Run Remote External tool: adds a remote SSH external tool.

the Remove buttonAlt+DeleteClick this icon to remove the selected task from the list.
EditEnterClick this icon to edit the selected task. Make the necessary changes in the dialog that opens.
Method up/ Method downAlt+Up/ Alt+DownClick these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list.
Show this pageSelect this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window

By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.

See also

Procedures

Reference