@metaobjectsdev/cli 1.0.0-rc.4 → 1.0.0-rc.5

package/src/lib/output.ts

@@ -15,7 +15,23 @@ export interface FormatOptions {
 // gen
 // ---------------------------------------------------------------------------
 
-export type GenFileStatus = "new" | "merged" | "conflict" | "unchanged" | "refused" | "removed";
+/**
+ * `overwrite` is distinct from `new` on purpose. Reviewing a run, "an entity
+ * appeared" and "an existing artifact was rewritten" are different facts, and the
+ * CLI used to report both as `new` — the engine has always distinguished them
+ * (`WriteStatus.overwrite`), and the reporting layer collapsed the two. Found on
+ * two adopter estates independently, which is what makes it a reporting defect
+ * rather than a preference: the summary line was right and the per-file status
+ * was not.
+ */
+export type GenFileStatus =
+  | "new"
+  | "overwrite"
+  | "merged"
+  | "conflict"
+  | "unchanged"
+  | "refused"
+  | "removed";
 
 export interface GenFileEntry {
   path: string;
@@ -45,6 +61,7 @@ export interface GenResultShape {
 
 const GEN_GLYPHS: Record<GenFileStatus, string> = {
   new: "✓",
+  overwrite: "↻",
   merged: "↺",
   conflict: "✗",
   unchanged: "=",
@@ -54,6 +71,7 @@ const GEN_GLYPHS: Record<GenFileStatus, string> = {
 
 const GEN_WORDS: Record<GenFileStatus, string> = {
   new: "NEW",
+  overwrite: "OVERWRITE",
   merged: "MERGED",
   conflict: "CONFLICT",
   unchanged: "UNCHANGED",
@@ -88,10 +106,14 @@ export function formatGenResult(result: GenResultShape, opts: FormatOptions): st
       acc[f.status] = (acc[f.status] ?? 0) + 1;
       return acc;
     },
-    { new: 0, merged: 0, conflict: 0, unchanged: 0, refused: 0, removed: 0 },
+    { new: 0, overwrite: 0, merged: 0, conflict: 0, unchanged: 0, refused: 0, removed: 0 },
   );
   const parts: string[] = [];
-  if (counts.new > 0) parts.push(`${counts.new} written`);
+  // "written" stays the sum of new + overwrite: that number was always correct and
+  // adopters read it. Splitting the SUMMARY as well would change a line nothing was
+  // wrong with; the per-file status is the one that was lying.
+  const written = counts.new + counts.overwrite;
+  if (written > 0) parts.push(`${written} written`);
   if (counts.merged > 0) parts.push(`${counts.merged} merged`);
   if (counts.conflict > 0) parts.push(`${counts.conflict} conflict`);
   if (counts.unchanged > 0) parts.push(`${counts.unchanged} unchanged`);
@@ -198,10 +220,13 @@ export function genResultToData(result: GenResultShape): {
 } {
   const counts = result.files.reduce<Record<GenFileStatus, number>>(
     (a, f) => ((a[f.status] = (a[f.status] ?? 0) + 1), a),
-    { new: 0, merged: 0, conflict: 0, unchanged: 0, refused: 0, removed: 0 },
+    { new: 0, overwrite: 0, merged: 0, conflict: 0, unchanged: 0, refused: 0, removed: 0 },
   );
   const parts: string[] = [];
-  if (counts.new) parts.push(`${counts.new} written`);
+  // Same split as the text formatter: `written` is new + overwrite, and the
+  // per-file rows carry which one each was.
+  const written = counts.new + counts.overwrite;
+  if (written) parts.push(`${written} written`);
   if (counts.merged) parts.push(`${counts.merged} merged`);
   if (counts.conflict) parts.push(`${counts.conflict} conflict`);
   if (counts.unchanged) parts.push(`${counts.unchanged} unchanged`);

package/src/lib/requirement-lint.ts

@@ -155,6 +155,26 @@ const INERT_SLOTS = [DOC_ATTR_SUMMARY] as const;
  */
 const TITLE_IS_AN_ID = /^[A-Z]{2,}[- ]?\d+/;
 
+/**
+ * What is LEFT of a title once a leading catalogue id and its separator are removed.
+ *
+ * The rule fires only when that remainder is empty — when the label IS the id and
+ * nothing else. A title that carries an id AND a noun phrase is not "an id"; it is a
+ * label with a citation prefix, which is a house style, and the warning's own name is
+ * false for it.
+ *
+ * Measured on a 323-node adopter ledger that uses `@title` deliberately as its bridge
+ * to a spec catalogue: the un-narrowed rule fired **203 times**, on every run, telling
+ * that author their entire convention was wrong and offering a 203-entry edit. That is
+ * the "355 findings, all false" shape the 0.24.2 narrowing exists to avoid, reproduced
+ * by the check that narrowing shipped alongside. A lint people argue with is a lint
+ * people mute, and muting takes the six useful checks with it.
+ *
+ * `@title: "REQ-1234"` — a slot holding only a citation, with no label anywhere — is
+ * still caught, and that is the case the rule was written for.
+ */
+const TITLE_ID_ONLY = /^[A-Z]{2,}[- ]?\d+[\s\-–—:.]*$/;
+
 /** Lowercase, drop everything that is not alphanumeric, collapse the gaps.
  *  Two slots "say the same thing" only if they survive this identically — no
  *  similarity score, no threshold. A fuzzy match on prose produces findings the
@@ -343,12 +363,13 @@ export function lintRequirements(
 
     // -- an id is not a label -------------------------------------------------
     const title = readOwnSlot(node, DOC_ATTR_TITLE);
-    if (title !== undefined && TITLE_IS_AN_ID.test(title.trim())) {
+    if (title !== undefined && TITLE_ID_ONLY.test(title.trim())) {
       out.push(warn(path, WARN_REQUIREMENT_TITLE_IS_AN_ID,
-        `@title opens with a catalogue or ticket id: ${excerpt(title)}. A title is a NOUN PHRASE and ` +
-        `an id is not a name, so this is two things in one slot. SPLIT them — put the id in ` +
-        `@${REQUIREMENT_ATTR_TRACKED_BY}, which is the free-form reference slot and IS read, and leave ` +
-        `the phrase as the title. Moving the whole string would throw the label away.`));
+        `@title holds only a catalogue or ticket id: ${excerpt(title)}. A title is the entry's ` +
+        `LABEL and an id is not a name, so this slot says nothing a reader can use. Put the id in ` +
+        `@${REQUIREMENT_ATTR_TRACKED_BY}, which is the free-form reference slot and IS read, and ` +
+        `give @${DOC_ATTR_TITLE} a noun phrase. A title that carries an id AND a phrase ` +
+        `("FR-448 — prompt construction as typed payloads") is a house style and is NOT flagged.`));
     }
   }