fix(docs): stabilize named range text output

steipete · steipete · commit edeee6874802 · 2026-06-10T07:22:59.000+01:00
diff --git a/internal/cmd/docs_named_ranges.go b/internal/cmd/docs_named_ranges.go
@@ -227,10 +227,15 @@ func (c *DocsNamedRangesCreateCmd) Run(ctx context.Context, kctx *kong.Context,
 	if createdID == "" {
 		return fmt.Errorf("create named range: response missing namedRangeId")
 	}
-	return writeResult(ctx, ui.FromContext(ctx),
-		kv("documentId", docID),
-		kv("namedRange", docsNamedRangeItem{Name: name, NamedRangeID: createdID, Ranges: []docsNamedRangeSpan{span}}),
-	)
+	created := docsNamedRangeItem{Name: name, NamedRangeID: createdID, Ranges: []docsNamedRangeSpan{span}}
+	if outfmt.IsJSON(ctx) {
+		return outfmt.WriteJSON(ctx, os.Stdout, map[string]any{
+			"documentId": docID,
+			"namedRange": created,
+		})
+	}
+	writeDocsNamedRangeTextResult(ui.FromContext(ctx), docID, created)
+	return nil
 }
 
 type DocsNamedRangesDeleteCmd struct {
@@ -280,10 +285,15 @@ func (c *DocsNamedRangesDeleteCmd) Run(ctx context.Context, flags *RootFlags) er
 	if err != nil {
 		return fmt.Errorf("delete named range: %w", err)
 	}
-	return writeResult(ctx, ui.FromContext(ctx),
-		kv("documentId", docID),
-		kv("deleted", map[string]any{"name": item.Name, "namedRangeId": item.NamedRangeID}),
-	)
+	if outfmt.IsJSON(ctx) {
+		return outfmt.WriteJSON(ctx, os.Stdout, map[string]any{
+			"documentId": docID,
+			"deleted":    map[string]any{"name": item.Name, "namedRangeId": item.NamedRangeID},
+		})
+	}
+	writeDocsNamedRangeTextResult(ui.FromContext(ctx), docID, item)
+	ui.FromContext(ctx).Out().Linef("deleted\ttrue")
+	return nil
 }
 
 type DocsNamedRangesReplaceCmd struct {
@@ -364,12 +374,19 @@ func (c *DocsNamedRangesReplaceCmd) Run(ctx context.Context, kctx *kong.Context,
 	if !found {
 		return fmt.Errorf("replaced named range not found (id=%q)", item.NamedRangeID)
 	}
-	return writeResult(ctx, ui.FromContext(ctx),
-		kv("documentId", docID),
-		kv("namedRange", updatedItem),
-		kv("replaced", true),
-		kv("textLength", utf16Len(text)),
-	)
+	if outfmt.IsJSON(ctx) {
+		return outfmt.WriteJSON(ctx, os.Stdout, map[string]any{
+			"documentId": docID,
+			"namedRange": updatedItem,
+			"replaced":   true,
+			"textLength": utf16Len(text),
+		})
+	}
+	u := ui.FromContext(ctx)
+	writeDocsNamedRangeTextResult(u, docID, updatedItem)
+	u.Out().Linef("replaced\ttrue")
+	u.Out().Linef("textLength\t%d", utf16Len(text))
+	return nil
 }
 
 type docsNamedRangeSpan struct {
@@ -516,3 +533,17 @@ func docsNamedRangeTSV(value string) string {
 		"\n", `\n`,
 	).Replace(value)
 }
+
+func writeDocsNamedRangeTextResult(u *ui.UI, docID string, item docsNamedRangeItem) {
+	u.Out().Linef("documentId\t%s", docsNamedRangeTSV(docID))
+	u.Out().Linef("name\t%s", docsNamedRangeTSV(item.Name))
+	u.Out().Linef("namedRangeId\t%s", docsNamedRangeTSV(item.NamedRangeID))
+	u.Out().Linef("rangeCount\t%d", len(item.Ranges))
+	for i, span := range item.Ranges {
+		prefix := fmt.Sprintf("range%d", i+1)
+		u.Out().Linef("%sStartIndex\t%d", prefix, span.StartIndex)
+		u.Out().Linef("%sEndIndex\t%d", prefix, span.EndIndex)
+		u.Out().Linef("%sTabId\t%s", prefix, docsNamedRangeTSV(span.TabID))
+		u.Out().Linef("%sSegmentId\t%s", prefix, docsNamedRangeTSV(span.SegmentID))
+	}
+}
diff --git a/internal/cmd/docs_named_ranges_test.go b/internal/cmd/docs_named_ranges_test.go
@@ -12,6 +12,7 @@ import (
 	"google.golang.org/api/docs/v1"
 
 	"github.com/steipete/gogcli/internal/outfmt"
+	"github.com/steipete/gogcli/internal/ui"
 )
 
 type docsNamedRangeRecorder struct {
@@ -263,6 +264,33 @@ func TestDocsNamedRangeTSVPreservesUnicodeAndLiteralCharacters(t *testing.T) {
 	}
 }
 
+func TestWriteDocsNamedRangeTextResultIsStableTSV(t *testing.T) {
+	ctx, out := newDocsCmdOutputContext(t)
+	ctx = outfmt.WithMode(ctx, outfmt.Mode{Plain: true})
+	writeDocsNamedRangeTextResult(ui.FromContext(ctx), "doc1", docsNamedRangeItem{
+		Name:         "Résumé\tline\nnext",
+		NamedRangeID: "nr1",
+		Ranges: []docsNamedRangeSpan{{
+			StartIndex: 2,
+			EndIndex:   5,
+			TabID:      "tab\t1",
+			SegmentID:  "header\n1",
+		}},
+	})
+	want := "" +
+		"documentId\tdoc1\n" +
+		"name\tRésumé\\tline\\nnext\n" +
+		"namedRangeId\tnr1\n" +
+		"rangeCount\t1\n" +
+		"range1StartIndex\t2\n" +
+		"range1EndIndex\t5\n" +
+		"range1TabId\ttab\\t1\n" +
+		"range1SegmentId\theader\\n1\n"
+	if got := out.String(); got != want {
+		t.Fatalf("output = %q, want %q", got, want)
+	}
+}
+
 func TestResolveDocsNamedRangeRejectsAmbiguousName(t *testing.T) {
 	items := []docsNamedRangeItem{
 		{Name: "same", NamedRangeID: "nr2"},
