Repository navigation
chore: onboard backend-quality-suite for jikan - #603
Merged
Merged
Conversation
Apply the backend-quality-suite plugin (irfan-dahir/backend-quality-suite) as jikan's first real consumer, following the suite's understand-existing- project flow (survey -> init --from-survey -> propose-config -> doctor). - profile.json: php adapter, src/ as source root, test/unit as test root, framework + audience declared, provenance recorded for all 13 fields (verified against commit 905813a on the 5.0.0 line). - docs.manifest.json: entry-point and api both mapped to readme.md (the library's only authored doc of its public surface). - arch-rules.json: errorHandling (Jikan exception hierarchy, HttpClientWrapper funnel) and testNetworkCoupling configured; app-shape sections absent so those audits refuse (exit 2) rather than report a confident zero. - exceptions.json: BadResponseException/ParserException exempted from the screen-shaped dead-state check, with written reasons. Audit posture: error_handling clean; test_network_coupling reports one real finding (HttpFilesystemCacheClientCallback falls back to a live HttpClient when a recording is missing); 14 audits refuse honestly as unconfigured.
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.
Summary
Applies the backend-quality-suite plugin (an API-contract / error-shape / doc-staleness auditing suite) as jikan's first real consumer, following its
understand-existing-projectflow: survey →init --from-survey→propose-config→doctor.No source code or tests are touched — this is pure configuration (
.backend-suite/).What's in the PR
profile.jsonphpadapter,src/source root,test/unittest root, framework/audience declared; all 13 fields carry provenance +verifiedAgainstcommit905813a(the 5.0.0 tip)docs.manifest.jsonentry-pointandapi→readme.md(the library's only authored doc of its public surface)arch-rules.jsonerrorHandling(Jikan exception hierarchy,HttpClientWrapperas the single outbound funnel) andtestNetworkCouplingconfigured; app-shape sections deliberately absent so those audits refuse (exit 2) instead of reporting a confident zeroexceptions.jsonBadResponseException/ParserExceptionexempted from the screen-shaped dead-state check, with written reasonssurvey.json,hooks.map.json,known-traps.json, schema +.gitignoreAudit posture (verified via
repo-health)error_handling— ✅ clean (388 files)test_network_coupling— 🟡 1 real finding:test/unit/HttpFilesystemCacheClientCallback.php:34builds a liveHttpClient::create()when a recording is missing, so a checkout that skipscomposer link-fixturesruns the suite against the live site while looking offline. Not fixed here — the suite reports, humans decide.Notes for reviewers
instanceof-consumption model is screen-shaped and doesn't describe how a library's exceptions are consumed). Worth a second pair of eyes.layerBoundariesis deliberately off: jikan's Model ↔ Parser layers import each other ~120 files both ways, so a clean rule can't be proposed yet.