microsoft / microsoft/debug-adapter-protocol

Formalize a few more things in the json?

Open
#167 0 comments 0 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

Hello,

While making a parser for the DAP json, there were a few things that currently exist only as free-form text that I believe would be better to be also represented as formal json data, for tool consumption:

The request type that a response type is associated with.

This is currently is indicated by the sentence Response to <the request type>, such as RunInTerminalResponse: "description": "Response to 'runInTerminal' request."

Default values for fields.

There are a few fields that indicate what their default value should be, but only in free-form text:

(873):          "description": "If true all line numbers are 1-based (default)."
(877):          "description": "If true all column numbers are 1-based (default)."
(882):          "description": "Determines in what format paths are specified. The default is 'path', which is the native format."
(3413):          "description": "Datatype of values in this column.  Defaults to 'string' if not specified."

Would it be possible to extend the schema to also include this information as dedicated fields in the JSON?
If you have a syntax for both items I could submit a PR.

Thanks

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

Review the DAP JSON schema and the response and field descriptions identified in the issue. Define dedicated schema fields for response request types and default values, with a consistent syntax that replaces the free-form-only information.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.