Skip to content

[BUGFIX] Improve debugger message for template-only components #21407

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

Open
olenderhub wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[BUGFIX] Improve debugger message for template-only components #21407

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
527f904
[BUGFIX] Improve debugger message for template-only components
olenderhub May 17, 2026
fff0373
[BUGFIX] Include named argument hint in debugger message for class-ba…
olenderhub May 19, 2026
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
55 changes: 55 additions & 0 deletions packages/@glimmer-workspace/integration-tests/lib/suites/debugger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,61 @@ export class DebuggerSuite extends RenderTest {
this.assertStableNodes();
}

@test({ kind: 'templateOnly' })
'debugger in template-only component logs template-only message'() {
let originalInfo = console.info;
let messages: string[] = [];

console.info = (...args: unknown[]) => {
messages.push(args.join(' '));
};

try {
resetDebuggerCallback();

this.registerComponent('TemplateOnly', 'DebugTest', '{{debugger}}');

this.render('<DebugTest @foo="bar" />', {});

this.assert.deepEqual(messages, [
"Use `get(<path>)` to debug this template. For named arguments, use `get('@argName')`.",
]);
} finally {
console.info = originalInfo;
resetDebuggerCallback();
}
}

@test
'debugger in class-backed component logs context message with named argument hint'() {
let originalInfo = console.info;
let messages: string[] = [];

console.info = (...args: unknown[]) => {
messages.push(args.join(' '));
};

try {
resetDebuggerCallback();

this.registerComponent(
'Glimmer',
'DebugTest',
'{{debugger}}',
class extends GlimmerishComponent {}
);

this.render('<DebugTest @foo="bar" />', {});

this.assert.deepEqual(messages, [
"Use `context`, and `get(<path>)` to debug this template. For named arguments, use `get('@argName')`.",
]);
} finally {
console.info = originalInfo;
resetDebuggerCallback();
}
}

@test
'can get locals'() {
let expectedContext = {
Expand Down
19 changes: 14 additions & 5 deletions packages/@glimmer/runtime/lib/compiled/opcodes/debugger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,20 @@ export type DebugGet = (path: string) => unknown;
export type DebugCallback = (context: unknown, get: DebugGet) => void;

function debugCallback(context: unknown, get: DebugGet): void {
// eslint-disable-next-line no-console
console.info('Use `context`, and `get(<path>)` to debug this template.');

// for example...
context === get('this');
if (context !== null && context !== undefined) {
// eslint-disable-next-line no-console
console.info(
"Use `context`, and `get(<path>)` to debug this template. For named arguments, use `get('@argName')`."
);

// for example...
context === get('this');
} else {
// eslint-disable-next-line no-console
console.info(
"Use `get(<path>)` to debug this template. For named arguments, use `get('@argName')`."
Copy link
Copy Markdown
Contributor

@NullVoxPopuli NullVoxPopuli May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are these instructions also valid for class-backed components?

Copy link
Copy Markdown
Contributor Author

@olenderhub olenderhub May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point - yes, get('@argName') is valid for class-backed components too.

The distinction here is only whether context is available. I updated the class-backed message to include the named-argument hint as well, and added test coverage for that case.

);
}

// eslint-disable-next-line no-debugger
debugger;
Expand Down
Loading