docs: recommend JSON output for new plugins, add kitchen-sink example - #125
Merged
Conversation
Steer new-plugin authors toward the structured JSON format across the
README, docs pages, and SDK/plugin READMEs, keeping the text protocol
fully documented as the xbar/SwiftBar compatibility format.
Add plugins/showcase/kitchen-sink.1m.sh — a zero-dependency bash plugin
emitting one {"vee":1} object that exercises every JSON field (titles,
colors, sfimage, href, shell, submenu, alternate, sparkline, progress,
toggle, slider, chart) — linked from the docs with a download one-liner.
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
1 participant
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
getting-started,plugin-authoring,json-output,writing-plugins-with-an-llm,sdk,migrating-from-swiftbar), and the SDK/plugin READMEs. The text protocol stays fully documented as the xbar/SwiftBar compatibility format.plugins/showcase/kitchen-sink.1m.sh: a zero-dependency, download-and-run bash plugin emitting one{"vee":1}object that exercises every JSON field — multi-line titles, colors/sfimage/size, header, href, shell action (say, honestly declared via<vee.exec>), refresh, disabled, checked, tooltip, separators, 3-level submenu, ⌥-alternate, sparkline, progress, toggle, slider, donut chart.Verification
swift run vee render plugins/showcase/kitchen-sink.1m.sh— every row decodes and renders (nesting, alternate, all accessories).swift run vee lint plugins/showcase/kitchen-sink.1m.sh— no findings.