JSON کو YAML میں تبدیل کریں!

JSON درج کریں اور آسانی سے پڑھا جانے والا YAML حاصل کریں! yml, Kubernetes, docker-compose, Spring application.yml سپورٹ۔
JSON
نتیجہ
 

JSON کو YAML میں تبدیل کریں!

یہ JSON کو indentation پر مبنی YAML میں بدلتا ہے۔ braces اور زیادہ تر quotes غائب ہو جاتے ہیں، جس سے نتیجہ config فائل کے طور پر ہاتھ سے سنبھالنا آسان ہو جاتا ہے، اور keys کی ترتیب بالکل ماخذ JSON جیسی رہتی ہے۔

یہ تب کام آتا ہے جب آپ kubectl get -o json سے حاصل کیے گئے resource کو manifest میں منتقل کریں، یا API سے ملی settings کو docker-compose.yml، application.yml یا GitHub Actions workflow میں پیسٹ کریں۔

استعمال کا طریقہ

  1. JSON باکس میں JSON پیسٹ کریں۔ غلط syntax پر نتیجے میں JSON parsing failed دکھائی دیتا ہے؛ ضرورت ہو تو پہلے JSON validator سے گزار لیں۔
  2. نتیجہ کے نیچے YAML کا جائزہ لیں۔ indentation دو spaces کی ہے۔
  3. اسے اپنی .yml فائل میں کاپی کریں، اور اگر کسی دوسرے بلاک کے نیچے رکھ رہے ہیں تو indent کی گہرائی درست کر لیں۔

مثال

ان پٹ (JSON)
{
  "services": {
    "web": {
      "image": "nginx:1.27",
      "ports": ["8080:80"],
      "environment": { "FEATURE_FLAG": "on", "GREETING": "hello\nworld" }
    }
  }
}
آؤٹ پٹ (YAML)
services:
  web:
    image: nginx:1.27
    ports:
      - 8080:80
    environment:
      FEATURE_FLAG: "on"
      GREETING: |-
        hello
        world

string "on" اپنے quotes برقرار رکھتی ہے: اگر اسے بغیر quotes کے on لکھا جائے تو YAML 1.1 parser اسے boolean true پڑھے گا۔ GREETING میں newline ہے، اس لیے اسے |- بلاک کی صورت میں لکھا جاتا ہے جو ہر لائن ویسی ہی دکھاتا ہے جیسی لکھی گئی تھی۔

معاون خصوصیات

  • quoting YAML 1.1 کے مطابق ہوتی ہے۔ yes، no، on، off، y، n، ~، null جیسی strings، اور "0777"، "1.0" یا "2024-01-01" جیسی ملتی جلتی values پر quotes لگائے جاتے ہیں تاکہ PyYAML (1.1) اور جدید 1.2 parsers ایک ہی value پڑھیں۔
  • 22:22 جیسی strings، جنہیں YAML 1.1 base-60 نمبر پڑھ سکتا ہے، پر بھی quotes لگتے ہیں، جس سے docker-compose کا مشہور port-mapping bug نہیں ہوتا۔
  • کئی لائنوں والی strings |- literal blocks بن جاتی ہیں۔
  • لمبی strings کبھی fold نہیں ہوتیں (لائن کی چوڑائی کی کوئی حد نہیں)۔
  • خالی arrays اور objects [] اور {} ہی رہتے ہیں۔

استعمال کے کیس

kubectl کے JSON آؤٹ پٹ سے manifest تک

cluster سے JSON کی صورت میں نکالے گئے Deployment یا ConfigMap کو تبدیل کریں، status اور metadata.uid جیسے فیلڈز مٹائیں، اور آپ کے پاس Git کے لیے تیار manifest ہوگا۔

Spring Boot کی application.yml لکھنا

config server یا docs سے JSON کی صورت میں ملا properties کا بلاک YAML hierarchy بن جاتا ہے، اس لیے spring.datasource.url جیسی keys کو ہاتھ سے indent نہیں کرنا پڑتا۔

نوٹس اور حدود

  • کوئی comments، anchors (&) یا aliases (*) نہیں بنائے جاتے؛ JSON میں دہرایا گیا آبجیکٹ YAML میں بھی دہرایا جاتا ہے۔
  • 9007199254740991 سے بڑے integers JavaScript کی نمبر حد کی وجہ سے درستگی کھو دیتے ہیں؛ لمبی IDs کو JSON میں strings کے طور پر رکھیں۔
  • آؤٹ پٹ ایک ہی document ہوتا ہے۔ --- سے الگ کیے گئے کئی resources والی فائل کے لیے ہر resource الگ سے تبدیل کر کے خود جوڑیں۔

عام سوالات

کچھ strings پر quotes کیوں ہیں اور کچھ پر نہیں؟

quotes صرف وہاں لگتے ہیں جہاں بغیر quotes کی value کسی اور type کے طور پر پڑھی جائے۔ nginx:1.27 ہر صورت string ہے، لیکن on، 010 اور 22:22 کچھ parsers میں booleans یا نمبر بن جاتے ہیں، اس لیے ان پر quotes لگتے ہیں۔

کیا میں آؤٹ پٹ براہ راست Kubernetes پر apply کر سکتا ہوں؟

ڈھانچہ جوں کا توں درست ہے۔ البتہ kubectl get -o json کے آؤٹ پٹ میں سرور کے بھرے ہوئے status، resourceVersion اور managedFields جیسے فیلڈز ہوتے ہیں، جنہیں apply کرنے سے پہلے ہٹا دینا بہتر ہے۔

کیا میں چار spaces والی indentation پر جا سکتا ہوں؟

اس کا کوئی option نہیں؛ یہ دو spaces پر مقرر ہے، جو Kubernetes، docker-compose اور GitHub Actions کی پوری documentation میں رائج ہے۔