@meith/plugin-reference 0.7.0 → 0.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meith/plugin-reference",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "The reference plugin: a handler for every hook Meith fires, as documentation that runs.",
   "license": "LGPL-3.0-or-later",
   "repository": {
@@ -20,7 +20,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@meith/plugin-kit": "^0.7.0"
+    "@meith/plugin-kit": "^0.9.0"
   },
   "peerDependencies": {
     "react": "^19.2.0"

package/src/index.ts

@@ -1 +1,2 @@
-export { referencePlugin, RECORDED, MARK, resetRecorder } from './plugin'
+export { referenceMessages } from './messages'
+export { MARK, RECORDED, referencePlugin, resetRecorder } from './plugin'

package/src/messages/en.json

@@ -0,0 +1,22 @@
+{
+  "reference.admin.status.summary": "{greeting} — {count, plural, one {# hook seen.} other {# hooks seen.}}",
+  "reference.admin.status.title": "Reference plugin",
+  "reference.definition.description": "Exercises every documented extension point. Installed in CI, not on a board.",
+  "reference.definition.name": "Reference plugin",
+  "reference.notification.poked.body": "The reference plugin exercised the notification seam.",
+  "reference.notification.poked.description": "Exists to exercise the notification seam end to end.",
+  "reference.notification.poked.subject": "You were poked",
+  "reference.notification.poked.title": "The reference plugin pokes you",
+  "reference.page.guest": "guest",
+  "reference.page.title": "Reference",
+  "reference.page.viewer": "reference-plugin page for viewer {viewer}",
+  "reference.setting.apiSecret.description": "Exists to exercise the write-only secret path.",
+  "reference.setting.apiSecret.label": "API secret",
+  "reference.setting.badgeLimit.label": "Badge limit",
+  "reference.setting.greeting.description": "Prefixed to the footer.",
+  "reference.setting.greeting.label": "Greeting",
+  "reference.setting.mode.label": "Mode",
+  "reference.setting.mode.record": "Record",
+  "reference.setting.mode.replay": "Replay",
+  "reference.setting.noisy.label": "Log every hook"
+}

package/src/messages/index.ts

@@ -0,0 +1,3 @@
+import en from './en.json'
+
+export const referenceMessages = { en }

package/src/plugin.tsx

@@ -1,10 +1,12 @@
 import {
   definePlugin,
-  REGION_NAMES,
   type PluginRegion,
   type PluginRegionContext,
+  REGION_NAMES,
 } from '@meith/plugin-kit'
 
+import en from './messages/en.json'
+
 export const RECORDED: {
   hooks: { name: string; value: unknown }[]
   regions: PluginRegion[]
@@ -45,39 +47,76 @@ function contribution(region: PluginRegion) {
 
 export const referencePlugin = definePlugin({
   key: 'reference',
-  name: 'Reference plugin',
-  version: '0.7.0',
-  description: 'Exercises every documented extension point. Installed in CI, not on a board.',
+  name: en['reference.definition.name'],
+  nameKey: 'reference.definition.name',
+  version: '0.9.0',
+  description: en['reference.definition.description'],
+  descriptionKey: 'reference.definition.description',
   apiVersion: '0',
 
   settings: [
-    { key: 'greeting', label: 'Greeting', default: 'hello', description: 'Prefixed to the footer.' },
-    { key: 'badge_limit', label: 'Badge limit', default: 3 },
-    { key: 'noisy', label: 'Log every hook', default: false, advanced: true },
+    {
+      key: 'greeting',
+      label: en['reference.setting.greeting.label'],
+      labelKey: 'reference.setting.greeting.label',
+      default: 'hello',
+      description: en['reference.setting.greeting.description'],
+      descriptionKey: 'reference.setting.greeting.description',
+    },
+    {
+      key: 'badge_limit',
+      label: en['reference.setting.badgeLimit.label'],
+      labelKey: 'reference.setting.badgeLimit.label',
+      default: 3,
+    },
+    {
+      key: 'noisy',
+      label: en['reference.setting.noisy.label'],
+      labelKey: 'reference.setting.noisy.label',
+      default: false,
+      advanced: true,
+    },
     {
       key: 'api_secret',
-      label: 'API secret',
+      label: en['reference.setting.apiSecret.label'],
+      labelKey: 'reference.setting.apiSecret.label',
       type: 'secret',
       env: 'REFERENCE_API_SECRET',
       required: true,
       default: '',
-      description: 'Exists to exercise the write-only secret path.',
+      description: en['reference.setting.apiSecret.description'],
+      descriptionKey: 'reference.setting.apiSecret.description',
     },
     {
       key: 'mode',
-      label: 'Mode',
+      label: en['reference.setting.mode.label'],
+      labelKey: 'reference.setting.mode.label',
       type: 'select',
       options: [
-        { value: 'record', label: 'Record' },
-        { value: 'replay', label: 'Replay' },
+        {
+          value: 'record',
+          label: en['reference.setting.mode.record'],
+          labelKey: 'reference.setting.mode.record',
+        },
+        {
+          value: 'replay',
+          label: en['reference.setting.mode.replay'],
+          labelKey: 'reference.setting.mode.replay',
+        },
       ],
       default: 'record',
     },
   ],
 
   migrations: [
-    { id: '0001_create_table', statements: ['create table if not exists plugin_reference_note (id serial primary key)'] },
-    { id: '0002_add_column', statements: ['alter table plugin_reference_note add column if not exists note text'] },
+    {
+      id: '0001_create_table',
+      statements: ['create table if not exists plugin_reference_note (id serial primary key)'],
+    },
+    {
+      id: '0002_add_column',
+      statements: ['alter table plugin_reference_note add column if not exists note text'],
+    },
   ],
 
   tasks: [
@@ -93,12 +132,13 @@ export const referencePlugin = definePlugin({
   adminPages: [
     {
       path: 'status',
-      title: 'Reference plugin',
-      render: (context) => (
-        <p>
-          {String(context.settings.greeting ?? 'hello')} — {RECORDED.hooks.length} hooks seen.
-        </p>
-      ),
+      title: en['reference.admin.status.title'],
+      titleKey: 'reference.admin.status.title',
+      render: (context) =>
+        context.t.t('reference.admin.status.summary', {
+          greeting: String(context.settings.greeting ?? 'hello'),
+          count: RECORDED.hooks.length,
+        }),
     },
   ],
 
@@ -139,8 +179,8 @@ export const referencePlugin = definePlugin({
         await context.notify.send({
           userId: request.viewer.userId ?? 0,
           kind: 'poked',
-          subject: 'You were poked',
-          body: 'The reference plugin exercised the notification seam.',
+          subjectKey: 'reference.notification.poked.subject',
+          bodyKey: 'reference.notification.poked.body',
           href: '/reference',
         })
         return { kind: 'json', body: { poked: true } }
@@ -161,8 +201,10 @@ export const referencePlugin = definePlugin({
   notifications: [
     {
       key: 'poked',
-      title: 'The reference plugin pokes you',
-      description: 'Exists to exercise the notification seam end to end.',
+      title: en['reference.notification.poked.title'],
+      titleKey: 'reference.notification.poked.title',
+      description: en['reference.notification.poked.description'],
+      descriptionKey: 'reference.notification.poked.description',
       emailByDefault: false,
     },
   ],
@@ -170,13 +212,16 @@ export const referencePlugin = definePlugin({
   pages: [
     {
       path: '',
-      title: 'Reference',
+      title: en['reference.page.title'],
+      titleKey: 'reference.page.title',
       access: 'anonymous',
       render: (context) => {
         RECORDED.pages.push(context.path)
         return (
           <p data-plugin={MARK}>
-            {MARK} page for viewer {String(context.viewer.userId ?? 'guest')}
+            {context.t.t('reference.page.viewer', {
+              viewer: String(context.viewer.userId ?? context.t.t('reference.page.guest')),
+            })}
           </p>
         )
       },