Repository navigation
Add case studies on Bagisto, Advising App and LaravelEcomm - #6
Open
ChrisAbner wants to merge 1 commit into
Open
ChrisAbner wants to merge 1 commit into
ChrisAbner wants to merge 1 commit into
Conversation
Cordon ran on three open source Laravel apps, one per supported module structure: Bagisto (namespaces), Advising App (InterNACHI/modular) and LaravelEcomm (nwidart/laravel-modules). All 2,858 internal_access reports were checked by machine (the line contains the class, the class is declared in the reported module) and sampled by hand. No false positives. Each page gives the commit analysed, the numbers with the default config and with the public API the app already uses declared, the configuration, and the coupling that remains, with code. Bagisto's purchase-flow diagram is rendered from cordon:docs output.
This branch has not been deployed
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
A new Case studies section in the docs site, linked from the nav, the sidebar and the README:
case-studies/index.md: overview, findings across the three apps, how the public API was declared, how to reproduce.case-studies/bagisto.md(namespaces, 42 packages): 919 → 158internal_accessafter declaring the shared kernel, repositories, facades and Concord proxies. It covers order status constants,OrderResourceused by every payment gateway, thePaymentextension point,Salesdepending onShop, and a purchase-flow diagram with two cycles.case-studies/advisingapp.md(InterNACHI/modular, 37 modules):StudentandProspecttake 28% of the reports even though anEducatablecontract already exists.case-studies/laravelecomm.md(nwidart/laravel-modules, 29 modules):Coreas a shared kernel (379 reports), what remains, and cycles created by Eloquent relations on both sides.How the numbers were checked
internal_accessreports were checked by machine. The reported line contains the class or its alias, and the class is declared in the reported module. 0 mismatches.Check before merging
The pages describe third-party projects in public. The tone aims to be factual ("snapshots, not judgments"), but please read them as their maintainers would.
npm run buildindocs-sitepasses, with no dead links.