Skip to content

docs: expand rules reference with signatures and per-rule TOC#634

Merged
fain182 merged 1 commit into
mainfrom
docs/expand-rules-reference-626
Jun 30, 2026
Merged

docs: expand rules reference with signatures and per-rule TOC#634
fain182 merged 1 commit into
mainfrom
docs/expand-rules-reference-626

Conversation

@fain182

@fain182 fain182 commented Jun 30, 2026

Copy link
Copy Markdown
Collaborator

What

Expands docs/rules.md so it is self-contained and easier to consult (both for humans searching for a rule and for LLM coding agents generating a phparkitect.php).

For every rule:

  • a one-line description of when it raises a violation
  • the constructor signature (read from src/Expression/ForClasses/, not from memory)
  • documentation for the previously opaque optional arguments — the $exclude allow-lists on DependsOnlyOnTheseNamespaces / NotDependsOnTheseNamespaces and $externalDependenciesToExclude on NotHaveDependencyOutsideNamespace

Also:

  • a new Imports section with the base use statements and the rule that every expression lives under Arkitect\Expression\ForClasses (the file had zero imports before, so a reader landing only on this page couldn't write working code)
  • a two-level table of contents linking every individual rule (anchors verified against the headings)

The existing examples are preserved.

Refs #626

Each rule now documents its constructor signature (taken from source),
a one-line description of when it raises a violation, and the previously
opaque optional arguments (e.g. the exclude/allow-list parameters).

Adds an Imports section so the file is self-contained, and expands the
table of contents to link every individual rule.

Refs #626

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@codecov

codecov Bot commented Jun 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.25%. Comparing base (ea0897d) to head (9b46b83).
⚠️ Report is 15 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##               main     #634   +/-   ##
=========================================
  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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@fain182 fain182 merged commit 80efb6e into main Jun 30, 2026
34 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant