microsoft / microsoft/vscode-java-debug

Add Support For Showing a Custom Type View via TypeCustomDebugDataView or Annotations

Ouverte
#1,162 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

ai-triaged enhancement feature request variables
Langage dominant
TypeScript
Étoiles
591
Forks
429
Merge moyen
1 j 9 h
PR mergées (30 j)
19

Description

Hi,

It seems currently vscode-java-debug doesn't support a way to have different representations of a type during debug in inline view, "variables" and "watch" windows.

Environment
  • Operating System: Windows 10 19043.1645 (x64)
  • JDK version: Java 11 (Oracle JDK 16)
  • Visual Studio Code version: 1.66.2
  • Java extension version: 1.6.0
  • Java Debugger extension version: 0.40.1
Steps To Reproduce
  1. Start a debugging session in vscode for any java file.
  2. See how class variables are represented in inline-view, "variables" and "watch" windows.
Current Result

For example, here is how it looks like during debug - inline view (extension version v0.40.1):
current-inline-view

and here is overridden toString method in the Point class:
point-ovirridden

notice, I have the following options in .vscode/settings.json:

{
  "java.debug.settings.showQualifiedNames": false,
  "java.debug.settings.showToString": true,
  "java.debug.settings.showLogicalStructure": true
}

also, when I expand an array in the variable view, the nested types are not showing until I click(...):
array-list-expanded-view

It seems there are no ways to enable a custom data view for a particular types, right?

Expected Result

It would be cool to have something like that:
inline-view-expected

It seems like it can be done using either:

  1. Adding an option to enable displaying a result of overridden toString method, e.g. java.debug.settings.showToStringInlineView: true
  2. Add "Java Type Renderer" to support custom data views similar to IntellijIdea "debugger -> Customize Data Views -> Java Type Renderer" (see link #1 in Additional Informations)
  3. Add something like DebuggerDisplay annotation similar to C# DebuggerDisplayAttribute (see link #2 in Additional Informatins)

For me the second way seems more appealing because it may allow setting custom debug views even for Java internal classes like java.utils.ArrayList

Additional Informations

For example, here are some StackOverflow questions that illustrate the problem:

  1. IntelliJ change toString for debug mode (variables view) | StackOverflow
  2. Display custom string in debugger variables | StackOverflow

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

Aucun fichier source, test ou point d’entrée n’est nommé. Commencez par retracer la manière dont vscode-java-debug restitue les valeurs dans les vues inline, Variables et Watch, puis comparez les approches proposées TypeCustomDebugDataView, annotation et toString. Le travail sera considéré comme terminé lorsqu’une conception aura été approuvée et que les représentations personnalisées des types seront prises en charge dans les vues demandées.

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

Évaluation

Stack technique
java, typescript
Domaine
devtools
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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