mirror of
https://github.com/got-feedBack/feedBack.git
synced 2026-07-22 21:01:40 +00:00
af2949677a
* Update GitHub repo references from feedback* to feedBack* * rename: slopsmith -> feedBack, byron -> got-feedBack Renames across the entire codebase: - slopsmith/Slopsmith/SLOPSMITH/SlopSmith -> feedBack/FeedBack/FEEDBACK/FeedBack - byron/Byron/Byrongamatos -> got-feedBack/got-feedBack/got-feedBack - /home/byron/ -> /opt/got-feedBack/ - byron@ougsoft.com -> hi@got-feedBack.org - github.com/byrongamatos/ -> github.com/got-feedback/ - com.byron. -> com.got-feedback. - SLOPSMITH_ env vars -> FEEDBACK_ with backward-compat fallback - Protocol/storage strings migrated with read-old/write-new pattern - window.slopsmith JS API -> window.feedBack (canonical) + backward-compat alias Refs: #rename-slopsmith * rename: complete regen against current main + fix backward-compat alias Regenerated the slopsmith->feedBack / byron->got-feedBack rename on top of current main (3 commits had landed since the branch: #572/#554/#574), resolving the four content conflicts in favour of main's newer content (autoplay/auto-exit, accuracy-badge, Virtuoso re-home, feedpak badge). Completion fixes on top of the mechanical rename: - Re-apply rename to post-branch content the original rename never saw: window.slopsmith(.Tour) consumers in lessons.js / notifications.js / onboarding-tour.js, and the matching JS + python tests (autoplay_exit, progression_*, test_feedpak_extension FEEDBACK_* env vars). The test env vars now match server.py (which reads FEEDBACK_SYNC_STARTUP / FEEDBACK_SKIP_STARTUP_TASKS), so the sync-startup test exercises the real path again. - Restore the window.slopsmith backward-compat alias dropped during conflict resolution, and move the bus aliases to AFTER the _feedBackExisting merge block so they reference the fully-assembled object (also fixes the loop_api.test.js API-surface regex, which the original PR latently broke). - Drop the stray empty data/web_library.db (runtime DB lives in CONFIG_DIR) and gitignore it. - Fix stale tone-source test: feed[dB]ack -> fee[dB]ack to match shipped source labels. Verified locally (org CI billing-blocked): JS 819/819 pass; pytest 1669 passed / 1683 collected with 0 import errors; zero residual slopsmith/byron except the two intentional window.slopsmith aliases. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * rename: implement advertised backward-compat + prune dead community plugins Address gaps where PR #537's "Backward compatibility" section was advertised but not implemented, and clean up the community plugin list. Env vars (FEEDBACK_* canonical, legacy SLOPSMITH_* honoured): - New lib/env_compat.py (getenv_compat / env_flag_compat) + tests. server.py (_env_flag + all FEEDBACK_* reads), diagnostics_hardware, gp2midi and tailwind_rebuild now resolve the legacy alias, so existing SLOPSMITH_UI / SLOPSMITH_PLUGINS_DIR / etc. deployments keep working. - Fix the rename collapsing plugins/__init__.py and minigames/routes.py from `FEEDBACK_PLUGINS_DIR or SLOPSMITH_PLUGINS_DIR` into a redundant `FEEDBACK_ or FEEDBACK_` (the fallback was silently lost). Storage (app.js update-channel): - Read feedBack-update-channel, fall back to legacy slopsmith-update-channel, and clear the legacy key on write — so a user's update-channel preference survives the rename instead of resetting to "stable". Community plugin list (README): the rename rewrote third-party repo URLs we don't own. Probed every one; their owners never renamed, so: - Restore the 13 live community plugins to their real slopsmith-* names. - Prune 6 that are 404 to the public (topkoa splitscreen/stems, OmikronApex tuner, Jafz2001 nam-rig-builder, DeathlySin song-preview, Erikcb91 shuffle). - Fix a pre-existing Guitar Theory clone-command typo (nam-tone -> guitar-theory). Verified: env_compat 7/7, JS 819/819, pytest 1690 collected / 0 import errors, rename-sensitive + startup suites green. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: byrongamatos <xasiklas@gmail.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
143 lines
5.6 KiB
Markdown
143 lines
5.6 KiB
Markdown
# Plugin styling — the `styles` capability
|
|
|
|
> Building for the redesigned **v3 UI** (`FEEDBACK_UI=v3` / `/v3`)? v3 uses `fb-*`
|
|
> design tokens and a restructured player chrome with a dedicated plugin-control
|
|
> slot. See **[plugin-v3-ui.md](plugin-v3-ui.md)** for the player-chrome contract
|
|
> plugins must follow in v3.
|
|
|
|
FeedBack serves Tailwind as a **prebuilt** stylesheet
|
|
(`static/tailwind.min.css`), never the runtime Play CDN. The CDN's on-the-fly
|
|
JIT rescanned the DOM on the main thread and dropped ~26% of frames with the 3D
|
|
highway running (feedBack-desktop#110). See **constitution Principle II**.
|
|
|
|
A prebuilt stylesheet only contains the classes the build scanner saw in **core
|
|
source at core build time**. That has a consequence for plugins:
|
|
|
|
- Core's build scans bundled plugins on disk, but **a plugin installed at
|
|
runtime** (community / NAS) was never scanned. Its classes — especially
|
|
arbitrary values like `text-[11px]`, `grid-cols-[1fr_auto]`,
|
|
`shadow-[0_0_8px_rgba(0,0,0,.5)]` — are **absent** from the served CSS, so its
|
|
UI renders unstyled.
|
|
|
|
The `styles` capability fixes this: your plugin ships its **own** compiled
|
|
stylesheet and declares it in the manifest. The frontend injects one versioned
|
|
`<link rel="stylesheet">` into `<head>` when your plugin activates, covering both
|
|
your screen and your settings panel.
|
|
|
|
> You only need this if you use Tailwind classes that aren't guaranteed in core —
|
|
> in practice, **any arbitrary-value class** (`w-[37px]`), or a custom class core
|
|
> doesn't ship. If you use only common core utilities (`flex`, `p-4`,
|
|
> `text-gray-300`, `bg-dark-600`), you can omit `styles` and rely on core's CSS.
|
|
|
|
## 1. Declare it in `plugin.json`
|
|
|
|
```json
|
|
{
|
|
"id": "my_plugin",
|
|
"name": "My Plugin",
|
|
"version": "1.2.0",
|
|
"screen": "screen.html",
|
|
"script": "screen.js",
|
|
"styles": "assets/plugin.css"
|
|
}
|
|
```
|
|
|
|
`styles` is a **plugin-root-relative path that must live under `assets/`** (like
|
|
`screen`/`script`/`routes` are root-relative). It serves through the sandboxed
|
|
`/api/plugins/<id>/assets/...` route, so the file must be at
|
|
`<plugin>/assets/plugin.css`. The injected `<link>` is cache-busted with
|
|
`?v=<version>`, so **bump your manifest `version`** whenever you rebuild the CSS,
|
|
or browsers may serve a stale copy within a session.
|
|
|
|
## 2. Build the stylesheet — utilities only, `preflight: false`
|
|
|
|
Core already ships Tailwind's base reset (preflight) once. Your plugin must
|
|
**not** re-apply it, or it would double the reset and fight core's styles. Build
|
|
with `corePlugins: { preflight: false }` so your sheet emits **only the utility
|
|
classes your files use**.
|
|
|
|
`tailwind.config.js` (in your plugin repo):
|
|
|
|
```js
|
|
/** Plugin stylesheet build — utilities only, scanned from this plugin's files.
|
|
* Regenerate assets/plugin.css with: bash build-tailwind.sh */
|
|
module.exports = {
|
|
corePlugins: { preflight: false }, // core owns the single base reset
|
|
content: [
|
|
'./screen.js',
|
|
'./settings.html',
|
|
'./screen.html',
|
|
// add any other file that carries Tailwind classes (e.g. './tour.json')
|
|
],
|
|
theme: {
|
|
extend: {
|
|
// Re-declare any core theme tokens you reference so they compile here.
|
|
colors: {
|
|
dark: { 900: '#050508', 800: '#0a0a12', 700: '#10101e', 600: '#181830', 500: '#1e1e3a' },
|
|
accent: { DEFAULT: '#4080e0', light: '#60a0ff', dark: '#2060b0' },
|
|
gold: '#e8c040',
|
|
},
|
|
fontFamily: { display: ['"Inter"', 'system-ui', 'sans-serif'] },
|
|
},
|
|
},
|
|
// Mirror only the dynamically-built classes your code generates at runtime
|
|
// (Tailwind can't see them textually). Drop this if you have none.
|
|
safelist: [
|
|
{ pattern: /^(bg|text|border)-(dark|accent)(-.+)?$/ },
|
|
],
|
|
plugins: [],
|
|
};
|
|
```
|
|
|
|
Input CSS — **`@tailwind utilities;` only** (no `@tailwind base`, that's the
|
|
preflight you're disabling):
|
|
|
|
`_plugin.src.css`:
|
|
|
|
```css
|
|
@tailwind utilities;
|
|
```
|
|
|
|
Build script `build-tailwind.sh` (run at your plugin's release time — the output
|
|
is committed; end users never build):
|
|
|
|
```bash
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
cd "$(dirname "$0")"
|
|
# Pin the same Tailwind 3.x core uses so output stays diff-stable.
|
|
exec npx -y tailwindcss@3.4.19 \
|
|
-c tailwind.config.js \
|
|
-i _plugin.src.css \
|
|
-o assets/plugin.css \
|
|
--minify
|
|
```
|
|
|
|
```bash
|
|
bash build-tailwind.sh # writes assets/plugin.css — commit it
|
|
```
|
|
|
|
## 3. Rules (inherited from the constitution)
|
|
|
|
- **No Play CDN, no runtime CSS JIT** — anywhere, ever. Same rule that binds core.
|
|
- **`preflight: false`** — utilities only; core ships the one base reset.
|
|
- **`styles` under `assets/`** — it serves through the sandboxed asset route;
|
|
`..`, absolute paths, and NUL bytes are rejected by `safe_join`.
|
|
- **Bump `version` on every CSS rebuild** so the `?v=` cache-buster fetches fresh.
|
|
- Plugins without `styles` are unaffected and inject no `<link>`.
|
|
|
|
## How it works (for reference)
|
|
|
|
- The loader derives a manifest-only `has_styles` boolean and passes the `styles`
|
|
path through to `/api/plugins` — no plugin code is imported
|
|
(`plugins/__init__.py::_nav_entry`).
|
|
- The frontend (`static/app.js::_injectPluginStyles`) injects one
|
|
`<link rel="stylesheet" data-plugin-id data-plugin-version
|
|
href="/api/plugins/<id>/assets/plugin.css?v=<version>">` (the `styles` value —
|
|
e.g. `assets/plugin.css` — appended to `/api/plugins/<id>/`) into `<head>`, **before** the
|
|
screen markup so styles are present on first paint. It's deduped by version: a
|
|
plugin upgrade swaps the old `<link>` for the new one; re-activation never piles
|
|
up duplicates.
|
|
- The stylesheet is served by the existing
|
|
`/api/plugins/<id>/assets/<path>` route as `text/css`.
|