josdejong/jsoneditor

Option to show quotes around strings

Open

#1 516 ouverte le 13 mai 2023

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)JavaScript (10 781 stars) (2 034 forks)batch import
featurehelp wanted

Description

The API we work with returns a JSON with a bunch of fields. Sometimes it deals with numbers that may be sent as a string, especially where the number of digits (and any leading zeroes) are important to be preserved.

For example, there are cases where an ID needs to be 5 characters so a 4-digit ID is sent as "01234". But the UI makes it hard to know whats a string and what's a number because neither are quoted.

{
  "num_id": 1234,
  "str_id": "01234",
}

is rendered as

It would be nice if there was an option to show quotes for string values in the tree UI.

Guide contributeur

Stack technique
javascripthtmlcss
Domaine
frontenddeveloper experience
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic understanding of the JSON editor's tree rendering component
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
The request is to add an option that displays quotes around string values in the tree UI. Start by examining the tree node rendering logic in 'src/js/TreeEditor.js' or similar files where string values are rendered. Look for the function that formats the value display, likely in the node's 'renderValue' method. Then, add a configuration option (e.g., 'showQuoteForStrings') to the editor's options. The existing options like 'indentation' or 'mode' can serve as a pattern for implementing the new toggle. Ensure the change only affects the display and does not alter the underlying data.