diff --git a/.gitignore b/.gitignore index a41eda3..1c16ae0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .DS_Store +.env.local node_modules/ *.log .astro/ diff --git a/README.md b/README.md index 44d1834..0ece3ab 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,28 @@ The independent application marketplace at [community.eidos.space](https://commu - This repository owns the website, its English and Chinese pages, and deployment. - [eidos-space/registry](https://github.com/eidos-space/registry) owns catalog entries, schemas, and plugin submissions. -- Both development and production fetch the public GitHub registry at runtime. +- By default, development and production fetch the public GitHub registry at runtime. Successful responses are cached for 10 minutes. Registry updates do not require a website deployment. A first load requires network access; refresh failures can use the last successful response available to the loader. -- Plugin README files and screenshots are read from their GitHub repositories. - Installation assets remain pinned to the releases and checksums in the registry. +- Localized format 3 documentation is read from the checksum-verified release + archive, selected as a whole document, and cached separately by package hash + and interface language. Missing translations show a fallback notice. Legacy + README files are read at the release tag. Screenshots remain repository assets. +- Optional registry `localization` metadata supplies translated names and + descriptions; the website uses the same exact/script/base/default matching + order as Plugin API 3.7. Permission summaries include background startup, + file-open metadata, network and Bluetooth declarations, separately from pages. Submit or update a plugin in the [registry repository](https://github.com/eidos-space/registry/blob/main/CONTRIBUTING.md). Report website issues and contribute UI changes here. +The [official plugin template](https://github.com/eidos-space/eidos-plugin-template) +and [first-plugin tutorial](https://docs.eidos.space/plugins/guide/) are linked +from the developer footer and plugin resources. The template uses published +SDK/tools; newer APIs require matching host and authoring-tool versions. + ## Development ```sh @@ -27,6 +38,16 @@ pnpm typecheck pnpm build ``` +`pnpm deploy:preview` deploys a separate `eidos-plugin-marketplace-preview` Worker +on its workers.dev address. Its routes are empty, so it does not bind the +production `community.eidos.space` domain. + +To preview unpublished registry changes, set `EIDOS_REGISTRY_PATH` to the absolute +path of your registry checkout's `plugins.registry.json` in `.env.local`, then +run `pnpm dev`. Development reads that file on every request so edits appear +after refreshing. An invalid local file produces a catalog error instead of +silently showing remote data. Production always uses the public GitHub registry. + ## Deployment ```sh diff --git a/package.json b/package.json index ac9a007..e9ecc5e 100644 --- a/package.json +++ b/package.json @@ -7,9 +7,10 @@ "dev": "astro dev", "build": "astro build", "preview": "pnpm build && wrangler dev --local", - "test": "node --experimental-strip-types --test src/lib/plugin-registry.test.ts src/lib/plugin-details.test.ts tests/marketplace-contract.test.mjs", + "test": "node --experimental-strip-types --test src/lib/plugin-registry.test.ts src/lib/plugin-details.test.ts src/lib/plugin-localization.test.ts tests/marketplace-contract.test.mjs", "typecheck": "astro check", - "deploy": "pnpm build && wrangler deploy" + "deploy": "pnpm build && wrangler deploy", + "deploy:preview": "pnpm build && wrangler deploy --config wrangler.jsonc --env preview" }, "dependencies": { "@astrojs/cloudflare": "12.6.0", diff --git a/src/components/Footer.astro b/src/components/Footer.astro index 2ceec76..a516d77 100644 --- a/src/components/Footer.astro +++ b/src/components/Footer.astro @@ -32,6 +32,8 @@ const groups = [ links: [ { label: t.documentation, href: docsUrl("/"), external: true }, { label: t.buildGuide, href: docsUrl("/developers/"), external: true }, + { label: t.pluginGuide, href: docsUrl("/plugins/guide/"), external: true }, + { label: t.pluginTemplate, href: "https://github.com/eidos-space/eidos-plugin-template", external: true }, { label: t.fileSpec, href: "https://github.com/mayneyao/eidos/blob/dev/docs/specs/eidos-file-1.0.md", external: true }, { label: "Runtime · npm", href: "https://www.npmjs.com/package/@eidos.space/eidos-file", external: true }, ], diff --git a/src/components/MarketplacePage.astro b/src/components/MarketplacePage.astro index e41950a..3eed9a7 100644 --- a/src/components/MarketplacePage.astro +++ b/src/components/MarketplacePage.astro @@ -2,6 +2,7 @@ import type { Locale } from "../i18n"; import { messages, pluginCategoryMessages } from "../i18n"; import Layout from "../layouts/Layout.astro"; +import { localizePlugin } from "../lib/plugin-localization"; import { loadMarketplaceRegistry } from "../lib/marketplace-registry"; import { PLUGIN_REGISTRY_REPO, @@ -25,6 +26,7 @@ Astro.response.headers.set( try { registry = await loadMarketplaceRegistry(); + registry = { ...registry, plugins: registry.plugins.map((plugin) => localizePlugin(plugin, locale)) }; } catch (error) { console.error("Could not load the Eidos plugin registry", error); } diff --git a/src/components/PluginDetailPage.astro b/src/components/PluginDetailPage.astro index 3f877cc..d1024e1 100644 --- a/src/components/PluginDetailPage.astro +++ b/src/components/PluginDetailPage.astro @@ -2,6 +2,7 @@ import type { Locale } from "../i18n"; import { detailMessages, pluginCategoryMessages } from "../i18n"; import Layout from "../layouts/Layout.astro"; +import { localizePlugin } from "../lib/plugin-localization"; import ScreenshotCarousel from "./ScreenshotCarousel.astro"; import { loadPluginDetails, type PluginContribution } from "../lib/plugin-details"; import { loadMarketplaceRegistry } from "../lib/marketplace-registry"; @@ -26,6 +27,7 @@ let plugin; try { const registry = await loadMarketplaceRegistry(); plugin = registry.plugins.find((entry) => entry.id === pluginId); + if (plugin) plugin = localizePlugin(plugin, locale); } catch (error) { console.error("Could not load the Eidos plugin registry", error); } @@ -42,7 +44,7 @@ const installUrl = plugin : ""; const iconVariant = plugin ? pluginVisualVariant(plugin.id) : 1; const contributions = manifest - ? [...manifest.views, ...manifest.actions, ...manifest.formatters] + ? [...manifest.views, ...manifest.actions, ...manifest.formatters, ...manifest.hooks] : []; const contributionType = (item: PluginContribution) => { @@ -140,6 +142,7 @@ const backUrl = isTheme

{plugin.kind === "theme" ? t.aboutTheme : t.about}

+ {details?.readmeFallback &&

{t.documentationFallback.replace("{locale}", details.readmeLocale ?? t.defaultLanguage)}

} {details?.readmeHtml ? (
) : ( @@ -157,7 +160,7 @@ const backUrl = isTheme
{t.version}
{plugin.version}
{t.apiVersion}
{manifest?.requiresPluginApi ?? manifest?.apiVersion ?? "1.0"}
{t.type}
{plugin.kind === "theme" ? t.theme : t.pluginType}
-
{t.compatibility}
{plugin.compatibility}
+
{t.compatibility}
{plugin.compatibility}
@@ -168,6 +171,8 @@ const backUrl = isTheme
{t.views}
{manifest?.views.length ?? 0}
{t.actions}
{manifest?.actions.length ?? 0}
{t.formatters}
{manifest?.formatters.length ?? 0}
+ {!!manifest?.hooks.length &&
{t.hooks}
{manifest.hooks.length}
} + {manifest?.background &&
{t.background}
1
} {contributions.length > 0 && (