microsoft / microsoft/java-debug

References to launch.json in error messaging may be misleading

Open
#431 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ai-triaged enhancement
Dominant language
Java
Stars
409
Forks
204
Avg merge
1d 13h
Merged PRs (30d)
4

Description

https://github.com/microsoft/java-debug/search?q=launch.json

There appear to be only two references to launch.json in this repository. There does not appear to be any part of the code actually reading or referencing or introspecting a file named launch.json.

End users may find references to launch.json confusing if a third party tool has launched the debugger to connect to a java process and did not pass in a "projectName" to the call. While I realize this is a bit outside the scope of this repository, an example would be a vscode extension using the vscode.debug API (which flows to the https://github.com/microsoft/vscode-java-debug extension) and not setting a project name. In this case there is no launch.json file.

private async startDebugger(port: string) {
        this.port = port;
        vscode.debug.startDebugging(undefined, {
            type: 'java',
            request: 'attach',
            name: 'Debug (Remote)',
            hostName: 'localhost',
            port,
           projectName // set to undefined as an example
        });
    }

Since this repository itself does not read a launch.json at all, and all configuration is passed in via a Debug Adapter, not an existing file, these references to a file name are very misleading.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repository search for launch.json linked in the issue and inspect the two error-message references. Determine wording that does not imply this repository reads a launch.json file; done means the misleading references are clarified or removed for debugger sessions started through the VS Code debug API.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, vscode
Domain
devtools
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.