- Eine Sammlung von Formatierungs-Utilities, die JSON-Daten menschenlesbar anordnen und dabei kompakt halten
- Arrays und Objekte werden nach Möglichkeit in einer Zeile dargestellt, und bei ähnlichen Strukturen tabellarisch ausgerichtet
- Unterstützt die Beibehaltung von Kommentaren und erhält Kommentare mit, die zwar nicht zum JSON-Standard gehören, in realen Einsatzumgebungen aber häufig sind
- Nutzbar in verschiedenen Umgebungen, darunter .NET-Bibliothek, JavaScript/TypeScript-Paket, VS Code-Erweiterung und Browser-Formatter
- Ein Werkzeug, das die Grenzen der Lesbarkeit bestehender JSON-Formatter verbessert und das visuelle Verständnis für Entwickler und Datenanalysten erhöht
Überblick über FracturedJson
- FracturedJson ist eine Sammlung von Utilities zur Erzeugung eines menschenlesbaren und zugleich relativ kompakten JSON-Formats
- Arrays und Objekte werden in einer Zeile ausgegeben, sofern sie nicht zu lang oder zu komplex sind
- Mehrzeilige Strukturen mit ähnlichem Aufbau werden durch Ausrichtung der Felder tabellarisch dargestellt
- Lange Arrays werden über mehrere Zeilen verteilt, wobei mehrere Elemente pro Zeile platziert werden
- Über verschiedene Einstellungen lässt sich das Ausgabeformat steuern; in den meisten Fällen liefern bereits die Standardeinstellungen ein gut lesbares Ergebnis
- Verfügbar als browserbasierte Formatter-Seite, .NET-Bibliothek, JavaScript/TypeScript-Paket und VS Code-Erweiterung
- Eine Option für Python wird ebenfalls separat beschrieben
Motivation
- Die meisten JSON-Bibliotheken bieten nur zwei Formate
- Minified JSON: effizient, aber für Menschen schwer lesbar
- Beautified/Indented JSON: zu stark ausgedehnt, sodass eine schnelle Erfassung schwierig ist
- FracturedJson formatiert Daten so, als hätte ein Mensch sie direkt geschrieben
- Außer wenn sie zu komplex oder zu lang sind, werden Container in einer Zeile gehalten
- Ähnliche Arrays oder Objekte werden tabellarisch ausgerichtet
Funktionsweise (How It Works)
- FracturedJson verwendet vier Formatierungstypen
- Inlined: Kurze und einfache Objekte oder Arrays werden in einer Zeile dargestellt
- Mit der Einstellung
MaxInlineComplexity lässt sich die erlaubte Verschachtelungstiefe steuern
- Compact Multiline Array: Mehrere Elemente werden pro Zeile platziert, aber über mehrere Zeilen verteilt dargestellt
- Mit
MaxCompactArrayComplexity lässt sich die erlaubte Verschachtelung anpassen; mit -1 kann dies deaktiviert werden
- Table: Elemente mit ähnlicher Struktur werden spaltenweise ausgerichtet
- Wenn innere Container zu komplex sind, werden nur Teile davon reduziert
- Steuerbar über
MaxTableRowComplexity und TableCommaPlacement
- Expanded: Wenn keine der obigen Bedingungen passt, wird jedes Element über mehrere Zeilen eingerückt dargestellt
Kommentarverarbeitung
- Der JSON-Standard erlaubt keine Kommentare, aber FracturedJson unterstützt die Beibehaltung von Kommentaren
- Kommentare bleiben zusammen mit dem zugehörigen Element erhalten; sowohl mehrzeilige Kommentare als auch Inline-Kommentare werden verarbeitet
Discussions
- Es gibt einen Bereich für GitHub Discussions für Nutzerfragen, Feedback und Vorschläge
- Diskussionen rund um das Projekt und Verbesserungsvorschläge sind möglich
Noch keine Kommentare.