تنسيق JSON والمسافات البادئة: أفضل الممارسات
2024-06-14
التنسيق ليس شكلًا فقط—التوحيد يقلل ضجيج المراجعة ويجعل الدمج أسهل. إليك كيف تختار ومتى تضغط النص.
المسافات في مواصفة JSON
المسافات والأسطر الجديدة لا تغيّر المعنى لدى المحلل؛ القرار هنا يخص القراءة والتوحيد داخل الفريق.
Tabs أم spaces
يفضل معظم الفرق spaces لأنها أكثر ثباتًا بين المحررات وتعطي فروق Git أوضح. tabs قانونية لكن نادرة في أمثلة JSON العامة.
2 أم 4 مسافات
مسافتان شائعتان في بيئات الويب وNode، وأربع مسافات تظهر أحيانًا في بيئات Java/Python. الأهم اختيار معيار واحد لكل مستودع.
{
"user": {
"name": "Alice",
"roles": ["admin", "editor"]
}
}متى تستخدم pretty-print
عند التصحيح والتوثيق والتحرير اليدوي. التنسيق قبل المراجعة يجعل diff يعرض التغييرات الحقيقية فقط.
متى تستخدم minify
للنقل في الإنتاج وتقليل الحجم. احتفظ بنسخة مقروءة في مكان آخر ولا تعدل JSON المصغر يدويًا.
نصائح للفريق
استخدم .editorconfig لملفات JSON، ويمكن إضافة فحص parse في CI، وتوحيد أمثلة الوثائق على مسافتين.