Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
#257 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
30/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
typescript, vscode
領域
documentation

調査の方向性

LoggingDebugSession の実装と、関連する mockDebug.ts の使用箇所を読み、InternalDebugger のコメントおよび TypeScript 拡張機能の logger.ts と比較してください。デフォルトファイルがどこに作成されるか、何が含まれるか、いつ、なぜ logging API を使用するのか、またコンソール出力および OutputChannel とどのような関係があるのかを文書化してください。これらの質問に明確な答えが得られれば、issue は完了です。

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
TypeScript
スター
306
フォーク
90
平均マージ
8時間 36分
マージ済み PR(30日)
3

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

microsoft/vscode-debugadapter-node のほかの issue

microsoft/vscode-debugadapter-node の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。