PhpStorm 2024.2 Help

Run/Debug configuration: XSLT

Create: Run | Edit Configurations | Add New Configuration | XSLT

This page describes the configuration-specific items as well as options that are common for all run/debug configurations. For more information about using this configuration, refer to XSLT run configurations and Examine a suspended program.

Settings tab

Item

Description

Input

Use the controls in this area to specify the XML file you want to process and the script you want to execute.

  • XSLT Script File - in this field, specify the path to the XSLT Style Sheet file. Type the path manually or click Browse the Browse button and select the desired file in the Choose XSLT File dialog that opens.

  • Choose XML Input File - from this list, select the XML input file to be transformed. The list contains all the XML files that have been associated with the chosen Style Sheet via the File Associations functionality. To specify a file, which is not on the list, click Browse the Browse button and select the desired file in the Choose XML File dialog, that opens.

Output

Use the controls in this area to configure handling of the script output.

  • Show in Default Console - select this option to have the output displayed in the normal run console, together with any warnings and error messages from the XSLT transformer, as well as messages generated by the script, for example, by xsl:message.

  • Show in Extra Console Tab - select this option to have the produced output displayed in an extra, XSLT Output, tab.

    This option is selected by default.

  • Highlight Output As - select the file type to highlight the output as.

  • Save to File - select this option to have the output saved directly to a file. In the field, specify the name of the target file. Type the path to the file manually or click Browse the Browse button and select the desired file in the Choose Output File dialog, that opens.

    If you type the name of a file that does not exist, PhpStorm will create a file and save the output to it.

    • Open File in Editor After Execution - select this checkbox to have the file with the output opened in the editor after the script is executed successfully.

    • Open File in Web Browser After Execution - select this checkbox to have the file with the output opened in the configured Web browser after the script is executed successfully.

Parameters

Use the controls in this area to create and manage a list of parameters to be passed to the script.

  • Add Add - click this button to create a new entry.

  • Remove Remove - click this button to remove the selected entry from the list.

  • Name - in this field, specify the name of the parameter.

  • Value - in this field, specify the value of the parameter.

Advanced tab

In this tab, configure additional options that are not commonly required in run configurations.

Item

Description

Smart Error Handling

  • Clear this checkbox to have the console display full error messages including their complete stack traces, when an error occurs during execution.

  • Select this checkbox to suppress showing stack trace and have the console display only the relevant information about errors.

VM Arguments

In this field, specify optional VM arguments to be passed to the VM where the XSLT script is executed. These can be heap size, garbage collection options, file encoding, etc. If the line of VM arguments is too long, click Expand to expand the field and type the text there.

Working Directory

In this field, specify the working directory to use. Type the path manually or click Browse the Browse button and select the desired folder in the Working Directory dialog, that opens.

If no folder is specified in field, the working directory will be the one where the XSLT script file is located.

Common settings

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 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, PhpStorm 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 PhpStorm 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.

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 PhpStorm yet, add its definition. For more information, refer to External tools and External Tools.

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

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

  • Run Phing target: add this task to execute the specified Phing target prior to running or debugging. To appoint a Phing target, click Browse the Browse button and select the desired target in the dialog that opens.

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

  • Upload files to Remote Host: select this option to have the application files automatically uploaded to the server according to the default server access configuration.

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

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: 28 June 2024