Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
#257 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
30/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
typescript, vscode
Área
documentation

Línea de trabajo

Lee la implementación de LoggingDebugSession y el uso relacionado de mockDebug.ts, y compáralos con el comentario sobre InternalDebugger y con logger.ts de la extensión de TypeScript. Documenta dónde se guarda el archivo predeterminado, qué contiene, cuándo y por qué se debe usar la logging API, y cómo se relaciona con la salida de la consola y OutputChannel; el issue estará terminado cuando estas preguntas tengan respuestas claras.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
TypeScript
Estrellas
306
Forks
90
Merge medio
8 h 36 min
PR fusionados (30 d)
3

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de microsoft/vscode-debugadapter-node

Todos los issues de microsoft/vscode-debugadapter-node

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.