From 078756a2ac7852d1f5699e942425a495290b4c12 Mon Sep 17 00:00:00 2001 From: Cole Miller Date: Sat, 5 Jul 2025 00:58:11 -0400 Subject: [PATCH] reorganize in preparation for more adapters --- Cargo.lock | 2 - crates/dap_adapters/Cargo.toml | 6 - crates/dap_adapters/schemas/JavaScript.json | 7348 +++++++++---------- crates/dap_adapters/src/dap_adapters.rs | 10 + crates/dap_adapters/src/javascript.rs | 183 +- crates/dap_adapters/src/update_schemas.rs | 159 +- 6 files changed, 3857 insertions(+), 3851 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 46bcca639528ab8d59a8afed87c5955c218cd2e7..aff66d068807e506ef0c3c18234d65d4ebcb8ddf 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4156,9 +4156,7 @@ dependencies = [ "log", "node_runtime", "paths", - "regex", "reqwest_client", - "schemars", "serde", "serde_json", "settings", diff --git a/crates/dap_adapters/Cargo.toml b/crates/dap_adapters/Cargo.toml index ba78a10fde87450e674849f52a818f7ec6f46a27..6a438643ca5bcea664c692148fd431b10152b786 100644 --- a/crates/dap_adapters/Cargo.toml +++ b/crates/dap_adapters/Cargo.toml @@ -16,9 +16,7 @@ test-support = [ ] update-schemas = [ "dep:node_runtime", - "dep:regex", "dep:reqwest_client", - "dep:schemars", "dep:settings", "dep:tempfile", ] @@ -56,11 +54,7 @@ util.workspace = true workspace-hack.workspace = true node_runtime = { workspace = true, optional = true } -# FIXME do we still need this -regex = { workspace = true, optional = true } reqwest_client = { workspace = true, optional = true } -# FIXME do we still need this -schemars = { workspace = true, optional = true } settings = { workspace = true, optional = true } tempfile = { workspace = true, optional = true } diff --git a/crates/dap_adapters/schemas/JavaScript.json b/crates/dap_adapters/schemas/JavaScript.json index d7a15ea35bc152d0b785c20485aba6f93a3fb064..044301841e8e506a043c8777167ba35da0e14dda 100644 --- a/crates/dap_adapters/schemas/JavaScript.json +++ b/crates/dap_adapters/schemas/JavaScript.json @@ -18,50 +18,49 @@ "then": { "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -71,37 +70,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -112,61 +111,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -178,212 +178,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -397,7 +397,7 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } @@ -422,63 +422,62 @@ "then": { "properties": { "address": { + "default": "localhost", "description": "TCP/IP address of process to be debugged. Default is 'localhost'.", - "type": "string", - "default": "localhost" + "type": "string" }, "attachExistingChildren": { + "default": false, "description": "Whether to attempt to attach to already-spawned child processes.", - "type": "boolean", - "default": false + "type": "boolean" }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "continueOnAttach": { - "type": "boolean", "default": true, - "markdownDescription": "If true, we'll automatically resume programs launched and waiting on `--inspect-brk`" + "markdownDescription": "If true, we'll automatically resume programs launched and waiting on `--inspect-brk`", + "type": "boolean" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -489,41 +488,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -535,20 +535,20 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "port": { - "description": "Debug port to attach to. Default is 9229.", "default": 9229, + "description": "Debug port to attach to. Default is 9229.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ], "tags": [ @@ -556,171 +556,171 @@ ] }, "processId": { + "default": "${command:PickProcess}", "description": "ID of process to attach to.", - "type": "string", - "default": "${command:PickProcess}" + "type": "string" }, "remoteHostHeader": { "description": "Explicit Host header to use when connecting to the websocket of inspector. If unspecified, the host header will be set to 'localhost'. This is useful when the inspector is running behind a proxy that only accept particular Host header.", "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -734,7 +734,7 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, @@ -763,50 +763,49 @@ "then": { "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -816,37 +815,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -857,61 +856,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -923,212 +923,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -1142,7 +1142,7 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } @@ -1167,63 +1167,62 @@ "then": { "properties": { "address": { + "default": "localhost", "description": "TCP/IP address of process to be debugged. Default is 'localhost'.", - "type": "string", - "default": "localhost" + "type": "string" }, "attachExistingChildren": { + "default": false, "description": "Whether to attempt to attach to already-spawned child processes.", - "type": "boolean", - "default": false + "type": "boolean" }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "continueOnAttach": { - "type": "boolean", "default": true, - "markdownDescription": "If true, we'll automatically resume programs launched and waiting on `--inspect-brk`" + "markdownDescription": "If true, we'll automatically resume programs launched and waiting on `--inspect-brk`", + "type": "boolean" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -1234,41 +1233,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -1280,20 +1280,20 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "port": { - "description": "Debug port to attach to. Default is 9229.", "default": 9229, + "description": "Debug port to attach to. Default is 9229.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ], "tags": [ @@ -1301,171 +1301,171 @@ ] }, "processId": { + "default": "${command:PickProcess}", "description": "ID of process to attach to.", - "type": "string", - "default": "${command:PickProcess}" + "type": "string" }, "remoteHostHeader": { "description": "Explicit Host header to use when connecting to the websocket of inspector. If unspecified, the host header will be set to 'localhost'. This is useful when the inspector is running behind a proxy that only accept particular Host header.", "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -1479,7 +1479,7 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, @@ -1508,28 +1508,28 @@ "then": { "properties": { "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "command": { + "default": "npm start", "description": "Command to run in the launched terminal. If not provided, the terminal will open without launching a program.", + "tags": [ + "setup" + ], "type": [ "string", "null" - ], - "default": "npm start", - "tags": [ - "setup" ] }, "customDescriptionGenerator": { @@ -1537,30 +1537,29 @@ "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -1571,41 +1570,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -1617,143 +1617,143 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -1767,7 +1767,7 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } @@ -1792,75 +1792,74 @@ "then": { "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": "array", "default": [ "--extensionDevelopmentPath=${ZED_WORKTREE_ROOT}" ], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "debugWebWorkerHost": { + "default": true, + "markdownDescription": "Configures whether we should try to attach to the web worker extension host.", "type": [ "boolean" - ], - "default": true, - "markdownDescription": "Configures whether we should try to attach to the web worker extension host." + ] }, "debugWebviews": { + "default": true, + "markdownDescription": "Configures whether we should try to attach to webviews in the launched VS Code instance. This will only work in desktop VS Code.", "type": [ "boolean" - ], - "default": true, - "markdownDescription": "Configures whether we should try to attach to webviews in the launched VS Code instance. This will only work in desktop VS Code." + ] }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -1871,41 +1870,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -1917,97 +1917,100 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "rendererDebugOptions": { - "type": "object", + "default": { + "webRoot": "${ZED_WORKTREE_ROOT}" + }, + "markdownDescription": "Chrome launch options used when attaching to the renderer process, with `debugWebviews` or `debugWebWorkerHost`.", "properties": { "address": { + "default": "localhost", "description": "IP address or hostname the debugged browser is listening on.", - "type": "string", - "default": "localhost" + "type": "string" }, "browserAttachLocation": { - "description": "Forces the browser to attach in one location. In a remote workspace (through ssh or WSL, for example) this can be used to attach to a browser on the remote machine rather than locally.", "default": null, + "description": "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.", "oneOf": [ { "type": "null" }, { - "type": "string", "enum": [ "ui", "workspace" - ] + ], + "type": "string" } ] }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "disableNetworkCache": { + "default": true, "description": "Controls whether to skip the network cache for each request", - "type": "boolean", - "default": true + "type": "boolean" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "inspectUri": { + "default": null, "description": "Format to use to rewrite the inspectUri: It's a template string that interpolates keys in `{curlyBraces}`. Available keys are:\n - `url.*` is the parsed address of the running application. For instance, `{url.port}`, `{url.hostname}`\n - `port` is the debug port that Chrome is listening on.\n - `browserInspectUri` is the inspector URI on the launched browser\n - `browserInspectUriPath` is the path part of the inspector URI on the launched browser (e.g.: \"/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2\").\n - `wsProtocol` is the hinted websocket protocol. This is set to `wss` if the original URL is `https`, or `ws` otherwise.\n", "type": [ "string", "null" - ], - "default": null + ] }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -2019,35 +2022,35 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pathMapping": { + "default": {}, "description": "A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk", - "type": "object", - "default": {} + "type": "object" }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "perScriptSourcemaps": { - "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", - "type": "string", "default": "auto", + "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", "enum": [ "yes", "no", "auto" - ] + ], + "type": "string" }, "port": { - "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "default": 9229, + "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ], "tags": [ @@ -2055,72 +2058,74 @@ ] }, "resolveSourceMapLocations": { + "default": null, "description": "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.", + "items": { + "type": "string" + }, "type": [ "array", "null" - ], - "default": null, - "items": { - "type": "string" - } + ] }, "restart": { - "type": "boolean", "default": false, - "markdownDescription": "Whether to reconnect if the browser connection is closed" + "markdownDescription": "Whether to reconnect if the browser connection is closed", + "type": "boolean" }, "server": { "oneOf": [ { + "additionalProperties": false, + "default": { + "program": "node my-server.js" + }, "description": "Configures a web server to start up. Takes the same configuration as the 'node' launch task.", - "type": "object", "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -2130,37 +2135,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -2171,61 +2176,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -2237,212 +2243,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -2456,43 +2462,43 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "node my-server.js" - } + "type": "object" }, { + "additionalProperties": false, + "default": { + "program": "npm start" + }, "description": "JavaScript Debug Terminal", - "type": "object", "properties": { "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "command": { + "default": "npm start", "description": "Command to run in the launched terminal. If not provided, the terminal will open without launching a program.", + "tags": [ + "setup" + ], "type": [ "string", "null" - ], - "default": "npm start", - "tags": [ - "setup" ] }, "customDescriptionGenerator": { @@ -2500,31 +2506,30 @@ "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "docDefault": "localRoot || ${ZED_WORKTREE_ROOT}", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -2535,41 +2540,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -2581,143 +2587,143 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -2731,130 +2737,127 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "npm start" - } + "type": "object" } ] }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "targetSelection": { - "type": "string", "default": "automatic", "enum": [ "pick", "automatic" ], - "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\")." + "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\").", + "type": "string" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -2868,187 +2871,184 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, "url": { - "description": "Will search for a tab with this exact url and attach to it, if found", - "type": "string", "default": "http://localhost:8080", + "description": "Will search for a tab with this exact url and attach to it, if found", "tags": [ "setup" - ] + ], + "type": "string" }, "urlFilter": { + "default": "", "description": "Will search for a page with this url and attach to it, if found. Can have * wildcards.", - "type": "string", - "default": "" + "type": "string" }, "vueComponentPaths": { - "description": "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.", - "type": "array", "default": [ "${ZED_WORKTREE_ROOT}/**/*.vue" - ] - }, + ], + "description": "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.", + "type": "array" + }, "webRoot": { - "description": "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 \"/\"", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "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 \"/\"", "tags": [ "setup" - ] + ], + "type": "string" } }, - "default": { - "webRoot": "${ZED_WORKTREE_ROOT}" - }, - "markdownDescription": "Chrome launch options used when attaching to the renderer process, with `debugWebviews` or `debugWebWorkerHost`." + "type": "object" }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Absolute path to VS Code.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Absolute path to VS Code." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "testConfiguration": { - "type": "string", "default": "${ZED_WORKTREE_ROOT}/.vscode-test.js", - "markdownDescription": "Path to a test configuration file for the [test CLI](https://code.visualstudio.com/api/working-with-extensions/testing-extension#quick-setup-the-test-cli)." + "markdownDescription": "Path to a test configuration file for the [test CLI](https://code.visualstudio.com/api/working-with-extensions/testing-extension#quick-setup-the-test-cli).", + "type": "string" }, "testConfigurationLabel": { - "type": "string", "default": "", - "markdownDescription": "A single configuration to run from the file. If not specified, you may be asked to pick." + "markdownDescription": "A single configuration to run from the file. If not specified, you may be asked to pick.", + "type": "string" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -3062,7 +3062,7 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } @@ -3088,75 +3088,74 @@ "then": { "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": "array", "default": [ "--extensionDevelopmentPath=${ZED_WORKTREE_ROOT}" ], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "debugWebWorkerHost": { + "default": true, + "markdownDescription": "Configures whether we should try to attach to the web worker extension host.", "type": [ "boolean" - ], - "default": true, - "markdownDescription": "Configures whether we should try to attach to the web worker extension host." + ] }, "debugWebviews": { + "default": true, + "markdownDescription": "Configures whether we should try to attach to webviews in the launched VS Code instance. This will only work in desktop VS Code.", "type": [ "boolean" - ], - "default": true, - "markdownDescription": "Configures whether we should try to attach to webviews in the launched VS Code instance. This will only work in desktop VS Code." + ] }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -3167,41 +3166,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -3213,97 +3213,100 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "rendererDebugOptions": { - "type": "object", + "default": { + "webRoot": "${ZED_WORKTREE_ROOT}" + }, + "markdownDescription": "Chrome launch options used when attaching to the renderer process, with `debugWebviews` or `debugWebWorkerHost`.", "properties": { "address": { + "default": "localhost", "description": "IP address or hostname the debugged browser is listening on.", - "type": "string", - "default": "localhost" + "type": "string" }, "browserAttachLocation": { - "description": "Forces the browser to attach in one location. In a remote workspace (through ssh or WSL, for example) this can be used to attach to a browser on the remote machine rather than locally.", "default": null, + "description": "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.", "oneOf": [ { "type": "null" }, { - "type": "string", "enum": [ "ui", "workspace" - ] + ], + "type": "string" } ] }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "disableNetworkCache": { + "default": true, "description": "Controls whether to skip the network cache for each request", - "type": "boolean", - "default": true + "type": "boolean" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "inspectUri": { + "default": null, "description": "Format to use to rewrite the inspectUri: It's a template string that interpolates keys in `{curlyBraces}`. Available keys are:\n - `url.*` is the parsed address of the running application. For instance, `{url.port}`, `{url.hostname}`\n - `port` is the debug port that Chrome is listening on.\n - `browserInspectUri` is the inspector URI on the launched browser\n - `browserInspectUriPath` is the path part of the inspector URI on the launched browser (e.g.: \"/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2\").\n - `wsProtocol` is the hinted websocket protocol. This is set to `wss` if the original URL is `https`, or `ws` otherwise.\n", "type": [ "string", "null" - ], - "default": null + ] }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -3315,35 +3318,35 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pathMapping": { + "default": {}, "description": "A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk", - "type": "object", - "default": {} + "type": "object" }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "perScriptSourcemaps": { - "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", - "type": "string", "default": "auto", + "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", "enum": [ "yes", "no", "auto" - ] + ], + "type": "string" }, "port": { - "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "default": 9229, + "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ], "tags": [ @@ -3351,72 +3354,74 @@ ] }, "resolveSourceMapLocations": { + "default": null, "description": "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.", + "items": { + "type": "string" + }, "type": [ "array", "null" - ], - "default": null, - "items": { - "type": "string" - } + ] }, "restart": { - "type": "boolean", "default": false, - "markdownDescription": "Whether to reconnect if the browser connection is closed" + "markdownDescription": "Whether to reconnect if the browser connection is closed", + "type": "boolean" }, "server": { "oneOf": [ { + "additionalProperties": false, + "default": { + "program": "node my-server.js" + }, "description": "Configures a web server to start up. Takes the same configuration as the 'node' launch task.", - "type": "object", "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -3426,37 +3431,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -3467,61 +3472,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -3533,212 +3539,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -3752,43 +3758,43 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "node my-server.js" - } + "type": "object" }, { + "additionalProperties": false, + "default": { + "program": "npm start" + }, "description": "JavaScript Debug Terminal", - "type": "object", "properties": { "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "command": { + "default": "npm start", "description": "Command to run in the launched terminal. If not provided, the terminal will open without launching a program.", + "tags": [ + "setup" + ], "type": [ "string", "null" - ], - "default": "npm start", - "tags": [ - "setup" ] }, "customDescriptionGenerator": { @@ -3796,31 +3802,30 @@ "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "docDefault": "localRoot || ${ZED_WORKTREE_ROOT}", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -3831,41 +3836,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -3877,143 +3883,143 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -4027,130 +4033,127 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "npm start" - } + "type": "object" } ] }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "targetSelection": { - "type": "string", "default": "automatic", "enum": [ "pick", "automatic" ], - "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\")." + "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\").", + "type": "string" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -4164,187 +4167,184 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, "url": { - "description": "Will search for a tab with this exact url and attach to it, if found", - "type": "string", "default": "http://localhost:8080", + "description": "Will search for a tab with this exact url and attach to it, if found", "tags": [ "setup" - ] + ], + "type": "string" }, "urlFilter": { + "default": "", "description": "Will search for a page with this url and attach to it, if found. Can have * wildcards.", - "type": "string", - "default": "" + "type": "string" }, "vueComponentPaths": { - "description": "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.", - "type": "array", "default": [ "${ZED_WORKTREE_ROOT}/**/*.vue" - ] + ], + "description": "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.", + "type": "array" }, "webRoot": { - "description": "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 \"/\"", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "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 \"/\"", "tags": [ "setup" - ] + ], + "type": "string" } }, - "default": { - "webRoot": "${ZED_WORKTREE_ROOT}" - }, - "markdownDescription": "Chrome launch options used when attaching to the renderer process, with `debugWebviews` or `debugWebWorkerHost`." + "type": "object" }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Absolute path to VS Code.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Absolute path to VS Code." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "testConfiguration": { - "type": "string", "default": "${ZED_WORKTREE_ROOT}/.vscode-test.js", - "markdownDescription": "Path to a test configuration file for the [test CLI](https://code.visualstudio.com/api/working-with-extensions/testing-extension#quick-setup-the-test-cli)." + "markdownDescription": "Path to a test configuration file for the [test CLI](https://code.visualstudio.com/api/working-with-extensions/testing-extension#quick-setup-the-test-cli).", + "type": "string" }, "testConfigurationLabel": { - "type": "string", "default": "", - "markdownDescription": "A single configuration to run from the file. If not specified, you may be asked to pick." + "markdownDescription": "A single configuration to run from the file. If not specified, you may be asked to pick.", + "type": "string" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -4358,7 +4358,7 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } @@ -4384,123 +4384,123 @@ "then": { "properties": { "browserLaunchLocation": { - "description": "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": null, + "description": "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.", "oneOf": [ { "type": "null" }, { - "type": "string", "enum": [ "ui", "workspace" - ] + ], + "type": "string" } ] }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "cleanUp": { - "description": "What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.", - "type": "string", "default": "wholeBrowser", + "description": "What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.", "enum": [ "wholeBrowser", "onlyTab" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { + "default": null, "description": "Optional working directory for the runtime executable.", - "type": "string", - "default": null + "type": "string" }, "disableNetworkCache": { + "default": true, "description": "Controls whether to skip the network cache for each request", - "type": "boolean", - "default": true + "type": "boolean" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { + "default": {}, "description": "Optional dictionary of environment key/value pairs for the browser.", - "type": "object", - "default": {} + "type": "object" }, "file": { - "description": "A local html file to open in the browser", - "type": "string", "default": "${ZED_WORKTREE_ROOT}/index.html", + "description": "A local html file to open in the browser", "tags": [ "setup" - ] + ], + "type": "string" }, "includeDefaultArgs": { + "default": true, "description": "Whether default browser launch arguments (to disable features that may make debugging harder) will be included in the launch.", - "type": "boolean", - "default": true + "type": "boolean" }, "includeLaunchArgs": { + "default": true, "description": "Advanced: whether any default launch/debugging arguments are set on the browser. The debugger will assume the browser will use pipe debugging such as that which is provided with `--remote-debugging-pipe`.", - "type": "boolean", - "default": true + "type": "boolean" }, "inspectUri": { + "default": null, "description": "Format to use to rewrite the inspectUri: It's a template string that interpolates keys in `{curlyBraces}`. Available keys are:\n - `url.*` is the parsed address of the running application. For instance, `{url.port}`, `{url.hostname}`\n - `port` is the debug port that Chrome is listening on.\n - `browserInspectUri` is the inspector URI on the launched browser\n - `browserInspectUriPath` is the path part of the inspector URI on the launched browser (e.g.: \"/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2\").\n - `wsProtocol` is the hinted websocket protocol. This is set to `wss` if the original URL is `https`, or `ws` otherwise.\n", "type": [ "string", "null" - ], - "default": null + ] }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how browser processes are killed when stopping the session with `cleanUp: wholeBrowser`. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how browser processes are killed when stopping the session with `cleanUp: wholeBrowser`. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -4512,113 +4512,115 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pathMapping": { + "default": {}, "description": "A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk", - "type": "object", - "default": {} + "type": "object" }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "perScriptSourcemaps": { - "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", - "type": "string", "default": "auto", + "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", "enum": [ "yes", "no", "auto" - ] + ], + "type": "string" }, "port": { + "default": 0, "description": "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.", - "type": "number", - "default": 0 + "type": "number" }, "profileStartup": { + "default": true, "description": "If true, will start profiling soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "resolveSourceMapLocations": { + "default": null, "description": "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.", + "items": { + "type": "string" + }, "type": [ "array", "null" - ], - "default": null, - "items": { - "type": "string" - } + ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" - } + }, + "type": "array" }, "runtimeExecutable": { + "default": "stable", "description": "Either 'canary', 'stable', 'custom' or path to the browser executable. Custom means a custom wrapper, custom build or CHROME_PATH environment variable.", "type": [ "string", "null" - ], - "default": "stable" + ] }, "server": { "oneOf": [ { + "additionalProperties": false, + "default": { + "program": "node my-server.js" + }, "description": "Configures a web server to start up. Takes the same configuration as the 'node' launch task.", - "type": "object", "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -4628,37 +4630,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -4669,61 +4671,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -4735,212 +4738,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -4954,43 +4957,43 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "node my-server.js" - } + "type": "object" }, { + "additionalProperties": false, + "default": { + "program": "npm start" + }, "description": "JavaScript Debug Terminal", - "type": "object", "properties": { "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "command": { + "default": "npm start", "description": "Command to run in the launched terminal. If not provided, the terminal will open without launching a program.", + "tags": [ + "setup" + ], "type": [ "string", "null" - ], - "default": "npm start", - "tags": [ - "setup" ] }, "customDescriptionGenerator": { @@ -4998,31 +5001,30 @@ "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "docDefault": "localRoot || ${ZED_WORKTREE_ROOT}", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -5033,41 +5035,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -5079,143 +5082,143 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -5229,121 +5232,118 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "npm start" - } + "type": "object" } ] }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -5357,45 +5357,45 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, "url": { - "description": "Will search for a tab with this exact url and attach to it, if found", - "type": "string", "default": "http://localhost:8080", + "description": "Will search for a tab with this exact url and attach to it, if found", "tags": [ "setup" - ] + ], + "type": "string" }, "urlFilter": { + "default": "", "description": "Will search for a page with this url and attach to it, if found. Can have * wildcards.", - "type": "string", - "default": "" + "type": "string" }, "userDataDir": { + "default": true, "description": "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`.", "type": [ "string", "boolean" - ], - "default": true + ] }, "vueComponentPaths": { - "description": "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.", - "type": "array", "default": [ "${ZED_WORKTREE_ROOT}/**/*.vue" - ] + ], + "description": "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.", + "type": "array" }, "webRoot": { - "description": "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 \"/\"", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "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 \"/\"", "tags": [ "setup" - ] + ], + "type": "string" } } } @@ -5418,81 +5418,81 @@ "then": { "properties": { "address": { + "default": "localhost", "description": "IP address or hostname the debugged browser is listening on.", - "type": "string", - "default": "localhost" + "type": "string" }, "browserAttachLocation": { - "description": "Forces the browser to attach in one location. In a remote workspace (through ssh or WSL, for example) this can be used to attach to a browser on the remote machine rather than locally.", "default": null, + "description": "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.", "oneOf": [ { "type": "null" }, { - "type": "string", "enum": [ "ui", "workspace" - ] + ], + "type": "string" } ] }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "disableNetworkCache": { + "default": true, "description": "Controls whether to skip the network cache for each request", - "type": "boolean", - "default": true + "type": "boolean" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "inspectUri": { + "default": null, "description": "Format to use to rewrite the inspectUri: It's a template string that interpolates keys in `{curlyBraces}`. Available keys are:\n - `url.*` is the parsed address of the running application. For instance, `{url.port}`, `{url.hostname}`\n - `port` is the debug port that Chrome is listening on.\n - `browserInspectUri` is the inspector URI on the launched browser\n - `browserInspectUriPath` is the path part of the inspector URI on the launched browser (e.g.: \"/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2\").\n - `wsProtocol` is the hinted websocket protocol. This is set to `wss` if the original URL is `https`, or `ws` otherwise.\n", "type": [ "string", "null" - ], - "default": null + ] }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -5504,35 +5504,35 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pathMapping": { + "default": {}, "description": "A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk", - "type": "object", - "default": {} + "type": "object" }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "perScriptSourcemaps": { - "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", - "type": "string", "default": "auto", + "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", "enum": [ "yes", "no", "auto" - ] + ], + "type": "string" }, "port": { - "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "default": 9229, + "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ], "tags": [ @@ -5540,72 +5540,74 @@ ] }, "resolveSourceMapLocations": { + "default": null, "description": "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.", + "items": { + "type": "string" + }, "type": [ "array", "null" - ], - "default": null, - "items": { - "type": "string" - } + ] }, "restart": { - "type": "boolean", "default": false, - "markdownDescription": "Whether to reconnect if the browser connection is closed" + "markdownDescription": "Whether to reconnect if the browser connection is closed", + "type": "boolean" }, "server": { "oneOf": [ { + "additionalProperties": false, + "default": { + "program": "node my-server.js" + }, "description": "Configures a web server to start up. Takes the same configuration as the 'node' launch task.", - "type": "object", "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -5615,37 +5617,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -5656,61 +5658,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -5722,212 +5725,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -5941,43 +5944,43 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "node my-server.js" - } + "type": "object" }, { + "additionalProperties": false, + "default": { + "program": "npm start" + }, "description": "JavaScript Debug Terminal", - "type": "object", "properties": { "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "command": { + "default": "npm start", "description": "Command to run in the launched terminal. If not provided, the terminal will open without launching a program.", + "tags": [ + "setup" + ], "type": [ "string", "null" - ], - "default": "npm start", - "tags": [ - "setup" ] }, "customDescriptionGenerator": { @@ -5985,31 +5988,30 @@ "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "docDefault": "localRoot || ${ZED_WORKTREE_ROOT}", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -6020,41 +6022,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -6066,143 +6069,143 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -6216,130 +6219,127 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "npm start" - } + "type": "object" } ] }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "targetSelection": { - "type": "string", "default": "automatic", "enum": [ "pick", "automatic" ], - "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\")." + "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\").", + "type": "string" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -6353,37 +6353,37 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, "url": { - "description": "Will search for a tab with this exact url and attach to it, if found", - "type": "string", "default": "http://localhost:8080", + "description": "Will search for a tab with this exact url and attach to it, if found", "tags": [ "setup" - ] + ], + "type": "string" }, "urlFilter": { + "default": "", "description": "Will search for a page with this url and attach to it, if found. Can have * wildcards.", - "type": "string", - "default": "" + "type": "string" }, "vueComponentPaths": { - "description": "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.", - "type": "array", "default": [ "${ZED_WORKTREE_ROOT}/**/*.vue" - ] + ], + "description": "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.", + "type": "array" }, "webRoot": { - "description": "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 \"/\"", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "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 \"/\"", "tags": [ "setup" - ] + ], + "type": "string" } } } @@ -6406,123 +6406,123 @@ "then": { "properties": { "browserLaunchLocation": { - "description": "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": null, + "description": "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.", "oneOf": [ { "type": "null" }, { - "type": "string", "enum": [ "ui", "workspace" - ] + ], + "type": "string" } ] }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "cleanUp": { - "description": "What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.", - "type": "string", "default": "wholeBrowser", + "description": "What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.", "enum": [ "wholeBrowser", "onlyTab" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { + "default": null, "description": "Optional working directory for the runtime executable.", - "type": "string", - "default": null + "type": "string" }, "disableNetworkCache": { + "default": true, "description": "Controls whether to skip the network cache for each request", - "type": "boolean", - "default": true + "type": "boolean" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { + "default": {}, "description": "Optional dictionary of environment key/value pairs for the browser.", - "type": "object", - "default": {} + "type": "object" }, "file": { - "description": "A local html file to open in the browser", - "type": "string", "default": "${ZED_WORKTREE_ROOT}/index.html", + "description": "A local html file to open in the browser", "tags": [ "setup" - ] + ], + "type": "string" }, "includeDefaultArgs": { + "default": true, "description": "Whether default browser launch arguments (to disable features that may make debugging harder) will be included in the launch.", - "type": "boolean", - "default": true + "type": "boolean" }, "includeLaunchArgs": { + "default": true, "description": "Advanced: whether any default launch/debugging arguments are set on the browser. The debugger will assume the browser will use pipe debugging such as that which is provided with `--remote-debugging-pipe`.", - "type": "boolean", - "default": true + "type": "boolean" }, "inspectUri": { + "default": null, "description": "Format to use to rewrite the inspectUri: It's a template string that interpolates keys in `{curlyBraces}`. Available keys are:\n - `url.*` is the parsed address of the running application. For instance, `{url.port}`, `{url.hostname}`\n - `port` is the debug port that Chrome is listening on.\n - `browserInspectUri` is the inspector URI on the launched browser\n - `browserInspectUriPath` is the path part of the inspector URI on the launched browser (e.g.: \"/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2\").\n - `wsProtocol` is the hinted websocket protocol. This is set to `wss` if the original URL is `https`, or `ws` otherwise.\n", "type": [ "string", "null" - ], - "default": null + ] }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how browser processes are killed when stopping the session with `cleanUp: wholeBrowser`. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how browser processes are killed when stopping the session with `cleanUp: wholeBrowser`. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -6534,113 +6534,115 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pathMapping": { + "default": {}, "description": "A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk", - "type": "object", - "default": {} + "type": "object" }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "perScriptSourcemaps": { - "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", - "type": "string", "default": "auto", + "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", "enum": [ "yes", "no", "auto" - ] + ], + "type": "string" }, "port": { + "default": 0, "description": "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.", - "type": "number", - "default": 0 + "type": "number" }, "profileStartup": { + "default": true, "description": "If true, will start profiling soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "resolveSourceMapLocations": { + "default": null, "description": "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.", + "items": { + "type": "string" + }, "type": [ "array", "null" - ], - "default": null, - "items": { - "type": "string" - } + ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" - } + }, + "type": "array" }, "runtimeExecutable": { + "default": "stable", "description": "Either 'canary', 'stable', 'custom' or path to the browser executable. Custom means a custom wrapper, custom build or CHROME_PATH environment variable.", "type": [ "string", "null" - ], - "default": "stable" + ] }, "server": { "oneOf": [ { + "additionalProperties": false, + "default": { + "program": "node my-server.js" + }, "description": "Configures a web server to start up. Takes the same configuration as the 'node' launch task.", - "type": "object", "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -6650,37 +6652,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -6691,61 +6693,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -6757,212 +6760,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -6976,43 +6979,43 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "node my-server.js" - } + "type": "object" }, { + "additionalProperties": false, + "default": { + "program": "npm start" + }, "description": "JavaScript Debug Terminal", - "type": "object", "properties": { "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "command": { + "default": "npm start", "description": "Command to run in the launched terminal. If not provided, the terminal will open without launching a program.", + "tags": [ + "setup" + ], "type": [ "string", "null" - ], - "default": "npm start", - "tags": [ - "setup" ] }, "customDescriptionGenerator": { @@ -7020,31 +7023,30 @@ "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "docDefault": "localRoot || ${ZED_WORKTREE_ROOT}", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -7055,41 +7057,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -7101,143 +7104,143 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -7251,121 +7254,118 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } - }, - "additionalProperties": false, - "default": { - "program": "npm start" - } + }, + "type": "object" } ] }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -7379,45 +7379,45 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, "url": { - "description": "Will search for a tab with this exact url and attach to it, if found", - "type": "string", "default": "http://localhost:8080", + "description": "Will search for a tab with this exact url and attach to it, if found", "tags": [ "setup" - ] + ], + "type": "string" }, "urlFilter": { + "default": "", "description": "Will search for a page with this url and attach to it, if found. Can have * wildcards.", - "type": "string", - "default": "" + "type": "string" }, "userDataDir": { + "default": true, "description": "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`.", "type": [ "string", "boolean" - ], - "default": true + ] }, "vueComponentPaths": { - "description": "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.", - "type": "array", "default": [ "${ZED_WORKTREE_ROOT}/**/*.vue" - ] + ], + "description": "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.", + "type": "array" }, "webRoot": { - "description": "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 \"/\"", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "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 \"/\"", "tags": [ "setup" - ] + ], + "type": "string" } } } @@ -7440,81 +7440,81 @@ "then": { "properties": { "address": { + "default": "localhost", "description": "IP address or hostname the debugged browser is listening on.", - "type": "string", - "default": "localhost" + "type": "string" }, "browserAttachLocation": { - "description": "Forces the browser to attach in one location. In a remote workspace (through ssh or WSL, for example) this can be used to attach to a browser on the remote machine rather than locally.", "default": null, + "description": "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.", "oneOf": [ { "type": "null" }, { - "type": "string", "enum": [ "ui", "workspace" - ] + ], + "type": "string" } ] }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "disableNetworkCache": { + "default": true, "description": "Controls whether to skip the network cache for each request", - "type": "boolean", - "default": true + "type": "boolean" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "inspectUri": { + "default": null, "description": "Format to use to rewrite the inspectUri: It's a template string that interpolates keys in `{curlyBraces}`. Available keys are:\n - `url.*` is the parsed address of the running application. For instance, `{url.port}`, `{url.hostname}`\n - `port` is the debug port that Chrome is listening on.\n - `browserInspectUri` is the inspector URI on the launched browser\n - `browserInspectUriPath` is the path part of the inspector URI on the launched browser (e.g.: \"/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2\").\n - `wsProtocol` is the hinted websocket protocol. This is set to `wss` if the original URL is `https`, or `ws` otherwise.\n", "type": [ "string", "null" - ], - "default": null + ] }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -7526,35 +7526,35 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pathMapping": { + "default": {}, "description": "A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk", - "type": "object", - "default": {} + "type": "object" }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "perScriptSourcemaps": { - "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", - "type": "string", "default": "auto", + "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", "enum": [ "yes", "no", "auto" - ] + ], + "type": "string" }, "port": { - "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "default": 9229, + "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ], "tags": [ @@ -7562,72 +7562,74 @@ ] }, "resolveSourceMapLocations": { + "default": null, "description": "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.", + "items": { + "type": "string" + }, "type": [ "array", "null" - ], - "default": null, - "items": { - "type": "string" - } + ] }, "restart": { - "type": "boolean", "default": false, - "markdownDescription": "Whether to reconnect if the browser connection is closed" + "markdownDescription": "Whether to reconnect if the browser connection is closed", + "type": "boolean" }, "server": { "oneOf": [ { + "additionalProperties": false, + "default": { + "program": "node my-server.js" + }, "description": "Configures a web server to start up. Takes the same configuration as the 'node' launch task.", - "type": "object", "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -7637,37 +7639,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -7678,61 +7680,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -7744,212 +7747,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -7963,43 +7966,43 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "node my-server.js" - } + "type": "object" }, { + "additionalProperties": false, + "default": { + "program": "npm start" + }, "description": "JavaScript Debug Terminal", - "type": "object", "properties": { "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "command": { + "default": "npm start", "description": "Command to run in the launched terminal. If not provided, the terminal will open without launching a program.", + "tags": [ + "setup" + ], "type": [ "string", "null" - ], - "default": "npm start", - "tags": [ - "setup" ] }, "customDescriptionGenerator": { @@ -8007,31 +8010,30 @@ "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "docDefault": "localRoot || ${ZED_WORKTREE_ROOT}", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -8042,41 +8044,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -8088,143 +8091,143 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, - "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], + "resolveSourceMapLocations": { "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -8238,130 +8241,127 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "npm start" - } + "type": "object" } ] }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "targetSelection": { - "type": "string", "default": "automatic", "enum": [ "pick", "automatic" ], - "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\")." + "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\").", + "type": "string" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -8375,37 +8375,37 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, "url": { - "description": "Will search for a tab with this exact url and attach to it, if found", - "type": "string", "default": "http://localhost:8080", + "description": "Will search for a tab with this exact url and attach to it, if found", "tags": [ "setup" - ] + ], + "type": "string" }, "urlFilter": { + "default": "", "description": "Will search for a page with this url and attach to it, if found. Can have * wildcards.", - "type": "string", - "default": "" + "type": "string" }, "vueComponentPaths": { - "description": "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.", - "type": "array", "default": [ "${ZED_WORKTREE_ROOT}/**/*.vue" - ] + ], + "description": "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.", + "type": "array" }, "webRoot": { - "description": "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 \"/\"", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "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 \"/\"", "tags": [ "setup" - ] + ], + "type": "string" } } } @@ -8428,128 +8428,128 @@ "then": { "properties": { "address": { + "default": "localhost", "description": "When debugging webviews, the IP address or hostname the webview is listening on. Will be automatically discovered if not set.", - "type": "string", - "default": "localhost" + "type": "string" }, "browserLaunchLocation": { - "description": "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": null, + "description": "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.", "oneOf": [ { "type": "null" }, { - "type": "string", "enum": [ "ui", "workspace" - ] + ], + "type": "string" } ] }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "cleanUp": { - "description": "What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.", - "type": "string", "default": "wholeBrowser", + "description": "What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.", "enum": [ "wholeBrowser", "onlyTab" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { + "default": null, "description": "Optional working directory for the runtime executable.", - "type": "string", - "default": null + "type": "string" }, "disableNetworkCache": { + "default": true, "description": "Controls whether to skip the network cache for each request", - "type": "boolean", - "default": true + "type": "boolean" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { + "default": {}, "description": "Optional dictionary of environment key/value pairs for the browser.", - "type": "object", - "default": {} + "type": "object" }, "file": { - "description": "A local html file to open in the browser", - "type": "string", "default": "${ZED_WORKTREE_ROOT}/index.html", + "description": "A local html file to open in the browser", "tags": [ "setup" - ] + ], + "type": "string" }, "includeDefaultArgs": { + "default": true, "description": "Whether default browser launch arguments (to disable features that may make debugging harder) will be included in the launch.", - "type": "boolean", - "default": true + "type": "boolean" }, "includeLaunchArgs": { + "default": true, "description": "Advanced: whether any default launch/debugging arguments are set on the browser. The debugger will assume the browser will use pipe debugging such as that which is provided with `--remote-debugging-pipe`.", - "type": "boolean", - "default": true + "type": "boolean" }, "inspectUri": { + "default": null, "description": "Format to use to rewrite the inspectUri: It's a template string that interpolates keys in `{curlyBraces}`. Available keys are:\n - `url.*` is the parsed address of the running application. For instance, `{url.port}`, `{url.hostname}`\n - `port` is the debug port that Chrome is listening on.\n - `browserInspectUri` is the inspector URI on the launched browser\n - `browserInspectUriPath` is the path part of the inspector URI on the launched browser (e.g.: \"/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2\").\n - `wsProtocol` is the hinted websocket protocol. This is set to `wss` if the original URL is `https`, or `ws` otherwise.\n", "type": [ "string", "null" - ], - "default": null + ] }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how browser processes are killed when stopping the session with `cleanUp: wholeBrowser`. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how browser processes are killed when stopping the session with `cleanUp: wholeBrowser`. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -8561,113 +8561,115 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pathMapping": { + "default": {}, "description": "A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk", - "type": "object", - "default": {} + "type": "object" }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "perScriptSourcemaps": { - "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", - "type": "string", "default": "auto", + "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", "enum": [ "yes", "no", "auto" - ] + ], + "type": "string" }, "port": { + "default": 9229, "description": "When debugging webviews, the port the webview debugger is listening on. Will be automatically discovered if not set.", - "type": "number", - "default": 9229 + "type": "number" }, "profileStartup": { + "default": true, "description": "If true, will start profiling soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "resolveSourceMapLocations": { + "default": null, "description": "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.", + "items": { + "type": "string" + }, "type": [ "array", "null" - ], - "default": null, - "items": { - "type": "string" - } + ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" - } + }, + "type": "array" }, "runtimeExecutable": { + "default": "stable", "description": "Either 'canary', 'stable', 'dev', 'custom' or path to the browser executable. Custom means a custom wrapper, custom build or EDGE_PATH environment variable.", "type": [ "string", "null" - ], - "default": "stable" + ] }, "server": { "oneOf": [ { + "additionalProperties": false, + "default": { + "program": "node my-server.js" + }, "description": "Configures a web server to start up. Takes the same configuration as the 'node' launch task.", - "type": "object", "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -8677,37 +8679,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -8718,61 +8720,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -8784,212 +8787,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -9003,43 +9006,43 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "node my-server.js" - } + "type": "object" }, { + "additionalProperties": false, + "default": { + "program": "npm start" + }, "description": "JavaScript Debug Terminal", - "type": "object", "properties": { "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "command": { + "default": "npm start", "description": "Command to run in the launched terminal. If not provided, the terminal will open without launching a program.", + "tags": [ + "setup" + ], "type": [ "string", "null" - ], - "default": "npm start", - "tags": [ - "setup" ] }, "customDescriptionGenerator": { @@ -9047,31 +9050,30 @@ "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "docDefault": "localRoot || ${ZED_WORKTREE_ROOT}", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -9082,41 +9084,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -9128,143 +9131,143 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -9278,121 +9281,118 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "npm start" - } + "type": "object" } ] }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -9406,50 +9406,50 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, "url": { - "description": "Will search for a tab with this exact url and attach to it, if found", - "type": "string", "default": "http://localhost:8080", + "description": "Will search for a tab with this exact url and attach to it, if found", "tags": [ "setup" - ] + ], + "type": "string" }, "urlFilter": { + "default": "", "description": "Will search for a page with this url and attach to it, if found. Can have * wildcards.", - "type": "string", - "default": "" + "type": "string" }, "useWebView": { + "default": false, "description": "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.", - "type": "boolean", - "default": false + "type": "boolean" }, "userDataDir": { + "default": true, "description": "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`.", "type": [ "string", "boolean" - ], - "default": true + ] }, "vueComponentPaths": { - "description": "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.", - "type": "array", "default": [ "${ZED_WORKTREE_ROOT}/**/*.vue" - ] + ], + "description": "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.", + "type": "array" }, "webRoot": { - "description": "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 \"/\"", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "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 \"/\"", "tags": [ "setup" - ] + ], + "type": "string" } } } @@ -9472,81 +9472,81 @@ "then": { "properties": { "address": { + "default": "localhost", "description": "IP address or hostname the debugged browser is listening on.", - "type": "string", - "default": "localhost" + "type": "string" }, "browserAttachLocation": { - "description": "Forces the browser to attach in one location. In a remote workspace (through ssh or WSL, for example) this can be used to attach to a browser on the remote machine rather than locally.", "default": null, + "description": "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.", "oneOf": [ { "type": "null" }, { - "type": "string", "enum": [ "ui", "workspace" - ] + ], + "type": "string" } ] }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "disableNetworkCache": { + "default": true, "description": "Controls whether to skip the network cache for each request", - "type": "boolean", - "default": true + "type": "boolean" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "inspectUri": { + "default": null, "description": "Format to use to rewrite the inspectUri: It's a template string that interpolates keys in `{curlyBraces}`. Available keys are:\n - `url.*` is the parsed address of the running application. For instance, `{url.port}`, `{url.hostname}`\n - `port` is the debug port that Chrome is listening on.\n - `browserInspectUri` is the inspector URI on the launched browser\n - `browserInspectUriPath` is the path part of the inspector URI on the launched browser (e.g.: \"/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2\").\n - `wsProtocol` is the hinted websocket protocol. This is set to `wss` if the original URL is `https`, or `ws` otherwise.\n", "type": [ "string", "null" - ], - "default": null + ] }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -9558,35 +9558,35 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pathMapping": { + "default": {}, "description": "A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk", - "type": "object", - "default": {} + "type": "object" }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "perScriptSourcemaps": { - "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", - "type": "string", "default": "auto", + "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", "enum": [ "yes", "no", "auto" - ] + ], + "type": "string" }, "port": { - "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "default": 9229, + "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ], "tags": [ @@ -9594,72 +9594,74 @@ ] }, "resolveSourceMapLocations": { + "default": null, "description": "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.", + "items": { + "type": "string" + }, "type": [ "array", "null" - ], - "default": null, - "items": { - "type": "string" - } + ] }, "restart": { - "type": "boolean", "default": false, - "markdownDescription": "Whether to reconnect if the browser connection is closed" + "markdownDescription": "Whether to reconnect if the browser connection is closed", + "type": "boolean" }, "server": { "oneOf": [ { + "additionalProperties": false, + "default": { + "program": "node my-server.js" + }, "description": "Configures a web server to start up. Takes the same configuration as the 'node' launch task.", - "type": "object", "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -9669,37 +9671,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -9710,61 +9712,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -9776,212 +9779,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -9995,43 +9998,43 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "node my-server.js" - } + "type": "object" }, { + "additionalProperties": false, + "default": { + "program": "npm start" + }, "description": "JavaScript Debug Terminal", - "type": "object", "properties": { "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "command": { + "default": "npm start", "description": "Command to run in the launched terminal. If not provided, the terminal will open without launching a program.", + "tags": [ + "setup" + ], "type": [ "string", "null" - ], - "default": "npm start", - "tags": [ - "setup" ] }, "customDescriptionGenerator": { @@ -10039,31 +10042,30 @@ "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "docDefault": "localRoot || ${ZED_WORKTREE_ROOT}", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -10074,41 +10076,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -10120,143 +10123,143 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -10270,130 +10273,127 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "npm start" - } + "type": "object" } ] }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "targetSelection": { - "type": "string", "default": "automatic", "enum": [ "pick", "automatic" ], - "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\")." + "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\").", + "type": "string" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -10407,49 +10407,49 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, "url": { - "description": "Will search for a tab with this exact url and attach to it, if found", - "type": "string", "default": "http://localhost:8080", + "description": "Will search for a tab with this exact url and attach to it, if found", "tags": [ "setup" - ] + ], + "type": "string" }, "urlFilter": { + "default": "", "description": "Will search for a page with this url and attach to it, if found. Can have * wildcards.", - "type": "string", - "default": "" + "type": "string" }, "useWebView": { + "default": { + "pipeName": "MyPipeName" + }, "description": "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\"", - "type": "object", "properties": { "pipeName": { "type": "string" } }, - "default": { - "pipeName": "MyPipeName" - } + "type": "object" }, "vueComponentPaths": { - "description": "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.", - "type": "array", "default": [ "${ZED_WORKTREE_ROOT}/**/*.vue" - ] + ], + "description": "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.", + "type": "array" }, "webRoot": { - "description": "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 \"/\"", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "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 \"/\"", "tags": [ "setup" - ] + ], + "type": "string" } } } @@ -10472,128 +10472,128 @@ "then": { "properties": { "address": { + "default": "localhost", "description": "When debugging webviews, the IP address or hostname the webview is listening on. Will be automatically discovered if not set.", - "type": "string", - "default": "localhost" + "type": "string" }, "browserLaunchLocation": { - "description": "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": null, + "description": "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.", "oneOf": [ { "type": "null" }, { - "type": "string", "enum": [ "ui", "workspace" - ] + ], + "type": "string" } ] }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "cleanUp": { - "description": "What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.", - "type": "string", "default": "wholeBrowser", + "description": "What clean-up to do after the debugging session finishes. Close only the tab being debug, vs. close the whole browser.", "enum": [ "wholeBrowser", "onlyTab" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { + "default": null, "description": "Optional working directory for the runtime executable.", - "type": "string", - "default": null + "type": "string" }, "disableNetworkCache": { + "default": true, "description": "Controls whether to skip the network cache for each request", - "type": "boolean", - "default": true + "type": "boolean" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { + "default": {}, "description": "Optional dictionary of environment key/value pairs for the browser.", - "type": "object", - "default": {} + "type": "object" }, "file": { - "description": "A local html file to open in the browser", - "type": "string", "default": "${ZED_WORKTREE_ROOT}/index.html", + "description": "A local html file to open in the browser", "tags": [ "setup" - ] + ], + "type": "string" }, "includeDefaultArgs": { + "default": true, "description": "Whether default browser launch arguments (to disable features that may make debugging harder) will be included in the launch.", - "type": "boolean", - "default": true + "type": "boolean" }, "includeLaunchArgs": { + "default": true, "description": "Advanced: whether any default launch/debugging arguments are set on the browser. The debugger will assume the browser will use pipe debugging such as that which is provided with `--remote-debugging-pipe`.", - "type": "boolean", - "default": true + "type": "boolean" }, "inspectUri": { + "default": null, "description": "Format to use to rewrite the inspectUri: It's a template string that interpolates keys in `{curlyBraces}`. Available keys are:\n - `url.*` is the parsed address of the running application. For instance, `{url.port}`, `{url.hostname}`\n - `port` is the debug port that Chrome is listening on.\n - `browserInspectUri` is the inspector URI on the launched browser\n - `browserInspectUriPath` is the path part of the inspector URI on the launched browser (e.g.: \"/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2\").\n - `wsProtocol` is the hinted websocket protocol. This is set to `wss` if the original URL is `https`, or `ws` otherwise.\n", "type": [ "string", "null" - ], - "default": null + ] }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how browser processes are killed when stopping the session with `cleanUp: wholeBrowser`. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how browser processes are killed when stopping the session with `cleanUp: wholeBrowser`. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -10605,113 +10605,115 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pathMapping": { + "default": {}, "description": "A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk", - "type": "object", - "default": {} + "type": "object" }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "perScriptSourcemaps": { - "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", - "type": "string", "default": "auto", + "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", "enum": [ "yes", "no", "auto" - ] + ], + "type": "string" }, "port": { + "default": 9229, "description": "When debugging webviews, the port the webview debugger is listening on. Will be automatically discovered if not set.", - "type": "number", - "default": 9229 + "type": "number" }, "profileStartup": { + "default": true, "description": "If true, will start profiling soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "resolveSourceMapLocations": { + "default": null, "description": "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.", + "items": { + "type": "string" + }, "type": [ "array", "null" - ], - "default": null, - "items": { - "type": "string" - } + ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" - } + }, + "type": "array" }, "runtimeExecutable": { + "default": "stable", "description": "Either 'canary', 'stable', 'dev', 'custom' or path to the browser executable. Custom means a custom wrapper, custom build or EDGE_PATH environment variable.", "type": [ "string", "null" - ], - "default": "stable" + ] }, "server": { "oneOf": [ { + "additionalProperties": false, + "default": { + "program": "node my-server.js" + }, "description": "Configures a web server to start up. Takes the same configuration as the 'node' launch task.", - "type": "object", "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -10721,37 +10723,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -10762,61 +10764,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -10828,212 +10831,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -11047,43 +11050,43 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "node my-server.js" - } + "type": "object" }, { + "additionalProperties": false, + "default": { + "program": "npm start" + }, "description": "JavaScript Debug Terminal", - "type": "object", "properties": { "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "command": { + "default": "npm start", "description": "Command to run in the launched terminal. If not provided, the terminal will open without launching a program.", + "tags": [ + "setup" + ], "type": [ "string", "null" - ], - "default": "npm start", - "tags": [ - "setup" ] }, "customDescriptionGenerator": { @@ -11091,31 +11094,30 @@ "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "docDefault": "localRoot || ${ZED_WORKTREE_ROOT}", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -11126,41 +11128,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -11172,143 +11175,143 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -11322,121 +11325,118 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "npm start" - } + "type": "object" } ] }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -11450,50 +11450,50 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, "url": { - "description": "Will search for a tab with this exact url and attach to it, if found", - "type": "string", "default": "http://localhost:8080", + "description": "Will search for a tab with this exact url and attach to it, if found", "tags": [ "setup" - ] + ], + "type": "string" }, "urlFilter": { + "default": "", "description": "Will search for a page with this url and attach to it, if found. Can have * wildcards.", - "type": "string", - "default": "" + "type": "string" }, "useWebView": { + "default": false, "description": "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.", - "type": "boolean", - "default": false + "type": "boolean" }, "userDataDir": { + "default": true, "description": "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`.", "type": [ "string", "boolean" - ], - "default": true + ] }, "vueComponentPaths": { - "description": "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.", - "type": "array", "default": [ "${ZED_WORKTREE_ROOT}/**/*.vue" - ] + ], + "description": "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.", + "type": "array" }, "webRoot": { - "description": "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 \"/\"", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "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 \"/\"", "tags": [ "setup" - ] + ], + "type": "string" } } } @@ -11516,81 +11516,81 @@ "then": { "properties": { "address": { + "default": "localhost", "description": "IP address or hostname the debugged browser is listening on.", - "type": "string", - "default": "localhost" + "type": "string" }, "browserAttachLocation": { - "description": "Forces the browser to attach in one location. In a remote workspace (through ssh or WSL, for example) this can be used to attach to a browser on the remote machine rather than locally.", "default": null, + "description": "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.", "oneOf": [ { "type": "null" }, { - "type": "string", "enum": [ "ui", "workspace" - ] + ], + "type": "string" } ] }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "disableNetworkCache": { + "default": true, "description": "Controls whether to skip the network cache for each request", - "type": "boolean", - "default": true + "type": "boolean" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "inspectUri": { + "default": null, "description": "Format to use to rewrite the inspectUri: It's a template string that interpolates keys in `{curlyBraces}`. Available keys are:\n - `url.*` is the parsed address of the running application. For instance, `{url.port}`, `{url.hostname}`\n - `port` is the debug port that Chrome is listening on.\n - `browserInspectUri` is the inspector URI on the launched browser\n - `browserInspectUriPath` is the path part of the inspector URI on the launched browser (e.g.: \"/devtools/browser/e9ec0098-306e-472a-8133-5e42488929c2\").\n - `wsProtocol` is the hinted websocket protocol. This is set to `wss` if the original URL is `https`, or `ws` otherwise.\n", "type": [ "string", "null" - ], - "default": null + ] }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -11602,35 +11602,35 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pathMapping": { + "default": {}, "description": "A mapping of URLs/paths to local folders, to resolve scripts in the Browser to scripts on disk", - "type": "object", - "default": {} + "type": "object" }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "perScriptSourcemaps": { - "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", - "type": "string", "default": "auto", + "description": "Whether scripts are loaded individually with unique sourcemaps containing the basename of the source file. This can be set to optimize sourcemap handling when dealing with lots of small scripts. If set to \"auto\", we'll detect known cases where this is appropriate.", "enum": [ "yes", "no", "auto" - ] + ], + "type": "string" }, "port": { - "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "default": 9229, + "description": "Port to use to remote debugging the browser, given as `--remote-debugging-port` when launching the browser.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ], "tags": [ @@ -11638,72 +11638,74 @@ ] }, "resolveSourceMapLocations": { + "default": null, "description": "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.", + "items": { + "type": "string" + }, "type": [ "array", "null" - ], - "default": null, - "items": { - "type": "string" - } + ] }, "restart": { - "type": "boolean", "default": false, - "markdownDescription": "Whether to reconnect if the browser connection is closed" + "markdownDescription": "Whether to reconnect if the browser connection is closed", + "type": "boolean" }, "server": { "oneOf": [ { + "additionalProperties": false, + "default": { + "program": "node my-server.js" + }, "description": "Configures a web server to start up. Takes the same configuration as the 'node' launch task.", - "type": "object", "properties": { "args": { - "description": "Command line arguments passed to the program.\n\nCan 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.", - "type": [ - "array", - "string" - ], "default": [], + "description": "Command line arguments passed to the program.\n\nCan 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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array", + "string" ] }, "attachSimplePort": { - "description": "If set, attaches to the process via the given port. This is generally no longer necessary for Node.js programs and loses the ability to debug child processes, but can be useful in more esoteric scenarios such as with Deno and Docker launches. If set to 0, a random port will be chosen and --inspect-brk added to the launch arguments automatically.", "default": 9229, + "description": "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.", "oneOf": [ { "type": "integer" }, { - "type": "string", - "pattern": "^\\${.*}$" + "pattern": "^\\${.*}$", + "type": "string" } ] }, "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "console": { - "description": "Where to launch the debug target.", - "type": "string", "default": "internalConsole", + "description": "Where to launch the debug target.", "enum": [ "internalConsole", "integratedTerminal", @@ -11713,37 +11715,37 @@ "VS Code Debug Console (which doesn't support to read input from a program)", "VS Code's integrated terminal", "External terminal that can be configured via user settings" - ] + ], + "type": "string" }, "customDescriptionGenerator": { "description": "Customize the textual description the debugger shows for objects (local variables, etc...). Samples:\n 1. this.toString() // will call toString to print all objects\n 2. this.customDescription ? this.customDescription() : defaultValue // Use customDescription method if available, if not return defaultValue\n 3. function (def) { return this.customDescription ? this.customDescription() : def } // Use customDescription method if available, if not return defaultValue\n ", "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -11754,61 +11756,62 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "experimentalNetworking": { - "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", - "type": "string", "default": "auto", + "description": "Enable experimental inspection in Node.js. When set to `auto` this is enabled for versions of Node.js that support it. It can be set to `on` or `off` to enable or disable it explicitly.", "enum": [ "auto", "on", "off" - ] + ], + "type": "string" }, "killBehavior": { - "type": "string", "default": "forceful", "enum": [ "forceful", "polite", "none" ], - "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen." + "markdownDescription": "Configures how debug processes are killed when stopping the session. Can be:\n\n- forceful (default): forcefully tears down the process tree. Sends SIGKILL on posix, or `taskkill.exe /F` on Windows.\n- 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.\n- none: no termination will happen.", + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -11820,212 +11823,212 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "profileStartup": { + "default": true, "description": "If true, will start profiling as soon as the process launches", - "type": "boolean", - "default": true + "type": "boolean" }, "program": { - "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", - "type": "string", "default": "", + "description": "Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.", "tags": [ "setup" - ] + ], + "type": "string" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "restart": { - "description": "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": true, + "description": "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.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "delay": { - "type": "number", "default": 1000, - "minimum": 0 + "minimum": 0, + "type": "number" }, "maxAttempts": { - "type": "number", "default": 10, - "minimum": 0 + "minimum": 0, + "type": "number" } - } + }, + "type": "object" } ] }, "runtimeArgs": { - "description": "Optional arguments passed to the runtime executable.", - "type": "array", "default": [], + "description": "Optional arguments passed to the runtime executable.", "items": { "type": "string" }, "tags": [ "setup" - ] + ], + "type": "array" }, "runtimeExecutable": { + "default": "node", + "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed.", "type": [ "string", "null" - ], - "default": "node", - "markdownDescription": "Runtime to use. Either an absolute path or the name of a runtime available on the PATH. If omitted `node` is assumed." + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "runtimeVersion": { - "type": "string", "default": "default", - "markdownDescription": "Version of `node` runtime to use. Requires `nvm`." + "markdownDescription": "Version of `node` runtime to use. Requires `nvm`.", + "type": "string" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "stopOnEntry": { + "default": true, "description": "Automatically stop program after launch.", "type": [ "boolean", "string" - ], - "default": true + ] }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -12039,43 +12042,43 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "node my-server.js" - } + "type": "object" }, { + "additionalProperties": false, + "default": { + "program": "npm start" + }, "description": "JavaScript Debug Terminal", - "type": "object", "properties": { "autoAttachChildProcesses": { + "default": true, "description": "Attach debugger to new child processes automatically.", - "type": "boolean", - "default": true + "type": "boolean" }, "cascadeTerminateToConfigurations": { - "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", - "type": "array", "default": [], + "description": "A list of debug sessions which, when this debug session is terminated, will also be stopped.", "items": { "type": "string", "uniqueItems": true - } + }, + "type": "array" }, "command": { + "default": "npm start", "description": "Command to run in the launched terminal. If not provided, the terminal will open without launching a program.", + "tags": [ + "setup" + ], "type": [ "string", "null" - ], - "default": "npm start", - "tags": [ - "setup" ] }, "customDescriptionGenerator": { @@ -12083,31 +12086,30 @@ "type": "string" }, "customPropertiesGenerator": { + "deprecated": true, "description": "Customize the properties shown for an object in the debugger (local variables, etc...). Samples:\n 1. { ...this, extraProperty: '12345' } // Add an extraProperty 12345 to all objects\n 2. this.customProperties ? this.customProperties() : this // Use customProperties method if available, if not use the properties in this (the default properties)\n 3. function () { return this.customProperties ? this.customProperties() : this } // Use customDescription method if available, if not return the default properties\n\n 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", - "type": "string", - "deprecated": true + "type": "string" }, "cwd": { - "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "Absolute path to the working directory of the program being debugged. If you've set localRoot then cwd will match that value otherwise it falls back to your workspaceFolder", "docDefault": "localRoot || ${ZED_WORKTREE_ROOT}", "tags": [ "setup" - ] + ], + "type": "string" }, "enableContentValidation": { + "default": true, "description": "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.", - "type": "boolean", - "default": true + "type": "boolean" }, "enableDWARF": { - "type": "boolean", "default": true, - "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function." + "markdownDescription": "Toggles whether the debugger will try to read DWARF debug symbols from WebAssembly, which can be resource intensive. Requires the `ms-vscode.wasm-dwarf-debugging` extension to function.", + "type": "boolean" }, "env": { - "type": "object", "additionalProperties": { "type": [ "string", @@ -12118,41 +12120,42 @@ "markdownDescription": "Environment variables passed to the program. The value `null` removes the variable from the environment.", "tags": [ "setup" - ] + ], + "type": "object" }, "envFile": { + "default": "${ZED_WORKTREE_ROOT}/.env", "description": "Absolute path to a file containing environment variable definitions.", - "type": "string", - "default": "${ZED_WORKTREE_ROOT}/.env" + "type": "string" }, "localRoot": { + "default": null, "description": "Path to the local directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "nodeVersionHint": { - "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", - "type": "number", "default": 12, - "minimum": 8 + "description": "Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not work.", + "minimum": 8, + "type": "number" }, "outFiles": { - "description": "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.", - "type": [ - "array" - ], "default": [ "${ZED_WORKTREE_ROOT}/**/*.(m|c|)js", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" }, "tags": [ "setup" + ], + "type": [ + "array" ] }, "outputCapture": { @@ -12164,143 +12167,143 @@ "markdownDescription": "From where to capture output messages: the default debug API if set to `console`, or stdout/stderr streams if set to `std`." }, "pauseForSourceMap": { - "type": "boolean", "default": false, - "markdownDescription": "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." + "markdownDescription": "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.", + "type": "boolean" }, "remoteRoot": { + "default": null, "description": "Absolute path to the remote directory containing the program.", "type": [ "string", "null" - ], - "default": null + ] }, "resolveSourceMapLocations": { - "description": "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.", - "type": [ - "array", - "null" - ], "default": [ "${ZED_WORKTREE_ROOT}/**", "!**/node_modules/**" ], + "description": "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.", "items": { "type": "string" - } + }, + "type": [ + "array", + "null" + ] }, "runtimeSourcemapPausePatterns": { - "type": "array", "default": [], "items": { "type": "string" }, - "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492)." + "markdownDescription": "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](https://github.com/microsoft/vscode-js-debug/issues/492).", + "type": "array" }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -12314,130 +12317,127 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] } }, - "additionalProperties": false, - "default": { - "program": "npm start" - } + "type": "object" } ] }, "showAsyncStacks": { - "description": "Show the async calls that led to the current call stack.", "default": true, + "description": "Show the async calls that led to the current call stack.", "oneOf": [ { "type": "boolean" }, { - "type": "object", "properties": { "onAttach": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onAttach" - ] + ], + "type": "object" }, { - "type": "object", "properties": { "onceBreakpointResolved": { - "type": "number", - "default": 32 + "default": 32, + "type": "number" } }, "required": [ "onceBreakpointResolved" - ] + ], + "type": "object" } ] }, "skipFiles": { - "description": "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/**\"]`", - "type": "array", "default": [ "${/**" - ] + ], + "description": "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/**\"]`", + "type": "array" }, "smartStep": { + "default": true, "description": "Automatically step through generated code that cannot be mapped back to the original source.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMapPathOverrides": { - "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", - "type": "object", "default": { "meteor://💻app/*": "${ZED_WORKTREE_ROOT}/*", "webpack:///./~/*": "${ZED_WORKTREE_ROOT}/node_modules/*", "webpack://?:*/*": "${ZED_WORKTREE_ROOT}/*" - } + }, + "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on disk.", + "type": "object" }, "sourceMapRenames": { + "default": true, "description": "Whether to use the \"names\" mapping in sourcemaps. This requires requesting source content, which can be slow with certain debuggers.", - "type": "boolean", - "default": true + "type": "boolean" }, "sourceMaps": { + "default": true, "description": "Use JavaScript source maps (if they exist).", - "type": "boolean", - "default": true + "type": "boolean" }, "targetSelection": { - "type": "string", "default": "automatic", "enum": [ "pick", "automatic" ], - "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\")." + "markdownDescription": "Whether to attach to all targets that match the URL filter (\"automatic\") or ask to pick one (\"pick\").", + "type": "string" }, "timeout": { + "default": 10000, "description": "Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.", - "type": "number", - "default": 10000 + "type": "number" }, "timeouts": { + "additionalProperties": false, + "default": {}, "description": "Timeouts for several debugger operations.", - "type": "object", + "markdownDescription": "Timeouts for several debugger operations.", "properties": { "hoverEvaluation": { + "default": 500, "description": "Time until value evaluation for hovered symbols is aborted. If set to 0, hover evaluation does never time out.", - "type": "number", - "default": 500 + "type": "number" }, "sourceMapCumulativePause": { + "default": 1000, "description": "Extra time in milliseconds allowed per session to be spent waiting for source-maps to be processed, after the minimum time (sourceMapMinPause) has been exhausted", - "type": "number", - "default": 1000 + "type": "number" }, "sourceMapMinPause": { + "default": 1000, "description": "Minimum time in milliseconds spent waiting for each source-map to be processed when a script is being parsed", - "type": "number", - "default": 1000 + "type": "number" } }, - "additionalProperties": false, - "default": {}, - "markdownDescription": "Timeouts for several debugger operations." + "type": "object" }, "trace": { - "description": "Configures what diagnostic output is produced.", "default": true, + "description": "Configures what diagnostic output is produced.", "oneOf": [ { "description": "Trace may be set to 'true' to write diagnostic logs to the disk.", "type": "boolean" }, { - "type": "object", + "additionalProperties": false, "properties": { "logFile": { "description": "Configures where on disk logs are written.", @@ -12451,49 +12451,49 @@ "type": "boolean" } }, - "additionalProperties": false + "type": "object" } ] }, "url": { - "description": "Will search for a tab with this exact url and attach to it, if found", - "type": "string", "default": "http://localhost:8080", + "description": "Will search for a tab with this exact url and attach to it, if found", "tags": [ "setup" - ] + ], + "type": "string" }, "urlFilter": { + "default": "", "description": "Will search for a page with this url and attach to it, if found. Can have * wildcards.", - "type": "string", - "default": "" + "type": "string" }, "useWebView": { + "default": { + "pipeName": "MyPipeName" + }, "description": "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\"", - "type": "object", "properties": { "pipeName": { "type": "string" } }, - "default": { - "pipeName": "MyPipeName" - } + "type": "object" }, "vueComponentPaths": { - "description": "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.", - "type": "array", "default": [ "${ZED_WORKTREE_ROOT}/**/*.vue" - ] + ], + "description": "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.", + "type": "array" }, "webRoot": { - "description": "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 \"/\"", - "type": "string", "default": "${ZED_WORKTREE_ROOT}", + "description": "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 \"/\"", "tags": [ "setup" - ] + ], + "type": "string" } } } diff --git a/crates/dap_adapters/src/dap_adapters.rs b/crates/dap_adapters/src/dap_adapters.rs index 3a7de1557700f9dca841fd6e21672562f03c021a..3f7c0e8088767b00534a4ce7f2e437c9fb67d818 100644 --- a/crates/dap_adapters/src/dap_adapters.rs +++ b/crates/dap_adapters/src/dap_adapters.rs @@ -49,6 +49,16 @@ struct UpdateSchemasDapDelegate { fs: std::sync::Arc, } +#[cfg(feature = "update-schemas")] +impl UpdateSchemasDapDelegate { + fn new(executor: gpui::BackgroundExecutor) -> Self { + // FIXME + let client = Arc::new(reqwest_client::ReqwestClient::user_agent("Cole").unwrap()); + let fs = Arc::new(fs::RealFs::new(None, executor.clone())); + Self { client, fs } + } +} + #[cfg(feature = "update-schemas")] #[async_trait] impl dap::adapters::DapDelegate for UpdateSchemasDapDelegate { diff --git a/crates/dap_adapters/src/javascript.rs b/crates/dap_adapters/src/javascript.rs index 03d5c0f87f45178a1ab5dd9531374f02384d8cc2..1cd180b713567a179de7f0646ea4a65428533b8a 100644 --- a/crates/dap_adapters/src/javascript.rs +++ b/crates/dap_adapters/src/javascript.rs @@ -1,8 +1,9 @@ use adapters::latest_github_release; use anyhow::Context as _; use dap::{StartDebuggingRequestArguments, adapters::DebugTaskDefinition}; -use fs::{Fs, RealFs}; -use gpui::{AsyncApp, background_executor}; +use fs::Fs; +use gpui::{AsyncApp, BackgroundExecutor}; +use serde::{Deserialize, Serialize}; use serde_json::Value; use std::{ borrow::Cow, @@ -10,7 +11,8 @@ use std::{ path::{Path, PathBuf}, sync::{LazyLock, OnceLock}, }; -use task::DebugRequest; +use task::{DebugRequest, EnvVariableReplacer, VariableName}; +use tempfile::TempDir; use util::{ResultExt, maybe}; use crate::*; @@ -276,18 +278,44 @@ impl DebugAdapter for JsDebugAdapter { } } +#[cfg(feature = "update-schemas")] impl JsDebugAdapter { - pub fn fetch_schema(dir: &Path) -> anyhow::Result<(String, String)> { - let executor = background_executor(); - // FIXME - let client = Arc::new(reqwest_client::ReqwestClient::user_agent("Cole").unwrap()); - let fs = Arc::new(RealFs::new(None, executor.clone())); - let delegate = UpdateSchemasDapDelegate { - client: client.clone(), - fs: fs.clone(), - }; + pub fn get_schema( + temp_dir: &TempDir, + output_dir: &Path, + executor: BackgroundExecutor, + ) -> anyhow::Result<()> { + #[derive(Serialize, Deserialize)] + struct PackageJsonConfigurationAttributes { + #[serde(default, skip_serializing_if = "Option::is_none")] + launch: Option, + #[serde(default, skip_serializing_if = "Option::is_none")] + attach: Option, + } + + #[derive(Serialize, Deserialize)] + #[serde(rename_all = "camelCase")] + struct PackageJsonDebugger { + r#type: String, + configuration_attributes: PackageJsonConfigurationAttributes, + } - executor.block(async move { + #[derive(Serialize, Deserialize)] + struct PackageJsonContributes { + debuggers: Vec, + } + + #[derive(Serialize, Deserialize)] + struct PackageJson { + contributes: PackageJsonContributes, + } + + let temp_dir = std::fs::canonicalize(temp_dir.path())?; + let delegate = UpdateSchemasDapDelegate::new(executor.clone()); + let fs = delegate.fs.clone(); + let client = delegate.client.clone(); + + let (package_json, package_nls_json) = executor.block(async move { let release = latest_github_release( &format!("microsoft/{}", Self::ADAPTER_NPM_NAME), true, @@ -296,7 +324,10 @@ impl JsDebugAdapter { ) .await?; - let version = release.tag_name.strip_prefix("v").unwrap(); + let version = release + .tag_name + .strip_prefix("v") + .context("parse version")?; let asset_name = format!("ms-vscode.js-debug.{version}.vsix",); let version = AdapterVersion { tag_name: release.tag_name, @@ -313,18 +344,132 @@ impl JsDebugAdapter { DebugAdapterName(Self::ADAPTER_NAME.into()), version, adapters::DownloadedFileType::Vsix, - dir, + &temp_dir, &delegate, ) .await?; - let package_json_content = fs + let package_json = fs .load(&path.join("extension").join("package.json")) .await?; - let package_nls_json_content = fs + let package_nls_json = fs .load(&path.join("extension").join("package.nls.json")) .await?; - Ok((package_json_content, package_nls_json_content)) - }) + anyhow::Ok((package_json, package_nls_json)) + })?; + + let package_nls_json = + serde_json::from_str::>(&package_nls_json)? + .into_iter() + .filter_map(|(k, v)| { + let v = v.as_str()?; + Some((k, v.to_owned())) + }) + .collect(); + + let package_json: serde_json::Value = serde_json::from_str(&package_json)?; + + struct Replacer { + package_nls_json: HashMap, + env: EnvVariableReplacer, + } + + impl Replacer { + fn replace(&self, input: serde_json::Value) -> serde_json::Value { + match input { + serde_json::Value::String(s) => { + if s.starts_with("%") && s.ends_with("%") { + self.package_nls_json + .get(s.trim_matches('%')) + .map(|s| s.as_str().into()) + .unwrap_or("(missing)".into()) + } else { + self.env.replace(&s).into() + } + } + serde_json::Value::Array(arr) => { + serde_json::Value::Array(arr.into_iter().map(|v| self.replace(v)).collect()) + } + serde_json::Value::Object(obj) => serde_json::Value::Object( + obj.into_iter().map(|(k, v)| (k, self.replace(v))).collect(), + ), + _ => input, + } + } + } + + let env = EnvVariableReplacer::new(HashMap::from_iter([( + "workspaceFolder".to_owned(), + VariableName::WorktreeRoot.to_string(), + )])); + let replacer = Replacer { + env, + package_nls_json, + }; + let package_json = replacer.replace(package_json); + + let package_json: PackageJson = serde_json::from_value(package_json)?; + + let types = package_json + .contributes + .debuggers + .iter() + .map(|debugger| debugger.r#type.clone()) + .collect::>(); + let mut conjuncts = package_json + .contributes + .debuggers + .into_iter() + .flat_map(|debugger| { + let r#type = debugger.r#type; + let configuration_attributes = debugger.configuration_attributes; + configuration_attributes + .launch + .map(|schema| ("launch", schema)) + .into_iter() + .chain( + configuration_attributes + .attach + .map(|schema| ("attach", schema)), + ) + .map(|(request, schema)| { + json!({ + "if": { + "properties": { + "type": { + "const": r#type + }, + "request": { + "const": request + } + }, + "required": ["type", "request"] + }, + "then": schema + }) + }) + .collect::>() + }) + .collect::>(); + conjuncts.push(json!({ + "properties": { + "type": { + "enum": types + } + }, + "required": ["type"] + })); + let schema = json!({ + "allOf": conjuncts + }); + + // FIXME figure out what to do about formatting + let mut schema = serde_json::to_string_pretty(&schema)?; + schema.push('\n'); + std::fs::write( + output_dir.join(Self::ADAPTER_NAME).with_extension("json"), + schema, + )?; + Ok(()) } } diff --git a/crates/dap_adapters/src/update_schemas.rs b/crates/dap_adapters/src/update_schemas.rs index 949825706a0cf61c8d6d26c26034868d1d206cf1..597ff8957603068976c001bc3fc46bfa6f14bc0b 100644 --- a/crates/dap_adapters/src/update_schemas.rs +++ b/crates/dap_adapters/src/update_schemas.rs @@ -1,154 +1,13 @@ -use collections::HashMap; +use std::path::Path; + use dap_adapters::JsDebugAdapter; -use schemars::{Schema, json_schema}; -use serde::{Deserialize, Serialize}; -use task::{EnvVariableReplacer, VariableName}; +use gpui::background_executor; use tempfile::TempDir; -fn main() { - #[derive(Serialize, Deserialize)] - struct PackageJsonConfigurationAttributes { - #[serde(default, skip_serializing_if = "Option::is_none")] - launch: Option, - #[serde(default, skip_serializing_if = "Option::is_none")] - attach: Option, - } - - #[derive(Serialize, Deserialize)] - #[serde(rename_all = "camelCase")] - struct PackageJsonDebugger { - r#type: String, - configuration_attributes: PackageJsonConfigurationAttributes, - } - - #[derive(Serialize, Deserialize)] - struct PackageJsonContributes { - debuggers: Vec, - } - - #[derive(Serialize, Deserialize)] - struct PackageJson { - contributes: PackageJsonContributes, - } - - let dir = TempDir::new().unwrap(); - let path = std::fs::canonicalize(dir.path()).unwrap(); - let (package_json, package_nls_json) = - dap_adapters::JsDebugAdapter::fetch_schema(&path).unwrap(); - let package_nls_json = - serde_json::from_str::>(&package_nls_json) - .unwrap() - .into_iter() - .filter_map(|(k, v)| { - let v = v.as_str()?; - Some((k, v.to_owned())) - }) - .collect::>(); - - let package_json: serde_json::Value = serde_json::from_str(&package_json).unwrap(); - - struct Replacer { - package_nls_json: HashMap, - env: EnvVariableReplacer, - } - - impl Replacer { - fn replace(&self, input: serde_json::Value) -> serde_json::Value { - match input { - serde_json::Value::String(s) => { - if s.starts_with("%") && s.ends_with("%") { - self.package_nls_json - .get(s.trim_matches('%')) - .map(|s| s.as_str().into()) - .unwrap_or("(missing)".into()) - } else { - self.env.replace(&s).into() - } - } - serde_json::Value::Array(arr) => { - serde_json::Value::Array(arr.into_iter().map(|v| self.replace(v)).collect()) - } - serde_json::Value::Object(obj) => serde_json::Value::Object( - obj.into_iter().map(|(k, v)| (k, self.replace(v))).collect(), - ), - _ => input, - } - } - } - - let env = EnvVariableReplacer::new(HashMap::from_iter([( - "workspaceFolder".to_owned(), - VariableName::WorktreeRoot.to_string(), - )])); - let replacer = Replacer { - env, - package_nls_json, - }; - let package_json = replacer.replace(package_json); - - let package_json: PackageJson = serde_json::from_value(package_json).unwrap(); - - let types = package_json - .contributes - .debuggers - .iter() - .map(|debugger| debugger.r#type.clone()) - .collect::>(); - let mut conjuncts = package_json - .contributes - .debuggers - .into_iter() - .flat_map(|debugger| { - let r#type = debugger.r#type; - let configuration_attributes = debugger.configuration_attributes; - configuration_attributes - .launch - .map(|schema| ("launch", schema)) - .into_iter() - .chain( - configuration_attributes - .attach - .map(|schema| ("attach", schema)), - ) - .map(|(request, schema)| { - json_schema!({ - "if": { - "properties": { - "type": { - "const": r#type - }, - "request": { - "const": request - } - }, - "required": ["type", "request"] - }, - "then": schema - }) - }) - .collect::>() - }) - .collect::>(); - conjuncts.push(json_schema!({ - "properties": { - "type": { - "enum": types - } - }, - "required": ["type"] - })); - let schema = json_schema!({ - "allOf": conjuncts - }); - - let mut schema = serde_json::to_string_pretty(&schema.to_value()).unwrap(); - schema.push('\n'); - std::fs::write( - format!( - "crates/dap_adapters/schemas/{}.json", - JsDebugAdapter::ADAPTER_NAME - ), - schema, - ) - .unwrap(); +fn main() -> anyhow::Result<()> { + let temp_dir = TempDir::new()?; + let output_dir = Path::new("crates/dap_adapters/schemas"); + let executor = background_executor(); + JsDebugAdapter::get_schema(&temp_dir, output_dir, executor.clone())?; + Ok(()) }