Options

node: attach

Details

address

TCP/IP address of process to be debugged. Default is 'localhost'.

Default value:

"localhost"

attachExistingChildren

Whether to attempt to attach to already-spawned child processes.

Default value:

true

autoAttachChildProcesses

Attach debugger to new child processes automatically.

Default value:

true

cascadeTerminateToConfigurations

A list of debug sessions which, when this debug session is terminated, will also be stopped.

Default value:

[]

continueOnAttach

If true, we'll automatically resume programs launched and waiting on --inspect-brk

Default value:

false

customDescriptionGenerator

Customize the textual description the debugger shows for objects (local variables, etc...). Samples:
1. this.toString() // will call toString to print all objects
2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue
3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue

Default value:

undefined

customPropertiesGenerator

Customize the properties shown for an object in the debugger (local variables, etc...). Samples:
1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects
2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)
3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties

Deprecated: This is a temporary implementation of this feature until we have time to implement it in the way described here: microsoft/vscode#102181

Default value:

undefined

cwd

Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder

Default value:

localRoot || ${workspaceFolder}

enableContentValidation

Toggles whether we verify the contents of files on disk match the ones loaded in the runtime. This is useful in a variety of scenarios and required in some, but can cause issues if you have server-side transformation of scripts, for example.

Default value:

true

enableDWARF

Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the ms-vscode.wasm-dwarf-debugging extension to function.

Default value:

true

env

Environment variables passed to the program. The value null removes the variable from the environment.

Default value:

{}

envFile

Absolute path to a file containing environment variable definitions.

Default value:

null

localRoot

Path to the local directory containing the program.

Default value:

null

nodeVersionHint

Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.

Default value:

undefined

outFiles

If source maps are enabled, these glob patterns specify the generated JavaScript files. If a pattern starts with ! the files are excluded. If not specified, the generated code is expected in the same directory as its source.

Default value:

[
  "${workspaceFolder}/**/*.(m|c|)js",
  "!**/node_modules/**"
]

outputCapture

From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.

Default value:

"console"

pauseForSourceMap

Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as rootPath is not disabled.

Default value:

false

port

Debug port to attach to. Default is 9229.

Default value:

processId

ID of process to attach to.

Default value:

undefined

remoteHostHeader

Explicit Host header to use when connecting to the websocket of inspector. If unspecified, the host header will be set to 'localhost'. This is useful when the inspector is running behind a proxy that only accept particular Host header.

Default value:

undefined

remoteRoot

Absolute path to the remote directory containing the program.

Default value:

null

resolveSourceMapLocations

A list of minimatch patterns for locations (folders and URLs) in which source maps can be used to resolve local files. This can be used to avoid incorrectly breaking in external source mapped code. Patterns can be prefixed with "!" to exclude them. May be set to an empty array or null to avoid restriction.

Default value:

[
  "**",
  "!**/node_modules/**"
]

restart

Try to reconnect to the program if we lose connection. If set to true, we'll try once a second, forever. You can customize the interval and maximum number of attempts by specifying the delay and maxAttempts in an object instead.

Default value:

false

runtimeSourcemapPausePatterns

A list of patterns at which to manually insert entrypoint breakpoints. This can be useful to give the debugger an opportunity to set breakpoints when using sourcemaps that don't exist or can't be detected before launch, such as with the Serverless framework.

Default value:

[]

showAsyncStacks

Show the async calls that led to the current call stack.

Default value:

true

skipFiles

An array of file or folder names, or path globs, to skip when debugging. Star patterns and negations are allowed, for example, ["**/node_modules/**", "!**/node_modules/my-module/**"]

Default value:

[
  "/**"
]

smartStep

Automatically step through generated code that cannot be mapped back to the original source.

Default value:

true

sourceMapPathOverrides

A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.

Default value:

{
  "webpack:///./~/*": "${workspaceFolder}/node_modules/*",
  "webpack:////*": "/*",
  "webpack://@?:*/?:*/*": "${workspaceFolder}/*",
  "webpack://?:*/*": "${workspaceFolder}/*",
  "webpack:///([a-z]):/(.+)": "$1:/$2",
  "meteor://💻app/*": "${workspaceFolder}/*",
  "turbopack://[project]/*": "${workspaceFolder}/*",
  "turbopack:///[project]/*": "${workspaceFolder}/*"
}

sourceMapRenames

Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.

Default value:

true

sourceMaps

Use JavaScript source maps (if they exist).

Default value:

true

timeout

Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.

Default value:

timeouts

Timeouts for several debugger operations.

Default value:

{}

trace

Configures what diagnostic output is produced.

Default value:

false

websocketAddress

Exact websocket address to attach to. If unspecified, it will be discovered from the address and port.

Default value:

undefined

node: launch

Details

args

Command line arguments passed to the program.

Can be an array of strings or a single string. When the program is launched in a terminal, setting this property to a single string will result in the arguments not being escaped for the shell.

Default value:

[]

attachSimplePort

If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.

Default value:

null

autoAttachChildProcesses

Attach debugger to new child processes automatically.

Default value:

true

cascadeTerminateToConfigurations

A list of debug sessions which, when this debug session is terminated, will also be stopped.

Default value:

[]

console

Where to launch the debug target.

Default value:

"internalConsole"

customDescriptionGenerator

Default value:

undefined

customPropertiesGenerator

Default value:

undefined

cwd

Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder

Default value:

"${workspaceFolder}"

enableContentValidation

Default value:

true

enableDWARF

Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the ms-vscode.wasm-dwarf-debugging extension to function.

Default value:

true

env

Environment variables passed to the program. The value null removes the variable from the environment.

Default value:

{}

envFile

Absolute path to a file containing environment variable definitions.

Default value:

null

experimentalNetworking

Enable experimental inspection in Node.js. When set to auto this is enabled for versions of Node.js that support it. It can be set to on or off to enable or disable it explicitly.

Default value:

"auto"

killBehavior

Configures how debug processes are killed when stopping the session. Can be:

- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or taskkill.exe /F on Windows.
- polite: gracefully tears down the process tree. It's possible that misbehaving processes continue to run after shutdown in this way. Sends SIGTERM on posix, or taskkill.exe with no /F (force) flag on Windows.
- none: no termination will happen.

Default value:

"forceful"

localRoot

Path to the local directory containing the program.

Default value:

null

nodeVersionHint

Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.

Default value:

undefined

outFiles

Default value:

[
  "${workspaceFolder}/**/*.(m|c|)js",
  "!**/node_modules/**"
]

outputCapture

From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.

Default value:

"console"

pauseForSourceMap

Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as rootPath is not disabled.

Default value:

false

profileStartup

If true, will start profiling as soon as the process launches

Default value:

false

program

Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.

Default value:

""

remoteRoot

Absolute path to the remote directory containing the program.

Default value:

null

resolveSourceMapLocations

Default value:

[
  "**",
  "!**/node_modules/**"
]

restart

Default value:

false

runtimeArgs

Optional arguments passed to the runtime executable.

Default value:

[]

runtimeExecutable

Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted node is assumed.

Default value:

"node"

runtimeSourcemapPausePatterns

Default value:

[]

runtimeVersion

Version of node runtime to use. Requires nvm.

Default value:

"default"

showAsyncStacks

Show the async calls that led to the current call stack.

Default value:

true

skipFiles

An array of file or folder names, or path globs, to skip when debugging. Star patterns and negations are allowed, for example, ["**/node_modules/**", "!**/node_modules/my-module/**"]

Default value:

[
  "/**"
]

smartStep

Automatically step through generated code that cannot be mapped back to the original source.

Default value:

true

sourceMapPathOverrides

A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.

Default value:

{
  "webpack:///./~/*": "${workspaceFolder}/node_modules/*",
  "webpack:////*": "/*",
  "webpack://@?:*/?:*/*": "${workspaceFolder}/*",
  "webpack://?:*/*": "${workspaceFolder}/*",
  "webpack:///([a-z]):/(.+)": "$1:/$2",
  "meteor://💻app/*": "${workspaceFolder}/*",
  "turbopack://[project]/*": "${workspaceFolder}/*",
  "turbopack:///[project]/*": "${workspaceFolder}/*"
}

sourceMapRenames

Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.

Default value:

true

sourceMaps

Use JavaScript source maps (if they exist).

Default value:

true

stopOnEntry

Automatically stop program after launch.

Default value:

false

timeout

Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.

Default value:

timeouts

Timeouts for several debugger operations.

Default value:

{}

trace

Configures what diagnostic output is produced.

Default value:

false

node-terminal: launch

Details

autoAttachChildProcesses

Attach debugger to new child processes automatically.

Default value:

true

cascadeTerminateToConfigurations

A list of debug sessions which, when this debug session is terminated, will also be stopped.

Default value:

[]

command

Command to run in the launched terminal. If not provided, the terminal will open without launching a program.

Default value:

undefined

customDescriptionGenerator

Default value:

undefined

customPropertiesGenerator

Default value:

undefined

cwd

Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder

Default value:

localRoot || ${workspaceFolder}

enableContentValidation

Default value:

true

enableDWARF

Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the ms-vscode.wasm-dwarf-debugging extension to function.

Default value:

true

env

Environment variables passed to the program. The value null removes the variable from the environment.

Default value:

{}

envFile

Absolute path to a file containing environment variable definitions.

Default value:

null

localRoot

Path to the local directory containing the program.

Default value:

null

nodeVersionHint

Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.

Default value:

undefined

outFiles

Default value:

[
  "${workspaceFolder}/**/*.(m|c|)js",
  "!**/node_modules/**"
]

outputCapture

From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.

Default value:

"console"

pauseForSourceMap

Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as rootPath is not disabled.

Default value:

false

remoteRoot

Absolute path to the remote directory containing the program.

Default value:

null

resolveSourceMapLocations

Default value:

[
  "**",
  "!**/node_modules/**"
]

runtimeSourcemapPausePatterns

Default value:

[]

showAsyncStacks

Show the async calls that led to the current call stack.

Default value:

{
  "onceBreakpointResolved": 16
}

skipFiles

An array of file or folder names, or path globs, to skip when debugging. Star patterns and negations are allowed, for example, ["**/node_modules/**", "!**/node_modules/my-module/**"]

Default value:

[
  "/**"
]

smartStep

Automatically step through generated code that cannot be mapped back to the original source.

Default value:

true

sourceMapPathOverrides

A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.

Default value:

{
  "webpack:///./~/*": "${workspaceFolder}/node_modules/*",
  "webpack:////*": "/*",
  "webpack://@?:*/?:*/*": "${workspaceFolder}/*",
  "webpack://?:*/*": "${workspaceFolder}/*",
  "webpack:///([a-z]):/(.+)": "$1:/$2",
  "meteor://💻app/*": "${workspaceFolder}/*",
  "turbopack://[project]/*": "${workspaceFolder}/*",
  "turbopack:///[project]/*": "${workspaceFolder}/*"
}

sourceMapRenames

Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.

Default value:

true

sourceMaps

Use JavaScript source maps (if they exist).

Default value:

true

timeout

Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.

Default value:

timeouts

Timeouts for several debugger operations.

Default value:

{}

trace

Configures what diagnostic output is produced.

Default value:

false

extensionHost: launch

Details

args

Default value:

[
  "--extensionDevelopmentPath=${workspaceFolder}"
]

autoAttachChildProcesses

Attach debugger to new child processes automatically.

Default value:

false

cascadeTerminateToConfigurations

A list of debug sessions which, when this debug session is terminated, will also be stopped.

Default value:

[]

customDescriptionGenerator

Default value:

undefined

customPropertiesGenerator

Default value:

undefined

cwd

Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder

Default value:

localRoot || ${workspaceFolder}

debugWebviews

Configures whether we should try to attach to webviews in the launched VS Code instance. This will only work in desktop VS Code.

Default value:

false

debugWebWorkerHost

Configures whether we should try to attach to the web worker extension host.

Default value:

false

enableContentValidation

Default value:

true

enableDWARF

Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the ms-vscode.wasm-dwarf-debugging extension to function.

Default value:

true

env

Environment variables passed to the program. The value null removes the variable from the environment.

Default value:

{}

envFile

Absolute path to a file containing environment variable definitions.

Default value:

null

localRoot

Path to the local directory containing the program.

Default value:

null

nodeVersionHint

Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.

Default value:

undefined

outFiles

Default value:

[
  "${workspaceFolder}/out/**/*.js"
]

outputCapture

From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.

Default value:

"console"

pauseForSourceMap

Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as rootPath is not disabled.

Default value:

false

remoteRoot

Absolute path to the remote directory containing the program.

Default value:

null

rendererDebugOptions

Chrome launch options used when attaching to the renderer process, with debugWebviews or debugWebWorkerHost.

Default value:

{}

resolveSourceMapLocations

Default value:

[
  "${workspaceFolder}/**",
  "!**/node_modules/**"
]

runtimeExecutable

Absolute path to VS Code.

Default value:

"${execPath}"

runtimeSourcemapPausePatterns

Default value:

[]

showAsyncStacks

Show the async calls that led to the current call stack.

Default value:

true

skipFiles

An array of file or folder names, or path globs, to skip when debugging. Star patterns and negations are allowed, for example, ["**/node_modules/**", "!**/node_modules/my-module/**"]

Default value:

[
  "/**"
]

smartStep

Automatically step through generated code that cannot be mapped back to the original source.

Default value:

true

sourceMapPathOverrides

A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.

Default value:

{
  "webpack:///./~/*": "${workspaceFolder}/node_modules/*",
  "webpack:////*": "/*",
  "webpack://@?:*/?:*/*": "${workspaceFolder}/*",
  "webpack://?:*/*": "${workspaceFolder}/*",
  "webpack:///([a-z]):/(.+)": "$1:/$2",
  "meteor://💻app/*": "${workspaceFolder}/*",
  "turbopack://[project]/*": "${workspaceFolder}/*",
  "turbopack:///[project]/*": "${workspaceFolder}/*"
}

sourceMapRenames

Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.

Default value:

true

sourceMaps

Use JavaScript source maps (if they exist).

Default value:

true

testConfiguration

Path to a test configuration file for the test CLI.

Default value:

undefined

testConfigurationLabel

A single configuration to run from the file. If not specified, you may be asked to pick.

Default value:

undefined

timeout

Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.

Default value:

timeouts

Timeouts for several debugger operations.

Default value:

{}

trace

Configures what diagnostic output is produced.

Default value:

false

chrome: launch

Details

browserLaunchLocation

Forces the browser to be launched in one location. In a remote workspace (through ssh or WSL, for example) this can be used to open the browser on the remote machine rather than locally.

Default value:

"workspace"

cascadeTerminateToConfigurations

A list of debug sessions which, when this debug session is terminated, will also be stopped.

Default value:

[]

cleanUp

What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.

Default value:

"wholeBrowser"

customDescriptionGenerator

Default value:

undefined

customPropertiesGenerator

Default value:

undefined

cwd

Optional working directory for the runtime executable.

Default value:

null

disableNetworkCache

Controls whether to skip the network cache for each request

Default value:

true

enableContentValidation

Default value:

true

enableDWARF

Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the ms-vscode.wasm-dwarf-debugging extension to function.

Default value:

true

env

Optional dictionary of environment key/value pairs for the browser.

Default value:

{}

file

A local html file to open in the browser

Default value:

null

includeDefaultArgs

Whether default browser launch arguments (to disable features that may make debugging harder) will be included in the launch.

Default value:

true

includeLaunchArgs

Advanced: whether any default launch/debugging arguments are set on the browser. The debugger will assume the browser will use pipe debugging such as that which is provided with --remote-debugging-pipe.

Default value:

true

inspectUri

Format to use to rewrite the inspectUri: It's a template string that interpolates keys in {curlyBraces}. Available keys are:
- url.* is the parsed address of the running application. For instance, {url.port}, {url.hostname}
- port is the debug port that Chrome is listening on.
- browserInspectUri is the inspector URI on the launched browser
- browserInspectUriPath is the path part of the inspector URI on the launched browser (e.g.: "/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2").
- wsProtocol is the hinted websocket protocol. This is set to wss if the original URL is https, or ws otherwise.

Default value:

undefined

killBehavior

Configures how browser processes are killed when stopping the session with cleanUp: wholeBrowser. Can be:

- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or taskkill.exe /F on Windows.
- polite: gracefully tears down the process tree. It's possible that misbehaving processes continue to run after shutdown in this way. Sends SIGTERM on posix, or taskkill.exe with no /F (force) flag on Windows.
- none: no termination will happen.

Default value:

"forceful"

outFiles

Default value:

[
  "${workspaceFolder}/**/*.(m|c|)js",
  "!**/node_modules/**"
]

outputCapture

From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.

Default value:

"console"

pathMapping

A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk

Default value:

{}

pauseForSourceMap

Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as rootPath is not disabled.

Default value:

true

perScriptSourcemaps

Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to "auto", we'll detect known cases where this is appropriate.

Default value:

"auto"

port

Port for the browser to listen on. Defaults to "0", which will cause the browser to be debugged via pipes, which is generally more secure and should be chosen unless you need to attach to the browser from another tool.

Default value:

profileStartup

If true, will start profiling soon as the process launches

Default value:

false

resolveSourceMapLocations

Default value:

null

runtimeArgs

Optional arguments passed to the runtime executable.

Default value:

null

runtimeExecutable

Either 'canary', 'stable', 'custom' or path to the browser executable. Custom means a custom wrapper, custom build or CHROME_PATH environment variable.

Default value:

"*"

showAsyncStacks

Show the async calls that led to the current call stack.

Default value:

true

skipFiles

An array of file or folder names, or path globs, to skip when debugging. Star patterns and negations are allowed, for example, ["**/node_modules/**", "!**/node_modules/my-module/**"]

Default value:

[]

smartStep

Automatically step through generated code that cannot be mapped back to the original source.

Default value:

true

sourceMapPathOverrides

A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.

Default value:

{
  "webpack:///./~/*": "${webRoot}/node_modules/*",
  "webpack:////*": "/*",
  "webpack://@?:*/?:*/*": "${webRoot}/*",
  "webpack://?:*/*": "${webRoot}/*",
  "webpack:///([a-z]):/(.+)": "$1:/$2",
  "meteor://💻app/*": "${webRoot}/*",
  "turbopack://[project]/*": "${workspaceFolder}/*",
  "turbopack:///[project]/*": "${workspaceFolder}/*"
}

sourceMapRenames

Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.

Default value:

true

sourceMaps

Use JavaScript source maps (if they exist).

Default value:

true

timeout

Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.

Default value:

timeouts

Timeouts for several debugger operations.

Default value:

{}

trace

Configures what diagnostic output is produced.

Default value:

false

url

Will search for a tab with this exact url and attach to it, if found

Default value:

null

urlFilter

Will search for a page with this url and attach to it, if found. Can have * wildcards.

Default value:

"*"

userDataDir

By default, the browser is launched with a separate user profile in a temp folder. Use this option to override it. Set to false to launch with your default user profile. A new browser can't be launched if an instance is already running from userDataDir.

Default value:

true

vueComponentPaths

A list of file glob patterns to find *.vue components. By default, searches the entire workspace. This needs to be specified due to extra lookups that Vue's sourcemaps require in Vue CLI 4. You can disable this special handling by setting this to an empty array.

Default value:

[
  "${workspaceFolder}/**/*.vue",
  "!**/node_modules/**"
]

webRoot

This specifies the workspace absolute path to the webserver root. Used to resolve paths like /app.js to files on disk. Shorthand for a pathMapping for "/"

Default value:

"${workspaceFolder}"

chrome: attach

Details

address

IP address or hostname the debugged browser is listening on.

Default value:

"localhost"

browserAttachLocation

Forces the browser to attach in one location. In a remote workspace (through ssh or WSL, for example) this can be used to attach to a browser on the remote machine rather than locally.

Default value:

"workspace"

cascadeTerminateToConfigurations

A list of debug sessions which, when this debug session is terminated, will also be stopped.

Default value:

[]

customDescriptionGenerator

Default value:

undefined

customPropertiesGenerator

Default value:

undefined

disableNetworkCache

Controls whether to skip the network cache for each request

Default value:

true

enableContentValidation

Default value:

true

enableDWARF

Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the ms-vscode.wasm-dwarf-debugging extension to function.

Default value:

true

inspectUri

Default value:

undefined

outFiles

Default value:

[
  "${workspaceFolder}/**/*.(m|c|)js",
  "!**/node_modules/**"
]

outputCapture

From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.

Default value:

"console"

pathMapping

A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk

Default value:

{}

pauseForSourceMap

Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as rootPath is not disabled.

Default value:

true

perScriptSourcemaps

Default value:

"auto"

port

Port to use to remote debugging the browser, given as --remote-debugging-port when launching the browser.

Default value:

resolveSourceMapLocations

Default value:

null

restart

Whether to reconnect if the browser connection is closed

Default value:

false

showAsyncStacks

Show the async calls that led to the current call stack.

Default value:

true

skipFiles

An array of file or folder names, or path globs, to skip when debugging. Star patterns and negations are allowed, for example, ["**/node_modules/**", "!**/node_modules/my-module/**"]

Default value:

[]

smartStep

Automatically step through generated code that cannot be mapped back to the original source.

Default value:

true

sourceMapPathOverrides

A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.

Default value:

{
  "webpack:///./~/*": "${webRoot}/node_modules/*",
  "webpack:////*": "/*",
  "webpack://@?:*/?:*/*": "${webRoot}/*",
  "webpack://?:*/*": "${webRoot}/*",
  "webpack:///([a-z]):/(.+)": "$1:/$2",
  "meteor://💻app/*": "${webRoot}/*",
  "turbopack://[project]/*": "${workspaceFolder}/*",
  "turbopack:///[project]/*": "${workspaceFolder}/*"
}

sourceMapRenames

Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.

Default value:

true

sourceMaps

Use JavaScript source maps (if they exist).

Default value:

true

targetSelection

Whether to attach to all targets that match the URL filter ("automatic") or ask to pick one ("pick").

Default value:

"automatic"

timeout

Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.

Default value:

timeouts

Timeouts for several debugger operations.

Default value:

{}

trace

Configures what diagnostic output is produced.

Default value:

false

url

Will search for a tab with this exact url and attach to it, if found

Default value:

null

urlFilter

Will search for a page with this url and attach to it, if found. Can have * wildcards.

Default value:

""

vueComponentPaths

Default value:

[
  "${workspaceFolder}/**/*.vue",
  "!**/node_modules/**"
]

webRoot

This specifies the workspace absolute path to the webserver root. Used to resolve paths like /app.js to files on disk. Shorthand for a pathMapping for "/"

Default value:

"${workspaceFolder}"

msedge: launch

Details

address

When debugging webviews, the IP address or hostname the webview is listening on. Will be automatically discovered if not set.

Default value:

"localhost"

browserLaunchLocation

Forces the browser to be launched in one location. In a remote workspace (through ssh or WSL, for example) this can be used to open the browser on the remote machine rather than locally.

Default value:

"workspace"

cascadeTerminateToConfigurations

A list of debug sessions which, when this debug session is terminated, will also be stopped.

Default value:

[]

cleanUp

What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.

Default value:

"wholeBrowser"

customDescriptionGenerator

Default value:

undefined

customPropertiesGenerator

Default value:

undefined

cwd

Optional working directory for the runtime executable.

Default value:

null

disableNetworkCache

Controls whether to skip the network cache for each request

Default value:

true

enableContentValidation

Default value:

true

enableDWARF

Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the ms-vscode.wasm-dwarf-debugging extension to function.

Default value:

true

env

Optional dictionary of environment key/value pairs for the browser.

Default value:

{}

file

A local html file to open in the browser

Default value:

null

includeDefaultArgs

Whether default browser launch arguments (to disable features that may make debugging harder) will be included in the launch.

Default value:

true

includeLaunchArgs

Default value:

true

inspectUri

Default value:

undefined

killBehavior

Default value:

"forceful"

outFiles

Default value:

[
  "${workspaceFolder}/**/*.(m|c|)js",
  "!**/node_modules/**"
]

outputCapture

From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.

Default value:

"console"

pathMapping

A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk

Default value:

{}

pauseForSourceMap

Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as rootPath is not disabled.

Default value:

true

perScriptSourcemaps

Default value:

"auto"

port

When debugging webviews, the port the webview debugger is listening on. Will be automatically discovered if not set.

Default value:

profileStartup

If true, will start profiling soon as the process launches

Default value:

false

resolveSourceMapLocations

Default value:

null

runtimeArgs

Optional arguments passed to the runtime executable.

Default value:

null

runtimeExecutable

Either 'canary', 'stable', 'dev', 'custom' or path to the browser executable. Custom means a custom wrapper, custom build or EDGE_PATH environment variable.

Default value:

"*"

showAsyncStacks

Show the async calls that led to the current call stack.

Default value:

true

skipFiles

An array of file or folder names, or path globs, to skip when debugging. Star patterns and negations are allowed, for example, ["**/node_modules/**", "!**/node_modules/my-module/**"]

Default value:

[]

smartStep

Automatically step through generated code that cannot be mapped back to the original source.

Default value:

true

sourceMapPathOverrides

A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.

Default value:

{
  "webpack:///./~/*": "${webRoot}/node_modules/*",
  "webpack:////*": "/*",
  "webpack://@?:*/?:*/*": "${webRoot}/*",
  "webpack://?:*/*": "${webRoot}/*",
  "webpack:///([a-z]):/(.+)": "$1:/$2",
  "meteor://💻app/*": "${webRoot}/*",
  "turbopack://[project]/*": "${workspaceFolder}/*",
  "turbopack:///[project]/*": "${workspaceFolder}/*"
}

sourceMapRenames

Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.

Default value:

true

sourceMaps

Use JavaScript source maps (if they exist).

Default value:

true

timeout

Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.

Default value:

timeouts

Timeouts for several debugger operations.

Default value:

{}

trace

Configures what diagnostic output is produced.

Default value:

false

url

Will search for a tab with this exact url and attach to it, if found

Default value:

null

urlFilter

Will search for a page with this url and attach to it, if found. Can have * wildcards.

Default value:

"*"

userDataDir

Default value:

true

useWebView

When 'true', the debugger will treat the runtime executable as a host application that contains a WebView allowing you to debug the WebView script content.

Default value:

false

vueComponentPaths

Default value:

[
  "${workspaceFolder}/**/*.vue",
  "!**/node_modules/**"
]

webRoot

This specifies the workspace absolute path to the webserver root. Used to resolve paths like /app.js to files on disk. Shorthand for a pathMapping for "/"

Default value:

"${workspaceFolder}"

msedge: attach

Details

address

IP address or hostname the debugged browser is listening on.

Default value:

"localhost"

browserAttachLocation

Forces the browser to attach in one location. In a remote workspace (through ssh or WSL, for example) this can be used to attach to a browser on the remote machine rather than locally.

Default value:

"workspace"

cascadeTerminateToConfigurations

A list of debug sessions which, when this debug session is terminated, will also be stopped.

Default value:

[]

customDescriptionGenerator

Default value:

undefined

customPropertiesGenerator

Default value:

undefined

disableNetworkCache

Controls whether to skip the network cache for each request

Default value:

true

enableContentValidation

Default value:

true

enableDWARF

Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the ms-vscode.wasm-dwarf-debugging extension to function.

Default value:

true

inspectUri

Default value:

undefined

outFiles

Default value:

[
  "${workspaceFolder}/**/*.(m|c|)js",
  "!**/node_modules/**"
]

outputCapture

From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.

Default value:

"console"

pathMapping

A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk

Default value:

{}

pauseForSourceMap

Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as rootPath is not disabled.

Default value:

true

perScriptSourcemaps

Default value:

"auto"

port

Port to use to remote debugging the browser, given as --remote-debugging-port when launching the browser.

Default value:

resolveSourceMapLocations

Default value:

null

restart

Whether to reconnect if the browser connection is closed

Default value:

false

showAsyncStacks

Show the async calls that led to the current call stack.

Default value:

true

skipFiles

An array of file or folder names, or path globs, to skip when debugging. Star patterns and negations are allowed, for example, ["**/node_modules/**", "!**/node_modules/my-module/**"]

Default value:

[]

smartStep

Automatically step through generated code that cannot be mapped back to the original source.

Default value:

true

sourceMapPathOverrides

A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.

Default value:

{
  "webpack:///./~/*": "${webRoot}/node_modules/*",
  "webpack:////*": "/*",
  "webpack://@?:*/?:*/*": "${webRoot}/*",
  "webpack://?:*/*": "${webRoot}/*",
  "webpack:///([a-z]):/(.+)": "$1:/$2",
  "meteor://💻app/*": "${webRoot}/*",
  "turbopack://[project]/*": "${workspaceFolder}/*",
  "turbopack:///[project]/*": "${workspaceFolder}/*"
}

sourceMapRenames

Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.

Default value:

true

sourceMaps

Use JavaScript source maps (if they exist).

Default value:

true

targetSelection

Whether to attach to all targets that match the URL filter ("automatic") or ask to pick one ("pick").

Default value:

"automatic"

timeout

Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.

Default value:

timeouts

Timeouts for several debugger operations.

Default value:

{}

trace

Configures what diagnostic output is produced.

Default value:

false

url

Will search for a tab with this exact url and attach to it, if found

Default value:

null

urlFilter

Will search for a page with this url and attach to it, if found. Can have * wildcards.

Default value:

""

useWebView

An object containing the pipeName of a debug pipe for a UWP hosted Webview2. This is the "MyTestSharedMemory" when creating the pipe "\.\pipe\LOCAL\MyTestSharedMemory"

Default value:

false

vueComponentPaths

Default value:

[
  "${workspaceFolder}/**/*.vue",
  "!**/node_modules/**"
]

webRoot

This specifies the workspace absolute path to the webserver root. Used to resolve paths like /app.js to files on disk. Shorthand for a pathMapping for "/"

Default value:

"${workspaceFolder}"

FilesExpand file tree

OPTIONS.md

Latest commit

History

OPTIONS.md

File metadata and controls

Options

node: attach

address

Default value:

attachExistingChildren

Default value:

autoAttachChildProcesses

Default value:

cascadeTerminateToConfigurations

Default value:

continueOnAttach

Default value:

customDescriptionGenerator

Default value:

customPropertiesGenerator

Default value:

cwd

Default value:

enableContentValidation

Default value:

enableDWARF

Default value:

env

Default value:

envFile

Default value:

localRoot

Default value:

nodeVersionHint

Default value:

outFiles

Default value:

outputCapture

Default value:

pauseForSourceMap

Default value:

port

Default value:

processId

Default value:

remoteHostHeader

Default value:

remoteRoot

Default value:

resolveSourceMapLocations

Default value:

restart

Default value:

runtimeSourcemapPausePatterns

Default value:

showAsyncStacks

Default value:

skipFiles

Default value:

smartStep

Default value:

sourceMapPathOverrides

Default value:

sourceMapRenames

Default value:

sourceMaps

Default value:

timeout

Default value:

timeouts

Default value:

trace

Default value:

websocketAddress

Default value:

node: launch

args

Default value:

attachSimplePort