diff --git a/OPTIONS.md b/OPTIONS.md index bc9ffac63..f59a48a3f 100644 --- a/OPTIONS.md +++ b/OPTIONS.md @@ -437,3 +437,93 @@ "!**/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}"
+
+### editor-browser: launch
+
+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: https://github.com/microsoft/vscode/issues/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"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.
+nullShow 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}/*",
+ "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
+"http://localhost:8080"Will 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}"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: https://github.com/microsoft/vscode/issues/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"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.
+nullShow 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}/*",
+ "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.
+""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}"