mirror of
https://gitea.com/gitea/tea.git
synced 2026-09-10 18:36:56 +00:00
ongolk
b2bab268d7
## Problem `tea pulls create` accepts `--output` (the flag parses successfully) but never reads it — the action always prints glamour-rendered markdown regardless of the requested format. That is a trap for anyone scripting the CLI: `tea pr create --output json | jq .url` quietly feeds jq a markdown document. The current output is also hostile to URL-scraping consumers even without `--output`: glamour autolinks the bare PR URL into an OSC 8 terminal hyperlink, so piped stdout contains ``` \x1b]8;;https://host/owner/repo/pulls/33\x1b\\https://host/owner/repo/pulls/33\x1b]8;;\x1b\\ ``` instead of a plain URL (repro: `tea pr create ... | cat -v`). ## Why the flag parses but does nothing `create` itself does not declare `--output`: its flag set (`IssuePRCreateFlags`) carries no `OutputFlag`. The flag parses anyway because urfave/cli v3 resolves flags through `Command.lookupAppliedFlag`, which searches `appliedFlags` — "local flags for current command **or persistent flags from ancestors**". The parent `pulls` command carries `--output` via `AllDefaultFlags`, so the flag reaches the subcommand's parser while being absent from `create --help` — and was never consulted by the action. ## What this changes - `task.CreatePull` now returns the created `*gitea.PullRequest` instead of printing it. - `runPullsCreate` switches on `--output`, mirroring the existing detail-command precedent (`RunPullsDetails` in `cmd/pulls.go`): `--output json` emits a lean JSON object; any other value (or no flag at all) falls through to the previous `print.PullDetails` rendering, byte-identical to before. - Lean JSON shape, since a freshly created PR has no reviews/comments/CI yet: `index`, `title`, `url`, `state`, `base`, `head`. - `--agit` combined with `--output` now fails fast with an explicit error before any API call or `git push`: the agit flow creates the PR server-side via push and returns no object to print. - The interactive path is untouched — it only triggers when zero flags are set, so `--output` can never be active there. Example: ``` $ tea pr create --output json --title "fix: thing" | jq -r .url https://gitea.example.com/owner/repo/pulls/33 ``` --------- Co-authored-by: Danilo Sousa <code@danilosousa.net> Reviewed-on: https://gitea.com/gitea/tea/pulls/1111 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: ongolk <238961+ongolk@noreply.gitea.com>
46 lines
1.2 KiB
Go
46 lines
1.2 KiB
Go
// Copyright 2026 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package pulls
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"testing"
|
|
|
|
gitea "gitea.dev/sdk"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestWriteCreatedPullAsJSON(t *testing.T) {
|
|
pr := &gitea.PullRequest{
|
|
Index: 33,
|
|
Title: "test title",
|
|
HTMLURL: "https://gitea.example.com/owner/repo/pulls/33",
|
|
State: gitea.StateOpen,
|
|
Base: &gitea.PRBranchInfo{Ref: "main"},
|
|
Head: &gitea.PRBranchInfo{Ref: "feature"},
|
|
}
|
|
|
|
var buf bytes.Buffer
|
|
require.NoError(t, writeCreatedPullAsJSON(&buf, pr))
|
|
|
|
var got map[string]any
|
|
require.NoError(t, json.Unmarshal(buf.Bytes(), &got))
|
|
|
|
assert.Equal(t, float64(33), got["index"])
|
|
assert.Equal(t, "test title", got["title"])
|
|
assert.Equal(t, "https://gitea.example.com/owner/repo/pulls/33", got["url"])
|
|
assert.Equal(t, "open", got["state"])
|
|
assert.Equal(t, "main", got["base"])
|
|
assert.Equal(t, "feature", got["head"])
|
|
|
|
// exactly the lean field set, nothing extra
|
|
assert.Len(t, got, 6)
|
|
|
|
// machine-readable output must not contain terminal escape sequences
|
|
assert.NotContains(t, buf.String(), "\x1b")
|
|
}
|