नियम लिखना

नियम src/apothem/rules/ में .md एक्सटेंशन वाली Markdown फ़ाइलें हैं।

नियम फ़्रंटमैटरCopy Anchor Link

---
name: "..."
description: "..."
pathFilter: ""            # empty string for always-on; a glob for path-filtered
alwaysApply: true         # true for always-on; false for path-filtered
---

नियम के दायरेCopy Anchor Link

नियम का दायरा दो फ़्रंटमैटर फ़ील्ड, alwaysApply और pathFilter, से तय होता है:

पाँच शिप किए गए नियम हमेशा-चालू हैं: agnostic-posture, authority-inquiry, session-closure, context-management, और नियम सूचकांक। हमेशा-चालू नियम हर सत्र में संदर्भ खर्च करता है, इसलिए नए नियम को (SHOULD) पथ-फ़िल्टर्ड होना चाहिए, ऐसे ग्लोब के साथ जो उन फ़ाइलों को नामित करें जिन्हें वह नियंत्रित करता है; केवल ** का फ़िल्टर कुछ भी सीमित नहीं करता, और Claude Code उस नियम को हमेशा-चालू नियम की तरह लॉन्च पर लोड करता है। शिप किया गया कॉर्पस हमेशा-चालू सेट को उसी सूची और एक बाइट सीमा तक सीमित रखता है; हमेशा-चालू में पदोन्नत किया गया नियम उसी परिवर्तन में दोनों को बदलता है। आप जो भी नियम जोड़ें, उसे नियम सूचकांक (apothem-rule-index) में नामित करें, ताकि ऐसे हार्नेस पर चलने वाला सत्र भी उसे ढूँढ ले जो नियमों को पथ के अनुसार सीमित नहीं करता। एक सहयोगी नियम (<parent>-<aspect>) अपने पैरेंट का pathFilter, या उससे संकरा कोई फ़िल्टर, लेता है, ताकि वह अपने पैरेंट के बिना कभी लोड न हो। अपने किसी नियम को apothem-rule-index नाम न दें: इंस्टॉल उस नाम वाली नियम फ़ाइल का बैकअप लेकर उसे अधिलेखित कर देता है।

उदाहरण नियमCopy Anchor Link

---
name: "python-conventions"
description: "Python style conventions for this project"
pathFilter: "**/*.py"
alwaysApply: false
---

# Python conventions

- Use type annotations on all public functions.
- Maximum line length: 88 characters.
- Prefer explicit over implicit.

नियमों को हार्नेस पर लागू करनाCopy Anchor Link

नियम लिखने के बाद, इंस्टॉल किए गए हर हार्नेस अडैप्टर को अपडेट करें। इंस्टॉल किए गए सेट को देखने के लिए apothem harnesses list चलाएँ, फिर हर हार्नेस के लिए एक बार update कॉल करें:

apothem update --harness claude-code
apothem update --harness cursor --project /path/to/project

प्रोजेक्ट-स्कोप हार्नेस को update पर --project चाहिए, जैसा कि दूसरी पंक्ति में है; उपयोगकर्ता-स्कोप हार्नेस को नहीं।

नियम सत्यापनCopy Anchor Link

आपने जो नियम फ़ाइल लिखी है, उस पर फ़्रंटमैटर वैलिडेटर चलाएँ। Apothem चेकआउट से, PYTHONPATH=src पैकेज को आयात-योग्य बनाता है; स्क्रिप्ट इंस्टॉल के बाद, उसकी जगह PYTHONPATH="$HOME/.apothem/src" का उपयोग करें।

PYTHONPATH=src python -m apothem.conformity.gate --check frontmatter-grep src/apothem/rules/<rule>.md

frontmatter-grep जैसी प्रति-लेखन जाँच जाँचने के लिए फ़ाइल लेती है, या मानक इनपुट से सामग्री पढ़ने के लिए --stdin; दोनों में से कोई न होने पर वह मानक इनपुट पर इनपुट की प्रतीक्षा करती है। स्टैंडअलोन जाँच इसके बजाय एक रूट डायरेक्टरी लेती है, जैसे --check naming-grep .।