JetBrains Rider 2022.3 Help

Run/Debug Configuration: Spy-js

Create: Run | Edit Configurations | Add New Configuration | Spy-js

In this dialog, create configurations for tracing Web applications using the Spy-js tool.

Before you start

  1. Download and install Node.js.

  2. Install the Node.js and Spy-js plugins on the Settings | Plugins page, tab Marketplace, as described in Installing plugins from JetBrains repository.

Spy-js-specific configuration settings

Item

Description

Node interpreter

In this field, specify the Node.js interpreter to use.

If you choose the Project alias, JetBrains Rider will automatically use the project default interpreter from the Node interpreter field on the Node.js page . In most cases, JetBrains Rider detects the project default interpreter and fills in the field itself.

You can also choose another configured local or remote interpreter or click the Browse button and configure a new one.

Trace server port

In this field, specify the port on which Spy-js will act as a proxy server.

The trace server port is filled in automatically. To avoid port conflicts, it is recommended that you accept the suggested value and keep the Automatically configure system proxy checkbox selected. As a result, the specified port number is automatically set for the system proxy server.

Alternatively, configure your system proxy port manually.

Go to Settings | Windows Settings | Network & Internet | Proxy and turn on Use a proxy server. In the Port field, type the trace server port number.

Learn more from the Microsoft official website.

Go to System Preferences | Network, click Advanced, switch to the Proxies tab, clear the Automatic Proxy Configuration, and type the URL address of your Proxy configuration file. Make sure, the port in the URL is the same as the trace server port from your run/debug configuration.

Learn more from the Apple official website.

Use

In this field, specify the way to configure a tracing session.

  • To have Spy-js apply its internal predefined configuration, choose Default configuration.

  • To have your custom manually created configuration applied, choose the Configuration file option and then specify the location of your custom configuration file in the Configuration field below.

    A configuration file is a JavaScript file with the extension .js or .conf.js that contains valid JavaScript code that meets the Spy-js configuration requirements. If JetBrains Rider detects files with the extension .conf.js in the project, these files are displayed in the list.

    Type the path to the configuration file manually or click Browse the Browse button and choose the location in the dialog that opens. Once specified, a configuration file is added to the list so you can get if next time from the list instead of specifying the path.

URL to trace

In this field, specify the URL address of the Web page to capture events on. By default, the field is empty. This means that Spy-js captures events on all the currently opened Web pages. If you want to restrict the tracing to a certain page, specify its URL address. Type the address manually or choose it from the list, if it has been once specified in the configuration.

Common settings

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

Name

Specify a name for the run configuration to quickly identify it among others when editing or running.

Allow multiple instances

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, JetBrains Rider suggests stopping the running instance and starting another one. This is helpful when a run 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 JetBrains Rider 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 solution as well as adjust default configurations templates.

Item

Shortcut

Description

the Add button

Alt+Insert

Create a run/debug configuration.

the Remove button

Alt+Delete

Delete the selected run/debug configuration. Note that you cannot delete default configurations.

Copy

Ctrl+D

Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.

Save configuration

The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.

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.

Item

Shortcut

Description

the Add button

Alt+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 JetBrains Rider yet, add its definition.

  • Run Another Configuration: select to execute another run/debug configuration and wait until it finishes before starting the current configuration. If you want to run several configurations in parallel, use a compound run/debug configuration.

  • Build solution: select this option to build the solution before launching the configuration.

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

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

  • 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.

the Remove button

Alt+Delete

Click this icon to remove the selected task from the list.

Edit

Enter

Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.

Method up/Method down

Alt+Up/Alt+Down

Click 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 page

Select 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.

Last modified: 17 November 2022