microsoft / microsoft/vscode-debugadapter-node
Where is the Documentation for Repo-Specific Features (e.g. LoggingDebugSession)?
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 306
- Fork
- 90
- Merge medio
- 8h 36m
- PR unite (30g)
- 3
Descrizione
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/errorand theOutputChannel? - How is this different from something like the TypeScript extension's
Loggerclass? - 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...)?
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Leggi l'implementazione di LoggingDebugSession e l'uso collegato di mockDebug.ts, quindi confrontali con il commento su InternalDebugger e con logger.ts dell'estensione TypeScript. Documenta dove viene creato il file predefinito, cosa contiene, quando e perché usare la logging API e come si rapporta all'output della console e a OutputChannel; l'issue è completata quando queste domande hanno risposte chiare.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript, vscode
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 30/100