8000 chore: onboard backend-quality-suite for jikan by irfan-dahir · Pull Request #603 · jikan-me/jikan · GitHub
[go: up one dir, main page]

Skip to content

chore: onboard backend-quality-suite for jikan - #603

Merged
irfan-dahir merged 1 commit into
5.0.0from
chore/backend-suite-onboarding
Oct 11, 2026
Merged

irfan-dahir merged 1 commit into
5.0.0from
chore/backend-suite-onboarding

Conversation

@irfan-dahir
Copy link
Copy Markdown
Collaborator

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-project flow: 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

File Content
profile.json php adapter, src/ source root, test/unit test root, framework/audience declared; all 13 fields carry provenance + verifiedAgainst commit 905813a (the 5.0.0 tip)
docs.manifest.json entry-point and api → readme.md (the library's only authored doc of its public surface)
arch-rules.json errorHandling (Jikan exception hierarchy, HttpClientWrapper as the single outbound funnel) and testNetworkCoupling configured; app-shape sections deliberately absent so those audits refuse (exit 2) instead of reporting a confident zero
exceptions.json BadResponseException/ParserException exempted from the screen-shaped dead-state check, with written reasons
survey.json, hooks.map.json, known-traps.json, schema + .gitignore scaffolded by the suite

Audit posture (verified via repo-health)

  • error_handling — ✅ clean (388 files)
  • test_network_coupling — 🟡 1 real finding: test/unit/HttpFilesystemCacheClientCallback.php:34 builds a live HttpClient::create() when a recording is missing, so a checkout that skips composer link-fixtures runs the suite against the live site while looking offline. Not fixed here — the suite reports, humans decide.
  • 14 audits — ⚪ refuse honestly (unconfigured / not applicable to a library)

Notes for reviewers

  • The two exception exemptions are a judgment call (the audit's instanceof-consumption model is screen-shaped and doesn't describe how a library's exceptions are consumed). Worth a second pair of eyes.
  • layerBoundaries is deliberately off: jikan's Model ↔ Parser layers import each other ~120 files both ways, so a clean rule can't be proposed yet.

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.
@irfan-dahir
irfan-dahir merged commit 85bed3b into 5.0.0 Oct 11, 2026
3 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

0