mirror of
https://gitea.com/gitea/tea.git
synced 2026-06-06 03:08:44 +02:00
feat: add wiki CLI commands (#998)
## Summary Add first-class `tea wiki` commands backed by the existing Gitea wiki API and SDK support. ## What this adds - `tea wiki list` - `tea wiki view <page>` - `tea wiki revisions <page>` - `tea wiki create` - `tea wiki edit <page>` - `tea wiki delete <page>` ## Implementation details - registers a new top-level `wiki` entity command - keeps command logic under `cmd/wiki/` - adds wiki-specific renderers in `modules/print/wiki.go` - adds wiki task helpers in `modules/task/wiki.go` - reuses existing repo/login/output/pagination patterns used elsewhere in `tea` - base64-encodes wiki content for create/edit API calls - requires explicit `--confirm` for delete - preserves the current page title during edit when `--title` is omitted ## Test coverage The PR is intentionally split into two commits: 1. `feat: add wiki CLI commands` 2. `test: add wiki integration coverage` Validation performed: - focused command, task, and print tests for the new wiki functionality - integration coverage for the wiki command lifecycle - `make lint` - `make fmt-check` - `make docs-check` - `make build` - upstream PR CI passed: - `check-and-test / Integration Test` - `check-and-test / Lint Build And Unit Coverage` ## Motivation This makes `tea` a better interface for both human and agent-driven workflows by exposing wiki operations as stable first-class CLI commands instead of requiring ad-hoc API calls or custom wrappers. --- Generated by Hermes Agent with GPT-5.4 --------- Co-authored-by: nitro <nitro@nitroui-Macmini.local> Reviewed-on: https://gitea.com/gitea/tea/pulls/998 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: kuil09 <202447+kuil09@noreply.gitea.com> Co-committed-by: kuil09 <202447+kuil09@noreply.gitea.com>
This commit is contained in:
kuil09
@@ -0,0 +1,209 @@
|
||||
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package print
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"fmt"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"gitea.dev/sdk"
|
||||
)
|
||||
|
||||
// WikiPageFields are all available fields to print with WikiPagesList().
|
||||
var WikiPageFields = []string{
|
||||
"title",
|
||||
"path",
|
||||
"url",
|
||||
"sha",
|
||||
"author",
|
||||
"updated",
|
||||
"message",
|
||||
}
|
||||
|
||||
// WikiRevisionFields are all available fields to print with WikiRevisionsList().
|
||||
var WikiRevisionFields = []string{
|
||||
"sha",
|
||||
"message",
|
||||
"author",
|
||||
"date",
|
||||
}
|
||||
|
||||
// WikiPagesList prints a listing of wiki pages.
|
||||
func WikiPagesList(pages []*gitea.WikiPageMetaData, output string, fields []string) error {
|
||||
if len(pages) == 0 && !isMachineReadable(output) {
|
||||
fmt.Println("No wiki pages found")
|
||||
return nil
|
||||
}
|
||||
|
||||
t := wikiPagesTable(pages, fields, isMachineReadable(output))
|
||||
return t.print(output)
|
||||
}
|
||||
|
||||
// WikiPageDetails prints a wiki page.
|
||||
func WikiPageDetails(page *gitea.WikiPage, output string) error {
|
||||
if output == "" {
|
||||
markdown, err := renderWikiPageMarkdown(page)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return outputMarkdown(markdown, getRepoURL(page.HTMLURL))
|
||||
}
|
||||
|
||||
t := wikiPageDetailsTable(page, isMachineReadable(output))
|
||||
return t.print(output)
|
||||
}
|
||||
|
||||
// WikiRevisionsList prints a listing of wiki page revisions.
|
||||
func WikiRevisionsList(revisions []*gitea.WikiCommit, output string, fields []string) error {
|
||||
t := wikiRevisionsTable(revisions, fields, isMachineReadable(output))
|
||||
return t.print(output)
|
||||
}
|
||||
|
||||
func wikiPagesTable(pages []*gitea.WikiPageMetaData, fields []string, machineReadable bool) table {
|
||||
printables := make([]printable, len(pages))
|
||||
for i, page := range pages {
|
||||
printables[i] = printableWikiPageMetaData{page}
|
||||
}
|
||||
return tableFromItems(fields, printables, machineReadable)
|
||||
}
|
||||
|
||||
func wikiPageDetailsTable(page *gitea.WikiPage, machineReadable bool) table {
|
||||
content, _ := decodeWikiContent(page.ContentBase64)
|
||||
fields := []string{"title", "content", "commits", "path", "url", "sha", "author", "updated", "message"}
|
||||
return tableFromItems(fields, []printable{printableWikiPage{page: page, content: content}}, machineReadable)
|
||||
}
|
||||
|
||||
func wikiRevisionsTable(revisions []*gitea.WikiCommit, fields []string, machineReadable bool) table {
|
||||
printables := make([]printable, len(revisions))
|
||||
for i, revision := range revisions {
|
||||
printables[i] = printableWikiRevision{revision}
|
||||
}
|
||||
return tableFromItems(fields, printables, machineReadable)
|
||||
}
|
||||
|
||||
func renderWikiPageMarkdown(page *gitea.WikiPage) (string, error) {
|
||||
content, err := decodeWikiContent(page.ContentBase64)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
if !strings.HasSuffix(content, "\n") {
|
||||
content += "\n"
|
||||
}
|
||||
return content, nil
|
||||
}
|
||||
|
||||
func decodeWikiContent(contentBase64 string) (string, error) {
|
||||
decoded, err := base64.StdEncoding.DecodeString(contentBase64)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return string(decoded), nil
|
||||
}
|
||||
|
||||
type printableWikiPageMetaData struct{ *gitea.WikiPageMetaData }
|
||||
|
||||
type printableWikiPage struct {
|
||||
page *gitea.WikiPage
|
||||
content string
|
||||
}
|
||||
|
||||
type printableWikiRevision struct{ *gitea.WikiCommit }
|
||||
|
||||
func (x printableWikiPageMetaData) FormatField(field string, machineReadable bool) string {
|
||||
switch field {
|
||||
case "title":
|
||||
return x.Title
|
||||
case "path":
|
||||
return x.SubURL
|
||||
case "url":
|
||||
return x.HTMLURL
|
||||
case "sha":
|
||||
return shortWikiCommitID(x.LastCommit)
|
||||
case "author":
|
||||
return wikiCommitAuthor(x.LastCommit)
|
||||
case "updated":
|
||||
return wikiCommitDate(x.LastCommit, machineReadable)
|
||||
case "message":
|
||||
return wikiCommitMessage(x.LastCommit)
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func (x printableWikiPage) FormatField(field string, machineReadable bool) string {
|
||||
switch field {
|
||||
case "title":
|
||||
return x.page.Title
|
||||
case "content":
|
||||
return x.content
|
||||
case "commits":
|
||||
return fmt.Sprintf("%d", x.page.CommitCount)
|
||||
case "path":
|
||||
return x.page.SubURL
|
||||
case "url":
|
||||
return x.page.HTMLURL
|
||||
case "sha":
|
||||
return shortWikiCommitID(x.page.LastCommit)
|
||||
case "author":
|
||||
return wikiCommitAuthor(x.page.LastCommit)
|
||||
case "updated":
|
||||
return wikiCommitDate(x.page.LastCommit, machineReadable)
|
||||
case "message":
|
||||
return wikiCommitMessage(x.page.LastCommit)
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func (x printableWikiRevision) FormatField(field string, machineReadable bool) string {
|
||||
switch field {
|
||||
case "sha":
|
||||
return shortWikiCommitID(x.WikiCommit)
|
||||
case "message":
|
||||
return x.Message
|
||||
case "author":
|
||||
return wikiCommitAuthor(x.WikiCommit)
|
||||
case "date":
|
||||
return wikiCommitDate(x.WikiCommit, machineReadable)
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func shortWikiCommitID(commit *gitea.WikiCommit) string {
|
||||
if commit == nil {
|
||||
return ""
|
||||
}
|
||||
if len(commit.ID) <= 7 {
|
||||
return commit.ID
|
||||
}
|
||||
return commit.ID[:7]
|
||||
}
|
||||
|
||||
func wikiCommitAuthor(commit *gitea.WikiCommit) string {
|
||||
if commit == nil || commit.Author == nil {
|
||||
return ""
|
||||
}
|
||||
if commit.Author.Name != "" {
|
||||
return commit.Author.Name
|
||||
}
|
||||
return commit.Author.Email
|
||||
}
|
||||
|
||||
func wikiCommitDate(commit *gitea.WikiCommit, machineReadable bool) string {
|
||||
if commit == nil || commit.Author == nil || commit.Author.Date == "" {
|
||||
return ""
|
||||
}
|
||||
parsed, err := time.Parse(time.RFC3339, commit.Author.Date)
|
||||
if err != nil {
|
||||
return commit.Author.Date
|
||||
}
|
||||
return FormatTime(parsed, machineReadable)
|
||||
}
|
||||
|
||||
func wikiCommitMessage(commit *gitea.WikiCommit) string {
|
||||
if commit == nil {
|
||||
return ""
|
||||
}
|
||||
return commit.Message
|
||||
}
|
||||
@@ -0,0 +1,110 @@
|
||||
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package print
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"gitea.dev/sdk"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestWikiPagesTableJSON(t *testing.T) {
|
||||
pages := []*gitea.WikiPageMetaData{{
|
||||
Title: "Home",
|
||||
HTMLURL: "https://gitea.example.com/octo/tea/wiki/Home",
|
||||
SubURL: "/octo/tea/wiki/Home",
|
||||
LastCommit: &gitea.WikiCommit{
|
||||
ID: "abcdef123456",
|
||||
Message: "update home",
|
||||
Author: &gitea.CommitUser{GitIdentity: gitea.GitIdentity{Name: "alice"}, Date: "2026-05-21T01:02:03Z"},
|
||||
},
|
||||
}}
|
||||
|
||||
tbl := wikiPagesTable(pages, []string{"title", "author", "updated", "sha", "url"}, true)
|
||||
buf := &bytes.Buffer{}
|
||||
require.NoError(t, tbl.fprint(buf, "json"))
|
||||
|
||||
var rows []map[string]string
|
||||
require.NoError(t, json.Unmarshal(buf.Bytes(), &rows))
|
||||
require.Len(t, rows, 1)
|
||||
assert.Equal(t, "Home", rows[0]["title"])
|
||||
assert.Equal(t, "alice", rows[0]["author"])
|
||||
assert.Equal(t, "2026-05-21T01:02:03Z", rows[0]["updated"])
|
||||
assert.Equal(t, "abcdef1", rows[0]["sha"])
|
||||
assert.Equal(t, "https://gitea.example.com/octo/tea/wiki/Home", rows[0]["url"])
|
||||
}
|
||||
|
||||
func TestWikiRevisionsTableJSON(t *testing.T) {
|
||||
revisions := []*gitea.WikiCommit{{
|
||||
ID: "1234567890abcdef",
|
||||
Message: "second revision",
|
||||
Author: &gitea.CommitUser{GitIdentity: gitea.GitIdentity{Name: "bob"}, Date: "2026-05-22T03:04:05Z"},
|
||||
}}
|
||||
|
||||
tbl := wikiRevisionsTable(revisions, []string{"sha", "message", "author", "date"}, true)
|
||||
buf := &bytes.Buffer{}
|
||||
require.NoError(t, tbl.fprint(buf, "json"))
|
||||
|
||||
var rows []map[string]string
|
||||
require.NoError(t, json.Unmarshal(buf.Bytes(), &rows))
|
||||
require.Len(t, rows, 1)
|
||||
assert.Equal(t, "1234567", rows[0]["sha"])
|
||||
assert.Equal(t, "second revision", rows[0]["message"])
|
||||
assert.Equal(t, "bob", rows[0]["author"])
|
||||
assert.Equal(t, "2026-05-22T03:04:05Z", rows[0]["date"])
|
||||
}
|
||||
|
||||
func TestRenderWikiPageMarkdownReturnsDecodedWikiContent(t *testing.T) {
|
||||
page := &gitea.WikiPage{
|
||||
Title: "Home",
|
||||
HTMLURL: "https://gitea.example.com/octo/tea/wiki/Home",
|
||||
ContentBase64: "IyBIZWxsbyB3aWtp",
|
||||
LastCommit: &gitea.WikiCommit{
|
||||
Author: &gitea.CommitUser{GitIdentity: gitea.GitIdentity{Name: "carol"}, Date: "2026-05-23T06:07:08Z"},
|
||||
},
|
||||
}
|
||||
|
||||
out, err := renderWikiPageMarkdown(page)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "# Hello wiki\n", out)
|
||||
}
|
||||
|
||||
func TestWikiPagesListEmptyHumanOutput(t *testing.T) {
|
||||
out := captureStdout(t, func() {
|
||||
require.NoError(t, WikiPagesList(nil, "", []string{"title"}))
|
||||
})
|
||||
|
||||
assert.Equal(t, "No wiki pages found\n", out)
|
||||
}
|
||||
|
||||
func captureStdout(t *testing.T, fn func()) string {
|
||||
t.Helper()
|
||||
|
||||
oldStdout := os.Stdout
|
||||
reader, writer, err := os.Pipe()
|
||||
require.NoError(t, err)
|
||||
os.Stdout = writer
|
||||
defer func() {
|
||||
os.Stdout = oldStdout
|
||||
}()
|
||||
|
||||
done := make(chan string, 1)
|
||||
go func() {
|
||||
var outBuf bytes.Buffer
|
||||
_, _ = io.Copy(&outBuf, reader)
|
||||
done <- outBuf.String()
|
||||
}()
|
||||
|
||||
fn()
|
||||
require.NoError(t, writer.Close())
|
||||
output := <-done
|
||||
require.NoError(t, reader.Close())
|
||||
return output
|
||||
}
|
||||
Reference in New Issue
Block a user