From 6e45fbb3e12f660c6faf1885a19cda6802e9aa00 Mon Sep 17 00:00:00 2001 From: NeeNe <26158277@qq.com> Date: Mon, 8 Jun 2026 11:36:41 +0800 Subject: [PATCH 1/4] =?UTF-8?q?feat:=20=E6=96=B0=E5=A2=9E=E4=BB=93?= =?UTF-8?q?=E5=BA=93=E6=96=87=E4=BB=B6=E6=A0=91=E5=BF=AB=E6=8D=B7=E5=91=BD?= =?UTF-8?q?=E4=BB=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 ++ README.zh-CN.md | 4 ++ doc/design.md | 4 +- shortcuts/repo/repo.go | 25 +++++++++++ shortcuts/repo/repo_test.go | 36 ++++++++++++++++ skills/gitlink-repo/SKILL.md | 3 ++ .../references/gitlink-repo-tree.md | 42 +++++++++++++++++++ 7 files changed, 116 insertions(+), 2 deletions(-) create mode 100644 skills/gitlink-repo/references/gitlink-repo-tree.md diff --git a/README.md b/README.md index eed6478..33b66b1 100644 --- a/README.md +++ b/README.md @@ -204,6 +204,10 @@ gitlink-cli repo +info --owner Gitlink --repo forgeplus # Read repository README gitlink-cli repo +readme --owner Gitlink --repo forgeplus --ref master +# List repository files at root or a directory +gitlink-cli repo +tree --owner Gitlink --repo forgeplus --ref master +gitlink-cli repo +tree --owner Gitlink --repo forgeplus --path src --ref main + # Show language breakdown gitlink-cli repo +languages --owner Gitlink --repo forgeplus diff --git a/README.zh-CN.md b/README.zh-CN.md index 7336d68..62ce9df 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -215,6 +215,10 @@ gitlink-cli repo +info --owner Gitlink --repo forgeplus # 读取仓库 README gitlink-cli repo +readme --owner Gitlink --repo forgeplus --ref master +# 列出仓库根目录或指定目录文件 +gitlink-cli repo +tree --owner Gitlink --repo forgeplus --ref master +gitlink-cli repo +tree --owner Gitlink --repo forgeplus --path src --ref main + # 查看语言占比 gitlink-cli repo +languages --owner Gitlink --repo forgeplus diff --git a/doc/design.md b/doc/design.md index d25295b..3a0e606 100644 --- a/doc/design.md +++ b/doc/design.md @@ -40,7 +40,7 @@ gitlink-cli/ │ ├── common/ │ │ ├── types.go # Shortcut / Flag / RuntimeContext 定义 │ │ └── runner.go # CallAPI / PaginateAll / ResolveOwnerRepo -│ ├── repo/ # repo +create / +clone / +fork / +list / +info +│ ├── repo/ # repo +create / +clone / +fork / +list / +info / +tree │ ├── issue/ # issue +list / +create / +view / +close / +comment │ ├── pr/ # pr +list / +create / +view / +merge / +review │ ├── release/ # release +list / +create / +download @@ -78,7 +78,7 @@ gitlink-cli/ | 领域 | Shortcuts | 数量 | |------|-----------|------| -| repo | `+create` `+clone` `+fork` `+list` `+info` `+delete` `+settings` | 7 | +| repo | `+create` `+clone` `+fork` `+list` `+info` `+tree` `+delete` `+settings` | 8 | | issue | `+list` `+create` `+view` `+update` `+close` `+comment` `+assign` `+label` | 8 | | pr | `+list` `+create` `+view` `+merge` `+close` `+review` `+files` `+diff` | 8 | | release | `+list` `+create` `+view` `+delete` `+download` | 5 | diff --git a/shortcuts/repo/repo.go b/shortcuts/repo/repo.go index 09c091c..e57963a 100644 --- a/shortcuts/repo/repo.go +++ b/shortcuts/repo/repo.go @@ -81,6 +81,31 @@ func Shortcuts(translators ...*i18n.Translator) []*common.Shortcut { return ctx.Output(env) }, }, + { + Name: "tree", + Description: "List repository files and directories", + Flags: []common.Flag{ + {Name: "path", Short: "p", Usage: "Directory path to list (default: repository root)"}, + {Name: "ref", Short: "r", Usage: "Branch, tag, or commit ref", Default: "master"}, + }, + Run: func(ctx *common.RuntimeContext) error { + if err := ctx.ResolveOwnerRepo(); err != nil { + return err + } + q := url.Values{} + ref := ctx.Arg("ref") + if ref == "" { + ref = "master" + } + q.Set("filepath", ctx.Arg("path")) + q.Set("ref", ref) + env, err := ctx.CallAPIWithQuery("GET", ctx.RepoPath()+"/sub_entries", q) + if err != nil { + return err + } + return ctx.Output(env) + }, + }, { Name: "languages", Description: "Show repository language statistics", diff --git a/shortcuts/repo/repo_test.go b/shortcuts/repo/repo_test.go index f3c1a35..38f8ab0 100644 --- a/shortcuts/repo/repo_test.go +++ b/shortcuts/repo/repo_test.go @@ -152,6 +152,42 @@ func TestRepoReadmeUsesRepositoryReadmeEndpoint(t *testing.T) { } } +func TestRepoTreeListsRootOnDefaultRef(t *testing.T) { + server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + assertRequest(t, r, "GET", "/owner/repo/sub_entries.json") + assertEqual(t, r.URL.Query().Get("filepath"), "") + assertEqual(t, r.URL.Query().Get("ref"), "master") + writeJSON(t, w, map[string]interface{}{ + "entries": []map[string]interface{}{ + {"name": "README.md", "type": "file"}, + }, + }) + })) + defer server.Close() + + if err := runShortcut(t, server, "tree", nil); err != nil { + t.Fatalf("tree shortcut failed: %v", err) + } +} + +func TestRepoTreeUsesPathAndRef(t *testing.T) { + server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + assertRequest(t, r, "GET", "/owner/repo/sub_entries.json") + assertEqual(t, r.URL.Query().Get("filepath"), "cmd") + assertEqual(t, r.URL.Query().Get("ref"), "main") + writeJSON(t, w, map[string]interface{}{ + "entries": []map[string]interface{}{ + {"name": "main.go", "type": "file"}, + }, + }) + })) + defer server.Close() + + if err := runShortcut(t, server, "tree", map[string]string{"path": "cmd", "ref": "main"}); err != nil { + t.Fatalf("tree shortcut failed: %v", err) + } +} + func TestRepoLanguagesUsesLanguagesEndpoint(t *testing.T) { server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { assertRequest(t, r, "GET", "/owner/repo/languages.json") diff --git a/skills/gitlink-repo/SKILL.md b/skills/gitlink-repo/SKILL.md index bdd75c9..9db96eb 100644 --- a/skills/gitlink-repo/SKILL.md +++ b/skills/gitlink-repo/SKILL.md @@ -23,6 +23,7 @@ metadata: | `repo +list` | 仓库列表 | 否（公开项目） | | `repo +info` | 仓库详情 | 否（公开项目） | | `repo +readme` | README 内容 | 否（公开项目） | +| `repo +tree` | 仓库文件树 | 否（公开项目） | | `repo +languages` | 仓库语言统计 | 否（公开项目） | | `repo +contributors` | 仓库贡献者列表 | 否（公开项目） | | `repo +contributor-stats` | 贡献者代码行统计 | 否（公开项目） | @@ -51,6 +52,8 @@ gitlink-cli repo +info gitlink-cli repo +list --user zhangsan # 查看语言占比和贡献者 +gitlink-cli repo +tree --owner Gitlink --repo forgeplus --ref master +gitlink-cli repo +tree --owner Gitlink --repo forgeplus --path src --ref main gitlink-cli repo +languages --owner Gitlink --repo forgeplus gitlink-cli repo +contributors --owner Gitlink --repo forgeplus diff --git a/skills/gitlink-repo/references/gitlink-repo-tree.md b/skills/gitlink-repo/references/gitlink-repo-tree.md new file mode 100644 index 0000000..faabb64 --- /dev/null +++ b/skills/gitlink-repo/references/gitlink-repo-tree.md @@ -0,0 +1,42 @@ +# repo +tree + +> **前置条件：** 先阅读 [`../gitlink-shared/SKILL.md`](../../gitlink-shared/SKILL.md) 了解认证、全局参数和安全规则。 + +列出 GitLink 仓库根目录或指定目录下的文件和子目录。该命令封装 `sub_entries` API，适合项目结构检查、文档检查、科研复现性分析和 Agent 自动化报告。 + +## 命令 + +```bash +# 列出仓库根目录 +gitlink-cli repo +tree --owner someone --repo myrepo + +# 指定分支、标签或提交 +gitlink-cli repo +tree --owner someone --repo myrepo --ref main + +# 列出指定目录 +gitlink-cli repo +tree --owner someone --repo myrepo --path src --ref main + +# 输出为 JSON +gitlink-cli repo +tree --owner someone --repo myrepo --format json +``` + +## 参数 + +| 参数 | 必填 | 说明 | +|------|------|------| +| `--path, -p` | 否 | 要列出的目录路径，默认为仓库根目录 | +| `--ref, -r` | 否 | 分支、标签或提交引用，默认 `master` | +| `--owner` | 否 | 全局参数 - 仓库所有者，可从 git remote 自动解析 | +| `--repo` | 否 | 全局参数 - 仓库名称，可从 git remote 自动解析 | +| `--format` | 否 | 输出格式：`json`/`table`/`yaml` | +| `--debug` | 否 | 启用调试输出 | + +## 注意事项 + +- GitLink 仓库常见默认分支是 `master`，镜像仓库也可能使用 `main`。如果根目录返回不存在，请显式指定 `--ref main` 或从 `repo +info` 的 `default_branch` 字段确认。 +- AI Agent 场景建议使用 `--format json`，便于读取 `data.entries` 中的文件名、路径、类型和 SHA。 + +## 参考 + +- [gitlink-repo](../SKILL.md) +- [gitlink-shared](../../gitlink-shared/SKILL.md) From a58056292203bce3eaa456bde62655a54bf62711 Mon Sep 17 00:00:00 2001 From: NeeNe <26158277@qq.com> Date: Mon, 8 Jun 2026 11:51:54 +0800 Subject: [PATCH 2/4] =?UTF-8?q?chore:=20=E6=89=93=E7=A3=A8=E4=BB=93?= =?UTF-8?q?=E5=BA=93=E6=96=87=E4=BB=B6=E6=A0=91=E5=91=BD=E4=BB=A4=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E5=92=8C=E5=9B=BD=E9=99=85=E5=8C=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/design.md | 4 ++-- internal/i18n/locales/en-US.json | 3 +++ internal/i18n/locales/zh-CN.json | 3 +++ shortcuts/repo/repo.go | 6 +++--- skills/gitlink-repo/SKILL.md | 2 +- 5 files changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/design.md b/doc/design.md index 3a0e606..d48f9c2 100644 --- a/doc/design.md +++ b/doc/design.md @@ -40,7 +40,7 @@ gitlink-cli/ │ ├── common/ │ │ ├── types.go # Shortcut / Flag / RuntimeContext 定义 │ │ └── runner.go # CallAPI / PaginateAll / ResolveOwnerRepo -│ ├── repo/ # repo +create / +clone / +fork / +list / +info / +tree +│ ├── repo/ # repo +list / +info / +readme / +tree / +languages / +create ... │ ├── issue/ # issue +list / +create / +view / +close / +comment │ ├── pr/ # pr +list / +create / +view / +merge / +review │ ├── release/ # release +list / +create / +download @@ -78,7 +78,7 @@ gitlink-cli/ | 领域 | Shortcuts | 数量 | |------|-----------|------| -| repo | `+create` `+clone` `+fork` `+list` `+info` `+tree` `+delete` `+settings` | 8 | +| repo | `+list` `+info` `+readme` `+tree` `+languages` `+contributors` `+contributor-stats` `+code-stats` `+watchers` `+stargazers` `+follow` `+unfollow` `+like` `+unlike` `+create` `+fork` `+delete` | 17 | | issue | `+list` `+create` `+view` `+update` `+close` `+comment` `+assign` `+label` | 8 | | pr | `+list` `+create` `+view` `+merge` `+close` `+review` `+files` `+diff` | 8 | | release | `+list` `+create` `+view` `+delete` `+download` | 5 | diff --git a/internal/i18n/locales/en-US.json b/internal/i18n/locales/en-US.json index 55ff7b7..c8df7cf 100644 --- a/internal/i18n/locales/en-US.json +++ b/internal/i18n/locales/en-US.json @@ -65,6 +65,7 @@ "cmd.repo.info.short": "Show repository details", "cmd.repo.list.short": "List repositories for a user or organization", "cmd.repo.short": "Repository operations", + "cmd.repo.tree.short": "List repository files and directories", "cmd.root.long": "Manage repositories, issues, pull requests, releases, CI and workflows on GitLink.", "cmd.root.short": "GitLink CLI - command-line tool for GitLink", "cmd.search.repos.short": "Search repositories", @@ -172,6 +173,8 @@ "flag.repo.description": "Repository description", "flag.repo.name": "Repository name", "flag.repo.private": "Make repository private (true/false)", + "flag.repo.tree.path": "Directory path to list (default: repository root)", + "flag.repo.tree.ref": "Branch, tag, or commit ref", "flag.search.keyword": "Search keyword", "flag.sort_by": "Sort field", "flag.sort_direction": "Sort direction: asc, desc", diff --git a/internal/i18n/locales/zh-CN.json b/internal/i18n/locales/zh-CN.json index 1409414..7fdc2b1 100644 --- a/internal/i18n/locales/zh-CN.json +++ b/internal/i18n/locales/zh-CN.json @@ -65,6 +65,7 @@ "cmd.repo.info.short": "显示仓库详情", "cmd.repo.list.short": "列出用户或组织的仓库", "cmd.repo.short": "仓库操作", + "cmd.repo.tree.short": "列出仓库文件和目录", "cmd.root.long": "用于管理 GitLink 上的仓库、议题、拉取请求、发布、CI 和工作流。", "cmd.root.short": "GitLink CLI - GitLink 命令行工具", "cmd.search.repos.short": "搜索仓库", @@ -172,6 +173,8 @@ "flag.repo.description": "仓库描述", "flag.repo.name": "仓库名称", "flag.repo.private": "设为私有仓库（true/false）", + "flag.repo.tree.path": "要列出的目录路径（默认：仓库根目录）", + "flag.repo.tree.ref": "分支、标签或提交引用", "flag.search.keyword": "搜索关键词", "flag.sort_by": "排序字段", "flag.sort_direction": "排序方向：asc、desc", diff --git a/shortcuts/repo/repo.go b/shortcuts/repo/repo.go index e57963a..90924b5 100644 --- a/shortcuts/repo/repo.go +++ b/shortcuts/repo/repo.go @@ -83,10 +83,10 @@ func Shortcuts(translators ...*i18n.Translator) []*common.Shortcut { }, { Name: "tree", - Description: "List repository files and directories", + Description: tr.T("cmd.repo.tree.short"), Flags: []common.Flag{ - {Name: "path", Short: "p", Usage: "Directory path to list (default: repository root)"}, - {Name: "ref", Short: "r", Usage: "Branch, tag, or commit ref", Default: "master"}, + {Name: "path", Short: "p", Usage: tr.T("flag.repo.tree.path")}, + {Name: "ref", Short: "r", Usage: tr.T("flag.repo.tree.ref"), Default: "master"}, }, Run: func(ctx *common.RuntimeContext) error { if err := ctx.ResolveOwnerRepo(); err != nil { diff --git a/skills/gitlink-repo/SKILL.md b/skills/gitlink-repo/SKILL.md index 9db96eb..5d59705 100644 --- a/skills/gitlink-repo/SKILL.md +++ b/skills/gitlink-repo/SKILL.md @@ -51,7 +51,7 @@ gitlink-cli repo +info # 列出用户的仓库 gitlink-cli repo +list --user zhangsan -# 查看语言占比和贡献者 +# 查看文件树、语言占比和贡献者 gitlink-cli repo +tree --owner Gitlink --repo forgeplus --ref master gitlink-cli repo +tree --owner Gitlink --repo forgeplus --path src --ref main gitlink-cli repo +languages --owner Gitlink --repo forgeplus From 0da1d8d7bf16f1fba43c99d19416c251fb78882d Mon Sep 17 00:00:00 2001 From: NeeNe <26158277@qq.com> Date: Mon, 8 Jun 2026 11:55:09 +0800 Subject: [PATCH 3/4] =?UTF-8?q?docs:=20=E8=A1=A5=E5=85=85=E4=BB=93?= =?UTF-8?q?=E5=BA=93=E6=96=87=E4=BB=B6=E6=A0=91=E5=91=BD=E4=BB=A4=E5=8F=98?= =?UTF-8?q?=E6=9B=B4=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/changes/repo-tree-shortcut.md | 60 +++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 doc/changes/repo-tree-shortcut.md diff --git a/doc/changes/repo-tree-shortcut.md b/doc/changes/repo-tree-shortcut.md new file mode 100644 index 0000000..85c3ee7 --- /dev/null +++ b/doc/changes/repo-tree-shortcut.md @@ -0,0 +1,60 @@ +# Repo Tree Shortcut + +## Summary + +Adds `gitlink-cli repo +tree` so users and AI Agents can list repository files and directories without manually calling the Raw API. + +## Command + +| Command | Purpose | +|---------|---------| +| `gitlink-cli repo +tree` | List repository files and directories at the repository root or a specified path | + +## Usage + +```bash +# List repository root entries +gitlink-cli repo +tree --owner Gitlink --repo forgeplus --ref master + +# List entries under a directory +gitlink-cli repo +tree --owner Gitlink --repo forgeplus --path src --ref main + +# AI Agent usage with structured output +gitlink-cli repo +tree --owner Gitlink --repo forgeplus --format json +``` + +## Behavior + +- Calls `GET /{owner}/{repo}/sub_entries`. +- Maps `--path, -p` to the `filepath` query parameter. +- Maps `--ref, -r` to the `ref` query parameter. +- Defaults `--ref` to `master` when omitted. +- Reuses existing repository context resolution and output formatting. + +## Tests + +Unit tests cover: + +- root directory listing with the default `master` ref; +- directory listing with explicit `--path` and `--ref`; +- endpoint path and query parameter mapping. + +Validation command: + +```bash +make test +``` + +## 中文说明 + +### 变更内容 + +- 新增 `repo +tree` 仓库文件树查询命令。 +- 支持查看仓库根目录或指定目录下的文件和子目录。 +- 支持通过 `--ref` 指定分支、标签或提交引用。 +- 更新 README、README.zh-CN、设计文档和 `gitlink-repo` Skill 文档。 +- 新增 `gitlink-repo` Skill 参考文档，便于 Agent 在项目结构检查、复现性检查和合规检查中复用。 + +### 验证 + +- `make test` From 21ebb2f89c08855134f9ba15d2ed1065b3652e6d Mon Sep 17 00:00:00 2001 From: NeeNe <26158277@qq.com> Date: Mon, 8 Jun 2026 12:13:28 +0800 Subject: [PATCH 4/4] =?UTF-8?q?chore:=20=E6=89=93=E7=A3=A8=E4=BB=93?= =?UTF-8?q?=E5=BA=93=E6=96=87=E4=BB=B6=E6=A0=91=E5=91=BD=E4=BB=A4=E4=BA=A4?= =?UTF-8?q?=E4=BB=98=E8=B4=A8=E9=87=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/changes/repo-tree-shortcut.md | 71 +++++++++++++++++-------------- shortcuts/repo/repo.go | 4 +- shortcuts/repo/repo_test.go | 32 +++++++++++++- 3 files changed, 72 insertions(+), 35 deletions(-) diff --git a/doc/changes/repo-tree-shortcut.md b/doc/changes/repo-tree-shortcut.md index 85c3ee7..ea1f66d 100644 --- a/doc/changes/repo-tree-shortcut.md +++ b/doc/changes/repo-tree-shortcut.md @@ -1,60 +1,65 @@ -# Repo Tree Shortcut +# repo +tree 仓库文件树查询命令 -## Summary +## 背景 -Adds `gitlink-cli repo +tree` so users and AI Agents can list repository files and directories without manually calling the Raw API. +`gitlink-cli repo` 已经提供仓库详情、README、语言统计和贡献者查询能力，但缺少直接查看仓库目录结构的 Shortcut。用户或 AI Agent 如果要判断仓库中是否存在 README、LICENSE、依赖清单、测试目录、文档目录等文件，过去需要手动调用 Raw API `/sub_entries`。 -## Command +本次变更把仓库文件树查询封装为 `repo +tree`，降低普通用户和自动化工作流的使用门槛。 -| Command | Purpose | -|---------|---------| -| `gitlink-cli repo +tree` | List repository files and directories at the repository root or a specified path | +## 变更内容 -## Usage +- 新增 `gitlink-cli repo +tree` Shortcut。 +- 调用 `GET /{owner}/{repo}/sub_entries` 获取仓库根目录或指定目录下的文件和子目录。 +- 支持 `--path, -p` 指定目录路径；不传时查询仓库根目录。 +- 支持 `--ref, -r` 指定分支、标签或提交引用；默认值为 `master`。 +- 复用现有仓库上下文解析、API 调用和统一输出格式。 +- 补充中英文 i18n 文案，避免新增命令帮助信息硬编码。 + +## 命令示例 ```bash -# List repository root entries +# 查看仓库根目录 gitlink-cli repo +tree --owner Gitlink --repo forgeplus --ref master -# List entries under a directory +# 查看指定目录 gitlink-cli repo +tree --owner Gitlink --repo forgeplus --path src --ref main -# AI Agent usage with structured output +# Agent 场景建议使用 JSON 输出 gitlink-cli repo +tree --owner Gitlink --repo forgeplus --format json ``` -## Behavior +## 参数说明 -- Calls `GET /{owner}/{repo}/sub_entries`. -- Maps `--path, -p` to the `filepath` query parameter. -- Maps `--ref, -r` to the `ref` query parameter. -- Defaults `--ref` to `master` when omitted. -- Reuses existing repository context resolution and output formatting. +| 参数 | 必填 | 说明 | +|------|------|------| +| `--path, -p` | 否 | 要查看的目录路径，不传时查询仓库根目录 | +| `--ref, -r` | 否 | 分支、标签或提交引用，默认 `master` | +| `--owner` | 否 | 全局参数，仓库所有者，可从 git remote 自动解析 | +| `--repo` | 否 | 全局参数，仓库名称，可从 git remote 自动解析 | +| `--format` | 否 | 全局参数，输出格式：`json`、`table` 或 `yaml` | -## Tests +## 测试覆盖 -Unit tests cover: +单元测试覆盖以下内容： -- root directory listing with the default `master` ref; -- directory listing with explicit `--path` and `--ref`; -- endpoint path and query parameter mapping. +- 根目录查询默认使用 `master`。 +- 根目录查询不发送空 `filepath` 参数。 +- 指定 `--path` 和 `--ref` 时正确映射到 `filepath` 与 `ref` 查询参数。 +- `repo +tree` 的命令说明和 `--path/-p`、`--ref/-r` 参数注册完整。 -Validation command: +验证命令： ```bash make test ``` -## 中文说明 +## 交付要求核对 -### 变更内容 +- 功能代码：`shortcuts/repo/repo.go` +- 单元测试：`shortcuts/repo/repo_test.go` +- 命令帮助文档：`README.md`、`README.zh-CN.md`、`skills/gitlink-repo/SKILL.md`、`skills/gitlink-repo/references/gitlink-repo-tree.md` +- 变更说明文档：`doc/changes/repo-tree-shortcut.md` -- 新增 `repo +tree` 仓库文件树查询命令。 -- 支持查看仓库根目录或指定目录下的文件和子目录。 -- 支持通过 `--ref` 指定分支、标签或提交引用。 -- 更新 README、README.zh-CN、设计文档和 `gitlink-repo` Skill 文档。 -- 新增 `gitlink-repo` Skill 参考文档，便于 Agent 在项目结构检查、复现性检查和合规检查中复用。 +## 兼容性 -### 验证 - -- `make test` +该变更只新增 Shortcut、单元测试和文档，不修改已有命令参数或输出结构。根目录查询时不再发送空 `filepath` 查询参数，语义更清晰，对现有功能无破坏性影响。 diff --git a/shortcuts/repo/repo.go b/shortcuts/repo/repo.go index 90924b5..06774a6 100644 --- a/shortcuts/repo/repo.go +++ b/shortcuts/repo/repo.go @@ -97,7 +97,9 @@ func Shortcuts(translators ...*i18n.Translator) []*common.Shortcut { if ref == "" { ref = "master" } - q.Set("filepath", ctx.Arg("path")) + if path := ctx.Arg("path"); path != "" { + q.Set("filepath", path) + } q.Set("ref", ref) env, err := ctx.CallAPIWithQuery("GET", ctx.RepoPath()+"/sub_entries", q) if err != nil { diff --git a/shortcuts/repo/repo_test.go b/shortcuts/repo/repo_test.go index 38f8ab0..5c5f34b 100644 --- a/shortcuts/repo/repo_test.go +++ b/shortcuts/repo/repo_test.go @@ -155,7 +155,9 @@ func TestRepoReadmeUsesRepositoryReadmeEndpoint(t *testing.T) { func TestRepoTreeListsRootOnDefaultRef(t *testing.T) { server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { assertRequest(t, r, "GET", "/owner/repo/sub_entries.json") - assertEqual(t, r.URL.Query().Get("filepath"), "") + if _, ok := r.URL.Query()["filepath"]; ok { + t.Fatalf("did not expect filepath query for repository root, got %q", r.URL.Query().Get("filepath")) + } assertEqual(t, r.URL.Query().Get("ref"), "master") writeJSON(t, w, map[string]interface{}{ "entries": []map[string]interface{}{ @@ -188,6 +190,34 @@ func TestRepoTreeUsesPathAndRef(t *testing.T) { } } +func TestRepoTreeShortcutRegistersHelpFlags(t *testing.T) { + tree := findShortcut(t, "tree") + if tree.Description == "" { + t.Fatal("tree shortcut description is empty") + } + + flags := map[string]common.Flag{} + for _, flag := range tree.Flags { + flags[flag.Name] = flag + } + + pathFlag, ok := flags["path"] + if !ok { + t.Fatal("tree shortcut missing path flag") + } + if pathFlag.Short != "p" || pathFlag.Usage == "" { + t.Fatalf("unexpected path flag: %+v", pathFlag) + } + + refFlag, ok := flags["ref"] + if !ok { + t.Fatal("tree shortcut missing ref flag") + } + if refFlag.Short != "r" || refFlag.Default != "master" || refFlag.Usage == "" { + t.Fatalf("unexpected ref flag: %+v", refFlag) + } +} + func TestRepoLanguagesUsesLanguagesEndpoint(t *testing.T) { server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { assertRequest(t, r, "GET", "/owner/repo/languages.json")