docs: add guide for writing custom rules#635
Open
fain182 wants to merge 1 commit into
Open
Conversation
Document how to write a custom Expression: the interface, the ClassDescription accessors available to query a class, an annotated walkthrough of the built-in IsFinal, a from-scratch example with a constructor argument, how to use it in a config, and how to test it. Link it from the README so the extension path is discoverable. Refs #626 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #635 +/- ##
=========================================
Coverage 98.25% 98.25%
Complexity 700 700
=========================================
Files 87 87
Lines 2000 2000
=========================================
Hits 1965 1965
Misses 35 35 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
docs/custom-rules.md, documenting how to extend PHPArkitect by writing your ownExpression— a first-class path, not a workaround.It covers:
Expressioninterface (describe()/evaluate(), plus the optionalappliesTo())ClassDescriptionaccessors available to query a class, with their real return typesIsFinalas a minimal templateHaveAtMostDependencies, a coupling budget) showing a constructor argument and querying dependenciesthat())The two code examples were executed against the real Arkitect classes to confirm they compile and behave as documented.
The README links to the new page so the extension path is discoverable.
Refs #626