Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added new settings for deferred scope loading and updated telemetry with some missing settings #620

Merged
merged 2 commits into from
Feb 19, 2025
Merged

Added new settings for deferred scope loading and updated telemetry with some missing settings #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6765b4d
Added new settings for defered scope loading and updated telemetry wi…
chrisdp Feb 18, 2025
8e1e60f
Updated roku debug
chrisdp Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/extension-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,11 @@ pkg:/source/main.brs(10:20)
...ce/main.brs(10:20)
```
### `brightscript.debug.enableVariablesPanel`
_(deprecated) Use `deferScopeLoading` instead._

Defaults to `true`. Enables automatic population of the debug variable panel on a breakpoint or runtime errors
### `brightscript.debug.deferScopeLoading`
Defaults to `false`. Will defer the population of the `Local` scope variables until the user expands it in the variables panel.
### `brightscript.debug.autoResolveVirtualVariables` (Experimental)
Defaults to `false`. Enables automatic population of the virtual variables.
### `brightscript.debug.enhanceREPLCompletions`
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 14 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
"postman-request": "^2.88.1-postman.32",
"pretty-bytes": "^5.6.0",
"resolve": "^1.22.8",
"roku-debug": "^0.21.22",
"roku-debug": "^0.21.23",
"roku-deploy": "^3.12.4",
"roku-test-automation": "^2.0.10",
"semver": "^7.1.3",
Expand Down Expand Up @@ -790,8 +790,14 @@
"enableVariablesPanel": {
"type": "boolean",
"description": "Enables automatic population of the debug variable panel on a breakpoint or runtime errors.",
"deprecationMessage": "Use 'deferScopeLoading' instead.",
"default": true
},
"deferScopeLoading": {
"type": "boolean",
"description": "Will defer the population of the 'Local' scope variables until the user expands it in the variables panel.",
"default": false
},
"autoResolveVirtualVariables": {
"type": "boolean",
"description": "(Experimental) Enables automatic population of the virtual variables.",
Expand Down Expand Up @@ -2241,9 +2247,16 @@
"brightscript.debug.enableVariablesPanel": {
"type": "boolean",
"description": "Enables automatic population of the debug variable panel on a breakpoint or runtime errors.",
"deprecationMessage": "Use 'deferScopeLoading' instead.",
"default": true,
"scope": "resource"
},
"brightscript.debug.deferScopeLoading": {
"type": "boolean",
"description": "Will defer the population of the 'Local' scope variables until the user expands it in the variables panel.",
"default": false,
"scope": "resource"
},
"brightscript.debug.autoResolveVirtualVariables": {
"type": "boolean",
"description": "(Experimental) Enables automatic population of the virtual variables.",
Expand Down
1 change: 1 addition & 0 deletions src/DebugConfigurationProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ export class BrightScriptDebugConfigurationProvider implements DebugConfiguratio
disableScreenSaver: true,
retainStagingFolder: false,
enableVariablesPanel: true,
deferScopeLoading: false,
autoResolveVirtualVariables: false,
enhanceREPLCompletions: false,
showHiddenVariables: false,
Expand Down
6 changes: 6 additions & 0 deletions src/managers/TelemetryManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ export class TelemetryManager implements Disposable {

this.reporter.sendTelemetryEvent('startDebugSession', {
enableDebugProtocol: boolToString(initialConfig.enableDebugProtocol),
enableVariablesPanel: boolToString(initialConfig.enableVariablesPanel),
deferScopeLoading: boolToString(initialConfig.deferScopeLoading),
autoResolveVirtualVariables: boolToString(initialConfig.autoResolveVirtualVariables),
enhanceREPLCompletions: boolToString(initialConfig.enhanceREPLCompletions),
rewriteDevicePathsInLogs: boolToString(initialConfig.rewriteDevicePathsInLogs),
showHiddenVariables: boolToString(initialConfig.showHiddenVariables),
debugConnectionType: debugConnectionType?.toString(),
retainDeploymentArchive: boolToString(initialConfig.retainDeploymentArchive),
retainStagingFolder: boolToString(initialConfig.retainStagingFolder),
Expand Down