Files
yellowjacket/frontend
logan 5ca6cad45a
Build & publish Arch package / arch-package (push) Successful in 2m8s
CI / check (push) Failing after 1m56s
CI / e2e (push) Skipped
Search index maintenance / maintain-index (push) Successful in 13s
feat(harness): agent-drivable dev harness and CI that gates
A coding agent could develop this repo's Go packages and could not
develop the application: every path to running YellowJacket ended in a
blocking GTK window, so 265 bound methods, 46 events, 33 component
directories and 13 stores had exactly one form of verification
available — `tsc --noEmit`.

The unlock is that `wails dev`'s dev server on :34115 serves the real
frontend with the real generated bindings against the same Go backend a
desktop window attaches to, so a plain Chromium under Xvfb gets a fully
functional app. Four test tiers now exist, cheapest first:

- `make ui-test` — 313 Vitest tests in a real browser in ~2 s, no app,
  no backend, no display. Works because `frontend/wailsjs/` is a pure
  passthrough to `window.go`/`window.runtime`, so faking just those two
  globals runs the real bindings and the real store code.
- `make test` — services in-process, asserting on the payload the
  frontend would receive, via a new `events.Emit` wrapper.
- `make dev-headless` + `playwright-cli` — the real app, driven
  interactively, with an event bridge on `window.__yjEvents` and a
  dev-only control surface at `/__test/`.
- `make e2e` — 19 of those flows frozen as Playwright specs.

`events.Emit(ctx, …)` replaces all 35 direct `runtime.EventsEmit` call
sites: wails' `getEvents` `log.Fatalf`s on any context without its
runtime, so those paths could not run under test and a background
worker could take the app down. Four packages had each hand-rolled the
same guard; nine more guarded on `ctx != nil`, which does not help.
`TestNoDirectRuntimeEmits` fails the build on a new one.

Fixtures are generated, not committed (`make testdata`), and seeds are
built by *running the app* — never by hand-writing config and DB rows,
which would be a second description of a valid YJ_HOME.

`.gitea/workflows/ci.yml` is the first workflow here that tests
anything; the other three only package, so `gitea_ci` reported only
packaging jobs and misled anyone asking whether a push was healthy.
Both jobs were prototyped to green in a bare ubuntu:24.04 container
before the YAML was written, which immediately caught `make lint`
linting three configurations that nothing builds: all three passes
omitted `webkit2_41`, so wails resolved webkit2gtk-4.0 — which Arch
still ships and Ubuntu 24.04 dropped.

Operational instructions live in `.pi/skills/yellowjacket-dev/`,
measured discoveries in `.planning/NOTES.md`, and architecture in
`CLAUDE.md` — split by tense, not by topic, because a topical split
gives every new fact two plausible homes. `make skill-check` fails a
commit if the skill cites a make target that does not exist.
2026-08-10 23:20:42 -04:00
..
2026-02-20 15:22:49 -05:00
2025-03-28 11:43:14 -05:00

YellowJacket Frontend

This directory contains the frontend for YellowJacket.

Dependencies

There are a couple of tools that are required to build and use the frontend.

  • vite for
    • transpiling typescript
    • bundling the final "package" that is useb by the webview
    • running a dev server with hot-reloading
    • configured with the vite.config.ts file in this directory
  • pnpm for managing frontend dependency packages

There are a handful of dependency packages that we use directly in the frontend.

Lastly, there are some dependencies that only benefit development

  • tsserver comes bundled with vscode and can be used as an LSP with other editors using typescript-language-server
    • Used for autocomplete, syntax highlighting, etc.
    • This can be configured with the tsconfig.json file in the root of the project
      • NOTE: your configuration should align with the vite config so you get in-editor feedback that aligns with how the build will be done.

Development

Ideally, you would use the frontend in the wails app as the frontend depends on the Go bindings generated by Wails. You can do this by running wails dev in the root of the YellowJacket repo.

If you want to run the frontend standalone, make sure the Wails go bindings have been generated with wails generate modules. Then, you can run pnpm dev to run the vite dev server. For more information on what commands are available, refer to package.json.

Code

Web Components

Our frontend is based off of Web Components, a standard that provides native browser encapsulation of components that can include HTML, CSS and Javascript all together. Instead of writing these components manually in Javascript, we utilize lit as a wrapper library.

Typescript

To better integrate with our tooling and to provide a better developer experience with strong typing, we have written all functional frontend code in Typescript. Vite serves as our Typescript transpiler.

Important Files and Directories

NOTE: most of these directories have aliases defined in tsconfig.json and vite.config.ts so that we may refer to them by shorthand when importing.

  • index.html and index.js is the entrypoint for the frontend. The first page that loads.
  • wailsjs/go Go code bindings generated by wails reside here
  • wailsjs/runtime the Wails runtime code needed to use Wails features
  • src all app code resides here
  • src/assets static assets like fonts, images and icons
  • src/components lit components that are used to compose the application
  • src/pages pages that serve as other entrypoints for the application that can be navigated to