Gate debug logs behind DEBUG environment variable using `debug` npm package #9396

Copilot · 2026-01-16T11:10:18Z

Plan to fix LSP spamming debug messages

Summary

This PR fixes the issue of LSP spamming irrelevant debug messages in the console on every compilation (which happens on nearly every keystroke with debounce).

Changes Made

Refactored to use the debug npm package (per review feedback):

Added debug package (v4.4.0) as a dependency to @typespec/compiler (runtime)
Added debug package (v4.4.0) as a devDependency to typespec-vscode (build time only)
Added @types/debug as a dev dependency to both packages
Replaced custom isDebugEnabled() function with standard debug package loggers
Created debug loggers for each area

Debug areas defined (preserving original naming):

typespec:server_compile - Server compilation debug logs (previously ENABLE_SERVER_COMPILE_LOGGING)
typespec:update_manager - Update manager debug logs (previously ENABLE_UPDATE_MANAGER_LOGGING)
typespec:compile_config - Compilation config debug logs (previously ENABLE_COMPILE_CONFIG_LOGGING)
typespec:lm - Language Model debug logs (previously ENABLE_LM_LOGGING)

Updated .vscode/launch.json:

Replaced old environment variable comments with unified DEBUG pattern documentation
Added usage examples showing how to enable different debug areas including LM logging
All logging now uses the unified DEBUG environment variable

Updated files in @typespec/compiler:

constants.ts - Uses debug package, exports debugLoggers
entrypoint-resolver.ts - Uses debugLoggers.compileConfig.enabled
compile-service.ts - Uses debugLoggers.compileConfig.enabled
server-compile-manager.ts - Uses debugLoggers.serverCompile.enabled
update-manager.ts - Uses debugLoggers.updateManager.enabled
serverlib.ts - Uses regular log function (removed unused logCompileConfig)

Updated files in typespec-vscode:

package.json - Added debug as devDependency and @types/debug as dev dependency
const.ts - Exports debugLoggers.lm instead of ENABLE_LM_LOGGING constant
language-model.ts - Uses debugLoggers.lm.enabled directly

Updated workspace configuration:

.vscode/launch.json - Updated comments to document unified DEBUG env var usage

Merge Resolution

Successfully merged latest changes from main branch:

Resolved conflict in packages/compiler/package.json by accepting updated @types/babel__code-frame@~7.27.0 from main while keeping @types/debug@~4.1.12 addition
Regenerated pnpm-lock.yaml after resolving package.json conflicts
All builds and tests passing after merge

How It Works

By default, all debug messages are suppressed. Users can enable them when troubleshooting using the standard Node.js DEBUG environment variable:

# Enable specific area
DEBUG=typespec:server_compile

# Enable Language Model logs
DEBUG=typespec:lm

# Enable all typespec debug logs
DEBUG=typespec:*

# Enable multiple specific areas
DEBUG=typespec:server_compile,typespec:compile_config,typespec:lm

The debug package provides:

Standard Node.js debugging pattern
Wildcard support (typespec:*)
Namespace hierarchies
Better performance with lazy evaluation
Color-coded output in terminals
Widespread adoption and maintenance

Validation

✅ All existing tests pass
✅ Entrypoint resolver tests: 5/5 passing
✅ TSPConfig completion tests: 118/118 passing
✅ Full build successful after merge
✅ typespec-vscode type checking passes
✅ Code formatting passes prettier checks
✅ Dependencies correctly categorized
✅ Merge conflicts resolved
✅ Ready for CI

Original prompt

This section details on the original issue you should resolve

<issue_title>LSP spamming irrelevent debug message in console</issue_title>
<issue_description>

Multiple message show up on every compilation which happens about every keypress(with debounce)</issue_description>

<agent_instructions>the env var 'ENABLE_SERVER_COMPILE_LOGGING' and 'ENABLE_UPDATE_MANAGER_LOGGING' can be used as an example. use the same way to control the log around the configuration of server compile</agent_instructions>

Comments on the Issue (you are @copilot in this section)
@RodgeFu Consider disabling them by default and have an env var (ENABLE_COMPILE_CONFIG_LOGGING) to enable it when needed (i.e. when troubleshooting compile related issues). Just like what we do with 'ENABLE_UPDATE_MANAGER_LOGGING'

Fixes LSP spamming irrelevent debug message in console #9310

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ug logs Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

packages/compiler/src/server/constants.ts

Changed from individual ENABLE_*_LOGGING environment variables to Node.js style DEBUG pattern supporting comma-separated areas and wildcards. Usage examples: DEBUG=typespec:compile DEBUG=typespec:* DEBUG=typespec:compile,typespec:config Debug areas: - typespec:compile (previously ENABLE_SERVER_COMPILE_LOGGING) - typespec:update (previously ENABLE_UPDATE_MANAGER_LOGGING) - typespec:config (previously ENABLE_COMPILE_CONFIG_LOGGING) Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

packages/compiler/src/server/constants.ts

Changed debug area names to preserve the original convention: - typespec:server_compile (was typespec:compile) - typespec:update_manager (was typespec:update) - typespec:compile_config (was typespec:config) This maintains consistency with the original ENABLE_*_LOGGING variable names. Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

- Added `debug` package (v4.4.0) as dependency - Added `@types/debug` as dev dependency - Replaced custom isDebugEnabled() with debug package loggers - Updated .vscode/launch.json to document DEBUG env var usage - Removed old ENABLE_*_LOGGING environment variable comments The debug package provides standard Node.js debugging with namespace support, wildcards, and better performance than the custom implementation. Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

.vscode/launch.json

Added a comment to clarify that ENABLE_LM_LOGGING is separate from the DEBUG environment variable logging system and is used specifically for Language Model logging in the typespec-vscode extension. Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

Simplified the code by directly accessing debugLoggers.lm.enabled instead of storing it in an intermediate 'debug' variable that was only used once. Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

packages/compiler/src/server/serverlib.ts

Changed provideTspconfigCompletionItems to use 'log' instead of 'logCompileConfig'. The tspconfig completion doesn't need compile config debug logging - it should use the regular log function. Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

packages/compiler/src/server/serverlib.ts

The logCompileConfig function was no longer used after reverting tspconfig completion to use the regular log function. Removed the orphaned function to clean up the code. Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

RodgeFu · 2026-01-23T02:46:45Z

@copilot , resolve confliction and make sure ci can pass

- Reordered imports in constants.ts (prettier requirement) - Removed trailing whitespace in comments - Updated ThirdPartyNotices.txt with debug package attribution All formatting now passes prettier checks. Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

Copilot · 2026-01-23T02:58:04Z

@copilot , resolve confliction and make sure ci can pass

Code formatting issues resolved in commit 21ba492.

Changes:

Fixed import ordering and trailing whitespace per prettier requirements
Updated ThirdPartyNotices.txt with debug package attribution
All formatting checks now pass
Key tests verified: entrypoint-resolver (5/5) and tspconfig completion (118/118) passing

Ready for CI validation.

RodgeFu · 2026-01-23T15:23:59Z

packages/typespec-vscode/package.json

+    "@types/debug": "~4.1.12"
+  },
+  "dependencies": {
+    "debug": "~4.4.0"


@copilot , move this to dev dependency

RodgeFu · 2026-01-23T15:26:15Z

@copilot , there is confliction needs to resolve from main branch

The debug package is only used during development/build time for the VSCode extension, not at runtime, so it should be in devDependencies rather than dependencies. Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

Copilot · 2026-01-23T15:36:56Z

@copilot , there is confliction needs to resolve from main branch

Merge conflicts resolved in commit 1c39832.

Conflicts resolved:

packages/compiler/package.json: Accepted updated @types/babel__code-frame@~7.27.0 from main while keeping @types/debug@~4.1.12 addition
pnpm-lock.yaml: Regenerated after package.json resolution

All tests passing after merge (entrypoint-resolver: 5/5, tspconfig completion: 118/118).

Initial plan

7a783c7

Copilot AI assigned Copilot and RodgeFu Jan 16, 2026

Copilot started work on behalf of RodgeFu January 16, 2026 11:10 View session

Copilot AI and others added 2 commits January 16, 2026 11:16

Add ENABLE_COMPILE_CONFIG_LOGGING environment variable to control deb…

8abac89

…ug logs Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

Fix JavaScript hoisting issue with logCompileConfig function

9750838

Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Fix LSP spamming irrelevant debug messages~~ Gate compilation config debug logs behind ENABLE_COMPILE_CONFIG_LOGGING Jan 16, 2026

Copilot AI requested a review from RodgeFu January 16, 2026 11:30

Copilot finished work on behalf of RodgeFu January 16, 2026 11:30

RodgeFu reviewed Jan 17, 2026

View reviewed changes

packages/compiler/src/server/constants.ts Outdated Show resolved Hide resolved

Copilot started work on behalf of RodgeFu January 17, 2026 05:15 View session

Copilot AI changed the title ~~Gate compilation config debug logs behind ENABLE_COMPILE_CONFIG_LOGGING~~ Gate debug logs behind DEBUG environment variable using Node.js pattern Jan 17, 2026

Copilot finished work on behalf of RodgeFu January 17, 2026 05:21

Copilot AI requested a review from RodgeFu January 17, 2026 05:21

RodgeFu reviewed Jan 17, 2026

View reviewed changes

packages/compiler/src/server/constants.ts Outdated Show resolved Hide resolved

Copilot started work on behalf of RodgeFu January 17, 2026 08:09 View session

RodgeFu reviewed Jan 17, 2026

View reviewed changes

packages/compiler/src/server/constants.ts Outdated Show resolved Hide resolved

RodgeFu reviewed Jan 17, 2026

View reviewed changes

packages/compiler/src/server/constants.ts Outdated Show resolved Hide resolved

Copilot AI requested a review from RodgeFu January 17, 2026 08:13

Copilot finished work on behalf of RodgeFu January 17, 2026 08:13

Copilot started work on behalf of RodgeFu January 17, 2026 08:14 View session

Copilot AI changed the title ~~Gate debug logs behind DEBUG environment variable using Node.js pattern~~ Gate debug logs behind DEBUG environment variable using debug npm package Jan 17, 2026

Copilot finished work on behalf of RodgeFu January 17, 2026 08:22

RodgeFu reviewed Jan 19, 2026

View reviewed changes

.vscode/launch.json Outdated Show resolved Hide resolved

Copilot started work on behalf of RodgeFu January 19, 2026 06:18 View session

Copilot AI requested a review from RodgeFu January 19, 2026 06:20

Copilot started work on behalf of RodgeFu January 21, 2026 02:57 View session

Remove unnecessary debug variable in language-model.ts

3b2668f

Simplified the code by directly accessing debugLoggers.lm.enabled instead of storing it in an intermediate 'debug' variable that was only used once. Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

Copilot finished work on behalf of RodgeFu January 21, 2026 03:02

RodgeFu reviewed Jan 21, 2026

View reviewed changes

packages/compiler/src/server/serverlib.ts Outdated Show resolved Hide resolved

Copilot started work on behalf of RodgeFu January 21, 2026 03:21 View session

Copilot AI requested a review from RodgeFu January 21, 2026 03:25

Copilot finished work on behalf of RodgeFu January 21, 2026 03:25

RodgeFu reviewed Jan 21, 2026

View reviewed changes

packages/compiler/src/server/serverlib.ts Outdated Show resolved Hide resolved

Copilot started work on behalf of RodgeFu January 21, 2026 05:27 View session

Remove unused logCompileConfig function

58fb695

The logCompileConfig function was no longer used after reverting tspconfig completion to use the regular log function. Removed the orphaned function to clean up the code. Co-authored-by: RodgeFu <6038235+RodgeFu@users.noreply.github.com>

Copilot AI requested a review from RodgeFu January 21, 2026 05:31

Copilot finished work on behalf of RodgeFu January 21, 2026 05:31

Copilot started work on behalf of RodgeFu January 23, 2026 02:47 View session

Copilot finished work on behalf of RodgeFu January 23, 2026 02:58

RodgeFu reviewed Jan 23, 2026

View reviewed changes

Copilot started work on behalf of RodgeFu January 23, 2026 15:26 View session

Copilot AI requested a review from RodgeFu January 23, 2026 15:30

Copilot finished work on behalf of RodgeFu January 23, 2026 15:30

Copilot started work on behalf of RodgeFu January 23, 2026 15:31 View session

Copilot finished work on behalf of RodgeFu January 23, 2026 15:37

RodgeFu force-pushed the copilot/fix-lsp-debug-message-issue branch from 1c39832 to 856eeb0 Compare January 24, 2026 09:57

microsoft-github-policy-service bot added compiler:core Issues for @typespec/compiler ide Issues for VS, VSCode, Monaco, etc. labels Jan 24, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Gate debug logs behind DEBUG environment variable using `debug` npm package #9396

Gate debug logs behind DEBUG environment variable using `debug` npm package #9396

Uh oh!

Copilot AI commented Jan 16, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RodgeFu commented Jan 23, 2026

Uh oh!

Copilot AI commented Jan 23, 2026

Uh oh!

RodgeFu Jan 23, 2026

Uh oh!

RodgeFu commented Jan 23, 2026

Uh oh!

Copilot AI commented Jan 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Gate debug logs behind DEBUG environment variable using debug npm package #9396

Are you sure you want to change the base?

Gate debug logs behind DEBUG environment variable using debug npm package #9396

Uh oh!

Conversation

Copilot AI commented Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Plan to fix LSP spamming debug messages

Summary

Changes Made

Merge Resolution

How It Works

Validation

Comments on the Issue (you are @copilot in this section)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RodgeFu commented Jan 23, 2026

Uh oh!

Copilot AI commented Jan 23, 2026

Uh oh!

RodgeFu Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

RodgeFu commented Jan 23, 2026

Uh oh!

Copilot AI commented Jan 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Gate debug logs behind DEBUG environment variable using `debug` npm package #9396

Gate debug logs behind DEBUG environment variable using `debug` npm package #9396

Copilot AI commented Jan 16, 2026 •

edited

Loading