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

YAML درج کریں اور اسے JSON میں تبدیل کریں! yml, Kubernetes, docker-compose سپورٹ۔
YAML
نتیجہ
 

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

YAML (yml) document کو JSON میں تبدیل کریں تاکہ وہ ڈھانچہ دیکھ سکیں جو indentation چھپا لیتی ہے، اور یہ بھی کہ ہر value اصل میں کس type کے طور پر parse ہوئی۔ anchors اور aliases اصلی values میں پھیلا دیے جاتے ہیں، اور --- سے الگ کیے گئے کئی documents ایک array میں جمع ہو جاتے ہیں۔

یہ YAML کی روایتی غلطیاں پکڑنے میں خاص طور پر کام آتا ہے: ایک space کم ہونے کی وجہ سے کسی value کا غلط parent سے جڑ جانا، یا version: 1.10 کا خاموشی سے نمبر 1.1 بن جانا۔

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

  1. docker-compose.yml، Kubernetes manifest یا workflow فائل YAML باکس میں پیسٹ کریں، یا فائل اس پر ڈراپ کریں۔
  2. syntax errors نتیجے میں لائن اور کالم نمبر کے ساتھ دکھائی دیتی ہیں؛ پہلے اسی جگہ کی indentation چیک کریں۔
  3. نتیجہ کے نیچے JSON پڑھ کر دیکھیں کہ ہر value string، نمبر یا boolean میں سے کیا بنی، اور ضرورت ہو تو کاپی کریں۔

مثال

ان پٹ (YAML)
name: ci
on:
  push:
    branches: [main]
defaults: &node
  runs-on: ubuntu-latest
  timeout-minutes: 10
jobs:
  test: *node
آؤٹ پٹ (JSON)
{
  "name": "ci",
  "on": {
    "push": {
      "branches": [
        "main"
      ]
    }
  },
  "defaults": {
    "runs-on": "ubuntu-latest",
    "timeout-minutes": 10
  },
  "jobs": {
    "test": {
      "runs-on": "ubuntu-latest",
      "timeout-minutes": 10
    }
  }
}

GitHub Actions کی on: key، string key "on" ہی رہتی ہے، کیونکہ یہ ٹول YAML 1.2 کے قواعد سے parse کرتا ہے۔ &node anchor سے بیان کیا گیا بلاک *node کی جگہ پھیلا دیا جاتا ہے۔

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

  • YAML 1.2 core schema سے parse ہوتا ہے: yes، on اور off strings رہتے ہیں، اور صرف true/True/false booleans بنتے ہیں۔
  • ~ اور خالی values null بنتی ہیں؛ hex 0x1F اور octal 0o17 نمبر بنتے ہیں۔
  • &anchors اور *aliases حوالہ دی گئی values میں حل ہو جاتے ہیں۔
  • literal | اور folded > block scalars، YAML کے newline قواعد لاگو کر کے strings میں بدلے جاتے ہیں۔
  • --- سے الگ کیے گئے کئی documents ایک JSON array بنتے ہیں؛ اکیلا document اپنی value کے طور پر آؤٹ پٹ ہوتا ہے۔
  • ایک ہی mapping میں دو بار آنے والی key کو error کے طور پر رپورٹ کیا جاتا ہے۔

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

Kubernetes manifest کی indentation جانچنا

اگر containers کے نیچے env ایک درجہ کم indent ہو تو وہ خاموشی سے کسی اور فیلڈ سے جڑ جاتا ہے اور پتا صرف apply کے وقت چلتا ہے۔ JSON میں braces بالکل دکھا دیتے ہیں کہ وہ کس آبجیکٹ کا حصہ ہے۔

کوڈ سے config استعمال کرنا

کسی script یا فرنٹ اینڈ bundle کے لیے جہاں YAML parser شامل کرنا ضرورت سے زیادہ ہو، config ایک بار تبدیل کریں اور اسے import config from './config.json' کی طرح استعمال کریں۔

OpenAPI spec کا معائنہ

YAML میں لکھا OpenAPI document تبدیل ہونے کے بعد JSONPath یا jq سے query کرنا آسان ہو جاتا ہے، مثلاً کسی خاص path کا اسکیما نکالنا۔

نوٹس اور حدود

  • merge keys (<<: *defaults) لاگو ہوتی ہیں: anchor والی mapping کی keys کاپی ہو جاتی ہیں، اور << کے ساتھ لکھی keys انہیں override کرتی ہیں۔ صرف YAML 1.2 والا parser << کو سادہ key رکھے گا، اس لیے ایسے ٹولز سے نتائج مختلف ہو سکتے ہیں۔
  • 2024-01-01 جیسی تاریخیں اور اوقات Date values بننے کے بجائے strings رہتے ہیں۔
  • .inf اور .nan کی JSON میں کوئی نمائندگی نہیں، اس لیے یہ null بن جاتے ہیں۔
  • comments کو JSON میں منتقل نہیں کیا جا سکتا اور وہ ہٹ جاتے ہیں۔
  • PyYAML (YAML 1.1) on اور yes کو true پڑھتا ہے، اس لیے Python کے نتائج مختلف ہو سکتے ہیں۔

عام سوالات

GitHub Actions کا on بطور true کے بجائے "on" کیوں دکھایا جاتا ہے؟

YAML 1.2 میں صرف true اور false booleans ہیں، اس لیے on ایک عام string ہے، اور GitHub Actions بھی اس key کو اسی طرح پڑھتا ہے۔ Python کا PyYAML 1.1 پر چلتا ہے اور اسے True key بنا دیتا ہے، اس لیے scripts سے workflows parse کرتے وقت دھیان رکھیں۔

version: 1.10 بدل کر 1.1 آتا ہے۔

بغیر quotes کا 1.10 YAML میں نمبر ہے، اور 1.10 برابر ہے 1.1 کے۔ version string برقرار رکھنے کے لیے ماخذ YAML میں اسے "1.10" کی طرح quotes میں لکھیں۔

کئی documents والی فائل کا کیا ہوتا ہے؟

--- سے الگ ہر document ترتیب سے ایک array element بنتا ہے، اس لیے kubectl apply -f کے ساتھ استعمال ہونے والی کئی resources والی فائل resources کی array دیتی ہے۔