Title: Plugin metadata: let plugins declare name, description, and required config (export const meta) · Issue #615 · JavaScriptSolidServer/JavaScriptSolidServer · GitHub
Open Graph Title: Plugin metadata: let plugins declare name, description, and required config (export const meta) · Issue #615 · JavaScriptSolidServer/JavaScriptSolidServer
X Title: Plugin metadata: let plugins declare name, description, and required config (export const meta) · Issue #615 · JavaScriptSolidServer/JavaScriptSolidServer
Description: Composability testing across the plugins collection (33 plugins) surfaced a pattern: the loader knows almost nothing about a plugin until activate() is already running, so every mismatch is discovered by crashing. Observed while trial-co...
Open Graph Description: Composability testing across the plugins collection (33 plugins) surfaced a pattern: the loader knows almost nothing about a plugin until activate() is already running, so every mismatch is discove...
X Description: Composability testing across the plugins collection (33 plugins) surfaced a pattern: the loader knows almost nothing about a plugin until activate() is already running, so every mismatch is discove...
Opengraph URL: https://github.com/JavaScriptSolidServer/JavaScriptSolidServer/issues/615
X: @github
Domain: github.com
IPv4 address: 140.82.112.3
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Plugin metadata: let plugins declare name, description, and required config (export const meta)","articleBody":"Composability testing across the plugins collection (33 plugins) surfaced a pattern: the loader knows almost nothing about a plugin until `activate()` is already running, so every mismatch is discovered by crashing.\n\nObserved while trial-composing on one server:\n\n- **20 of 33 plugins hard-require config** (18 need `config.baseUrl`; `terminal` correctly refuses to boot an open shell without auth config). The only way to discover this is to boot and read the throw — and boot is fail-closed, so one missing config key = no server. It took four boot attempts to find a 13-plugin set that co-loads (which then ran conflict-free — isolation is in good shape; discoverability is the gap).\n- **Identity is inferred, not declared** — #614: the id comes from path heuristics, which the `pod/plugin.js` app-repo layout defeats.\n- The roster (`api.plugins`) carries only `{ id, prefix, module }`, so meta-plugins like `admin`/`dashboard` can enumerate siblings but can't describe them.\n\n**Proposal: an optional exported `meta` object** that plugins declare and the loader reads before calling `activate()`:\n\n```js\nexport const meta = {\n name: 'gamestr', // stable id — solves #614 explicitly, no path heuristics\n description: 'Points system: bump / day aggregation / stream over hour files',\n version: '0.1.0',\n jss: '>=0.0.219', // engine compat range\n config: { // declared config surface\n baseUrl: { required: true, description: 'Public origin for absolute URLs in feeds/JRDs' },\n token: { required: false, description: 'Shared secret for privileged routes' },\n },\n}\n```\n\nLoader behavior, all backwards-compatible (no `meta` = exactly today's behavior):\n\n1. **Pre-activate validation** — required config missing produces one precise boot error naming the plugin, the key, and its description (instead of whatever the plugin's own throw says), or a skip-with-warning if a lenient mode ever exists.\n2. **`meta.name` wins over path derivation** for the id — fixes #614 without guessing at generic directory names.\n3. **Roster enrichment** — `api.plugins` entries carry `description`/`version`, so `admin` and `dashboard` can render a real catalog.\n4. **Downstream, not now:** a declared-metadata convention is the enabler for an install story (`jspod install \u003crepo>` reading the meta before mounting) and compat checks — WordPress's plugin header (`Plugin Name: … Requires at least: …`) is the 20-year precedent: that one convention made its directory, installer, and compatibility matrix possible.\n\nAlternatives considered: a WordPress-style comment header (parseable without importing the module — nice for registries, but the loader imports anyway) or a `plugin.json` sidecar (keeps metadata out of code, but splits the plugin across two files). The exported object is the most natural fit for ESM and is trivially optional.\n\nDeliberately filed as a marker/discussion, not a mandate — plugin conventions are still in an experimentation phase and this should be shaped by more plugin-building experience.\n","author":{"url":"https://github.com/melvincarvalho","@type":"Person","name":"melvincarvalho"},"datePublished":"2026-07-12T01:07:59Z","url":"https://github.com/JavaScriptSolidServer/JavaScriptSolidServer/issues/615"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:370d05a3-7eeb-a26b-4fe0-57eda51ab3de |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8350:C707B:E127A8:11DFC66:6B037D44 |
| html-safe-nonce | eeaebc83dea9b62285074b736960322ff270fb600effc3e8e20bbdeafe19258d |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4MzUwOkM3MDdCOkUxMjdBODoxMURGQzY2OjZCMDM3RDQ0IiwidmlzaXRvcl9pZCI6IjY2NjU5NzY0NzE0MDE3NTgwMjAiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 5f94f674ede5bb6baa3d3d365d1253a6ca9505b02cfcb1be9cfb58592a880541 |
| hovercard-subject-tag | issue:4864873214 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/JavaScriptSolidServer/JavaScriptSolidServer/615/issue_layout |
| twitter:image | https://opengraph.githubassets.com/59b472a72037a1ceac4fe848072a2008b62284869b3aa492f9e574db999a6d27/JavaScriptSolidServer/JavaScriptSolidServer/issues/615 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/59b472a72037a1ceac4fe848072a2008b62284869b3aa492f9e574db999a6d27/JavaScriptSolidServer/JavaScriptSolidServer/issues/615 |
| og:image:alt | Composability testing across the plugins collection (33 plugins) surfaced a pattern: the loader knows almost nothing about a plugin until activate() is already running, so every mismatch is discove... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | melvincarvalho |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| turbo-cache-control | no-preview |
| go-import | github.com/JavaScriptSolidServer/JavaScriptSolidServer git https://github.com/JavaScriptSolidServer/JavaScriptSolidServer.git |
| octolytics-dimension-user_id | 205442424 |
| octolytics-dimension-user_login | JavaScriptSolidServer |
| octolytics-dimension-repository_id | 958025407 |
| octolytics-dimension-repository_nwo | JavaScriptSolidServer/JavaScriptSolidServer |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 958025407 |
| octolytics-dimension-repository_network_root_nwo | JavaScriptSolidServer/JavaScriptSolidServer |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
| Server | github.com |
| Content-Type | text/html; charset=utf-8 |
| Cache-Control | max-age=0, private, must-revalidate |
Viewport: width=device-width