Skip to content

Document --trace and --protocol-log-level server CLI arguments - #50

Merged
clrudolphi merged 1 commit into
masterfrom
docs/issue-46-cli-args-documentation
Jul 5, 2026
Merged

Document --trace and --protocol-log-level server CLI arguments#50
clrudolphi merged 1 commit into
masterfrom
docs/issue-46-cli-args-documentation

Conversation

@clrudolphi

Copy link
Copy Markdown
Collaborator

Summary

Fixes #46

PR #42 (F41: LSP trace support) added two new command-line arguments to the LSP server (Reqnroll.IdeSupport.LSP.Server.exe), alongside the existing --log-level, but none of the top-level or per-client docs described them. This PR documents:

  • --trace <Off/Messages/Verbose> and --protocol-log-level <Off/Error/Warning/Info/Verbose> alongside --log-level, in src/LSP/CONTRIBUTING.md, including the --trace precedence order (CLI default → InitializeParams.Trace$/setTrace), read directly from Program.cs's ConfigureServer/ResolveInitialTrace.
  • LspServerConnectionService.ServerArguments's DEBUG vs. RELEASE defaults in src/VisualStudio/CONTRIBUTING.md, and that VS currently has no end-user UI to change these at runtime.
  • The reqnroll.trace.server VS Code setting in src/VSCode/CONTRIBUTING.md, and how it maps to both the wire-level trace (InitializeParams.Trace/$/setTrace, handled by vscode-languageclient itself) and the server's --log-level CLI argument (via traceServerToLogLevel()) — VS Code does not pass --trace or --protocol-log-level at all.
  • A short cross-linking summary in the top-level README.md and CONTRIBUTING.md.

Test plan

  • Docs-only change; no build/test run required.
  • Verified flag names, defaults, and precedence against src/LSP/Reqnroll.IdeSupport.LSP.Server/Hosting/Program.cs, src/VisualStudio/Reqnroll.IdeSupport.VisualStudio.Extension/LspInterception/LspServerConnectionService.cs, and src/VSCode/src/lspInspectorLogger.ts / extension.ts.
  • Read through the final diff for accuracy.

🤖 Generated with Claude Code

PR #42 (F41) added --trace and --protocol-log-level alongside the existing
--log-level, and wired per-IDE defaults into the VS extension's server
launch and VS Code's reqnroll.trace.server setting, but none of the docs
described them. Document the flags, their defaults, the --trace precedence
against InitializeParams.Trace/$/setTrace, and how each IDE client sets
them, in README.md and the four CONTRIBUTING.md guides.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@clrudolphi
clrudolphi merged commit a7e107b into master Jul 5, 2026
8 checks passed
@clrudolphi
clrudolphi deleted the docs/issue-46-cli-args-documentation branch July 5, 2026 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document new server CLI arguments (--trace, --protocol-log-level) in README/CONTRIBUTING

1 participant