microsoft / microsoft/debug-adapter-protocol

Formalize a few more things in the json?

Ouverte
#167 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

feature-request
Langage dominant
HTML
Étoiles
1.8k
Forks
173
Merge moyen
7 j 7 h
PR mergées (30 j)
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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Examinez le schéma JSON de DAP ainsi que les descriptions des réponses et des champs identifiées dans l’issue. Définissez des champs de schéma dédiés pour les types de requêtes de réponse et les valeurs par défaut, avec une syntaxe cohérente qui remplace les informations uniquement en texte libre.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
json
Domaine
api
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.