Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
#257 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
30/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
typescript, vscode
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc phần triển khai LoggingDebugSession và cách sử dụng mockDebug.ts liên quan, sau đó so sánh chúng với chú thích về InternalDebugger và logger.ts của extension TypeScript. Ghi lại file mặc định được đặt ở đâu, nó chứa gì, khi nào và vì sao nên sử dụng logging API, cũng như nó liên quan thế nào đến đầu ra console và OutputChannel; issue hoàn tất khi các câu hỏi này có câu trả lời rõ ràng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
TypeScript
Star
306
Fork
90
Merge trung bình
8 giờ 36 phút
Pull request đã merge (30 ngày)
3

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của microsoft/vscode-debugadapter-node

Tất cả issue của microsoft/vscode-debugadapter-node

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.