مخطّط الفرونت-ماتر (Frontmatter Schema)
دليل مرجعي لبنية كتلة الفرونت-ماتر YAML، والمفاتيح المطلوبة لكل صنف، وقواعد إنفاذ المُدقِّق عبر أصناف الأدوات.
مرجع كنسي للفرونت-ماتر YAML على كل صنف من أصناف الأدوات. الملخّص في
CLAUDE.md§٤ الاصطلاحات هو الإعلان المضمَّن؛ ومخطّطات JSON Schema لكل صنف فيschemas/هي العقد المقروء آليًّا؛ وهذه الصفحة هي المرجع المستقلّ الذي يستشهد به المساهمون اللاحقون.
١. بنية كتلة الفرونت-ماتر
تحمل كل أداة فرونت-ماتر YAML في رأسها، مُحدَّدًا بأسطر ---. ويقع شعار رأس النسبة الكنسي بحسب site/content/docs/reference/authorship-header.mdx فوق الفرونت-ماتر في ملفّات عائلة Markdown؛ ويتبعه الفرونت-ماتر مباشرةً.
تستخدم المفاتيح kebab-case. والقيم القياسية إمّا عارية وإمّا بين علامتَي اقتباس مزدوجتين؛ أمّا القيم النصّية التي تحتوي على نقطتين رأسيّتين أو علامات تجزئة أو غيرها من المحارف ذات الدلالة في YAML فتُحاط بعلامات اقتباس.
٢. الحقول المطلوبة لكل صنف
تتفاوت مجموعة المفاتيح المطلوبة بحسب صنف الأداة. وتُنفَّذ البنية المُعتمَدة بواسطة scripts/dev/validate_ecosystem.py ومخطّطات JSON Schema لكل صنف تحت الدليل schemas/ (ملفّ مخطّط واحد لكل صنف أداة).
schemas/agent.schema.json
schemas/skill.schema.json
schemas/command.schema.json
schemas/output-style.schema.json
schemas/plan.schema.json| الصنف | المفاتيح المطلوبة |
|---|---|
CLAUDE.md (إعداد الجذر) | name، version، updated، description، scope، portability |
القواعد (src/apothem/rules/*.md) | name، description، pathFilter، alwaysApply |
الأوامر (src/apothem/commands/*.md) | name، version، updated، description، argument-hint، disable-model-invocation |
| المساعِدون (الدليل الكنسي المعروض أدناه) | name، version، updated، description، tools، disallowedTools، maxTurns، effort |
المهارات (src/apothem/skills/*/SKILL.md) | name، description، archetype، userInvocable |
تحمل المخطّطات لكل صنف في schemas/ مجموعة القيود الكاملة، بما في ذلك قيود النوع والتنسيق وenum والنمط.
٣. المُدقِّقات
يجتاز scripts/dev/validate_ecosystem.py شجرة الأدوات، ويطبّق مجموعات المفاتيح المطلوبة أعلاه، ويُبلِّغ [FAIL] عن أي أداة ينقصها حقل مطلوب. ويُنفِّذ frontmatter-grep العامل عند كل كتابة في src/apothem/conformity/frontmatter_grep.py البنية نفسها عند حدود خطّاف PreToolUse Write/Edit.
اصطلاحات التسمية
تحدّد أسماء الملفات بصيغة kebab-case، وتنسيق مفاتيح frontmatter، وتسمية الفروع بادئات النوع، ودلالات البادئات الرقمية لتسلسلات المُخرَجات المُرتَّبة.
اصطلاحات Markdown
توحيد نكهة Markdown، وبنية العناوين، وإعلانات أسوار الشيفرة، وصيغ الروابط الداخلية، ولافتات الكِتابة، والإنفاذ عبر المُتحقِّقات.