feat(sheets): add read-format and harden borders formatting

Author: nilzzzzzz

CHANGELOG.md

@@ -21,6 +21,7 @@
 - Forms: add form update/question-management commands plus response watch create/list/delete/renew, with delete-question validation and confirmation guardrails. (#274) — thanks @alexknowshtml.
 - Sheets: add `sheets update-note` / `set-note` to write or clear cell notes across a range. (#430) — thanks @andybergon.
 - Sheets: add `sheets create --parent` to place new spreadsheets in a Drive folder. (#424) — thanks @ManManavadaria.
+- Sheets: add `sheets read-format` to inspect `userEnteredFormat` / `effectiveFormat` per cell. (#284) — thanks @nilzzzzzz.
 - Contacts: support `--org`, `--title`, `--url`, `--note`, and `--custom` on create/update; include custom fields in get output with deterministic ordering. (#199) — thanks @phuctm97.
 - Contacts: add `--relation type=person` to contact create/update, include relations in text `contacts get`, and cover relation payload updates. (#351) — thanks @karbassi.
 - Contacts: add `--address` to contact create/update and include addresses in text `contacts get`. (#148) — thanks @beezly.
@@ -50,6 +51,7 @@
 - Auth: add `--gmail-scope full|readonly`, and disable `include_granted_scopes` for readonly/limited auth requests to avoid Drive/Gmail scope accumulation. (#113) — thanks @salmonumbrella.
 - Calendar: force-send `minutes=0` for `--reminder popup:0m` so zero-minute popup reminders survive Google Calendar API JSON omission rules. (#316) — thanks @salmonumbrella.
 - Calendar: hide cancelled/deleted events from `calendar events` list output by explicitly setting `showDeleted=false`. (#362) — thanks @sharukh010.
+- Sheets: harden `sheets format` against `boarders` typo (JSON and field mask), with clearer error messages. (#284) — thanks @nilzzzzzz.
 - Calendar: reject ambiguous calendar-name selectors for `calendar events` instead of guessing. (#131) — thanks @salmonumbrella.
 - Calendar: respond patches only attendees to avoid custom reminders validation errors. (#265) — thanks @sebasrodriguez.
 - Calendar: clarify that RFC3339 `--from/--to` timestamps must include a timezone while keeping date and relative-time help intact. (#409) — thanks @dbhurley.

README.md

@@ -928,6 +928,8 @@ gog slides replace-slide <presentationId> <slideId> ./new-slide.png --notes "New
 gog sheets copy <spreadsheetId> "My Sheet Copy"
 gog sheets export <spreadsheetId> --format pdf --out ./sheet.pdf
 gog sheets format <spreadsheetId> 'Sheet1!A1:B2' --format-json '{"textFormat":{"bold":true}}' --format-fields 'userEnteredFormat.textFormat.bold'
+gog sheets format <spreadsheetId> 'Sheet1!A1:B2' --format-json '{"borders":{"top":{"style":"SOLID"}}}' --format-fields 'userEnteredFormat.borders.top.style'
+gog sheets read-format <spreadsheetId> 'Sheet1!A1:B2'
 gog sheets insert <spreadsheetId> "Sheet1" rows 2 --count 3
 gog sheets notes <spreadsheetId> 'Sheet1!A1:B10'
 gog sheets links <spreadsheetId> 'Sheet1!A1:B10'
@@ -1028,6 +1030,9 @@ gog sheets clear <spreadsheetId> MyNamedRange
 # Format
 gog sheets format <spreadsheetId> 'Sheet1!A1:B2' --format-json '{"textFormat":{"bold":true}}' --format-fields 'userEnteredFormat.textFormat.bold'
 gog sheets format <spreadsheetId> MyNamedRange --format-json '{"textFormat":{"bold":true}}' --format-fields 'userEnteredFormat.textFormat.bold'
+gog sheets format <spreadsheetId> 'Sheet1!A1:B2' --format-json '{"borders":{"top":{"style":"SOLID"}}}' --format-fields 'userEnteredFormat.borders.top.style'
+gog sheets read-format <spreadsheetId> 'Sheet1!A1:B2'
+gog sheets read-format <spreadsheetId> 'Sheet1!A1:B2' --effective
 
 # Named ranges
 gog sheets named-ranges <spreadsheetId>

internal/cmd/execute_sheets_more_commands_test.go

@@ -58,7 +58,27 @@ func TestExecute_SheetsMoreCommands(t *testing.T) {
 				"spreadsheetId": "id1",
 				"properties":    map[string]any{"title": "T"},
 				"sheets": []map[string]any{
-					{"properties": map[string]any{"sheetId": 0, "title": "Sheet1"}},
+					{
+						"properties": map[string]any{"sheetId": 0, "title": "Sheet1"},
+						"data": []map[string]any{
+							{
+								"startRow":    0,
+								"startColumn": 0,
+								"rowData": []map[string]any{
+									{
+										"values": []map[string]any{
+											{
+												"formattedValue": "a",
+												"userEnteredFormat": map[string]any{
+													"textFormat": map[string]any{"bold": true},
+												},
+											},
+										},
+									},
+								},
+							},
+						},
+					},
 				},
 			})
 			return
@@ -138,6 +158,11 @@ func TestExecute_SheetsMoreCommands(t *testing.T) {
 				t.Fatalf("metadata: %v", err)
 			}
 		})
+		_ = captureStdout(t, func() {
+			if err := Execute([]string{"--json", "sheets", "read-format", "id1", "Sheet1!A1:A1"}); err != nil {
+				t.Fatalf("read-format: %v", err)
+			}
+		})
 		_ = captureStdout(t, func() {
 			if err := Execute([]string{"--json", "sheets", "create", "New", "--sheets", "Income,Expenses"}); err != nil {
 				t.Fatalf("create: %v", err)

internal/cmd/sheets.go

@@ -30,6 +30,7 @@ type SheetsCmd struct {
 	Insert     SheetsInsertCmd      `cmd:"" name:"insert" help:"Insert empty rows or columns into a sheet"`
 	Clear      SheetsClearCmd       `cmd:"" name:"clear" help:"Clear values in a range"`
 	Format     SheetsFormatCmd      `cmd:"" name:"format" help:"Apply cell formatting to a range"`
+	ReadFormat SheetsReadFormatCmd  `cmd:"" name:"read-format" aliases:"get-format,format-read" help:"Read cell formatting from a range"`
 	Notes      SheetsNotesCmd       `cmd:"" name:"notes" help:"Get cell notes from a range"`
 	UpdateNote SheetsUpdateNoteCmd  `cmd:"" name:"update-note" aliases:"set-note" help:"Set or clear a cell note"`
 	Links      SheetsLinksCmd       `cmd:"" name:"links" aliases:"hyperlinks" help:"Get cell hyperlinks from a range"`

internal/cmd/sheets_format.go

@@ -1,9 +1,11 @@
 package cmd
 
 import (
+	"bytes"
 	"context"
 	"encoding/json"
 	"fmt"
+	"io"
 	"os"
 	"strings"
 
@@ -38,13 +40,17 @@ func (c *SheetsFormatCmd) Run(ctx context.Context, flags *RootFlags) error {
 		return fmt.Errorf("provide format fields via --format-fields")
 	}
 
+	if hasBoardersTypo(formatFields) {
+		return fmt.Errorf(`invalid --format-fields: found "boarders"; use "borders"`)
+	}
+
 	var err error
 	var format sheets.CellFormat
 	b, err := resolveInlineOrFileBytes(c.FormatJSON)
 	if err != nil {
 		return fmt.Errorf("read --format-json: %w", err)
 	}
-	if err = json.Unmarshal(b, &format); err != nil {
+	if err = decodeCellFormatJSON(b, &format); err != nil {
 		return fmt.Errorf("invalid format JSON: %w", err)
 	}
 
@@ -112,3 +118,35 @@ func (c *SheetsFormatCmd) Run(ctx context.Context, flags *RootFlags) error {
 	u.Out().Printf("Formatted %s", rangeSpec)
 	return nil
 }
+
+func decodeCellFormatJSON(data []byte, dst *sheets.CellFormat) error {
+	if dst == nil {
+		return fmt.Errorf("format is required")
+	}
+
+	dec := json.NewDecoder(bytes.NewReader(data))
+	dec.DisallowUnknownFields()
+
+	if err := dec.Decode(dst); err != nil {
+		return err
+	}
+	var extra any
+	if err := dec.Decode(&extra); err != io.EOF {
+		if err == nil {
+			return fmt.Errorf("multiple JSON values")
+		}
+		return err
+	}
+	return nil
+}
+
+func hasBoardersTypo(mask string) bool {
+	for _, part := range splitFieldMask(mask) {
+		for _, token := range strings.Split(part, ".") {
+			if strings.EqualFold(strings.TrimSpace(token), "boarders") {
+				return true
+			}
+		}
+	}
+	return false
+}

internal/cmd/sheets_format_fields_test.go

@@ -39,6 +39,19 @@ func TestApplyForceSendFields_NumberFormatType(t *testing.T) {
 	}
 }
 
+func TestApplyForceSendFields_BordersTopStyle(t *testing.T) {
+	format := sheets.CellFormat{}
+	if err := applyForceSendFields(&format, []string{"borders.top.style"}); err != nil {
+		t.Fatalf("applyForceSendFields: %v", err)
+	}
+	if format.Borders == nil || format.Borders.Top == nil {
+		t.Fatalf("expected borders.top to be allocated, got %#v", format.Borders)
+	}
+	if !hasString(format.Borders.Top.ForceSendFields, "Style") {
+		t.Fatalf("expected Style to be force-sent, got %#v", format.Borders.Top.ForceSendFields)
+	}
+}
+
 func TestApplyForceSendFields_NilFormat(t *testing.T) {
 	if err := applyForceSendFields(nil, []string{"textFormat.bold"}); err == nil {
 		t.Fatalf("expected error for nil format")
@@ -83,3 +96,15 @@ func TestNormalizeFormatMask_LeavesUnknowns(t *testing.T) {
 		t.Fatalf("unexpected format paths: %#v", paths)
 	}
 }
+
+func TestHasBoardersTypo(t *testing.T) {
+	if !hasBoardersTypo("boarders.top.style") {
+		t.Fatalf("expected typo detection for boarders")
+	}
+	if !hasBoardersTypo("userEnteredFormat.boarders.top.style") {
+		t.Fatalf("expected typo detection for userEnteredFormat.boarders")
+	}
+	if hasBoardersTypo("borders.top.style") {
+		t.Fatalf("did not expect typo detection for borders")
+	}
+}

internal/cmd/sheets_format_test.go

@@ -104,7 +104,6 @@ func TestSheetsFormatCmd(t *testing.T) {
 		t.Fatalf("expected bold text format, got %#v", gotRepeat.Cell.UserEnteredFormat.TextFormat)
 	}
 }
-
 func TestSheetsFormatCmdNamedRange(t *testing.T) {
 	origNew := newSheetsService
 	t.Cleanup(func() { newSheetsService = origNew })
@@ -195,3 +194,81 @@ func TestSheetsFormatCmdNamedRange(t *testing.T) {
 		t.Fatalf("unexpected column range: %#v", gotRepeat.Range)
 	}
 }
+
+func TestSheetsFormatCmd_BordersTopStyle(t *testing.T) {
+	origNew := newSheetsService
+	t.Cleanup(func() { newSheetsService = origNew })
+
+	var gotRepeat *sheets.RepeatCellRequest
+
+	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		path := strings.TrimPrefix(r.URL.Path, "/sheets/v4")
+		path = strings.TrimPrefix(path, "/v4")
+		switch {
+		case strings.HasPrefix(path, "/spreadsheets/s1") && r.Method == http.MethodGet:
+			w.Header().Set("Content-Type", "application/json")
+			_ = json.NewEncoder(w).Encode(map[string]any{
+				"spreadsheetId": "s1",
+				"sheets": []map[string]any{
+					{"properties": map[string]any{"sheetId": 42, "title": "Sheet1"}},
+				},
+			})
+			return
+		case strings.Contains(path, "/spreadsheets/s1:batchUpdate") && r.Method == http.MethodPost:
+			var req sheets.BatchUpdateSpreadsheetRequest
+			if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
+				t.Fatalf("decode batchUpdate: %v", err)
+			}
+			if len(req.Requests) != 1 || req.Requests[0].RepeatCell == nil {
+				t.Fatalf("expected repeatCell request, got %#v", req.Requests)
+			}
+			gotRepeat = req.Requests[0].RepeatCell
+			w.Header().Set("Content-Type", "application/json")
+			_ = json.NewEncoder(w).Encode(map[string]any{})
+			return
+		default:
+			http.NotFound(w, r)
+			return
+		}
+	}))
+	defer srv.Close()
+
+	svc, err := sheets.NewService(context.Background(),
+		option.WithoutAuthentication(),
+		option.WithHTTPClient(srv.Client()),
+		option.WithEndpoint(srv.URL+"/"),
+	)
+	if err != nil {
+		t.Fatalf("NewService: %v", err)
+	}
+	newSheetsService = func(context.Context, string) (*sheets.Service, error) { return svc, nil }
+
+	flags := &RootFlags{Account: "a@b.com"}
+	u, uiErr := ui.New(ui.Options{Stdout: io.Discard, Stderr: io.Discard, Color: "never"})
+	if uiErr != nil {
+		t.Fatalf("ui.New: %v", uiErr)
+	}
+	ctx := ui.WithUI(context.Background(), u)
+	cmd := &SheetsFormatCmd{}
+	if err := runKong(t, cmd, []string{
+		"s1",
+		"Sheet1!B2:C3",
+		"--format-json", `{"borders":{"top":{"style":"SOLID"}}}`,
+		"--format-fields", "borders.top.style",
+	}, ctx, flags); err != nil {
+		t.Fatalf("format: %v", err)
+	}
+
+	if gotRepeat == nil {
+		t.Fatal("expected repeatCell request")
+	}
+	if gotRepeat.Fields != "userEnteredFormat.borders.top.style" {
+		t.Fatalf("unexpected fields: %s", gotRepeat.Fields)
+	}
+	if gotRepeat.Cell == nil || gotRepeat.Cell.UserEnteredFormat == nil || gotRepeat.Cell.UserEnteredFormat.Borders == nil || gotRepeat.Cell.UserEnteredFormat.Borders.Top == nil {
+		t.Fatalf("missing border data: %#v", gotRepeat.Cell)
+	}
+	if gotRepeat.Cell.UserEnteredFormat.Borders.Top.Style != "SOLID" {
+		t.Fatalf("expected SOLID top border, got %#v", gotRepeat.Cell.UserEnteredFormat.Borders.Top)
+	}
+}