waybetter 0.5.0: docs for the host's page commands, the runtime composition, the i18n command and dev-tools
This commit is contained in:
parent
e1aa2631d9
commit
f99b8e6755
5 changed files with 70 additions and 11 deletions
|
|
@ -50,6 +50,10 @@ pieces. The source comments document each module's contract.
|
|||
**Runtime**
|
||||
|
||||
- `accountReport`: reports the signed-in account seen in the page's own UI.
|
||||
- `siteRuntime`: composes a runtime entry: `pageInvoke`, `createFeatureFlags` (flag-controlled parts, a deck column's overrides), `installSiteRuntime` (the runtime object under `window.wayBetter` and the app's names, the members native code calls, queued native deliveries, the palette command report).
|
||||
- `pageStrings`: the page's language (English built in; native deliveries are checked as data).
|
||||
- `panelButton`: the way into the app's panel from the page: the adapter's navigation entry, or a floating button.
|
||||
- `commandReport`: reports plugin palette commands to the shell; developer-mode start errors.
|
||||
- `column`: a site tab as a narrow deck column: hides the site's chrome, lets its content fill the width, per-column filters (keywords, `/regex/`, replies, reposts, media only) and an unread count from what the site rendered. Makes no requests.
|
||||
- `domHub`: one `MutationObserver` and one animation frame shared by every DOM feature.
|
||||
- `linkRouting`: routes clicks on the app's own links per the "links to app pages" setting.
|
||||
|
|
@ -108,6 +112,8 @@ const Shell = createShell({ ...site, panel: { id: 'app', title: 'wayBetter', com
|
|||
|
||||
- `waybetter store build --config store.config.mjs`: builds an app's part of the shared store folder (its items only, validated with the apps' own rules).
|
||||
- `waybetter store sign [--init] --key <private key>` / `waybetter store verify --pub <key file>`: Ed25519 signature over the exact catalog bytes; any listed public key verifies (rotation). The private key is never printed or copied.
|
||||
- `waybetter i18n check [--write] [--verbose] [locale…]`: checks an app's catalogs (and the framework's in the same languages) with the `waybetter/i18n/check` rules, bundled plugins' inline English and the generated files; `--write` regenerates `languages.json` and the native localization files (macOS, Linux). `waybetter i18n extract [--missing]`: keys the code looks up that English lacks, and English keys without a literal lookup. Both read `waybetter.i18n.json` in the app's root (`locales`, `sources`, `nativeSources`, `bundledPlugins`, `runtimeKeys`, `native`).
|
||||
- `windows/languages/<Language>.nsh`: the Windows installer's messages for the languages Tauri does not ship, next to the installer template (`windows/installer.nsi`).
|
||||
|
||||
## Plugin UI kit (`runtime/ui`)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "waybetter",
|
||||
"version": "0.4.0",
|
||||
"version": "0.5.0",
|
||||
"license": "GPL-3.0-or-later",
|
||||
"type": "module",
|
||||
"description": "wayBetter: the framework for apps that run the apps you already use in a light native (Tauri) window and extend them in place. Page runtime (DOM/request hubs, plugins, plugin UI kit with themed dialogs and toasts, theme API and theme JSON Schema, theme color model, link routing, account reporting, deck columns, i18n: ICU-lite messages, locale fallback, plugin strings, catalog checks and JSON Schemas), shell models (address bar, panes, decks, profiles, palette, updates), the shell frame (createShell: tabs, splits, address bar, titlebar, palette, account switcher, decks, workspaces, overlays, the language state; React + dockview peers), the panel (createPanel: an app's own tab with Appearance and the Theme Builder, plugins and custom CSS, the Store, Make, accounts, settings, backup and sync, developer mode, updates; the app adds its sections) and the Store: install screen and Store view React components (optional React peer), their state and catalog models, the store catalog JSON Schema and the `waybetter store build|sign|verify` command, `waybetter release windows|macos` (signed native releases and the update manifest, configured by waybetter.release.json) and `waybetter/build` (the page runtime bundle, with an optional esbuild peer). No dependencies.",
|
||||
|
|
@ -186,6 +186,7 @@
|
|||
"./store-catalog.schema.json": "./store-catalog.schema.json",
|
||||
"./cli/store": "./cli/store.mjs",
|
||||
"./cli/release": "./cli/release.mjs",
|
||||
"./cli/i18n": "./cli/i18n.mjs",
|
||||
"./build": "./build/runtime.mjs",
|
||||
"./package.json": "./package.json"
|
||||
},
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue