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.

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

Finalize "simpleUI" debug option #147264

Closed
Tracked by #149861
roblourens opened this issue Apr 11, 2022 · 8 comments · Fixed by #163316
Closed
Tracked by #149861

Finalize "simpleUI" debug option #147264

roblourens opened this issue Apr 11, 2022 · 8 comments · Fixed by #163316
Assignees
Labels
api api-finalization debug Debug viewlet, configurations, breakpoints, adapter issues insiders-released Patch has been released in VS Code Insiders
Milestone

Comments

@roblourens
Copy link
Member

Added in #128588

	export interface DebugSessionOptions {

		debugUI?: {
			/**
			 * When true, the debug toolbar will not be shown for this session, the window statusbar color will not be changed, and the debug viewlet will not be automatically revealed.
			 */
			simple?: boolean;
		};

Allows to start a debug session which has the debug UI hidden by default. Used for jupyter's Run By Line, and could be useful for other extensions starting atypical-style debug experiences.

@roblourens roblourens added api debug Debug viewlet, configurations, breakpoints, adapter issues api-finalization labels Apr 11, 2022
@roblourens roblourens added this to the Backlog milestone Apr 11, 2022
@roblourens roblourens self-assigned this Apr 11, 2022
@mjbvz
Copy link
Collaborator

mjbvz commented May 24, 2022

Anything holding back this from finalization @roblourens?

@roblourens
Copy link
Member Author

No. Could discuss it next month

@roblourens roblourens modified the milestones: Backlog, June 2022 May 25, 2022
@mjbvz mjbvz modified the milestones: June 2022, July 2022 Jun 22, 2022
@mjbvz
Copy link
Collaborator

mjbvz commented Jun 22, 2022

Moving this to July based on discussions from last week

@roblourens
Copy link
Member Author

Last month we discussed breaking this into multiple specific flags. This could look like:

export interface DebugSessionOptions {

	debugUI?: {
		/**
		 * Whether to show the debug toolbar for this debug session. Defaults to true.
		 */
		showDebugToolbar?: boolean;

		/**
		 * Whether the window statusbar color should be changed to indicate an active debug session. Defaults to true.
		 */
		useDebugStatusbarColor?: boolean;

		/**
		 * Whether to prevent the debug viewlet from being automatically revealed.
		 * When false or undefined, this behavior is determined by the setting `debug.openDebug`.
		 */
		suppressOpenDebugView?: boolean;
	};
}

@roblourens
Copy link
Member Author

Today, talked about using flags where false/undefined matches the default:

export interface DebugSessionOptions {

	debugUI?: {
		/**
		 * Whether to hide the debug toolbar for this debug session
		 */
		hideDebugToolbar?: boolean; // Can also use suppressDebugToolbar for consistency

		/**
		 * By default vscode will change the window statusbar color to indicate an active debug session. Set this option to disable this behavior.
		 */
		suppressDebugStatusbarColor?: boolean;

		/**
		 * Whether to prevent the debug viewlet from being automatically revealed.
		 * When false or undefined, this behavior is determined by the setting `debug.openDebug`.
		 */
		suppressOpenDebugView?: boolean;
	};

@jrieken
Copy link
Member

jrieken commented Jul 11, 2022

Maybe inside debugUI into DebugSessionOptions, like the compact property and other?

@roblourens
Copy link
Member Author

The only thing that bugs me is flooding DebugSessionOptions with a bunch of properties that feel sort of different from the others, and probably won't be commonly used... but I don't have a strong opinion about it

@jrieken
Copy link
Member

jrieken commented Jul 19, 2022

suppressDebugToolbar?: boolean;
suppressDebugStatusbar?: boolean;
suppressDebugView?: boolean;

@roblourens roblourens modified the milestones: July 2022, August 2022 Jul 20, 2022
roblourens added a commit that referenced this issue Oct 11, 2022
roblourens added a commit that referenced this issue Oct 12, 2022
* Finalize notebookDebugOptions API
Fix #147264

* Backcompat for the option from vscode-jupyter

* Undo comment

* Fix build
@VSCodeTriageBot VSCodeTriageBot added unreleased Patch has not yet been released in VS Code Insiders and removed unreleased Patch has not yet been released in VS Code Insiders labels Oct 12, 2022
@VSCodeTriageBot VSCodeTriageBot added the insiders-released Patch has been released in VS Code Insiders label Oct 12, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Nov 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api api-finalization debug Debug viewlet, configurations, breakpoints, adapter issues insiders-released Patch has been released in VS Code Insiders
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants