@hoardodile/create-plugin 0.1.13 → 0.1.15

package/dist/template/README.md

@@ -43,6 +43,9 @@ pnpm dev
   `src/hooks.ts`.
 - `src/shared.ts` — the plugin schema (`PluginSchema`) typed once and
   shared between the server and client sides.
+- `src/i18n.ts` + `src/locales/` — plugin UI strings via
+  `createPluginTranslation`, one bundle per supported language (see
+  [Localization](#localization)).
 - `testdata/` — sample data for `pnpm dev`.
 - `__tests__/` — Vitest unit tests against `createResourceAPIFixture`.
 
@@ -112,6 +115,24 @@ git tag v<version> && git push origin v<version>
 Local installs (zip upload in **Settings → Plugins**) still work for
 private packages.
 
+## Localization
+
+The app is localized in five languages (**en, zh, ja, de, es**). A plugin
+can localize three surfaces:
+
+1. **Display name / description** — the `i18n` block in `manifest.json`
+   maps `name`/`description` (and any extra label keys) to a locale table;
+   the host picks the text for the user's UI language.
+2. **Plugin UI strings** — `src/i18n.ts` wraps `createPluginTranslation`
+   with one bundle per language in `src/locales/`; the hook starts in the
+   host's language and follows `languageChanged` pushes, falling back to
+   English for a language the plugin does not ship. `src/__tests__/locales.test.ts`
+   keeps the bundles in lockstep (key set, interpolation placeholders,
+   no untranslated English copy).
+3. **The marketplace readme** — see [Publishing a readme](#publishing-a-readme):
+   one `README.<locale>.md` per language, `README.md` as the English
+   fallback.
+
 ## Publishing a readme
 
 The marketplace detail view shows a per-release **Readme** tab. Ship the

package/dist/template/manifest.json

@@ -13,11 +13,17 @@
 	"i18n": {
 		"name": {
 			"en": "Template",
-			"zh": "模板"
+			"zh": "模板",
+			"ja": "テンプレート",
+			"de": "Vorlage",
+			"es": "Plantilla"
 		},
 		"description": {
 			"en": "Template plugin — copy this directory to start your own plugin",
-			"zh": "模板插件——复制此目录作为你自己插件的起点"
+			"zh": "模板插件——复制此目录作为你自己插件的起点",
+			"ja": "テンプレートプラグイン — このディレクトリをコピーして独自プラグインを作成してください",
+			"de": "Vorlagen-Plugin — kopiere dieses Verzeichnis, um dein eigenes Plugin zu starten",
+			"es": "Plugin de plantilla — copia este directorio para empezar tu propio plugin"
 		}
 	}
 }

package/dist/template/readme/README.de.md

@@ -0,0 +1,19 @@
+# Mein Plugin
+
+_Ersetze diese Readme durch einen echten Überblick: welchen Inhalt das
+Plugin erkennt, wie es ihn rendert und wo Nutzer ihn sehen._
+
+Diese Readme wird mit **jedem GitHub-Release** veröffentlicht — bearbeite
+sie pro Release, damit jede Version ihre eigenen Notizen im Marktplatz
+präsentiert.
+
+## Funktionen
+
+- Erkennt Ressourcen mit … und rendert sie inline.
+- Deklariert folgende Berechtigungen: _siehe `manifest.json`_.
+
+## Voraussetzungen
+
+- hoardodile ≥ 0.1.1 (Details im Repository-README).
+- Vertraue dem Repository, bevor du installierst — Plugin-Code läuft
+  serverseitig in einer Sandbox.

package/dist/template/readme/README.es.md

@@ -0,0 +1,18 @@
+# Mi plugin
+
+_Sustituye esta readme por una descripción real: qué contenido detecta el
+plugin, cómo lo renderiza y dónde lo verán las personas usuarias._
+
+Esta readme se publica con **cada release de GitHub** — edítala en cada
+versión para que cada release presente sus propias notas en el marketplace.
+
+## Funciones
+
+- Detecta recursos que contienen … y los renderiza en línea.
+- Declara los siguientes permisos: _consulta `manifest.json`_.
+
+## Requisitos
+
+- hoardodile ≥ 0.1.1 (detalles en el README del repositorio).
+- Confía en el repositorio antes de instalar: el código del plugin se
+  ejecuta en el servidor dentro de un sandbox restringido.

package/dist/template/readme/README.ja.md

@@ -0,0 +1,18 @@
+# 私のプラグイン
+
+_この README を実際の概要に置き換えてください：プラグインが認識する内容、
+そのレンダリング方法、ユーザーがどこで目にするかを説明します。_
+
+この README は**すべての GitHub Release** と一緒に公開されます——リリースの
+たびに編集し、各バージョンがマーケットプレイスでそれぞれの説明を提示できるようにしてください。
+
+## 機能
+
+- ～を含むリソースを認識し、インラインでレンダリングします。
+- 権限の宣言：_`manifest.json` を参照してください_。
+
+## 要件
+
+- hoardodile ≥ 0.1.1（詳しくはリポジトリの README を参照）。
+- インストール前にこのリポジトリを信頼してください——プラグインコードは
+  制限付きサンドボックス内のサーバー側コードとして実行されます。

package/dist/template/src/TemplateView.tsx

@@ -1,7 +1,9 @@
 import { usePluginAPI } from "./hooks"
+import { useTranslation } from "./i18n"
 
 export function TemplateView() {
 	const api = usePluginAPI()
+	const { t } = useTranslation()
 	const files = api.resource.sourceMeta?.files ?? []
 	const hdtplCount = api.resource.sourceMeta?.hdtplCount
 
@@ -10,14 +12,13 @@ export function TemplateView() {
 			<header>
 				<h1 className="text-lg font-semibold">{api.resource.name}</h1>
 				<p className="text-gray-500 dark:text-gray-400">
-					Rendered by the template plugin. Edit src/TemplateView.tsx to make it
-					your own.
+					{t("renderedBy")} {t("editHint")}
 				</p>
 			</header>
 			<p>
 				{hdtplCount !== undefined
-					? `${hdtplCount} .hdtpl file(s) — classified once by detect.`
-					: "No sourceMeta yet."}
+					? t("fileCount", { count: hdtplCount })
+					: t("noSourceMeta")}
 			</p>
 			<ul className="list-inside list-disc">
 				{files.map((file) => (

package/dist/template/src/__tests__/locales.test.ts

@@ -0,0 +1,86 @@
+import { describe, expect, it } from "vitest"
+import de from "../locales/de"
+import en from "../locales/en"
+import es from "../locales/es"
+import ja from "../locales/ja"
+import zh from "../locales/zh"
+
+const BUNDLES: Record<string, Record<string, unknown>> = {
+	en: en as unknown as Record<string, unknown>,
+	zh: zh as unknown as Record<string, unknown>,
+	ja: ja as unknown as Record<string, unknown>,
+	de: de as unknown as Record<string, unknown>,
+	es: es as unknown as Record<string, unknown>,
+}
+
+function flatten(
+	obj: Record<string, unknown>,
+	path: string[] = [],
+	out: { key: string; value: string }[] = [],
+): { key: string; value: string }[] {
+	for (const [k, v] of Object.entries(obj)) {
+		if (typeof v === "object" && v !== null) {
+			flatten(v as Record<string, unknown>, [...path, k], out)
+		} else {
+			out.push({ key: [...path, k].join("."), value: String(v) })
+		}
+	}
+	return out
+}
+
+function vars(value: string): string {
+	return (value.match(/\{\{[^}]+\}\}/g) ?? [])
+		.map((m) => m.slice(2, -2))
+		.sort()
+		.join(",")
+}
+
+describe("plugin locale parity", () => {
+	const enFlat = flatten(BUNDLES.en!)
+	const enKeys = new Set(enFlat.map((r) => r.key))
+
+	it("ships every hoardodile-supported language", () => {
+		expect(Object.keys(BUNDLES).sort()).toEqual(["de", "en", "es", "ja", "zh"])
+	})
+
+	it("has identical flat key sets across all bundles", () => {
+		for (const [lang, bundle] of Object.entries(BUNDLES)) {
+			const flat = flatten(bundle)
+			const keys = new Set(flat.map((r) => r.key))
+			expect(
+				[...enKeys].filter((k) => !keys.has(k)),
+				`keys only in en`,
+			).toEqual([])
+			expect(
+				[...keys].filter((k) => !enKeys.has(k)),
+				`keys only in ${lang}`,
+			).toEqual([])
+		}
+	})
+
+	it("uses the same interpolation placeholders per key", () => {
+		for (const [lang, bundle] of Object.entries(BUNDLES)) {
+			const byKey = new Map(flatten(bundle).map((r) => [r.key, r.value]))
+			const mismatched: string[] = []
+			for (const { key, value } of enFlat) {
+				const other = byKey.get(key)
+				if (other !== undefined && vars(value) !== vars(other)) {
+					mismatched.push(key)
+				}
+			}
+			expect(mismatched, `placeholder mismatch in ${lang}`).toEqual([])
+		}
+	})
+
+	it("never ships untranslated English source copy", () => {
+		const english = new Map(enFlat.map((r) => [r.key, r.value]))
+		for (const [lang, bundle] of Object.entries(BUNDLES)) {
+			if (lang === "en") continue
+			const untranslated: string[] = []
+			for (const { key, value } of flatten(bundle)) {
+				if (value === english.get(key)) untranslated.push(key)
+			}
+			expect(untranslated, `untranslated keys in ${lang}`).toEqual([])
+		}
+	})
+})

package/dist/template/src/i18n.ts

@@ -0,0 +1,16 @@
+import { createPluginTranslation } from "@hoardodile/sdk-react"
+import de from "./locales/de"
+import en from "./locales/en"
+import es from "./locales/es"
+import ja from "./locales/ja"
+import zh from "./locales/zh"
+
+/**
+ * Plugin UI strings, one bundle per hoardodile-supported language (see
+ * `@hoardodile/i18n` — en, zh, ja, de, es). The host's current language is
+ * picked automatically and follows `languageChanged` pushes; a language
+ * the plugin misses falls back to English.
+ */
+const { useTranslation } = createPluginTranslation({ en, zh, ja, de, es })
+
+export { useTranslation }

package/dist/template/src/locales/de.ts

@@ -0,0 +1,7 @@
+export default {
+	renderedBy: "Gerendert vom Template-Plugin.",
+	editHint:
+		"Bearbeite src/TemplateView.tsx, um daraus dein eigenes Plugin zu machen.",
+	fileCount: "{{count}} .hdtpl-Datei(en) — einmal durch detect klassifiziert.",
+	noSourceMeta: "Noch keine sourceMeta.",
+} as const

package/dist/template/src/locales/en.ts

@@ -0,0 +1,6 @@
+export default {
+	renderedBy: "Rendered by the template plugin.",
+	editHint: "Edit src/TemplateView.tsx to make it your own.",
+	fileCount: "{{count}} .hdtpl file(s) — classified once by detect.",
+	noSourceMeta: "No sourceMeta yet.",
+} as const

package/dist/template/src/locales/es.ts

@@ -0,0 +1,6 @@
+export default {
+	renderedBy: "Renderizado por el plugin de plantilla.",
+	editHint: "Edita src/TemplateView.tsx para convertirlo en tu propio plugin.",
+	fileCount: "{{count}} archivo(s) .hdtpl — clasificados una vez por detect.",
+	noSourceMeta: "Aún no hay sourceMeta.",
+} as const

package/dist/template/src/locales/ja.ts

@@ -0,0 +1,8 @@
+export default {
+	renderedBy: "テンプレートプラグインで描画されています。",
+	editHint:
+		"src/TemplateView.tsx を編集して、自分用のプラグインに作り替えてください。",
+	fileCount:
+		"{{count}} 個の .hdtpl ファイル — detect により一度だけ分類されます。",
+	noSourceMeta: "sourceMeta はまだありません。",
+} as const

package/dist/template/src/locales/zh.ts

@@ -0,0 +1,6 @@
+export default {
+	renderedBy: "由模板插件渲染。",
+	editHint: "编辑 src/TemplateView.tsx，让它成为你自己的插件。",
+	fileCount: "{{count}} 个 .hdtpl 文件——由 detect 分类一次。",
+	noSourceMeta: "尚无 sourceMeta。",
+} as const

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hoardodile/create-plugin",
-  "version": "0.1.13",
+  "version": "0.1.15",
   "license": "MIT",
   "description": "Scaffold a hoardodile content plugin.",
   "keywords": [
@@ -37,7 +37,7 @@
   "dependencies": {
     "@clack/prompts": "^1.7.0",
     "zod": "^4.4.3",
-    "@hoardodile/sdk-types": "0.1.13"
+    "@hoardodile/sdk-types": "0.1.15"
   },
   "devDependencies": {
     "@types/node": "^26.2.0",