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

Where is the Documentation for Repo-Specific Features (e.g. LoggingDebugSession)? #257

Open
ericdrobinson opened this issue Jan 19, 2022 · 0 comments

Comments

@ericdrobinson
Copy link

I've been trying to figure out what the "LoggingDebugSession" is for and how it is expected to be used. The best I've been able to muster is that the vscode-mock-debug implementation uses it, setting a default text file as the output location. But...

  • Where does that file end up?
  • What is it expected to contain?
  • When would I want to use it?
  • Why would I want to use it?
  • If I'm looking for Logging features, why would I use this over built-ins like console.log/warn/error and the OutputChannel?
  • How is this different from something like the TypeScript extension's Logger class?
  • Why isn't this integrated into VSCode's Output Channel system?*

This list sort of goes on... I'm only personally aware of this because an extension I'm working on was originally based off of the Mock Debug project - as far as I can tell, nothing was ever done with the logging functionality of the LoggingDebugSession, which makes me wonder why it's the default (and has no discernible documentation)?

Have I missed something crucial here?


* The comment for the InternalDebugger class:

Manages logging, whether to console.log, file, or VS Code console.

seems to indicate ("VS Code console") that there was at some point intention to integrate this with OutputChannel but it maybe just never happened? Or does "VS Code console" simply refer to the DevTools console (which is, as far as I'm aware, the same as console.log...)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant