zinkee 0.1.31 → 0.1.32

package/dist/index.js

@@ -2444,7 +2444,7 @@ var specificExamples = {
 }`
     },
     {
-      description: "Set the highlighted (main) field of a schema.",
+      description: "Set the schema's highlighted (main) field \u2014 the field whose value names each record in the UI (activity-panel title and detail-view record list).",
       command: "zinkee --json schemas update contacts --highlighted-field contact-name",
       raw: `{
   "highlightedField": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
@@ -11266,6 +11266,15 @@ function registerRecordsCommands(program, options = {}) {
 // src/commands/schemas.ts
 import { readFileSync as readFileSync9 } from "fs";
 import { InvalidArgumentError as InvalidArgumentError9 } from "commander";
+var HIGHLIGHTED_FIELD_HELP = `
+Highlighted field:
+  The schema's "main" field. The frontend uses its value as each record's
+  display name, in two places:
+    - Activity panel: the record's title in the activity side panel
+      (the panel with the record's logs and comments).
+    - Detail view: the record's name in the left-hand record list you
+      browse to open each record's form.
+`;
 function getCommandIo11(stdout) {
   return stdout ?? process.stdout;
 }
@@ -11603,7 +11612,7 @@ function registerSchemasCommands(program, options = {}) {
   });
   schemas.command("update").description("Update a schema").argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector9).option("--name <name>", "schema name").option("--slug <slug>", "schema slug").option("--auditable <bool>", "auditable flag", parseBooleanFlag).option("--commentable <bool>", "commentable flag", parseBooleanFlag).option(
     "--highlighted-field <field>",
-    "highlighted (main) field uuid or slug",
+    "its value is used as each record's display name in the UI (field uuid or slug)",
     parseUuidOrSlugSelector9
   ).action(async function action(schema, commandOptions) {
     const { api, json, readOnly } = createSchemasApi(this, filePath);
@@ -11630,7 +11639,7 @@ function registerSchemasCommands(program, options = {}) {
       return;
     }
     writeLine11(stdout, `Updated schema "${data.slug ?? schema.value}".`);
-  });
+  }).addHelpText("after", HIGHLIGHTED_FIELD_HELP);
   schemas.command("set-unique-fields").description("Set or clear the composite unique-field constraint on a schema").argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector9).option(
     "--field <field>",
     "field uuid or slug to include in the unique constraint (repeatable)",