README
¶
wada-kit
The core and window of a native MyGo desktop app, without the app: a plugin kernel, a window shell (title strip, rounded panel, clear or frosted backdrop, light and dark appearance, menus, shortcuts, a SQLite settings store), the palette every pane paints with, a settings page and plugin diagnostics. An app adds its own plugins and contracts on top. Apps consume tagged releases from this independent repository.
| Package | What it is |
|---|---|
kernel |
Plugin lifecycle, services, events, pipelines, extension points, commands, tasks, settings; standard library only |
kernel/kerneltest |
A kernel for tests, with background work and posts the test runs |
contract/shell |
The window's slots (Pages, Strip, TitleBar, Overlays) and shell.Host |
contract/settings |
Settings sections |
shell |
The window host: shell.Run(app, plugins...), and shell.New for tests |
native |
The palette (native.PaletteFor) and small shared controls |
plugins/settings |
The settings page, with Appearance and Plugins |
plugins/inspector |
Plugin diagnostics |
kittest |
A fake shell.Host and the palette guard for an app's tests |
examples/notes |
The smallest app on the kit |
examples/extensions |
A tested, headless two-plugin example of services, topics, pipelines and points |
Notes: kernel API, shell and the kit's plugins. Read the extension guide when plugins need shared contracts. Upgrading from v0.1? Read the v0.2 upgrade guide.
Build a new app
Agents and app authors: start with Build an app. It includes
a generation command, a tested independent starter and an
async document recipe. The starter lives in
examples/starter; Notes remains the smallest API example.
Use
shell.Run(shell.App{Name: "Notes", Folder: "notes", Env: "NOTES", Width: 900, Height: 640},
newNotes, inspector.New, settings.New)
Requires the Go version in go.mod. The desktop packages use MyGo and Onevra;
kernel uses only the standard library. Native checks run on macOS.
The repository is public. Normal Go module downloads need no GitHub credentials,
deploy keys, or GOPRIVATE configuration.
Add the kit to your app:
go get github.com/xleotranx/wada-kit@v0.3.1
An app owns its main.go, plugins, contracts, packaging configuration, bundle
identifier and assets. Give each app its own shell.App.Folder and Env so data
and environment variables are separate. Use examples/notes as a small reference;
go run ./examples/notes runs it from a kit checkout.
The supported dependency combination is pinned in go.mod. Apps that also depend
on MyGo or Onevra should test the versions Go selects in their own module graph.
The shell opens one main window; the palette's clear-window setting is process-wide.
Develop with an app
Keep normal app dependencies on tagged versions. For coordinated local changes, create an uncommitted workspace in a directory containing both repositories:
go work init ./wada-kit ./my-app
Run app tests normally to use the local kit. Run GOWORK=off make check in each
repository to validate its declared dependencies. Do not commit a local replace
or workspace as an app's release dependency.
Maintenance and releases describes ownership, compatibility, consumer access, and the release checks. Changelog records releases.
Check
make check: MyGo lifetime vet, pinned lint (the import boundaries; nothing here
imports an app), race tests, no-cgo tests and generated external-consumer checks.
Checks run locally; this repository has no automated CI workflow.
License
MIT. Third-party dependencies retain their own licenses.
Directories
¶
| Path | Synopsis |
|---|---|
|
contract
|
|
|
settings
Package settings declares the settings page's extension point.
|
Package settings declares the settings page's extension point. |
|
shell
Package shell declares the window's extension points and the host service.
|
Package shell declares the window's extension points and the host service. |
|
examples
|
|
|
extensions
command
Extensions runs a headless two-plugin notebook.
|
Extensions runs a headless two-plugin notebook. |
|
extensions/internal/contract/notebook
Package notebook declares this example's plugin contracts, not kit APIs.
|
Package notebook declares this example's plugin contracts, not kit APIs. |
|
extensions/internal/plugins/notebook
Package notebook owns the example's in-memory notebook capability.
|
Package notebook owns the example's in-memory notebook capability. |
|
extensions/internal/plugins/workspace
Package workspace extends the notebook through its public contracts.
|
Package workspace extends the notebook through its public contracts. |
|
notes
command
Notes is the smallest app built on the kit: one plugin with a page, a command in the menu bar, a saved setting and a settings section, beside the kit's own settings page and inspector.
|
Notes is the smallest app built on the kit: one plugin with a page, a command in the menu bar, a saved setting and a settings section, beside the kit's own settings page and inspector. |
|
starter
command
|
|
|
starter/internal/documents
Package documents owns document access without knowing about plugins or UI.
|
Package documents owns document access without knowing about plugins or UI. |
|
starter/internal/plugins/documents
Package documents connects document access to the kit's lifecycle.
|
Package documents connects document access to the kit's lifecycle. |
|
Package kernel is the app's plugin core: plugin lifecycle, scoped and reversible registration, services, events, pipelines, extension points, background tasks and settings.
|
Package kernel is the app's plugin core: plugin lifecycle, scoped and reversible registration, services, events, pipelines, extension points, background tasks and settings. |
|
kerneltest
Package kerneltest runs a kernel in tests with a controllable UI thread and background queue.
|
Package kerneltest runs a kernel in tests with a controllable UI thread and background queue. |
|
Package kittest helps an app's tests: Host fakes what the shell provides plugins, ColorsStayInThePalette guards the app's colors and PluginsSpawnTheirGoroutines its plugins' goroutines.
|
Package kittest helps an app's tests: Host fakes what the shell provides plugins, ColorsStayInThePalette guards the app's colors and PluginsSpawnTheirGoroutines its plugins' goroutines. |
|
plugins
|
|
|
inspector
Package inspector contributes a read-only page for plugin diagnostics.
|
Package inspector contributes a read-only page for plugin diagnostics. |
|
settings
Package settings is the settings page: appearance, the installed plugins, and every section other plugins contribute to settings.Sections.
|
Package settings is the settings page: appearance, the installed plugins, and every section other plugins contribute to settings.Sections. |
|
Package shell is the native window host.
|
Package shell is the native window host. |