microsoft / microsoft/vscode-debugadapter-node

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

Open
#257 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
306
Forks
90
Avg merge
8h 36m
Merged PRs (30d)
3

Description

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...)?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the LoggingDebugSession implementation and the linked mockDebug.ts usage, then compare them with the InternalDebugger comment and the TypeScript extension's logger.ts. Document where the default file goes, what it contains, when and why to use the logging API, and how it relates to console output and OutputChannel; the issue is done when these questions have clear answers.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.