JavaScript run configurations

This topic summarizes the run configurations available for JavaScript. Each table provides keys that are available within a run configuration and their descriptions.

npm

Run configuration for launching npm, yarn and pnpm commands

`command` (required)	command to run
`environment`	Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example: "environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }
`dependsOn`	Names of other configurations which will be executed before this configuration, for example: `"dependsOn": ["first", "second"]`. For more information, refer to Chained run configurations.
`workingDir`	Working directory for this run configuration.
`allowParallelRun`	When set to `true`, more than one instance of this configuration can run in parallel.
`scripts`	Whitespace-separated list of scripts to apply with the 'run' command Default value: `null`
`packageFile`	Path to package.json file if it's outside of workspace root or working directory Default value: `null`
`commandArguments`	Arguments passed to the command Default value: `[]`
`packageManagerOptions`	Arguments passed to the package manager executable Default value: `[]`
`packageManagerExecutable`	Path to an npm executable Default value: `null`
`packageManagerKind`	Package manager kind: npm, yarn or pnpm. Detected automatically if not specified Default value: `null`

node

Run configuration for launching Node.js

`file` (required)	File to run
`environment`	Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example: "environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }
`dependsOn`	Names of other configurations which will be executed before this configuration, for example: `"dependsOn": ["first", "second"]`. For more information, refer to Chained run configurations.
`workingDir`	Working directory for this run configuration.
`allowParallelRun`	When set to `true`, more than one instance of this configuration can run in parallel.
`nodeOptions`	Node.js command line options Default value: `[]`
`appOptions`	Application command line options Default value: `[]`
`nodeExecutablePath`	Path to a node executable Default value: `null`

jest

Run configuration for launching Jest tests

`file` (required)	File to run
`environment`	Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example: "environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }
`dependsOn`	Names of other configurations which will be executed before this configuration, for example: `"dependsOn": ["first", "second"]`. For more information, refer to Chained run configurations.
`workingDir`	Working directory for this run configuration.
`allowParallelRun`	When set to `true`, more than one instance of this configuration can run in parallel.
`testNames`	Names of containing test fixtures and/or the test itself Default value: `null`
`nodeOptions`	Node.js command line options Default value: `[]`
`jestOptions`	Jest command line options Default value: `[]`
`isRerun`	Reserved for internal use Default value: `false`

vitest

Run configuration for launching Vitest tests

`file` (required)	File to run
`environment`	Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example: "environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }
`dependsOn`	Names of other configurations which will be executed before this configuration, for example: `"dependsOn": ["first", "second"]`. For more information, refer to Chained run configurations.
`workingDir`	Working directory for this run configuration.
`allowParallelRun`	When set to `true`, more than one instance of this configuration can run in parallel.
`testNames`	Names of containing test fixtures and/or the test itself Default value: `null`
`nodeOptions`	Node.js command line options Default value: `[]`
`vitestOptions`	Vitest command line options Default value: `[]`
`isRerun`	Reserved for internal use Default value: `false`

mocha

Run configuration for launching Mocha tests

`file` (required)	File to run
`environment`	Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example: "environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }
`dependsOn`	Names of other configurations which will be executed before this configuration, for example: `"dependsOn": ["first", "second"]`. For more information, refer to Chained run configurations.
`workingDir`	Working directory for this run configuration.
`allowParallelRun`	When set to `true`, more than one instance of this configuration can run in parallel.
`testNames`	Names of containing test fixtures and/or the test itself Default value: `null`
`nodeOptions`	Node.js command line options Default value: `[]`
`mochaOptions`	Mocha command line options Default value: `[]`
`isRerun`	Reserved for internal use Default value: `false`

nodeAttach

Attach to a Node.js process

`pid` (required)	Process PID
`environment`	Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example: "environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }
`dependsOn`	Names of other configurations which will be executed before this configuration, for example: `"dependsOn": ["first", "second"]`. For more information, refer to Chained run configurations.
`workingDir`	Working directory for this run configuration.
`allowParallelRun`	When set to `true`, more than one instance of this configuration can run in parallel.

browser

Run a web browser

`url` (required)	URL to open
`environment`	Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example: "environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }
`dependsOn`	Names of other configurations which will be executed before this configuration, for example: `"dependsOn": ["first", "second"]`. For more information, refer to Chained run configurations.
`workingDir`	Working directory for this run configuration.
`allowParallelRun`	When set to `true`, more than one instance of this configuration can run in parallel.
`commandLineOptions`	Browser command line options Default value: `[]`
`browserKind`	Currently only 'chrome' is supported Default value: `"chrome"`
`browserExecutablePath`	Path to the browser executable Default value: `null`

Last modified: 23 September 2024