@mercury-fw/cli 0.53.1 → 0.53.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @mercury-fw/cli
 
+## 0.53.2
+
+### Patch Changes
+
+- 4a9a528: `mfw create` writes the whole persona inside `mercury.config.ts`: the assistant's name once, as a `const`, referred to by the identity and by the tone, which is written out in full, one string per line. There are no `persona/identity.md` and `persona/tone.md` files anymore, no `markdown.d.ts`, and the Dockerfile no longer copies them.
+
+  An existing app keeps working as it is. To move it to the new layout:
+
+  1. In `mercury.config.ts`, drop the two `import … from "./persona/…md"` lines, add `const name = "<the assistant's name>";` and set `persona: { name, identity: "…", tone: "…" }` with the text of the two files (`${name}` in a template literal where they say `{{assistant}}`, or keep `{{assistant}}`: the core still replaces it).
+  2. Delete `persona/` and `markdown.d.ts`.
+  3. In the `Dockerfile`, change `COPY --chown=mercury:mercury mercury.config.ts markdown.d.ts ./` to `COPY --chown=mercury:mercury mercury.config.ts ./` and delete `COPY --chown=mercury:mercury persona ./persona`.
+
+  - @mercury-fw/core@0.53.2
+  - @mercury-fw/utils@0.53.2
+
 ## 0.53.1
 
 ### Patch Changes

package/README.md

@@ -47,7 +47,7 @@ Without a global install: `bun create mercury-agent my-agent` creates an app, an
 Writes a new Mercury app into `<folder>`, which has to be missing or empty; the folder's own name is turned into kebab case (`My Agent` becomes `my-agent`, the path above it stays as typed). Without flags it asks:
 
 - the app name (the `name` in `package.json`, defaulting to the folder's);
-- the assistant's name and role: the name becomes `persona.name` in the config, the role `persona/identity.md` ("You are {{assistant}}, the platform team's release assistant.", the core putting the name in place of `{{assistant}}`), next to a `persona/tone.md` to edit;
+- the assistant's name and role: the whole persona goes in the config, the name written once as a `const` and referred to by the identity (`` `You are ${name}, the platform team's release assistant.` ``) and by the tone, written out in full to edit;
 - which channels and which tool plugins to include (none is fine: the REPL always works);
 - the git remote for `origin`, which you can leave empty (most of the time it doesn't exist yet when you scaffold).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mercury-fw/cli",
-  "version": "0.53.1",
+  "version": "0.53.2",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -41,8 +41,8 @@
   "comment:shape": "The Mercury CLI (`mfw`). `mfw create <dir>` writes a new Mercury app from the template. The framework packages move in lockstep with it, so a new app gets them at the CLI's own version; plugins and channels at the registry's latest. The plugin and channel packages are devDependencies only for the catalog test. `main(argv)` is exported for create-mercury-agent.",
   "dependencies": {
     "@clack/prompts": "^1.8.1",
-    "@mercury-fw/core": "0.53.1",
-    "@mercury-fw/utils": "0.53.1",
+    "@mercury-fw/core": "0.53.2",
+    "@mercury-fw/utils": "0.53.2",
     "commander": "^15.0.0"
   },
   "devDependencies": {
@@ -51,7 +51,7 @@
     "@mercury-fw/channel-google-chat": "0.8.2",
     "@mercury-fw/channel-http": "0.10.1",
     "@mercury-fw/directory-static": "0.1.1",
-    "@mercury-fw/formatter": "0.53.1",
+    "@mercury-fw/formatter": "0.53.2",
     "@mercury-fw/plugin-atlassian-admin": "0.3.2",
     "@mercury-fw/plugin-bitbucket": "0.4.1",
     "@mercury-fw/plugin-jira": "0.6.5",

package/src/program.ts

@@ -52,7 +52,7 @@ function buildProgram(handlers: ProgramHandlers, result: { code: number }): Comm
     .command("create")
     .summary("writes a new Mercury app")
     .description(
-      "Writes a new Mercury app into <folder>, which has to be missing or empty (its own name is turned into kebab case). Without options it asks for the app name, the assistant's name and role, and which channels (with the HTTP channel's auth provider) and tool plugins to include; then it writes mercury.config.ts for that selection, with the assistant's name as persona.name, the persona (persona/identity.md, persona/tone.md, which refer to the name as {{assistant}}), the service and REPL entrypoints, a Dockerfile, a compose file with Qdrant, and an env example listing every variable the app reads. Then it runs bun install, and creates a git repository on main with a first commit, adding the origin when given (nothing is pushed).",
+      "Writes a new Mercury app into <folder>, which has to be missing or empty (its own name is turned into kebab case). Without options it asks for the app name, the assistant's name and role, and which channels (with the HTTP channel's auth provider) and tool plugins to include; then it writes mercury.config.ts for that selection, with the whole persona in it (the assistant's name, its role as the identity, and the default tone written out to edit), the service and REPL entrypoints, a Dockerfile, a compose file with Qdrant, and an env example listing every variable the app reads. Then it runs bun install, and creates a git repository on main with a first commit, adding the origin when given (nothing is pushed).",
     )
     .argument("<folder>", "where to write the app")
     .option("--name <name>", "app name, as in package.json (default: the folder's name)")

package/src/render.ts

@@ -3,16 +3,15 @@
  * Turns the wizard's answers into the new app's files, as a `path → content`
  * map, without touching the disk (`write.ts` does that). The static files come
  * from `template/` imported as text, so they are bundled with the CLI; the
- * config, the manifest, the env example, the compose file, the persona and the
- * README are generated from the selection. Channels and plugins are always
+ * config (with the persona), the manifest, the env example, the compose file
+ * and the README are generated from the selection. Channels and plugins are always
  * written in catalog order, whatever order they were chosen in; the auth
  * provider, when there is one, after the channels.
  */
-import { DEFAULT_PERSONA_IDENTITY, DEFAULT_PERSONA_TONE, assistantNameOf } from "@mercury-fw/core";
+import { DEFAULT_PERSONA_TONE, assistantNameOf } from "@mercury-fw/core";
 import { CATALOG, type CatalogEntry, type EnvVar } from "./catalog.ts";
 import indexTs from "../template/src/index.ts.tpl" with { type: "text" };
 import replTs from "../template/src/repl.ts.tpl" with { type: "text" };
-import markdownDts from "../template/markdown.d.ts.tpl" with { type: "text" };
 import tsconfigJson from "../template/tsconfig.json.tpl" with { type: "text" };
 import gitignore from "../template/gitignore.tpl" with { type: "text" };
 import dockerignore from "../template/dockerignore.tpl" with { type: "text" };
@@ -86,12 +85,8 @@ export function renderApp(input: RenderInput): Map<string, string> {
     ["Dockerfile", dockerfile],
     ["README.md", renderReadme(input.name, channels, auth, tools, directory)],
     ["docker-compose.yml", renderCompose(input.name, channels.some((c) => c.id === "http"), services)],
-    ["markdown.d.ts", markdownDts],
-    ["mercury.config.ts", renderConfig(assistantName, channels, auth, tools, directory)],
+    ["mercury.config.ts", renderConfig(assistantName, input.role, channels, auth, tools, directory)],
     ["package.json", renderPackageJson(input.name, channels, auth, tools, input.versions, directory)],
-    // The name is persona.name in the config; the persona files refer to it.
-    ["persona/identity.md", `You are {{assistant}}, ${input.role.trim().replace(/\.+$/, "")}.\n`],
-    ["persona/tone.md", `${DEFAULT_PERSONA_TONE}\n`],
     ["src/index.ts", indexTs],
     ["src/repl.ts", replTs],
     ["tsconfig.json", tsconfigJson],
@@ -169,11 +164,41 @@ function selected(kind: CatalogEntry["kind"], ids: string[]): CatalogEntry[] {
   return CATALOG.filter((e) => e.kind === kind && ids.includes(e.id));
 }
 
-/** `mercury.config.ts`: imports, the formatter helpers of the plugins that have
- * any, then the config with each plugin (wrapped in the formatter when it has
- * starting rules) and channel. */
+/** What the core's persona texts write where the assistant's name goes. */
+const ASSISTANT = "{{assistant}}";
+
+/** `text` as the inside of a template literal: backslashes, backticks and `${` stay text. */
+function templateText(text: string): string {
+  return text.replace(/\\/g, "\\\\").replace(/`/g, "\\`").replace(/\$\{/g, "\\${");
+}
+
+/** One line of the persona as config source: a template literal referring to
+ * the config's `name` where the line names the assistant, a string otherwise. */
+function personaLine(line: string): string {
+  if (!line.includes(ASSISTANT)) return JSON.stringify(line);
+  return `\`${line.split(ASSISTANT).map(templateText).join("${name}")}\``;
+}
+
+/** The config's `persona`: the name, the role as the identity, and the core's
+ * default tone written out line by line, so the whole persona is there to edit. */
+function renderPersona(role: string): string[] {
+  return [
+    "  persona: {",
+    "    name,",
+    `    identity: ${personaLine(`You are ${ASSISTANT}, ${role.trim().replace(/\.+$/, "")}.`)},`,
+    "    tone: [",
+    ...DEFAULT_PERSONA_TONE.split("\n").map((line) => `      ${personaLine(line)},`),
+    '    ].join("\\n"),',
+    "  },",
+  ];
+}
+
+/** `mercury.config.ts`: imports, the assistant's name, the formatter helpers of
+ * the plugins that have any, then the config with the persona, each plugin
+ * (wrapped in the formatter when it has starting rules) and channel. */
 function renderConfig(
   assistantName: string,
+  role: string,
   channels: CatalogEntry[],
   auth: CatalogEntry | undefined,
   tools: CatalogEntry[],
@@ -192,8 +217,6 @@ function renderConfig(
   for (const c of [...channels, ...(auth ? [auth] : []), ...(directory ? [directory] : [])]) {
     imports.push(`import { ${c.exportName} } from "${c.package}";`);
   }
-  imports.push('import identity from "./persona/identity.md" with { type: "text" };');
-  imports.push('import tone from "./persona/tone.md" with { type: "text" };');
 
   const helpers = withRules.map((t) => `${t.formatter?.helpers}\n\n`).join("");
 
@@ -207,8 +230,11 @@ function renderConfig(
     CONFIG_HEADER,
     ...imports,
     "",
+    "/** The assistant's name: what the persona calls it, and every text the model reads. */",
+    `const name = ${JSON.stringify(assistantName)};`,
+    "",
     `${helpers}export default defineMercuryConfig({`,
-    `  persona: { name: ${JSON.stringify(assistantName)}, identity, tone },`,
+    ...renderPersona(role),
     plugins,
     channelList,
     ...(auth ? [`  auth: ${auth.exportName},`] : []),
@@ -379,8 +405,7 @@ ${auth ? `- Auth: ${auth.id}\n` : ""}- Tool plugins: ${list(tools)}
 ${directory ? `- Directory: ${directory.id}\n` : ""}
 ## Layout
 
-- \`mercury.config.ts\`: what the app is made of (tool plugins, channels, how their lists read) and the assistant's persona.
-- \`persona/identity.md\`, \`persona/tone.md\`: who the assistant is and how it answers. Edit them freely.
+- \`mercury.config.ts\`: what the app is made of (tool plugins, channels, how their lists read) and the assistant's persona: its name, who it is and how it answers. Edit them freely.
 - \`src/index.ts\`: the service (channels, crons). \`src/repl.ts\`: an interactive terminal for trying things out.
 - \`.env.example\`: every variable the app reads. Copy it to \`.env\` and fill it in.
 

package/template/Dockerfile.tpl

@@ -20,8 +20,7 @@ COPY --chown=mercury:mercury .pack[s] ./.packs/
 RUN bun install --production && chown -R mercury:mercury node_modules
 RUN find /app/node_modules -path '*/@mercury-fw/*/bin/*' -type f -exec ln -sf {} /usr/local/bin/ \;
 
-COPY --chown=mercury:mercury mercury.config.ts markdown.d.ts ./
-COPY --chown=mercury:mercury persona ./persona
+COPY --chown=mercury:mercury mercury.config.ts ./
 COPY --chown=mercury:mercury src ./src
 
 # Mount points of the named volumes, owned by the runtime user before a fresh

package/template/markdown.d.ts.tpl

@@ -1,5 +0,0 @@
-/** Markdown imported as text (`with { type: "text" }`), as the persona files are. */
-declare module "*.md" {
-  const text: string;
-  export default text;
-}