Twig/coding standards

إننا ننصح أثناء كتابة قوالب Twig باتباع معايير الكتابة التالية:

• ضع مسافة واحدة -واحدة فقط- بعد بدء المحدِّد (delimiter) }} و ‎‏%}‎ و ‎{#‎، وقبل نهاية المحدِّدات {{ و {% و {#:

{{ foo }}
{# تعليق #}
{% if foo %}{% endif %}

وعند استخدام محرف التحكم في المسافات الفارغة، لا تضع أي مسافات بينه وبين المحدِّد:

{{- foo -}}
{#- تعليق -#}
{%- if foo -%}{%- endif -%}

• ضع مسافة واحدة -واحدة فقط- قبل وبعد العوامل التالية:
  • عوامل الموازنة (==, ‎!=‎, <, >, ‎>=‎, ‎<=‎).
  • العوامل الرياضية (+, -, /, *, %, //, **).
  • العوامل المنطقية (not, and, or)، و ~ و is و in.
  • العامل الثلاثي (‎?:‎):

{{ 1 + 2 }}
{{ foo ~ bar }}
{{ true ? true : false }}

• ضع مسافة واحدة -واحدة فقط- بعد علامة : في الجداول (hashes) و , في المصفوفات والجداول:

{{ [1, 2, 3] }}
{{ {'foo': 'bar'} }}

• لا تضع أي مسافات بعد أقواس البدء ولا قبل أقواس الإغلاق في التعابير:

{{ 1 + (2 * 3) }}

• لا تضع أي مسافات قبل محددات السلاسل النصية ولا بعدها:

{{ 'foo' }}
{{ "foo" }}

• لا تضع أي مسافات قبل أو بعد العوامل التالية | , . , .. , []:

{{ foo|upper|lower }}
{{ user.name }}
{{ user[name] }}
{% for i in 1..12 %}{% endfor %}

• لا تضع أي مسافات قبل أو بعد الأقواس المستخدمة في استدعاءات الفلاتر والدوال:

{{ foo|default('foo') }}
{{ range(1..10) }}

• لا تضع أي مسافات قبل أو بعد بدايات أو نهايات المصفوفات والجداول:

{{ [1, 2, 3] }}
{{ {'foo': 'bar'} }}

• اكتب المتغيرات باستخدام أحرف في حالتها الصغرى وباستخدام شرطة سفلية مكان المسافات:

{% set foo = 'foo' %}
{% set foo_bar = 'foo' %}

• استخدم الإزاحات في شيفرتك داخل الوسوم، مع الحفاظ على نفس الإزاحة المستخدمة للغة الهدف للقالب المصيَّر:

{% block foo %}
    {% if true %}
        true
    {% endif %}
{% endblock %}

انظر أيضًا

• المكونات الداخلية لمحرك القوالب Twig
• محرك Twig للمطورين
• محرك Twig لمصممي القوالب

المصادر

• صفحة Coding Standards في توثيق Twig الرسمي