GitHub - EricCornelson/vscode-pwa-1: VSCode PWA Extension

The new, upcoming JavaScript debugger for VS Code. This extension debugs Node.js and web applications (in Edge and Chrome), and will eventually become the built-in debugger for VS Code. You can install this extension by:

Installing the js-debug-nightly extension from the marketplace.
Adding "debug.javascript.usePreview": true to your user settings.

Then you should be able to run and debug your existing programs without changing your launch config. If you can't, then please file an issue.

What's new?

In js-debug we aim to provide rich debugging for modern applications, with no or minimal configuration required. Here are a few new features that js-debug brings:

Debug child process and workers

In Node.js, child processes will automatically be debugged. In browsers, service workers, webworkers, and iframes will be debugged as well.

While debugging workers, you can also step through postMessage() calls.

Debug Node.js processes in the terminal

You can debug any Node.js process you run in the terminal with our revamped Auto Attach. If auto attach isn't on, you can run the command Debug: Toggle Auto Attach to turn it on. Next time you run a command like npm start, we'll debug it.

Once enabled, you can toggle Auto Attach by clicking the Auto Attach: On/Off button in the status bar on the bottom of your screen.

You can also create a one-off terminal for debugging via the Debug: Create JavaScript Debug Terminal command.

In the previous debugger, you had to remember to add the --inspect flag when you ran a command, and couldn't hit breakpoints early in the program since attachment was asynchronous.

Profiling Support

You can capture and view performance profiles natively in VS Code, by clicking on the ⚪ button in the Call Stack view, or through the Debug: Take Performance Profile command. The profile information collected through VS Code is sourcemap-aware.

Easy npm script debugging

You can debug npm scripts by clicking the code lens shown in the package.json, or by running the Debug: Debug NPM Script command/

You can configure where and if the code lens is displayed in the debug.javascript.codelens.npmScripts setting.

Automatic browser debugging

By default, any links you click through the JavaScript debug terminal (Debug: Create JavaScript Debug Terminal command) will open in debug mode. If you'd like, you can enable this for all terminals, or disable it, by setting debug.javascript.debugByLinkOptions to always or off, respectively.

Instrumentation breakpoints

When debugging web apps, you can configure instrumentation breakpoints from VS Code in the "Browser Breakpoints" view.

Better autocompletion in debug console

Autocomplete in the debug console has been significantly improved. You can expect better suggestions for more complex expressions than VS Code was able to handle before.

Return value interception

On a function's return statement, you can use, inspect, and modify the $returnValue.

Note that you can use and modify properties on the $returnValue, but not assign it to--it is effectively a const variable.

Top-Level `await`

You can use await at the top level in the debug console.

However, like the Chrome devtools, if you use await while paused on a breakpoint, you'll only get a pending Promise back. This is because the JavaScript event loop is paused while on a breakpoint.

Pretty-print minified sources

The debugger can now pretty print files, especially useful when dealing with minified sources. It will show a prompt when you step into or open a file that looks minified, and you can also trigger pretty printing manually via the Debug: Pretty print for debugging command.

Click to view gif

You can turn off the suggestion prompt by selecting Never, or changing the setting debug.javascript.suggestPrettyPrinting to false.

Support for Microsoft Edge and WebView2

We support launching the new Microsoft Edge browser, via the pwa-msedge debug type. It supports all the same configuration settings as chrome does.

With this comes support for the WebView2 control in desktop Windows applications. Check out our webview demo to learn how to set this up.

Better sourcemap and breakpoint behavior

Js-debug has a rewritten suite of sourcemap handling and breakpoint resolution logic. This results in more reliable breakpoint behavior in more cases. For example:

We are guaranteed to set breakpoints before hitting them, where there were previously scenarios where this did not happen.
We can handle sources present in multiple compiled files. This is common when dealing with split bundles in web apps.
We now support in-place transpilation (such as ts-node and @babel/register).

Copy values in call stack view

VS Code has long had an action to "Copy Value" from the Variables view. However, previously this was truncated for object or long values. Changes in VS Code and js-debug allow us to losslessly copy the full expressions as JSON.

Other small things

js-debug is a cleanroom rewrite of a JavaScript debugger, so there are a large number of small improvements. Here are some more that are unworthy of their own heading:

Console output is now improved. Promises, ArrayViews/ArrayBuffers, and other complex data structures are better supported.
Logpoint breakpoints now support complex expressions and statements. Errors thrown will be printed, rather than silently eaten.
You can now specify partial versions in the Node.js runtimeVersion. Previously you needed to specify the full version, such as 12.3.4. Now, you can specify 12 and we'll use the most recent 12.* installed on the system.
Sourcemaps are now supported when attaching via the Attach to Node.js Process command.
Several improvements have been made for faster performance and better out-of-the-box behavior in monorepos and multi-part applications.
The console.group() set of APIs are now supported.
You can pass stable, canary, or dev as runtimeExecutables when launching browsers. We'll do our best to discover and use the specified version on your machine.
You can now set the Node.js program to files with other or no extensions without workarounds.
Restart frame requests are now supported.
Command line APIs like inpect() and copy() are now available.

Options

The following options can be configured:

When creating your launch.json
In the setting debug.javascript.debugByLinkOptions to configure defaults when control+clicking links in the debug terminal (the pwa-chrome: launch type)
In the setting debug.javascript.pickAndAttachOptions to configure defaults when using the "Attach to Node.js Process" command (the pwa-node: attach type)
In the setting debug.javascript.terminalOptions to configure defaults in the debug terminal (the pwa-node-terminal: launch type)

This section is a work in process; documentation on some options needs further clarification

pwa-node: attach

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

continueOnAttach

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

Default value:

false

cwd

Absolute path to the working directory of the program being debugged.

Default value:

"${workspaceFolder}"

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

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}/**/*.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 5858.

Default value:

processId

ID of process to attach to.

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:

null

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.

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}/*",
  "webpack:///./~/*": "${workspaceFolder}/node_modules/*",
  "meteor://💻app/*": "${workspaceFolder}/*"
}

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:

trace

Configures what diagnostic output is produced.

Default value:

false

pwa-node: launch

args

Command line arguments passed to the program.

Default value:

[]

autoAttachChildProcesses

Attach debugger to new child processes automatically.

Default value:

true

console

Where to launch the debug target.

Default value:

"internalConsole"

cwd

Absolute path to the working directory of the program being debugged.

Default value:

"${workspaceFolder}"

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

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}/**/*.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 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

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:

null

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

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

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:

[]

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.

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}/*",
  "webpack:///./~/*": "${workspaceFolder}/node_modules/*",
  "meteor://💻app/*": "${workspaceFolder}/*"
}

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:

trace

Configures what diagnostic output is produced.

Default value:

false

node-terminal: launch

autoAttachChildProcesses

Attach debugger to new child processes automatically.

Default value:

true

command

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

Default value:

undefined

cwd

Absolute path to the working directory of the program being debugged.

Default value:

"${workspaceFolder}"

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

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}/**/*.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

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:

null

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:

{
  "onceBreakpointResolved": 16
}

skipFiles

An array of file or folder names, or path globs, to skip when debugging.

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}/*",
  "webpack:///./~/*": "${workspaceFolder}/node_modules/*",
  "meteor://💻app/*": "${workspaceFolder}/*"
}

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:

trace

Configures what diagnostic output is produced.

Default value:

false

pwa-extensionHost: launch

args

Command line arguments passed to the program.

Default value:

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

autoAttachChildProcesses

Attach debugger to new child processes automatically.

Default value:

false

cwd

Absolute path to the working directory of the program being debugged.

Default value:

"${workspaceFolder}"

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

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}/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

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:

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

runtimeExecutable

Absolute path to VS Code.

Default value:

"${execPath}"

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.

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}/*",
  "webpack:///./~/*": "${workspaceFolder}/node_modules/*",
  "meteor://💻app/*": "${workspaceFolder}/*"
}

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:

trace

Configures what diagnostic output is produced.

Default value:

false

pwa-chrome: launch

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"

cleanUp

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

Default value:

"onlyTab"

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

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

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
- wsProtocol is the hinted websocket protocol. This is set to wss if the original URL is https, or ws otherwise.

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}/**/*.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

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

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:

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:

"stable"

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.

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}/*",
  "webpack:///./~/*": "${webRoot}/node_modules/*",
  "meteor://💻app/*": "${webRoot}/*"
}

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:

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.

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}"

pwa-chrome: attach

address

IP address or hostname the debugged browser is listening on.

Default value:

"localhost"

disableNetworkCache

Controls whether to skip the network cache for each request

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
- wsProtocol is the hinted websocket protocol. This is set to wss if the original URL is https, or ws otherwise.

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}/**/*.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

port

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

Default value:

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:

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.

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}/*",
  "webpack:///./~/*": "${webRoot}/node_modules/*",
  "meteor://💻app/*": "${webRoot}/*"
}

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:

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

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}"

pwa-msedge: launch

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"

cleanUp

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

Default value:

"onlyTab"

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

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

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
- wsProtocol is the hinted websocket protocol. This is set to wss if the original URL is https, or ws otherwise.

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}/**/*.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

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

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:

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:

"stable"

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.

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}/*",
  "webpack:///./~/*": "${webRoot}/node_modules/*",
  "meteor://💻app/*": "${webRoot}/*"
}

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:

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.

Default value:

true

useWebView

(Edge (Chromium) only) 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

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}"

pwa-msedge: attach

address

IP address or hostname the debugged browser is listening on.

Default value:

"localhost"

disableNetworkCache

Controls whether to skip the network cache for each request

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
- wsProtocol is the hinted websocket protocol. This is set to wss if the original URL is https, or ws otherwise.

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}/**/*.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

port

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

Default value:

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:

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.

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}/*",
  "webpack:///./~/*": "${webRoot}/node_modules/*",
  "meteor://💻app/*": "${webRoot}/*"
}

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:

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

(Edge (Chromium) only) 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

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}"

Name		Name	Last commit message	Last commit date
Latest commit History 1,132 Commits
.ci		.ci
.github/workflows		.github/workflows
.vscode		.vscode
demos		demos
resources		resources
src		src
testWorkspace		testWorkspace
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
.vscodeignore		.vscodeignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
README.nightly.md		README.nightly.md
gulpfile.js		gulpfile.js
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

License

EricCornelson/vscode-pwa-1

Folders and files

Latest commit

History

Repository files navigation

What's new?

Debug child process and workers

Debug Node.js processes in the terminal

Profiling Support

Easy npm script debugging

Automatic browser debugging

Instrumentation breakpoints

Better autocompletion in debug console

Return value interception

Top-Level await

Pretty-print minified sources

Support for Microsoft Edge and WebView2

Better sourcemap and breakpoint behavior

Copy values in call stack view

Other small things

Options

pwa-node: attach

address

Default value:

attachExistingChildren

Default value:

autoAttachChildProcesses

Default value:

continueOnAttach

Default value:

cwd

Default value:

env

Default value:

envFile

Default value:

localRoot

Default value:

outFiles

Default value:

outputCapture

Default value:

pauseForSourceMap

Default value:

port

Default value:

processId

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:

sourceMaps

Default value:

timeout

Default value:

trace

Default value:

pwa-node: launch

args

Default value:

autoAttachChildProcesses

Default value:

console

Default value:

cwd

Default value:

Top-Level `await`