JSON से YAML: मशीन आउटपुट को फिर से पढ़ने योग्य बनाना

JSON को YAML में कनवर्ट ही क्यों करें

दोनों प्रारूपों में समान डेटा होता है, लेकिन वे विभिन्न पाठकों के लिए अनुकूलित होते हैं। JSON अक्षरों को ब्रेसिज़, अल्पविराम और उद्धरण चिह्नों पर खर्च करता है; YAML उन्हें संरचना पर खर्च करता है जिसे आंख इंडेंटेशन के रूप में अनुसरण कर सकती है। प्रोग्राम द्वारा उत्पन्न और उपभोग किए जाने वाले डेटा के लिए, JSON जीतता है। उस डेटा के लिए जिसे कोई व्यक्ति संपादित करता है - Helm मान, सीआई परिभाषाएँ, अन्सिबल इन्वेंटरी, Docker फ़ाइलें लिखें - YAML जीतता है, यही कारण है कि जब भी उत्पन्न डेटा को मानव स्वामी की आवश्यकता होती है तो यह दिशा सामने आती है।

टिप्पणियाँ एक ऐसी चीज़ है जो जीवित नहीं रह सकती

रूपांतरण पठनीयता को बहाल कर सकता है लेकिन यह इरादे को बहाल नहीं कर सकता: स्रोत JSON के पास आगे बढ़ाने के लिए कोई टिप्पणी नहीं थी। यदि आपका जेनरेट किया गया YAML लोगों द्वारा बनाए रखा जाएगा, तो एक संक्षिप्त हेडर टिप्पणी जोड़ें जिसमें यह बताया गया हो कि यह कहां से आया है और क्या इसे पुनर्जीवित करता है, ताकि कोई भी उस फ़ाइल को संपादित न करे जिसे अगले परिनियोजन पर अधिलेखित कर दिया जाएगा।

उद्धरण: जहां परिवर्तित YAML चुपचाप टूट जाता है

YAML कई नंगे शब्दों को स्ट्रिंग के बजाय मान के रूप में मानता है। एक कनवर्टर जो आक्रामक तरीके से उद्धरण छोड़ता है वह एक भी दृश्यमान वर्ण को बदले बिना प्रकार बदल सकता है:

                country: NO        # parses as boolean false in YAML 1.1
version: 1.10      # parses as the number 1.1
time: 22:30        # parses as a sexagesimal integer
name: "on"         # quoted on purpose — must stay a string
              

अच्छा आउटपुट किसी भी स्ट्रिंग को उद्धृत करता है जिसे गलत पढ़ा जा सकता है - `yes`/`no`/`on`/`off`, संख्यात्मक दिखने वाले पहचानकर्ता, अग्रणी शून्य वाले मान, समय और दिनांक - सब कुछ उद्धृत करने के बजाय, जो विराम चिह्न की दीवार उत्पन्न करता है जिससे आप बचने की कोशिश कर रहे थे।

इंडेंटेशन और मल्टी-लाइन स्ट्रिंग्स

दो स्थान सुरक्षित डिफ़ॉल्ट है: Kubernetes दस्तावेज़ीकरण, Helm टेम्प्लेट और अधिकांश संपादक यही मानते हैं, और यह टूल के बीच कॉपी-पेस्ट से बचता है। चार-अंतरिक्ष शैली में गहरे घोंसलों को लगभग छह स्तरों से आगे स्कैन करना कठिन हो जाता है। लंबी स्ट्रिंग्स अन्य स्वरूपण निर्णय हैं - एम्बेडेड न्यूलाइन के साथ एक JSON मान एस्केप्ड वन-लाइनर के रूप में या YAML ब्लॉक स्केलर के रूप में सामने आ सकता है जो स्वाभाविक रूप से पढ़ता है। यदि फ़ील्ड एक शेल स्क्रिप्ट या कॉन्फ़िगरेशन स्निपेट है, तो ब्लॉक फॉर्म मांगें।

कुंजियाँ क्रमबद्ध करने से अंतर सार्थक हो जाता है

JSON ऑब्जेक्ट कुंजी क्रम महत्वपूर्ण नहीं है, इसलिए कन्वर्टर्स पुन: व्यवस्थित करने के लिए स्वतंत्र हैं। कुंजियों को वर्णानुक्रम में क्रमबद्ध करने से पुनर्जीवित फ़ाइलें स्पष्ट रूप से भिन्न हो जाती हैं: इसके बिना, एक परिवर्तित परिनियोजन क्रम संपूर्ण-फ़ाइल पुनर्लेखन के रूप में दिखाई देता है। यदि आप गिट में उत्पन्न YAML को ट्रैक कर रहे हैं, तो सॉर्टिंग एक-पंक्ति अंतर और दो-सौ-पंक्ति अंतर के बीच का अंतर है।

राउंड ट्रिप को एक ही स्थान पर रखें

चूँकि दोनों दिशाएँ व्युत्क्रम हैं, इसलिए दोनों को एक ही टूल में रखना उचित है ताकि आप संदर्भ को बदले बिना या अपने कॉन्फ़िगरेशन को तीन अलग-अलग सेवाओं में चिपकाए बिना परिवर्तित, संपादित और वापस परिवर्तित कर सकें। इस साइट पर ब्राउज़र-आधारित कनवर्टर YAML से JSON टूल के साथ जुड़ता है, ऑफ़लाइन काम करता है, और कभी भी पेलोड अपलोड नहीं करता है - जो तब मायने रखता है जब प्रश्न में JSON एक उत्पादन API प्रतिक्रिया हो।