microsoft / microsoft/debug-adapter-protocol

Formalize a few more things in the json?

Offen
#167 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature-request
Vorherrschende Sprache
HTML
Sterne
1.8k
Forks
173
Ø Merge
7 T. 7 Std.
Gemergte PRs (30 T.)
2

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Überprüfe das DAP-JSON-Schema sowie die im Issue identifizierten Beschreibungen von Responses und Feldern. Definiere dedizierte Schemafelder für Response-Request-Typen und Standardwerte mit einer konsistenten Syntax, die die ausschließlich frei formulierten Informationen ersetzt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
json
Bereich
api
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.