Skip to content

plugin store: add opt-in preview flag to plugin introspect - #1260

Open
reptil1990 wants to merge 2 commits into
tobychui:mainfrom
reptil1990:feature/plugin-store-preview-flag
Open

plugin store: add opt-in preview flag to plugin introspect#1260
reptil1990 wants to merge 2 commits into
tobychui:mainfrom
reptil1990:feature/plugin-store-preview-flag

Conversation

@reptil1990

Copy link
Copy Markdown

The app store derives the "Preview" tag solely from a missing icon.png, so a finished plugin without an icon is flagged as preview and a plugin cannot deliberately mark itself as preview.

Add an optional preview boolean to the plugin IntroSpect. The field is needed on the Go struct so the flag survives the JSON round-trip into the store frontend. The existing missing-icon fallback stays for backward compatibility.

The app store derives the "Preview" tag solely from a missing icon.png,
so a finished plugin without an icon is flagged as preview and a plugin
cannot deliberately mark itself as beta.

Add an optional preview boolean to the plugin IntroSpect. The field is
needed on the Go struct so the flag survives the JSON round-trip into
the store frontend. The existing missing-icon fallback stays for
backward compatibility.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Add the Preview field to the IntroSpect structure in the plugin docs and
describe when to set it. Regenerated the corresponding html page with
docs/plugins build.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an explicit, opt-in preview flag to plugin introspection metadata so the plugin store can display a “Preview” tag even when a plugin ships with an icon (while keeping the existing missing-icon fallback for backward compatibility).

Changes:

  • Extend the Go IntroSpect struct with an optional preview boolean (json:"preview,omitempty").
  • Update the app store UI logic to treat PluginIntroSpect.preview === true as “Preview” in addition to the missing-icon placeholder check.
  • Update introspect documentation (Markdown + generated HTML) to describe the new field and refresh the “Last Update” date.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
src/web/components/appstore.html Uses PluginIntroSpect.preview to drive the “Preview” tag, keeping the placeholder-icon fallback.
src/mod/plugins/zoraxy_plugin/zoraxy_plugin.go Adds Preview bool \json:"preview,omitempty"`` to preserve the flag through JSON unmarshal/marshal.
docs/plugins/html/2. Architecture/2. Introspect.html Documents the new preview field and updates the page date.
docs/plugins/docs/2. Architecture/2. Introspect.md Documents the new preview field and updates the page date.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@tobychui tobychui left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, will be adding this in next rc-1 (release candidate specifically for new feature integrations)

@reptil1990

Copy link
Copy Markdown
Author

Tonight I will look into the plugin-repo to see if there are changes necessary but i think so.

@AnthonyMichaelTDM AnthonyMichaelTDM left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@AnthonyMichaelTDM

Copy link
Copy Markdown
Collaborator

Tonight I will look into the plugin-repo to see if there are changes necessary but i think so.

Yeah you'll need to make the dirupdate2 tool in the plugin store repo fill out the field, and then regenerate the index

@reptil1990

Copy link
Copy Markdown
Author

Tonight I will look into the plugin-repo to see if there are changes necessary but i think so.

Yeah you'll need to make the dirupdate2 tool in the plugin store repo fill out the field, and then regenerate the index

Yeah I thought so.. it is already in:
‎tools/dirupdate/mod/zoraxy_plugin/zoraxy_plugin.go

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.

4 participants