TCP/IP address of process to be debugged. Default is 'localhost'.
"localhost"Whether to attempt to attach to already-spawned child processes.
trueAttach debugger to new child processes automatically.
trueA list of debug sessions which, when this debug session is terminated, will also be stopped.
[]If true, we'll automatically resume programs launched and waiting on --inspect-brk
falseCustomize 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
undefinedCustomize 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
undefinedAbsolute 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
localRoot || ${workspaceFolder}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.
trueToggles 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.
trueEnvironment variables passed to the program. The value null removes the variable from the environment.
{}Absolute path to a file containing environment variable definitions.
nullPath to the local directory containing the program.
nullAllows 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.
undefinedIf 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.
[
"${workspaceFolder}/**/*.(m|c|)js",
"!**/node_modules/**"
]From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.
"console"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.
falseDebug port to attach to. Default is 9229.
9229ID of process to attach to.
undefinedExplicit 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.
undefinedAbsolute path to the remote directory containing the program.
nullA 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.
[
"**",
"!**/node_modules/**"
]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.
falseA 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.
[]Show the async calls that led to the current call stack.
trueAn 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/**"]
[
"/**"
]Automatically step through generated code that cannot be mapped back to the original source.
trueA set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.
{
"webpack:///./~/*": "${workspaceFolder}/node_modules/*",
"webpack:////*": "/*",
"webpack://@?:*/?:*/*": "${workspaceFolder}/*",
"webpack://?:*/*": "${workspaceFolder}/*",
"webpack:///([a-z]):/(.+)": "$1:/$2",
"meteor://💻app/*": "${workspaceFolder}/*",
"turbopack://[project]/*": "${workspaceFolder}/*"
}Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.
trueUse JavaScript source maps (if they exist).
trueRetry for this number of milliseconds to connect to Node.js. Default is 10000 ms.
10000Timeouts for several debugger operations.
{}Configures what diagnostic output is produced.
falseExact websocket address to attach to. If unspecified, it will be discovered from the address and port.
undefinedCommand 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.
[]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.
nullAttach debugger to new child processes automatically.
trueA list of debug sessions which, when this debug session is terminated, will also be stopped.
[]Where to launch the debug target.
"internalConsole"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
undefinedCustomize 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
undefinedAbsolute 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
"${workspaceFolder}"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.
trueToggles 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.
trueEnvironment variables passed to the program. The value null removes the variable from the environment.
{}Absolute path to a file containing environment variable definitions.
nullEnable 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.
"auto"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.
"forceful"Path to the local directory containing the program.
nullAllows 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.
undefinedIf 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.
[
"${workspaceFolder}/**/*.(m|c|)js",
"!**/node_modules/**"
]From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.
"console"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.
falseIf true, will start profiling as soon as the process launches
falseAbsolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.
""Absolute path to the remote directory containing the program.
nullA 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.
[
"**",
"!**/node_modules/**"
]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.
falseOptional arguments passed to the runtime executable.
[]Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted node is assumed.
"node"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.
[]Version of node runtime to use. Requires nvm.
"default"Show the async calls that led to the current call stack.
trueAn 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/**"]
[
"/**"
]Automatically step through generated code that cannot be mapped back to the original source.
trueA set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.
{
"webpack:///./~/*": "${workspaceFolder}/node_modules/*",
"webpack:////*": "/*",
"webpack://@?:*/?:*/*": "${workspaceFolder}/*",
"webpack://?:*/*": "${workspaceFolder}/*",
"webpack:///([a-z]):/(.+)": "$1:/$2",
"meteor://💻app/*": "${workspaceFolder}/*",
"turbopack://[project]/*": "${workspaceFolder}/*"
}Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.
trueUse JavaScript source maps (if they exist).
trueAutomatically stop program after launch.
falseRetry for this number of milliseconds to connect to Node.js. Default is 10000 ms.
10000Timeouts for several debugger operations.
{}Configures what diagnostic output is produced.
falseAttach debugger to new child processes automatically.
trueA list of debug sessions which, when this debug session is terminated, will also be stopped.
[]Command to run in the launched terminal. If not provided, the terminal will open without launching a program.
undefinedCustomize 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
undefinedCustomize 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
undefinedAbsolute 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
localRoot || ${workspaceFolder}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.
trueToggles 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.
trueEnvironment variables passed to the program. The value null removes the variable from the environment.
{}Absolute path to a file containing environment variable definitions.
nullPath to the local directory containing the program.
nullAllows 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.
undefinedIf 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.
[
"${workspaceFolder}/**/*.(m|c|)js",
"!**/node_modules/**"
]From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.
"console"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.
falseAbsolute path to the remote directory containing the program.
nullA 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.
[
"**",
"!**/node_modules/**"
]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.
[]Show the async calls that led to the current call stack.
{
"onceBreakpointResolved": 16
}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/**"]
[
"/**"
]Automatically step through generated code that cannot be mapped back to the original source.
trueA set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.
{
"webpack:///./~/*": "${workspaceFolder}/node_modules/*",
"webpack:////*": "/*",
"webpack://@?:*/?:*/*": "${workspaceFolder}/*",
"webpack://?:*/*": "${workspaceFolder}/*",
"webpack:///([a-z]):/(.+)": "$1:/$2",
"meteor://💻app/*": "${workspaceFolder}/*",
"turbopack://[project]/*": "${workspaceFolder}/*"
}Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.
trueUse JavaScript source maps (if they exist).
trueRetry for this number of milliseconds to connect to Node.js. Default is 10000 ms.
10000Timeouts for several debugger operations.
{}Configures what diagnostic output is produced.
falseCommand 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.
[
"--extensionDevelopmentPath=${workspaceFolder}"
]Attach debugger to new child processes automatically.
falseA list of debug sessions which, when this debug session is terminated, will also be stopped.
[]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
undefinedCustomize 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
undefinedAbsolute 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
localRoot || ${workspaceFolder}Configures whether we should try to attach to webviews in the launched VS Code instance. This will only work in desktop VS Code.
falseConfigures whether we should try to attach to the web worker extension host.
falseToggles 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.
trueToggles 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.
trueEnvironment variables passed to the program. The value null removes the variable from the environment.
{}Absolute path to a file containing environment variable definitions.
nullPath to the local directory containing the program.
nullAllows 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.
undefinedIf 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.
[
"${workspaceFolder}/out/**/*.js"
]From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.
"console"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.
falseAbsolute path to the remote directory containing the program.
nullChrome launch options used when attaching to the renderer process, with debugWebviews or debugWebWorkerHost.
{}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.
[
"${workspaceFolder}/**",
"!**/node_modules/**"
]Absolute path to VS Code.
"${execPath}"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.
[]Show the async calls that led to the current call stack.
trueAn 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/**"]
[
"/**"
]Automatically step through generated code that cannot be mapped back to the original source.
trueA set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.
{
"webpack:///./~/*": "${workspaceFolder}/node_modules/*",
"webpack:////*": "/*",
"webpack://@?:*/?:*/*": "${workspaceFolder}/*",
"webpack://?:*/*": "${workspaceFolder}/*",
"webpack:///([a-z]):/(.+)": "$1:/$2",
"meteor://💻app/*": "${workspaceFolder}/*",
"turbopack://[project]/*": "${workspaceFolder}/*"
}Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.
trueUse JavaScript source maps (if they exist).
truePath to a test configuration file for the test CLI.
undefinedA single configuration to run from the file. If not specified, you may be asked to pick.
undefinedRetry for this number of milliseconds to connect to Node.js. Default is 10000 ms.
10000Timeouts for several debugger operations.
{}Configures what diagnostic output is produced.
falseForces 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.
"workspace"A list of debug sessions which, when this debug session is terminated, will also be stopped.
[]What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.
"wholeBrowser"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
undefinedCustomize 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
undefinedOptional working directory for the runtime executable.
nullControls whether to skip the network cache for each request
trueToggles 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.
trueToggles 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.
trueOptional dictionary of environment key/value pairs for the browser.
{}A local html file to open in the browser
nullWhether default browser launch arguments (to disable features that may make debugging harder) will be included in the launch.
trueAdvanced: 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.
trueFormat 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.
undefinedIf 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.
[
"${workspaceFolder}/**/*.(m|c|)js",
"!**/node_modules/**"
]From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.
"console"A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk
{}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.
trueWhether 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.
"auto"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.
0If true, will start profiling soon as the process launches
falseA 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.
nullOptional arguments passed to the runtime executable.
nullEither 'canary', 'stable', 'custom' or path to the browser executable. Custom means a custom wrapper, custom build or CHROME_PATH environment variable.
"*"Show the async calls that led to the current call stack.
trueAn 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/**"]
[]Automatically step through generated code that cannot be mapped back to the original source.
trueA set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.
{
"webpack:///./~/*": "${webRoot}/node_modules/*",
"webpack:////*": "/*",
"webpack://@?:*/?:*/*": "${webRoot}/*",
"webpack://?:*/*": "${webRoot}/*",
"webpack:///([a-z]):/(.+)": "$1:/$2",
"meteor://💻app/*": "${webRoot}/*",
"turbopack://[project]/*": "${workspaceFolder}/*"
}Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.
trueUse JavaScript source maps (if they exist).
trueRetry for this number of milliseconds to connect to Node.js. Default is 10000 ms.
10000Timeouts for several debugger operations.
{}Configures what diagnostic output is produced.
falseWill search for a tab with this exact url and attach to it, if found
nullWill search for a page with this url and attach to it, if found. Can have * wildcards.
"*"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.
trueA 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.
[
"${workspaceFolder}/**/*.vue",
"!**/node_modules/**"
]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 "/"
"${workspaceFolder}"IP address or hostname the debugged browser is listening on.
"localhost"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.
"workspace"A list of debug sessions which, when this debug session is terminated, will also be stopped.
[]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
undefinedCustomize 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
undefinedControls whether to skip the network cache for each request
trueToggles 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.
trueToggles 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.
trueFormat 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.
undefinedIf 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.
[
"${workspaceFolder}/**/*.(m|c|)js",
"!**/node_modules/**"
]From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.
"console"A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk
{}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.
trueWhether 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.
"auto"Port to use to remote debugging the browser, given as --remote-debugging-port when launching the browser.
0A 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.
nullWhether to reconnect if the browser connection is closed
falseShow the async calls that led to the current call stack.
trueAn 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/**"]
[]Automatically step through generated code that cannot be mapped back to the original source.
trueA set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.
{
"webpack:///./~/*": "${webRoot}/node_modules/*",
"webpack:////*": "/*",
"webpack://@?:*/?:*/*": "${webRoot}/*",
"webpack://?:*/*": "${webRoot}/*",
"webpack:///([a-z]):/(.+)": "$1:/$2",
"meteor://💻app/*": "${webRoot}/*",
"turbopack://[project]/*": "${workspaceFolder}/*"
}Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.
trueUse JavaScript source maps (if they exist).
trueWhether to attach to all targets that match the URL filter ("automatic") or ask to pick one ("pick").
"automatic"Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.
10000Timeouts for several debugger operations.
{}Configures what diagnostic output is produced.
falseWill search for a tab with this exact url and attach to it, if found
nullWill search for a page with this url and attach to it, if found. Can have * wildcards.
""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.
[
"${workspaceFolder}/**/*.vue",
"!**/node_modules/**"
]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 "/"
"${workspaceFolder}"When debugging webviews, the IP address or hostname the webview is listening on. Will be automatically discovered if not set.
"localhost"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.
"workspace"A list of debug sessions which, when this debug session is terminated, will also be stopped.
[]What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.
"wholeBrowser"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
undefinedCustomize 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
undefinedOptional working directory for the runtime executable.
nullControls whether to skip the network cache for each request
trueToggles 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.
trueToggles 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.
trueOptional dictionary of environment key/value pairs for the browser.
{}A local html file to open in the browser
nullWhether default browser launch arguments (to disable features that may make debugging harder) will be included in the launch.
trueAdvanced: 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.
trueFormat 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.
undefinedIf 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.
[
"${workspaceFolder}/**/*.(m|c|)js",
"!**/node_modules/**"
]From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.
"console"A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk
{}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.
trueWhether 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.
"auto"When debugging webviews, the port the webview debugger is listening on. Will be automatically discovered if not set.
0If true, will start profiling soon as the process launches
falseA 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.
nullOptional arguments passed to the runtime executable.
nullEither 'canary', 'stable', 'dev', 'custom' or path to the browser executable. Custom means a custom wrapper, custom build or EDGE_PATH environment variable.
"*"Show the async calls that led to the current call stack.
trueAn 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/**"]
[]Automatically step through generated code that cannot be mapped back to the original source.
trueA set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.
{
"webpack:///./~/*": "${webRoot}/node_modules/*",
"webpack:////*": "/*",
"webpack://@?:*/?:*/*": "${webRoot}/*",
"webpack://?:*/*": "${webRoot}/*",
"webpack:///([a-z]):/(.+)": "$1:/$2",
"meteor://💻app/*": "${webRoot}/*",
"turbopack://[project]/*": "${workspaceFolder}/*"
}Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.
trueUse JavaScript source maps (if they exist).
trueRetry for this number of milliseconds to connect to Node.js. Default is 10000 ms.
10000Timeouts for several debugger operations.
{}Configures what diagnostic output is produced.
falseWill search for a tab with this exact url and attach to it, if found
nullWill search for a page with this url and attach to it, if found. Can have * wildcards.
"*"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.
trueWhen 'true', the debugger will treat the runtime executable as a host application that contains a WebView allowing you to debug the WebView script content.
falseA 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.
[
"${workspaceFolder}/**/*.vue",
"!**/node_modules/**"
]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 "/"
"${workspaceFolder}"IP address or hostname the debugged browser is listening on.
"localhost"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.
"workspace"A list of debug sessions which, when this debug session is terminated, will also be stopped.
[]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
undefinedCustomize 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
undefinedControls whether to skip the network cache for each request
trueToggles 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.
trueToggles 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.
trueFormat 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.
undefinedIf 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.
[
"${workspaceFolder}/**/*.(m|c|)js",
"!**/node_modules/**"
]From where to capture output messages: the default debug API if set to console, or stdout/stderr streams if set to std.
"console"A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk
{}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.
trueWhether 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.
"auto"Port to use to remote debugging the browser, given as --remote-debugging-port when launching the browser.
0A 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.
nullWhether to reconnect if the browser connection is closed
falseShow the async calls that led to the current call stack.
trueAn 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/**"]
[]Automatically step through generated code that cannot be mapped back to the original source.
trueA set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.
{
"webpack:///./~/*": "${webRoot}/node_modules/*",
"webpack:////*": "/*",
"webpack://@?:*/?:*/*": "${webRoot}/*",
"webpack://?:*/*": "${webRoot}/*",
"webpack:///([a-z]):/(.+)": "$1:/$2",
"meteor://💻app/*": "${webRoot}/*",
"turbopack://[project]/*": "${workspaceFolder}/*"
}Whether to use the "names" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.
trueUse JavaScript source maps (if they exist).
trueWhether to attach to all targets that match the URL filter ("automatic") or ask to pick one ("pick").
"automatic"Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.
10000Timeouts for several debugger operations.
{}Configures what diagnostic output is produced.
falseWill search for a tab with this exact url and attach to it, if found
nullWill search for a page with this url and attach to it, if found. Can have * wildcards.
""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"
falseA 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.
[
"${workspaceFolder}/**/*.vue",
"!**/node_modules/**"
]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 "/"
"${workspaceFolder}"