josdejong/jsoneditor

Option to show quotes around strings

Open

#1.516 geöffnet am 13. Mai 2023

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (10.781 Stars) (2.034 Forks)batch import
featurehelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
javascripthtmlcss
Domain
frontenddeveloper experience
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic understanding of the JSON editor's tree rendering component
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.