@mercury-fw/cli 0.64.0 → 0.65.1

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @mercury-fw/cli
 
+## 0.65.1
+
+### Patch Changes
+
+- 9b2e1bf: - `mfw create`: the comment above the config's `version` and the app's README say what it shows, and no longer how to move the number: that's the app's own business.
+  - The `version` field's description says Mercury never changes it, with no advice on who does.
+- Updated dependencies [9b2e1bf]
+  - @mercury-fw/core@0.65.1
+  - @mercury-fw/utils@0.65.1
+
+## 0.65.0
+
+### Minor Changes
+
+- 7a76257: - `mfw create`: the new app's `mercury.config.ts` declares its version, the one in its `package.json` (`version: pkg.version`), with a comment on what it shows and what it doesn't; the app's README says the same.
+
+### Patch Changes
+
+- Updated dependencies [7a76257]
+  - @mercury-fw/core@0.65.0
+  - @mercury-fw/utils@0.65.0
+
 ## 0.64.0
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mercury-fw/cli",
-  "version": "0.64.0",
+  "version": "0.65.1",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -41,17 +41,17 @@
   "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.64.0",
-    "@mercury-fw/utils": "0.64.0",
+    "@mercury-fw/core": "0.65.1",
+    "@mercury-fw/utils": "0.65.1",
     "commander": "^15.0.0"
   },
   "devDependencies": {
     "@mercury-fw/auth-oidc": "0.2.1",
     "@mercury-fw/auth-static": "0.2.2",
     "@mercury-fw/channel-google-chat": "0.11.1",
-    "@mercury-fw/channel-http": "0.13.2",
+    "@mercury-fw/channel-http": "0.14.1",
     "@mercury-fw/directory-static": "0.1.2",
-    "@mercury-fw/formatter": "0.64.0",
+    "@mercury-fw/formatter": "0.65.1",
     "@mercury-fw/plugin-atlassian-admin": "0.5.1",
     "@mercury-fw/plugin-bitbucket": "0.6.1",
     "@mercury-fw/plugin-confluence": "0.1.0",

package/src/render.ts

@@ -55,11 +55,19 @@ const CORE_ENV: EnvVar[] = [
   },
 ];
 
+/** Above the config's `version`: what it does, and what it doesn't. */
+const VERSION_COMMENT = [
+  "  // The app's version, from package.json: GET /version shows it next to the",
+  "  // framework's, to anyone (no token). Mercury never changes it, and a new",
+  "  // one shows once the app is rebuilt. Remove this line to show none.",
+].join("\n");
+
 const CONFIG_HEADER = `/**
  * This app's composition: the tool plugins and channels it runs, the auth
  * provider when a channel needs one, how the lists its plugins hand over read,
  * the assistant's persona and the languages it speaks (\`i18n\`: a file per
- * language in \`locales/\`, \`en.json\` overriding the English texts). The entrypoints
+ * language in \`locales/\`, \`en.json\` overriding the English texts) and its version
+ * (\`version\`, its \`package.json\`'s, shown on the HTTP channel's \`/version\`). The entrypoints
  * (\`src/index.ts\`, \`src/repl.ts\`) hand this config to \`composeMercury\`.
  *
  * Every tool plugin and channel declared here is active.
@@ -214,7 +222,11 @@ function renderConfig(
   directory: CatalogEntry | undefined,
 ): string {
   const withRules = tools.filter((t) => t.formatter);
-  const imports = ['import { defineMercuryConfig } from "@mercury-fw/core";', 'import en from "./locales/en.json";'];
+  const imports = [
+    'import { defineMercuryConfig } from "@mercury-fw/core";',
+    'import en from "./locales/en.json";',
+    'import pkg from "./package.json";',
+  ];
   if (withRules.length > 0) {
     imports.push('import { formatterPlugin, formatter } from "@mercury-fw/formatter";');
   }
@@ -249,6 +261,8 @@ function renderConfig(
     ...(auth ? [`  auth: ${auth.exportName},`] : []),
     ...(directory ? [`  directory: ${directory.exportName},`] : []),
     "  i18n: { locales: { en } },",
+    VERSION_COMMENT,
+    "  version: pkg.version,",
     "});",
     "",
   ].join("\n");
@@ -417,7 +431,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: its name, who it 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. Its \`version\` is the one in \`package.json\`, which the HTTP channel's \`GET /version\` shows to anyone, no token needed: Mercury never changes it, and a new one shows once the app is rebuilt. Remove the line to show none.
 - \`locales/\`: the texts people see, one file per language the assistant speaks. \`en.json\` overrides the English ones; add \`it.json\` (and \`it\` to \`i18n.locales\` in the config) for Italian, \`i18n.defaultLocale\` for the language people get when they haven't picked one, \`i18n.timeZone\` (an IANA name such as \`Europe/Rome\`) for the time zone of whoever saved none and whose app says none. The app's own texts (a formatter rule's) are \`app.\` keys, written in English in \`en.json\` and translated in every other file. Mercury logs at startup the keys a file is missing.
 - \`src/index.ts\`: the service (channels, crons). \`src/repl.ts\`: an interactive terminal for trying things out.
 - \`plugins/\`: the app's own plugins, when it has any: each one a package in a folder of its own (\`plugins/<name>\`, a workspace), listed in \`dependencies\` as \`workspace:*\` and declared in \`mercury.config.ts\`. \`bun run test\` runs their tests.