microsoft / microsoft/debug-adapter-protocol

Make jump to code a standard event

Open
#399 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request
Dominant language
HTML
Stars
1.8k
Forks
173
Avg merge
7d 7h
Merged PRs (30d)
2

Description

Within the Dart extension, we use a custom event to indicate to the IDE client that we would like to jump to a specific spot in code. Our current use case for this is allowing developers to run a mobile application and click on an element in the application to move to the code that corresponds to the UI element (see https://github.com/Dart-Code/Dart-Code/blob/master/src/extension/commands/debug.ts#L559 and https://github.com/Dart-Code/Dart-Code/blob/master/src/extension/commands/edit.ts#L21). We could also see this type of event being helpful for performance tooling where data could be associated with a point in code.

interface CodePointerEvent extends Event {
  event: 'codePointer';

  body: {
    /** The file requested. */
    uri: string;

    /** The line requested. */
    line: number;

    /** The column requested, optionally. */
    column?: number;
  };
}

Contributor guide

Open the contributing guide

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 by reading the current custom event usage in Dart-Code's src/extension/commands/debug.ts around line 559 and src/extension/commands/edit.ts around line 21. Compare those payloads with the proposed CodePointerEvent shape, then define the protocol change and verify that the documented event covers file, line, and optional column targets.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.