FracturedJson

• Ensemble d’utilitaires de formatage qui organisent les données JSON pour les rendre lisibles tout en conservant une forme compacte
• Les tableaux et objets sont représentés autant que possible sur une seule ligne, et lorsque les structures se ressemblent, ils sont alignés sous forme de tableau
• Prend en charge la préservation des commentaires et conserve les commentaires, absents du standard JSON mais fréquents dans les usages réels
• Utilisable dans divers environnements, notamment comme bibliothèque .NET, package JavaScript/TypeScript, extension VS Code et formateur pour navigateur
• Un outil qui améliore les limites de lisibilité des formateurs JSON existants et renforce la compréhension visuelle des développeurs et analystes de données

---

Aperçu de FracturedJson

• FracturedJson est un ensemble d’utilitaires qui génèrent un format JSON compact tout en restant facile à lire pour un humain
  • Les tableaux et objets sont affichés sur une seule ligne s’ils ne sont ni trop longs ni trop complexes
  • Les lignes multiples de structure similaire alignent les champs pour un affichage tabulaire
  • Les tableaux longs sont répartis sur plusieurs lignes avec plusieurs éléments par ligne
• Le format de sortie peut être contrôlé via divers réglages, et dans la plupart des cas, les paramètres par défaut produisent déjà un résultat agréable à lire
• Disponible sous forme de page de formatage dans le navigateur, de bibliothèque .NET, de package JavaScript/TypeScript et d’extension VS Code
• Une option pour Python est également indiquée séparément

Motivation

• La plupart des bibliothèques JSON ne proposent que deux formats
  • Minified JSON : efficace, mais difficile à lire pour un humain
  • Beautified/Indented JSON : trop étalé, ce qui rend la lecture rapide plus difficile
• FracturedJson formate les données comme le ferait une personne en les écrivant directement
  • Sauf si elles sont trop complexes ou trop longues, les structures conteneurs restent sur une seule ligne
  • Les tableaux ou objets similaires sont alignés sous forme de tableau

Fonctionnement (How It Works)

• FracturedJson utilise quatre types de formatage
  1. Inlined : représente sur une seule ligne les objets ou tableaux courts et simples
     • Le réglage MaxInlineComplexity contrôle le niveau d’imbrication autorisé
  2. Compact Multiline Array : place plusieurs éléments sur une même ligne tout en les répartissant sur plusieurs lignes
     • MaxCompactArrayComplexity permet d’ajuster la profondeur d’imbrication autorisée, avec -1 pour désactiver cette option
  3. Table : aligne les éléments de structure similaire en colonnes
     • Si les conteneurs internes sont trop complexes, seule une partie est condensée
     • Le comportement peut être contrôlé avec MaxTableRowComplexity et TableCommaPlacement
  4. Expanded : si aucune des conditions précédentes ne s’applique, chaque élément est affiché sur plusieurs lignes avec indentation

Gestion des commentaires

• Le standard JSON n’autorise pas les commentaires, mais FracturedJson prend en charge une fonction de préservation des commentaires
  • Les commentaires sont conservés avec les éléments concernés, et les commentaires multiligne comme les commentaires en ligne sont tous deux pris en charge

Discussions

• Un espace GitHub Discussions est proposé pour les questions des utilisateurs, les retours et les suggestions
• Il permet d’échanger sur le projet et de proposer des améliorations