Repository navigation
Make the example screen runnable and verify it in CI (#13) - #16
Merged
Merged
Conversation
5 tasks
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Files Reviewed (13 files)
Reviewed by efficient · Input: 90K · Output: 7.6K · Cached: 180K |
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.
Problem
At audited main,
my-plugin/plugin.jsondeclared anaventry andscriptbut no top-levelscreenkey, and the repo had noscreen.html. The Host only creates theplugin-my-plugincontainer when the manifest declaresscreen, soscreen.js's root resolved tonulland the advertised counter/settings demo never mounted.READMEstill called it a complete working example, andcustom-checks.ymlpassed without exercising any of it.Changes
my-plugin/screen.html— new screen markup (counter + persisted-color display) exposing thedata-rolehooksscreen.jsqueries.my-plugin/plugin.json— adds"screen": "screen.html"and changestypefrom"visualization"to"utility"(the example is a settings screen, not asetRenderernote-highway renderer).tests/+requirements-dev.txt— pytest suite covering the manifest/screen mount contract and the settings routes: GET defaults, valid-subset POST + persistence toconfig_dir, invalid and unknown values (includingboolrejected whereintexpected), non-object and malformed JSON bodies, and the 16 KiB body limit via both theContent-Lengthfast path and the chunked-stream guard. Tests discover the plugin by scanning forplugin.json, so they survive a rename.custom-checks.yml— now fails when required screen markup or manifest references are missing (declared files exist,screen == "screen.html"because the shipped Host hardcodes that fetch path,nav.screen == "plugin-<id>"), and runspytest.AGENTS.md,CLAUDE.md, andCHANGELOG.mdupdated with exact verification commands, the corrected mount contract, and rename instructions that now call out every hard-codedPLUGIN_ID..gitignore— ignore Python bytecode and pytest caches.Verification
pip install -r requirements-dev.txt pytest -q # 19 passedThe screen contract was verified against the shipped Host source (
plugins/__init__.pyhas_screengate andstatic/js/plugin-loader.jshardcoded/api/plugins/<id>/screen.htmlfetch) and the spec inget-flashbacks/feedback-plugin-spec.big-pickle(free) | 𝕏