Compare commits
201 Commits
| Author | SHA1 | Date |
|---|---|---|
|
|
9df6e2830b | |
|
|
c19b52e5b7 | |
|
|
217a3a5861 | |
|
|
9dd3777e17 | |
|
|
07f7a86304 | |
|
|
4e889737db | |
|
|
de535f650f | |
|
|
fc15715336 | |
|
|
1aebf115f6 | |
|
|
9c296fafcf | |
|
|
07edea2153 | |
|
|
8c5fee06f6 | |
|
|
b3e30f907d | |
|
|
6f722c1334 | |
|
|
6c78185b90 | |
|
|
6009a7ce8b | |
|
|
363c9e478c | |
|
|
dc77493159 | |
|
|
31058942b5 | |
|
|
20f7f1fa43 | |
|
|
3f4809bffb | |
|
|
4c85a09921 | |
|
|
776871c2b1 | |
|
|
321ef64fe5 | |
|
|
348f2ab696 | |
|
|
be2df69734 | |
|
|
51a1fb6a46 | |
|
|
932d877b3c | |
|
|
a35dc781b9 | |
|
|
897b2ff59e | |
|
|
9de2f209c8 | |
|
|
c60033ae48 | |
|
|
b2192cc272 | |
|
|
dcf75299eb | |
|
|
516651cb34 | |
|
|
b09d7d70f2 | |
|
|
111edbc346 | |
|
|
b1a5d1433f | |
|
|
ab47233e94 | |
|
|
bafa9e6364 | |
|
|
6f7af3b000 | |
|
|
6425ff6ae1 | |
|
|
b97181f05e | |
|
|
ab0cf7fe64 | |
|
|
8bfa601edf | |
|
|
d2b4e308c5 | |
|
|
fe9f4396b0 | |
|
|
57993e8bea | |
|
|
47c5083095 | |
|
|
b777088ea3 | |
|
|
c9530a0929 | |
|
|
aea30485a3 | |
|
|
a8d5dd5349 | |
|
|
a429ff1505 | |
|
|
43348a195f | |
|
|
09baf7f44f | |
|
|
40497520e2 | |
|
|
474a54115a | |
|
|
8f19d958a8 | |
|
|
457bf66909 | |
|
|
90812b7d0c | |
|
|
059476bd7c | |
|
|
a75c281254 | |
|
|
8739b18a23 | |
|
|
283cd76bfd | |
|
|
f1e5386c43 | |
|
|
d336e5facb | |
|
|
de1d4ea2cf | |
|
|
b33267447b | |
|
|
b41a07d2fe | |
|
|
c2b667c1e2 | |
|
|
6bcfb77b58 | |
|
|
9a451f9d75 | |
|
|
9129c2f1c4 | |
|
|
13882157c2 | |
|
|
2bedb68ef7 | |
|
|
fa31e09dc4 | |
|
|
93f65a7d78 | |
|
|
d4af2e3207 | |
|
|
3f04d95631 | |
|
|
46d16e21a2 | |
|
|
148ce89c2b | |
|
|
4d56487520 | |
|
|
30336c69ef | |
|
|
74f6aea0e9 | |
|
|
92f65a92d1 | |
|
|
f44471d173 | |
|
|
c0c7580a7e | |
|
|
393a090c0e | |
|
|
7b43711db3 | |
|
|
b0d46b42af | |
|
|
378d8f15a6 | |
|
|
3fdc615a05 | |
|
|
b46352af51 | |
|
|
33d2578f90 | |
|
|
21a3447581 | |
|
|
5866600401 | |
|
|
3703594d66 | |
|
|
42c5d11a62 | |
|
|
955e8dd2b7 | |
|
|
f1e237ad18 | |
|
|
b914138338 | |
|
|
75a8ed235a | |
|
|
e9f36c29fb | |
|
|
f248ed9d04 | |
|
|
f9efae89a3 | |
|
|
d12ce0fb57 | |
|
|
c7a2ca3685 | |
|
|
386e3c92b8 | |
|
|
612deddb57 | |
|
|
fb051af813 | |
|
|
c345b5af5d | |
|
|
c192b26da8 | |
|
|
5a5db6d298 | |
|
|
d20b3b09e1 | |
|
|
0ff97fd213 | |
|
|
f5f1a34310 | |
|
|
a8be1a8100 | |
|
|
46eff83ef5 | |
|
|
01e4515cb9 | |
|
|
fd647b7e75 | |
|
|
5c8cc3462c | |
|
|
a31b8e5b11 | |
|
|
7fa93cb3c1 | |
|
|
68e7994d08 | |
|
|
81cfcfb3e4 | |
|
|
596fb81a55 | |
|
|
84aae8554b | |
|
|
be152b9fa1 | |
|
|
5c9e24c725 | |
|
|
59240d18c5 | |
|
|
799af5f3cf | |
|
|
cafde7d2f4 | |
|
|
2aa1b2ffe4 | |
|
|
bc12b43fc0 | |
|
|
30f16b9613 | |
|
|
461b28e6c8 | |
|
|
d66c88ecca | |
|
|
295eda5a4e | |
|
|
25ee6cc5fb | |
|
|
f1dc2f8bc9 | |
|
|
b2136559bf | |
|
|
16787b8f8c | |
|
|
2596d1dc70 | |
|
|
65a4e60d6d | |
|
|
db8f3c7cae | |
|
|
76cb5be259 | |
|
|
cbbec86b49 | |
|
|
503a5aeead | |
|
|
1d4e177152 | |
|
|
d1cc68b6d9 | |
|
|
6c0ad3b7ae | |
|
|
9a51db0989 | |
|
|
a4587f95c4 | |
|
|
38658fb7b1 | |
|
|
5eb67055fd | |
|
|
dd905fb045 | |
|
|
e60e876fad | |
|
|
a115c97dde | |
|
|
66ec432036 | |
|
|
cb238f132c | |
|
|
240a4ff6b7 | |
|
|
d46a0cc48b | |
|
|
59552d9286 | |
|
|
811bae1cd5 | |
|
|
015a30caa5 | |
|
|
e3470ba592 | |
|
|
167a2ff12c | |
|
|
63cbb2cef8 | |
|
|
9f479a27db | |
|
|
f18eea273f | |
|
|
6fda83bf38 | |
|
|
92a953ba56 | |
|
|
9a2e6a3280 | |
|
|
3a47936f9f | |
|
|
15110df6f1 | |
|
|
b9638fe0b6 | |
|
|
1762a24851 | |
|
|
5ae0a134bb | |
|
|
2669c632d0 | |
|
|
3ee71a1ffc | |
|
|
87277cbf4f | |
|
|
fef44dc5e3 | |
|
|
d1e44867c3 | |
|
|
8d3d6cc5ce | |
|
|
9598142c2f | |
|
|
52dc8a9967 | |
|
|
2ddad05646 | |
|
|
44b184723e | |
|
|
c7d374ab32 | |
|
|
aebb24d51c | |
|
|
9f99247422 | |
|
|
637be3cb4b | |
|
|
4121524100 | |
|
|
c2e0b0da18 | |
|
|
a94088e4ee | |
|
|
94661010ac | |
|
|
ca7f5aacce | |
|
|
667f28a618 | |
|
|
8df76dcb7a | |
|
|
b64a5104a8 |
|
|
@ -0,0 +1,119 @@
|
|||
---
|
||||
description: GitLink 操作中心 — 列出所有常用操作、端到端场景与科研辅助,上下选择并执行;也可传入仓库网址直接对其操作
|
||||
argument-hint: "[可选: GitLink 仓库网址 或 场景关键词,如 代码审查 / 健康度]"
|
||||
---
|
||||
|
||||
# GitLink 操作中心(交互式菜单)
|
||||
|
||||
你是 **GitLink 操作中心**的调度器。请严格按下列流程,为用户呈现一个可「上下方向键选择并执行」的交互式菜单,并调用对应已实现的 skill 完成操作。
|
||||
|
||||
> **铁律**:所有 GitLink 操作必须用 `gitlink-cli`,禁止用 `gh`。所有写操作默认 dry-run,确认后再实际执行。
|
||||
|
||||
---
|
||||
|
||||
## 第 1 步:解析目标仓库(TARGET)
|
||||
|
||||
检查命令参数 `$ARGUMENTS`:
|
||||
|
||||
1. 若包含 GitLink 网址(形如 `https://gitlink.org.cn/<owner>/<repo>`,可能带 `.git`、`/pulls/<n>`、`/issues/<n>`、`/compare/...` 等后缀),用正则 `gitlink\.org\.cn/([^/]+)/([^/?.#]+)` 提取 `<owner>` 和 `<repo>`(去掉末尾 `.git`)→ 记为 **TARGET = owner/repo**。
|
||||
2. 否则若形如 `<owner>/<repo>`(如 `z2_cc/gitlink-cli`),直接作为 TARGET。
|
||||
3. 否则若当前处于一个 git 仓库且其 remote 指向 GitLink,自动解析 owner/repo 作为 TARGET(可运行 `git remote -v` 判断)。
|
||||
4. 否则 **TARGET = 空**(后续按需向用户询问)。
|
||||
|
||||
**关键词直跳**:若 `$ARGUMENTS` 命中下方「映射表」中的任一场景关键词(代码审查 / Issue 分拣 / Release / 健康度 / 合规 / 新人引导 / 社区运营 / 质量门禁 / 项目初始化 / 多仓库 / 贡献者 / 科研洞悉 / 科研热点 / 知识图谱 / 科研合规 / 复现性 / 科研协作匹配 / 科研进度 / 预警),**跳过第 2 步菜单**,直接进入第 3 步执行该场景(TARGET 仍按上面规则解析)。
|
||||
|
||||
---
|
||||
|
||||
## 第 2 步:呈现菜单(无关键词时)
|
||||
|
||||
### 2.1 先在对话中「列出所有」可选项
|
||||
|
||||
用中文打印下面这张完整目录(让用户一眼看到全部 16 项 + 仓库定位),格式如下:
|
||||
|
||||
```
|
||||
🧭 GitLink 操作中心 — 请选择要执行的操作(也可直接输入序号 / 关键词 / 仓库网址)
|
||||
|
||||
🔍 单项操作
|
||||
1 智能代码审查 分析 PR diff,输出结构化 Review 意见并自动评论
|
||||
2 Issue 自动分拣 根据内容自动分类、打标签、分配责任人
|
||||
3 Release Notes 生成 根据 commit / PR 记录生成结构化版本说明
|
||||
4 新人引导 为 good-first-issue 自动添加引导评论
|
||||
|
||||
📊 分析与成长
|
||||
5 项目健康度报告 统计 Issue 响应时间、PR 合并效率、贡献者活跃度
|
||||
6 许可证合规检查 扫描许可证合规性与敏感信息泄露风险
|
||||
7 贡献者成长体系 追踪 PR/Issue 活动 → 生成排行 → 自动颁发徽章
|
||||
|
||||
🚀 端到端自动化场景
|
||||
8 社区运营自动化 Issue 分拣 → 周报 → 自动发布 Release
|
||||
9 代码质量看门人 PR 审查 → CI → 门禁决策 → 自动合并
|
||||
10 项目一键初始化 创建仓库 → 生成 README/LICENSE/CI → 初始 Issue/里程碑
|
||||
11 多仓库协同 跨仓库 Issue 追踪 / PR 看板 / Release 协调发布
|
||||
|
||||
🔬 科研辅助(面向科研工作者 / 课题组,打通开源生态与学术科研)
|
||||
12 科研项目洞悉 8 维数据采集 + AI 分析(成熟度/文档/贡献模式/社区健康)→ 结构化评分报告
|
||||
13 科研热点与知识图谱 多关键词搜索 → 实体/关系抽取 → Mermaid 知识图谱 + 交互式 HTML
|
||||
14 科研合规与复现性 数据可用性 / 环境可复现 / 结果可验证 多维评估
|
||||
15 科研协作智能匹配 角色(数据/算法/工程/评估)推断 → 人员-任务匹配 → 综合建议
|
||||
16 科研进度跟踪与预警 6 维风险信号(停滞/高优无人/零回复/积压/提交突变/里程碑 DDL)+ 100 分制评分
|
||||
|
||||
🌐 也可以:粘贴一个 GitLink 仓库网址(https://gitlink.org.cn/<owner>/<repo>),我对它执行上述任一操作。
|
||||
```
|
||||
|
||||
### 2.2 再用 AskUserQuestion 弹出原生「上下选择」菜单
|
||||
|
||||
调用一次 `AskUserQuestion`,header 为「操作类别」,提供 4 个选项(用户可用方向键上下选择,也可选「Other」直接输入序号/关键词/网址):
|
||||
|
||||
| 选项 | 描述 |
|
||||
|---|---|
|
||||
| 🔍 单项操作 | 代码审查 / Issue 分拣 / Release Notes / 新人引导 |
|
||||
| 📊 分析与成长 | 项目健康度 / 许可证合规 / 贡献者成长 |
|
||||
| 🚀 端到端自动化 | 社区运营 / 质量门禁 / 项目初始化 / 多仓库协同 |
|
||||
| 🔬 科研辅助 | 项目洞悉 / 热点与知识图谱 / 合规复现 / 协作匹配 / 进度预警 |
|
||||
|
||||
- 若用户选了 🔍 / 📊 / 🚀 三类(每类 ≤4 项):再调用一次 `AskUserQuestion` 列出该类别下具体操作(每项描述一句话),让用户上下选择。
|
||||
- 若用户选 🔬 科研辅助(共 5 项,超过单次 4 项上限):先把 5 项编号打印,再用 `AskUserQuestion` 列出其中 4 项,并提示「可选 Other 输入第 5 项序号」;用户也可直接回复 1-5 序号。
|
||||
- 若用户在任何一步选「Other」输入了仓库网址 / `owner/repo`:按第 1 步规则解析为 TARGET,再继续选操作。
|
||||
- 若用户选「Other」直接输入了序号或关键词:按映射表直接定位操作,进入第 3 步。
|
||||
|
||||
---
|
||||
|
||||
## 第 3 步:执行对应 skill
|
||||
|
||||
### 操作 → skill 映射表
|
||||
|
||||
| 序号 | 菜单项 | 调用的 skill |
|
||||
|---|---|---|
|
||||
| 1 | 智能代码审查 | `gitlink-code-review` |
|
||||
| 2 | Issue 自动分拣 | `gitlink-issue-triage` |
|
||||
| 3 | Release Notes 生成 | `gitlink-release-auto` |
|
||||
| 4 | 新人引导 | `gitlink-newcomer-guide` |
|
||||
| 5 | 项目健康度报告 | `gitlink-project-health` |
|
||||
| 6 | 许可证合规检查 | `gitlink-compliance` |
|
||||
| 7 | 贡献者成长体系 | `gitlink-contributor-growth` |
|
||||
| 8 | 社区运营自动化 | `gitlink-community-ops` |
|
||||
| 9 | 代码质量看门人 | `gitlink-quality-gate` |
|
||||
| 10 | 项目一键初始化 | `gitlink-project-bootstrap` |
|
||||
| 11 | 多仓库协同 | `gitlink-multi-repo-coordination` |
|
||||
| 12 | 科研项目洞悉 | `gitlink-research-insight` |
|
||||
| 13 | 科研热点与知识图谱 | `gitlink-research-hotspot` |
|
||||
| 14 | 科研合规与复现性 | `gitlink-research-compliance` |
|
||||
| 15 | 科研协作智能匹配 | `gitlink-research-matching` |
|
||||
| 16 | 科研进度跟踪与预警 | `gitlink-research-progress` |
|
||||
|
||||
> 这些 skill 都在当前项目(`Desktop/gitlink-cl`)下。用 `Skill` 工具按上表名字调用即可。
|
||||
|
||||
执行规则:
|
||||
1. **若 TARGET 仍为空**,先用 `AskUserQuestion` 询问「请提供目标 GitLink 仓库(owner/repo 或网址)」。
|
||||
2. 调用对应 skill,把 TARGET 的 owner/repo 传达给它(skill 内部用 `--owner/--repo` 或环境变量;端到端场景脚本形如 `bash skills/<skill>/scripts/*-full.sh <owner> <repo>`)。
|
||||
3. **写操作一律先 dry-run**(`DRY_RUN=true`),把将要执行的变更展示给用户,经确认后再 `DRY_RUN=false` 实际执行。
|
||||
4. 操作完成后,用中文给出简洁结果摘要(做了什么 / 关键数据 / 产物路径)。
|
||||
|
||||
---
|
||||
|
||||
## 备注
|
||||
|
||||
- 多仓库协同(11)支持 `REPOS="owner1/repo1,owner2/repo2"` 同时处理多个仓库。
|
||||
- **科研辅助(12-16)**均为 **evidence-oriented / read-only**(只读分析、不改仓库),可放心对任意公开 GitLink 仓库运行;产物多为结构化报告 / 知识图谱 / 交互式 HTML(位于各 skill 的 `scripts/_output/`)。`gitlink-research-matching` 已验证于 `Gitlink/forgeplus`,`research-progress` / `research-compliance` 已验证于 `forgeplus`、`gitlink-cli`、`ifzhang/FairMOT`。
|
||||
- 若 `gitlink-cli` 未登录,先提示用户运行 `gitlink-cli auth login`(或调用 `gitlink-shared` skill)。
|
||||
- 用户随时可输入「返回」回到主菜单,或「退出」结束。
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
version: 2
|
||||
name: gitlink_cli_ci
|
||||
description: "gitlink-cli 代码提交时自动执行 CI 检查(构建、测试、格式化)"
|
||||
trigger:
|
||||
webhook: gitlink@1.0.0
|
||||
event:
|
||||
- ref: push
|
||||
ruleset-operator: AND
|
||||
global:
|
||||
concurrent: 1
|
||||
workflow:
|
||||
- ref: start
|
||||
name: 开始
|
||||
task: start
|
||||
- ref: git_clone_0
|
||||
name: 拉取代码
|
||||
task: git_clone@1.2.9
|
||||
input:
|
||||
remote_url: '"https://gitlink.org.cn/jiangtx/gitlink-cli.git"'
|
||||
ref: '"refs/heads/wyx_branch"'
|
||||
commit_id: '""'
|
||||
depth: 1
|
||||
needs:
|
||||
- start
|
||||
- ref: ssh_cmd_0
|
||||
name: CI 检查
|
||||
task: ssh_cmd@1.1.1
|
||||
input:
|
||||
ssh_pass: ((gitlink_cli_ci.ssh_pass))
|
||||
ssh_ip: '"121.41.212.97"'
|
||||
ssh_port: '"22"'
|
||||
ssh_user: '"root"'
|
||||
ssh_cmd: >-
|
||||
"cd /root && rm -rf gitlink-cli && git clone --depth=1 -b wyx_branch https://gitlink.org.cn/jiangtx/gitlink-cli.git && cd gitlink-cli && export PATH=$PATH:/usr/local/go/bin && export GOPROXY=https://goproxy.cn,direct && go version && go build ./... && go vet ./... && go test -race ./... && output=$(gofmt -s -l .) && if [ -n \"$output\" ]; then echo '格式化检查失败:' && echo \"$output\" && exit 1; fi && echo '所有 CI 检查通过'"
|
||||
needs:
|
||||
- git_clone_0
|
||||
- ref: end
|
||||
name: 结束
|
||||
task: end
|
||||
needs:
|
||||
- ssh_cmd_0
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
version: 2
|
||||
name: 多仓库协同流水线
|
||||
description: "定时运行:多仓库 Issue 追踪 → PR 看板 → Release 协调发布"
|
||||
trigger:
|
||||
webhook: gitlink@1.0.0
|
||||
event:
|
||||
- ref: schedule
|
||||
ruleset-operator: AND
|
||||
global:
|
||||
concurrent: 1
|
||||
param:
|
||||
- ref: remote_url
|
||||
name: ""
|
||||
value: '"https://gitlink.org.cn/z2_cc/gitlink-cli.git"'
|
||||
required: false
|
||||
type: STRING
|
||||
hidden: false
|
||||
- ref: owner
|
||||
name: "仓库所有者"
|
||||
value: '"z2_cc"'
|
||||
required: true
|
||||
type: STRING
|
||||
hidden: false
|
||||
- ref: repo
|
||||
name: "仓库名称"
|
||||
value: '"gitlink-cli"'
|
||||
required: true
|
||||
type: STRING
|
||||
hidden: false
|
||||
- ref: repos
|
||||
name: "多仓库列表(逗号分隔 owner/repo)"
|
||||
value: '"z2_cc/gitlink-cli,z2_cc/gitlink-bisync"'
|
||||
required: false
|
||||
type: STRING
|
||||
hidden: false
|
||||
workflow:
|
||||
- ref: start
|
||||
name: 开始
|
||||
task: start
|
||||
- ref: ssh_cmd_0
|
||||
name: 运行多仓库协同流水线
|
||||
task: ssh_cmd@1.1.1
|
||||
input:
|
||||
ssh_pass: ((work_together.ssh_key))
|
||||
ssh_ip: '"121.41.216.243"'
|
||||
ssh_port: '"22"'
|
||||
ssh_user: '"root"'
|
||||
ssh_cmd: '"cd /root/gitlink-cli && git pull origin master && DRY_RUN=true REPOS=$(repos) bash skills/gitlink-multi-repo-coordination/scripts/multi-repo-full.sh"'
|
||||
needs:
|
||||
- start
|
||||
- ref: end
|
||||
name: 结束
|
||||
task: end
|
||||
needs:
|
||||
- ssh_cmd_0
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
version: 2
|
||||
name: 构建流水线
|
||||
description: "gitlink-cli CI 流水线:拉取代码、构建、部署、验证"
|
||||
trigger:
|
||||
webhook: gitlink@1.0.0
|
||||
event:
|
||||
- ref: push
|
||||
ruleset-operator: AND
|
||||
global:
|
||||
concurrent: 1
|
||||
param:
|
||||
- ref: remote_url
|
||||
name: ""
|
||||
value: '"https://gitlink.org.cn/z2_cc/gitlink-cli.git"'
|
||||
required: false
|
||||
type: STRING
|
||||
hidden: false
|
||||
workflow:
|
||||
- ref: start
|
||||
name: 开始
|
||||
task: start
|
||||
- ref: ssh_cmd_0
|
||||
name: 拉取代码并构建部署
|
||||
task: ssh_cmd@1.1.1
|
||||
input:
|
||||
ssh_pass: ((work_together.ssh_key))
|
||||
ssh_ip: '"121.41.216.243"'
|
||||
ssh_port: '"22"'
|
||||
ssh_user: '"root"'
|
||||
ssh_cmd: '"export GOPROXY=https://goproxy.cn,direct && cd /root/gitlink-cli || git clone https://gitlink.org.cn/z2_cc/gitlink-cli.git /root/gitlink-cli; cd /root/gitlink-cli && git pull origin master && go build -o gitlink-cli . && cp gitlink-cli /usr/local/bin/ && gitlink-cli version"'
|
||||
needs:
|
||||
- start
|
||||
- ref: end
|
||||
name: 结束
|
||||
task: end
|
||||
needs:
|
||||
- ssh_cmd_0
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
version: 2
|
||||
name: 自动构建部署
|
||||
description: "代码提交自动触发 - 增量拉取 + Docker镜像构建与部署"
|
||||
global:
|
||||
concurrent: 1
|
||||
trigger:
|
||||
webhook: gitlink@1.0.0
|
||||
event:
|
||||
- ref: push
|
||||
ruleset-operator: AND
|
||||
workflow:
|
||||
- ref: start
|
||||
name: 开始
|
||||
task: start
|
||||
- ref: ssh_cmd_0
|
||||
name: ssh增量拉取并部署
|
||||
task: ssh_cmd@1.1.1
|
||||
input:
|
||||
ssh_pass: ((deploy_server.password))
|
||||
ssh_ip: '"121.41.222.73"'
|
||||
ssh_port: '"22"'
|
||||
ssh_user: '"root"'
|
||||
ssh_cmd: '"if [ -d /root/gitlink-cli/.git ]; then cd /root/gitlink-cli && git fetch origin && git checkout master && git reset --hard origin/master; else rm -rf /root/gitlink-cli && git clone https://gitlink.org.cn/whale_hihihi/gitlink-cli.git /root/gitlink-cli && cd /root/gitlink-cli && git checkout master; fi && docker stop gitlink-cli 2>/dev/null; docker rm gitlink-cli 2>/dev/null; docker rmi gitlink-cli:latest 2>/dev/null; docker build --no-cache -t gitlink-cli:latest . && docker run -d --name gitlink-cli -p 8080:8080 $([ -f /root/.gitlink-env ] && echo --env-file /root/.gitlink-env) gitlink-cli:latest && echo Deploy success"'
|
||||
needs:
|
||||
- start
|
||||
- ref: ssh_cmd_1
|
||||
name: 构建并部署demo网页(8000)
|
||||
task: ssh_cmd@1.1.1
|
||||
input:
|
||||
ssh_pass: ((deploy_server.password))
|
||||
ssh_ip: '"121.41.222.73"'
|
||||
ssh_port: '"22"'
|
||||
ssh_user: '"root"'
|
||||
ssh_cmd: '"cd /root/gitlink-cli && docker stop gitlink-cli-demo 2>/dev/null; docker rm gitlink-cli-demo 2>/dev/null; docker rmi gitlink-cli-demo:latest 2>/dev/null; (docker build --no-cache -f demo/Dockerfile -t gitlink-cli-demo:latest . && docker run -d --name gitlink-cli-demo -p 8000:8000 --restart unless-stopped gitlink-cli-demo:latest && echo Demo deploy success at http://121.41.222.73:8000) || echo Demo deploy FAILED non-blocking, main :8080 unaffected"'
|
||||
needs:
|
||||
- ssh_cmd_0
|
||||
- ref: end
|
||||
name: 结束
|
||||
task: end
|
||||
needs:
|
||||
- ssh_cmd_0
|
||||
- ssh_cmd_1
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
version: 2
|
||||
name: 自动部署
|
||||
description: ""
|
||||
global:
|
||||
concurrent: 1
|
||||
trigger:
|
||||
webhook: gitlink@1.0.0
|
||||
event:
|
||||
- ref: push
|
||||
ruleset-operator: AND
|
||||
workflow:
|
||||
- ref: start
|
||||
name: 开始
|
||||
task: start
|
||||
- ref: git_clone_0
|
||||
name: git clone
|
||||
task: git_clone@1.2.9
|
||||
input:
|
||||
username: ((gitlink_cli.ylly_git_user))
|
||||
password: ((gitlink_cli.ylly_git_pass))
|
||||
remote_url: '"https://gitlink.org.cn/ylly/gitlink-cli.git"'
|
||||
ref: '"refs/heads/master"'
|
||||
commit_id: '""'
|
||||
depth: 1
|
||||
needs:
|
||||
- start
|
||||
- ref: ssh_cmd_0
|
||||
name: ssh执行命令
|
||||
task: ssh_cmd@1.1.1
|
||||
input:
|
||||
ssh_ip: '"8.136.61.14"'
|
||||
ssh_port: '"22"'
|
||||
ssh_user: '"root"'
|
||||
ssh_private_key: ((gitlink_cli.ecs_ssh_key))
|
||||
ssh_cmd: '"cd /opt/gitlink-cli && git pull && go build -o /usr/local/bin/gitlink-cli . && gitlink-cli version"'
|
||||
needs:
|
||||
- git_clone_0
|
||||
- ref: end
|
||||
name: 结束
|
||||
task: end
|
||||
needs:
|
||||
- ssh_cmd_0
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
version: 2
|
||||
name: 贡献者成长体系流水线
|
||||
description: "每周定时运行:贡献追踪 → 排行段位 → 自动颁发徽章"
|
||||
trigger:
|
||||
webhook: gitlink@1.0.0
|
||||
event:
|
||||
- ref: schedule
|
||||
ruleset-operator: AND
|
||||
global:
|
||||
concurrent: 1
|
||||
param:
|
||||
- ref: remote_url
|
||||
name: ""
|
||||
value: '"https://gitlink.org.cn/z2_cc/gitlink-cli.git"'
|
||||
required: false
|
||||
type: STRING
|
||||
hidden: false
|
||||
- ref: owner
|
||||
name: "仓库所有者"
|
||||
value: '"z2_cc"'
|
||||
required: true
|
||||
type: STRING
|
||||
hidden: false
|
||||
- ref: repo
|
||||
name: "仓库名称"
|
||||
value: '"gitlink-cli"'
|
||||
required: true
|
||||
type: STRING
|
||||
hidden: false
|
||||
- ref: dry_run
|
||||
name: "是否 dry-run"
|
||||
value: '"true"'
|
||||
required: false
|
||||
type: STRING
|
||||
hidden: false
|
||||
workflow:
|
||||
- ref: start
|
||||
name: 开始
|
||||
task: start
|
||||
- ref: ssh_cmd_0
|
||||
name: 运行贡献者成长体系流水线
|
||||
task: ssh_cmd@1.1.1
|
||||
input:
|
||||
ssh_pass: ((work_together.ssh_key))
|
||||
ssh_ip: '"121.41.216.243"'
|
||||
ssh_port: '"22"'
|
||||
ssh_user: '"root"'
|
||||
ssh_cmd: '"cd /root/gitlink-cli && git pull origin master && DRY_RUN=$(dry_run) bash skills/gitlink-contributor-growth/scripts/contributor-growth-full.sh $(owner) $(repo)"'
|
||||
needs:
|
||||
- start
|
||||
- ref: end
|
||||
name: 结束
|
||||
task: end
|
||||
needs:
|
||||
- ssh_cmd_0
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
version: 2
|
||||
name: 项目初始化流水线
|
||||
description: "新项目一键初始化:创建仓库 → 生成 README/LICENSE/CI → 创建初始 Issue 和里程碑"
|
||||
trigger:
|
||||
webhook: gitlink@1.0.0
|
||||
event:
|
||||
- ref: manual
|
||||
ruleset-operator: AND
|
||||
global:
|
||||
concurrent: 1
|
||||
param:
|
||||
- ref: remote_url
|
||||
name: ""
|
||||
value: '"https://gitlink.org.cn/z2_cc/gitlink-cli.git"'
|
||||
required: false
|
||||
type: STRING
|
||||
hidden: false
|
||||
- ref: owner
|
||||
name: "仓库所有者"
|
||||
value: '"z2_cc"'
|
||||
required: true
|
||||
type: STRING
|
||||
hidden: false
|
||||
- ref: repo
|
||||
name: "仓库名称"
|
||||
value: '"gitlink-cli"'
|
||||
required: true
|
||||
type: STRING
|
||||
hidden: false
|
||||
- ref: project_desc
|
||||
name: "项目描述"
|
||||
value: '"一个用 Go 编写的 GitLink 命令行工具"'
|
||||
required: true
|
||||
type: STRING
|
||||
hidden: false
|
||||
- ref: dry_run
|
||||
name: "是否 dry-run"
|
||||
value: '"true"'
|
||||
required: false
|
||||
type: STRING
|
||||
hidden: false
|
||||
workflow:
|
||||
- ref: start
|
||||
name: 开始
|
||||
task: start
|
||||
- ref: ssh_cmd_0
|
||||
name: 运行项目一键初始化流水线
|
||||
task: ssh_cmd@1.1.1
|
||||
input:
|
||||
ssh_pass: ((work_together.ssh_key))
|
||||
ssh_ip: '"121.41.216.243"'
|
||||
ssh_port: '"22"'
|
||||
ssh_user: '"root"'
|
||||
ssh_cmd: '"cd /root/gitlink-cli && git pull origin master && DRY_RUN=$(dry_run) PROJECT_DESC=\"$(project_desc)\" bash skills/gitlink-project-bootstrap/scripts/project-bootstrap-full.sh $(owner) $(repo)"'
|
||||
needs:
|
||||
- start
|
||||
- ref: end
|
||||
name: 结束
|
||||
task: end
|
||||
needs:
|
||||
- ssh_cmd_0
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
.git
|
||||
.devops
|
||||
.github
|
||||
node_modules
|
||||
dist
|
||||
doc
|
||||
npm
|
||||
*.md
|
||||
*.exe
|
||||
.gitignore
|
||||
.golangci.yml
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
.gitattributes text eol=lf
|
||||
internal/i18n/locales/*.json text eol=lf
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master]
|
||||
pull_request:
|
||||
branches: [master]
|
||||
|
||||
jobs:
|
||||
check:
|
||||
name: Build, Lint, Test
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.26.1'
|
||||
|
||||
- name: Build
|
||||
run: go build ./...
|
||||
|
||||
- name: Validate i18n and skill metadata
|
||||
run: |
|
||||
go run ./internal/i18n/cmd/check
|
||||
go run ./internal/skillmeta/cmd/check
|
||||
|
||||
- name: Lint
|
||||
run: make lint
|
||||
|
||||
- name: Test
|
||||
run: make test
|
||||
|
||||
- name: Check formatting
|
||||
run: make fmt
|
||||
|
|
@ -1,26 +1,20 @@
|
|||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master, main]
|
||||
branches: [master]
|
||||
pull_request:
|
||||
branches: [master, main]
|
||||
|
||||
branches: [master]
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.22'
|
||||
|
||||
go-version-file: 'go.mod'
|
||||
- name: Vet
|
||||
run: go vet ./...
|
||||
|
||||
- name: Test
|
||||
run: go test -v -race ./...
|
||||
|
||||
run: go test ./...
|
||||
- name: Build
|
||||
run: go build -v .
|
||||
run: go build -ldflags "-s -w" .
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ jobs:
|
|||
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version-file: go.mod
|
||||
go-version-file: 'go.mod'
|
||||
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
|
|
@ -57,6 +57,10 @@ jobs:
|
|||
rm -rf "$BUILD_DIR"
|
||||
done
|
||||
|
||||
# Generate SHA256 checksums
|
||||
cd dist
|
||||
sha256sum *.tar.gz *.zip > checksums-sha256.txt
|
||||
cd ..
|
||||
ls -lh dist
|
||||
|
||||
- name: Create Release
|
||||
|
|
@ -65,8 +69,44 @@ jobs:
|
|||
files: |
|
||||
dist/*.tar.gz
|
||||
dist/*.zip
|
||||
dist/checksums-sha256.txt
|
||||
generate_release_notes: true
|
||||
|
||||
- name: Update Scoop manifest
|
||||
run: |
|
||||
VERSION=${GITHUB_REF#refs/tags/v}
|
||||
cd dist
|
||||
|
||||
# Parse SHA256 hashes from checksums file
|
||||
declare -A HASHES
|
||||
while read -r hash file; do
|
||||
HASHES["$file"]="$hash"
|
||||
done < checksums-sha256.txt
|
||||
|
||||
# Update bucket/gitlink-cli.json
|
||||
cd ..
|
||||
SCOOP_FILE="bucket/gitlink-cli.json"
|
||||
if [ -f "$SCOOP_FILE" ]; then
|
||||
# Update version
|
||||
sed -i "s/\"version\": \".*\"/\"version\": \"${VERSION}\"/" "$SCOOP_FILE"
|
||||
|
||||
# Update amd64 hash and URL
|
||||
AMD64_FILE="gitlink-cli_${VERSION}_windows_amd64.zip"
|
||||
if [ -n "${HASHES[$AMD64_FILE]}" ]; then
|
||||
sed -i "/64bit/,/}/ s|\"url\": \".*\"|\"url\": \"https://github.com/gitlink-org/gitlink-cli/releases/download/v${VERSION}/${AMD64_FILE}\"|" "$SCOOP_FILE"
|
||||
sed -i "/64bit/,/}/ s|\"hash\": \".*\"|\"hash\": \"${HASHES[$AMD64_FILE]}\"|" "$SCOOP_FILE"
|
||||
fi
|
||||
|
||||
# Update arm64 hash and URL
|
||||
ARM64_FILE="gitlink-cli_${VERSION}_windows_arm64.zip"
|
||||
if [ -n "${HASHES[$ARM64_FILE]}" ]; then
|
||||
sed -i "/arm64/,/}/ s|\"url\": \".*\"|\"url\": \"https://github.com/gitlink-org/gitlink-cli/releases/download/v${VERSION}/${ARM64_FILE}\"|" "$SCOOP_FILE"
|
||||
sed -i "/arm64/,/}/ s|\"hash\": \".*\"|\"hash\": \"${HASHES[$ARM64_FILE]}\"|" "$SCOOP_FILE"
|
||||
fi
|
||||
|
||||
echo "Updated $SCOOP_FILE for version $VERSION"
|
||||
fi
|
||||
|
||||
- name: Build npm package
|
||||
run: |
|
||||
VERSION=${GITHUB_REF#refs/tags/v}
|
||||
|
|
|
|||
|
|
@ -1,39 +0,0 @@
|
|||
name: Test
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- master
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version-file: go.mod
|
||||
|
||||
- name: Validate i18n messages
|
||||
run: go run ./internal/i18n/cmd/check
|
||||
|
||||
- name: Scan i18n key references
|
||||
run: go run ./internal/i18n/cmd/check --scan-code
|
||||
|
||||
- name: Test Feishu shortcuts
|
||||
run: go test ./shortcuts/feishu
|
||||
|
||||
- name: Test workflow shortcuts
|
||||
run: go test ./shortcuts/workflow
|
||||
|
||||
- name: Run Go tests
|
||||
run: go test ./...
|
||||
|
||||
- name: Vet
|
||||
run: go vet ./...
|
||||
|
|
@ -1,9 +1,38 @@
|
|||
# 编译输出
|
||||
*.exe
|
||||
|
||||
gitlink-cli.exe
|
||||
/gitlink-cli
|
||||
.local/*
|
||||
!.local/
|
||||
!.local/feishu-gitlink.env.example.ps1
|
||||
*.local.ps1
|
||||
*.secret.*
|
||||
reports/feishu-real-smoke-terminal.log
|
||||
# IDE
|
||||
.vscode/
|
||||
.idea/
|
||||
|
||||
# 系统
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# 临时文件
|
||||
*.tmp
|
||||
*.log
|
||||
|
||||
# 个人工作区
|
||||
my_docs/
|
||||
CLAUDE.md
|
||||
.claude/
|
||||
docs/
|
||||
|
||||
# 脚本输出目录
|
||||
skills/*/scripts/_output/
|
||||
doc/sub-task4-module-c/_output/
|
||||
doc/sub-task4-module-d/_output/
|
||||
|
||||
# CLI 包装器
|
||||
.cli-bin/
|
||||
|
||||
# 测试/临时数据文件
|
||||
*.json
|
||||
!package.json
|
||||
snapshots/
|
||||
tmp/
|
||||
|
||||
# Node.js
|
||||
node_modules/
|
||||
package-lock.json
|
||||
|
|
|
|||
|
|
@ -1,24 +0,0 @@
|
|||
run:
|
||||
timeout: 5m
|
||||
go: '1.22'
|
||||
|
||||
linters:
|
||||
enable:
|
||||
- errcheck
|
||||
- govet
|
||||
- revive
|
||||
- unused
|
||||
- gosimple
|
||||
- ineffassign
|
||||
- typecheck
|
||||
|
||||
linters-settings:
|
||||
revive:
|
||||
rules:
|
||||
- name: unused-parameter
|
||||
severity: warning
|
||||
|
||||
issues:
|
||||
exclude-use-default: false
|
||||
max-issues-per-linter: 50
|
||||
max-same-issues: 3
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
# Stable Feishu webhook
|
||||
$env:FEISHU_WEBHOOK_URL=""
|
||||
$env:FEISHU_WEBHOOK_SECRET=""
|
||||
|
||||
# Feishu Open Platform
|
||||
$env:FEISHU_APP_ID=""
|
||||
$env:FEISHU_APP_SECRET=""
|
||||
|
||||
# Feishu DocX / Wiki
|
||||
$env:FEISHU_WIKI_URL=""
|
||||
$env:FEISHU_WIKI_NODE_TOKEN=""
|
||||
$env:FEISHU_FOLDER_TOKEN=""
|
||||
$env:FEISHU_DOCUMENT_ID=""
|
||||
|
||||
# Feishu Base / Bitable
|
||||
$env:FEISHU_BASE_APP_TOKEN=""
|
||||
$env:FEISHU_REPORT_TABLE_ID=""
|
||||
$env:FEISHU_ISSUE_TABLE_ID=""
|
||||
$env:FEISHU_PR_TABLE_ID=""
|
||||
$env:FEISHU_CONTRIBUTOR_TABLE_ID=""
|
||||
$env:FEISHU_TASK_TABLE_ID=""
|
||||
|
||||
# Feishu Task
|
||||
$env:FEISHU_TASK_PROJECT_ID=""
|
||||
$env:FEISHU_TASK_SECTION_ID=""
|
||||
|
||||
# GitLink real test input
|
||||
$env:GITLINK_OWNER=""
|
||||
$env:GITLINK_REPO=""
|
||||
$env:GITLINK_TEST_PR_IDS=""
|
||||
$env:GITLINK_TOKEN=""
|
||||
|
|
@ -0,0 +1,264 @@
|
|||
# gitlink-cli 项目指南
|
||||
|
||||
## 项目背景
|
||||
|
||||
本项目是《软件演化与运维》(2026 春)课程的**进阶实践任务**:**GitLink 智能化能力提升项目**。
|
||||
|
||||
GitLink CLI 是 GitLink 平台的命令行工具,采用 Go 语言开发(cobra 框架),提供 40+ 命令覆盖仓库管理、Issue 跟踪、PR 协作、CI/CD 等场景,并内置 AI Agent Skills 体系,兼容 Claude Code 等主流 Agent 平台。
|
||||
|
||||
- **仓库**:https://gitlink.org.cn/gitlink/gitlink-cli(本仓库 fork 自 `z2_cc/gitlink-cli`)
|
||||
- **Skills 开发指南**:`skills/README.md`
|
||||
- **API 文档**:https://s.apifox.cn/da30afb0-9d2e-429b-a4bc-a83209e06021
|
||||
- **CLI 设计文档**:`doc/design.md`
|
||||
|
||||
进阶任务包含四个子任务(已全部完成),另加 DevOps 流水线:
|
||||
|
||||
| 子任务 | 定位 | 占比 | 技术栈 |
|
||||
|--------|------|------|--------|
|
||||
| 子任务一 | 扩展 CLI 能力 | 50% | Go |
|
||||
| 子任务二 | 编写 Skills | 20% | Markdown + CLI |
|
||||
| 子任务三 | 端到端工作流 | 20% | Shell + Skills 编排 |
|
||||
| 子任务四 | 科研辅助(加分项) | 额外加分 | Markdown + CLI |
|
||||
| DevOps | CI/CD 流水线 | 10% | YAML |
|
||||
|
||||
---
|
||||
|
||||
## 🧭 操作中心(交互式菜单)
|
||||
|
||||
**触发方式**(任一即可):
|
||||
- 输入 `/gitlink`(斜杠命令,最推荐),可附带参数:`/gitlink 代码审查`、`/gitlink https://gitlink.org.cn/z2_cc/gitlink-cli`
|
||||
- 直接说「常用操作」、「常用操作以及场景」、「列出操作」、「gitlink 菜单」
|
||||
|
||||
触发后按 [`.claude/commands/gitlink.md`](.claude/commands/gitlink.md) 的流程:先列出全部 16 项操作(单项操作 / 分析与成长 / 端到端自动化 / 科研辅助),再用原生上下方向键菜单让用户选择,或接收一个 GitLink 仓库网址直接对其操作,最后调用对应已实现的 skill 执行(写操作默认 dry-run)。操作 → skill 映射见该命令文件。
|
||||
|
||||
---
|
||||
|
||||
## 技术架构
|
||||
|
||||
```
|
||||
gitlink-cli/
|
||||
├── main.go # 入口
|
||||
├── cmd/ # CLI 命令定义(cobra)
|
||||
│ ├── root.go # 根命令,注册所有 shortcuts
|
||||
│ ├── api/api.go # raw API 调用:gitlink api <METHOD> <PATH>
|
||||
│ ├── auth/ # 认证:login/logout/status/refresh
|
||||
│ ├── config/ # 配置管理
|
||||
│ └── interactive/ # 交互式 REPL(bubbletea TUI)
|
||||
├── shortcuts/ # 23 个命令组(repo/issue/pr/release/ci/…)
|
||||
│ ├── register.go # RegisterAll() 注册入口
|
||||
│ ├── common/ # 共享类型 + 批量操作框架(batch.go)
|
||||
│ └── {group}/ # 每个命令组一个目录
|
||||
├── internal/ # 核心包
|
||||
│ ├── auth/ # 登录、token 存储、HTTP 传输
|
||||
│ ├── client/ # API 客户端(auto-.json、分页、错误映射)
|
||||
│ ├── config/ # 配置文件管理
|
||||
│ ├── context/ # 自动解析 owner/repo(从 git remote)
|
||||
│ └── output/ # 格式化输出(json/table/yaml)
|
||||
├── skills/ # 32 个 Skill 定义(SKILL.md + examples/ + scripts/)
|
||||
├── .claude/skills/ # Claude Code 使用的符号链接 → ../../skills/{name}
|
||||
├── .devops/ # GitLink DevOps 流水线(3 个 YAML)
|
||||
├── doc/ # 设计文档、交接文档、架构图
|
||||
└── my_docs/ # 工作文档、总结、计划
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 子任务一:CLI 能力扩展(Go)
|
||||
|
||||
**定位**:为 gitlink-cli 增加新功能、优化现有功能。所有改动在 `cmd/`、`shortcuts/`、`internal/` 中。
|
||||
|
||||
### 已完成(P1-P4)
|
||||
|
||||
| 优先级 | 内容 | 关键文件 |
|
||||
|--------|------|----------|
|
||||
| **P1** Bug 修复(3 项) | `--label` 参数未发送、硬编码 `master` 默认分支、`pr +diff`/`+files` 重复 | `shortcuts/issue/`, `shortcuts/common/`, `shortcuts/pr/` |
|
||||
| **P2** 参数补全(10 项) | 补全 `--milestone`/`--assignee`/`--priority`/`--sort` 等 CLI 参数与 API 的映射 | `shortcuts/issue/`, `shortcuts/pr/`, `shortcuts/release/` |
|
||||
| **P3** 批量操作(9 个命令) | 通用批量框架 + issue/PR/collaborator/branch 批量命令,支持 `--dry-run`/`--yes`/CSV 输入 | `shortcuts/common/batch.go` |
|
||||
| **P4** 体验优化 | 40+ 命令帮助文档、破坏性操作确认提示、API 错误友好建议 | `shortcuts/*/`, `internal/client/` |
|
||||
|
||||
### 交互式 REPL
|
||||
|
||||
`cmd/interactive/` 提供基于 bubbletea 的 TUI:命令面板(模糊搜索)→ 参数表单 → 输出查看器。支持 `/` 前缀打开面板。
|
||||
|
||||
### 后续可完善方向
|
||||
|
||||
- 补全 GitLink OpenAPI 中尚未封装的 Raw API
|
||||
- 新增 Shortcut 命令组(如看板增强)
|
||||
- 跨平台兼容性和安装体验优化
|
||||
- 单元测试覆盖
|
||||
|
||||
---
|
||||
|
||||
## 子任务二:Skills 开发(Markdown + CLI)
|
||||
|
||||
**定位**:基于 gitlink-cli 开发 AI Agent Skill。核心交付物是 SKILL.md + 使用示例 + Agent 平台验证。
|
||||
|
||||
### Skills 规范
|
||||
|
||||
每个 Skill 位于 `skills/{name}/`,包含:
|
||||
- `SKILL.md`:YAML 前-matter(name、description、triggers)+ 使用说明
|
||||
- `examples/`:Agent 对话记录或运行示例
|
||||
- `scripts/`(可选):可执行脚本
|
||||
|
||||
### 已完成的 Skills(32 个)
|
||||
|
||||
**平台基础操作**(原始 11 个 + 扩展):
|
||||
`gitlink-repo` `gitlink-issue` `gitlink-pr` `gitlink-release` `gitlink-branch` `gitlink-org` `gitlink-user` `gitlink-search` `gitlink-ci` `gitlink-webhook` `gitlink-wiki` `gitlink-snippet` `gitlink-pm`
|
||||
|
||||
**智能化 Skills**(子任务二核心交付):
|
||||
`gitlink-code-review` `gitlink-pr-deep-review` `gitlink-issue-triage` `gitlink-release-auto` `gitlink-project-health` `gitlink-insight` `gitlink-commit-quality` `gitlink-compliance` `gitlink-duplicate-detector` `gitlink-newcomer-guide`
|
||||
|
||||
**工作流 Skills**(子任务三):
|
||||
`gitlink-community-ops` `gitlink-quality-gate` `gitlink-workflow`
|
||||
|
||||
**科研 Skills**(子任务四):
|
||||
`gitlink-research-insight` `gitlink-research-hotspot` `gitlink-research-matching` `gitlink-research-progress` `gitlink-research-compliance`
|
||||
|
||||
**共享基础**:
|
||||
`gitlink-shared`(认证、全局参数、安全规则)
|
||||
|
||||
### 后续可完善方向
|
||||
|
||||
- 为现有 Skill 补充更多 Agent 平台验证(OpenClaw、Cursor)
|
||||
- 优化 Skill 触发词准确性
|
||||
- 增加 Skill 使用示例的覆盖度
|
||||
|
||||
---
|
||||
|
||||
## 子任务三:端到端自动化工作流(Shell + Skills 编排)
|
||||
|
||||
**定位**:组合 gitlink-cli 命令和 Skills,完成可复现的端到端自动化场景。每个工作流串联 ≥3 个步骤。
|
||||
|
||||
### 场景 A:社区运营自动化
|
||||
|
||||
`skills/gitlink-community-ops/` — 三阶段流水线:
|
||||
1. Issue 分拣(关键词分析 → 建议标签)
|
||||
2. 社区周报(Issue/PR/Commit/Milestone 统计)
|
||||
3. Release Notes 生成(Conventional Commits 分类)
|
||||
|
||||
关键文件:`community-ops-full.sh`(全流程编排)、`health-analyze.js`、`release-analyze.js`
|
||||
|
||||
### 场景 B:代码质量看门人
|
||||
|
||||
`skills/gitlink-quality-gate/` — 四阶段门禁:
|
||||
1. PR 采集 → 2. 深度审查 → 3. CI 检查 → 4. 评分决策(≥70 分 + CI 通过 → 建议合并)
|
||||
|
||||
评分模型:CodeReview(40%) + CI(30%) + 设计一致性(30%)
|
||||
|
||||
关键文件:`quality-gate-full.sh`(全流程编排)
|
||||
|
||||
### DevOps 流水线
|
||||
|
||||
`.devops/` 目录下 3 个 YAML 配置,均配置在 `z2_cc/gitlink-cli`:
|
||||
- `构建流水线.yml`:push 触发 Go 构建 + 版本校验
|
||||
- `社区运营流水线.yml`:定时触发社区运营全流程
|
||||
- `代码质量门禁流水线.yml`:PR 触发质量门禁
|
||||
|
||||
### 后续可完善方向
|
||||
|
||||
- 贡献者成长体系(追踪→排行→徽章)
|
||||
- 多仓库协同场景
|
||||
- 项目一键初始化工作流
|
||||
- 工作流的错误恢复和通知机制
|
||||
|
||||
---
|
||||
|
||||
## 子任务四:科研辅助(Markdown + CLI,加分项)
|
||||
|
||||
**定位**:依托 gitlink-cli 数据获取与 AI Agent 能力,为科研场景提供智能化辅助。设计原则:**evidence-oriented(证据驱动)、read-only(只读不写)、delegation pattern(委托已有 Skill)、pure remote analysis(纯远程分析)**。
|
||||
|
||||
### 已完成的 5 个科研 Skill
|
||||
|
||||
| Skill | 功能 | 关键文件 |
|
||||
|-------|------|----------|
|
||||
| `gitlink-research-insight` | 仓库级科研项目洞悉:8 维数据采集 + 4 维 AI 分析(成熟度/文档/贡献模式/社区健康),输出结构化评分报告 | `scripts/research-insight-full.sh`、`scripts/analyze.js` |
|
||||
| `gitlink-research-hotspot` | 科研热点追踪:多关键词搜索 → 实体提取 → 关系图构建 → Mermaid.js 知识图谱 + 交互式 HTML 可视化 | `scripts/hotspot-tracker-full.sh`、`scripts/kg-to-html.js` |
|
||||
| `gitlink-research-matching` | 科研协作智能匹配:4 角色推断(数据/算法/工程/评估)→ 人员-任务匹配 → 资源探测 → 综合建议报告 | `examples/matching-run.md`(已验证于 `Gitlink/forgeplus`) |
|
||||
| `gitlink-research-progress` | 科研进度跟踪与预警:6 维风险信号(停滞 Issue/高优无人/零回复/积压趋势/提交突变/里程碑 DDL),100 分制风险评分 | 已验证于 `forgeplus`/`gitlink-cli`/`FairMOT` |
|
||||
| `gitlink-research-compliance` | 科研合规与复现性检查:数据可用性/环境可复现/结果可验证 4 维评估 | `examples/reproducibility-check.md`(已验证于 `ifzhang/FairMOT`) |
|
||||
|
||||
### 共享工具
|
||||
|
||||
`skills/gitlink-shared/scripts/` 提供 `detect-cli.sh`(CLI 版本检测)和 `md-to-html.js`(报告转交互式 HTML)。
|
||||
|
||||
### 后续可完善方向
|
||||
|
||||
- 增加更多科研仓库验证案例
|
||||
- 知识图谱的交互式探索能力
|
||||
- 科研主体画像功能
|
||||
- 创新启发式推荐
|
||||
|
||||
---
|
||||
|
||||
## Skill 触发映射
|
||||
|
||||
当用户提及以下内容时,**优先调用对应 Skill**(而非手动执行命令):
|
||||
|
||||
### 平台操作
|
||||
- **Issue 管理** → `gitlink-issue`
|
||||
- **PR 管理** → `gitlink-pr`
|
||||
- **Release / 发版 / changelog** → `gitlink-release` 或 `gitlink-release-auto`
|
||||
- **仓库管理** → `gitlink-repo`
|
||||
- **分支管理** → `gitlink-branch`
|
||||
- **组织管理** → `gitlink-org`
|
||||
- **CI/CD** → `gitlink-ci`
|
||||
- **Wiki** → `gitlink-wiki`
|
||||
- **代码片段** → `gitlink-snippet`
|
||||
- **Webhook** → `gitlink-webhook`
|
||||
- **搜索** → `gitlink-search`
|
||||
|
||||
### 智能化与自动化
|
||||
- **代码审查 / PR Review** → `gitlink-code-review` 或 `gitlink-pr-deep-review`
|
||||
- **Issue 分拣 / 分类 / Triage** → `gitlink-issue-triage`
|
||||
- **项目健康度 / 周报** → `gitlink-project-health` 或 `gitlink-insight`
|
||||
- **新人引导 / good-first-issue** → `gitlink-newcomer-guide`
|
||||
- **重复 Issue 检测** → `gitlink-duplicate-detector`
|
||||
- **许可证合规检查** → `gitlink-compliance`
|
||||
- **提交质量检查** → `gitlink-commit-quality`
|
||||
- **项目管理 / Sprint / 看板** → `gitlink-pm`
|
||||
|
||||
### 工作流(子任务三)
|
||||
- **社区运营自动化 / 周报生成** → `gitlink-community-ops`
|
||||
- **代码质量门禁 / PR 自动门禁** → `gitlink-quality-gate`
|
||||
- **工作流模板参考** → `gitlink-workflow`
|
||||
|
||||
### 科研辅助(子任务四)
|
||||
- **科研项目洞悉 / 成熟度评估 / 仓库洞察** → `gitlink-research-insight`
|
||||
- **科研热点追踪 / 知识图谱 / 研究趋势** → `gitlink-research-hotspot`
|
||||
- **科研协作匹配 / 角色推断** → `gitlink-research-matching`
|
||||
- **科研进度跟踪 / 风险预警** → `gitlink-research-progress`
|
||||
- **科研合规检查 / 复现性评估** → `gitlink-research-compliance`
|
||||
|
||||
### 工作流扩展(子任务五)
|
||||
- **项目一键初始化 / 创建仓库 / 生成 README/LICENSE/CI / 初始 Issue 和里程碑** → 调用 `gitlink-project-bootstrap` skill
|
||||
- **多仓库协同 / 跨仓库 Issue 追踪 / PR 状态看板 / Release 协调发布** → 调用 `gitlink-multi-repo-coordination` skill(通过 `REPOS="owner/repo,..."` 指定多仓库)
|
||||
- **贡献者成长体系 / 贡献排行 / 成长段位 / 自动颁发徽章** → 调用 `gitlink-contributor-growth` skill
|
||||
|
||||
---
|
||||
|
||||
## 开发约定
|
||||
|
||||
### 命令使用
|
||||
- 所有 GitLink API 操作使用 `gitlink-cli` 命令,不得直接调用 REST API
|
||||
- 使用 Skill 前先阅读对应 `SKILL.md` 和 `skills/gitlink-shared/SKILL.md` 了解认证与已知限制
|
||||
- 命令输出优先使用 `--format json` 获取结构化数据
|
||||
|
||||
### 构建与测试
|
||||
```bash
|
||||
make build # 编译到 bin/gitlink-cli
|
||||
make install # 安装到 $GOPATH/bin
|
||||
go test ./... # 运行所有测试
|
||||
```
|
||||
|
||||
### 添加新 Skill
|
||||
1. 在 `skills/` 下创建目录(如 `skills/gitlink-xxx/`)
|
||||
2. 编写 `SKILL.md`(参考 `skills/README.md` 规范)
|
||||
3. 在 `.claude/skills/` 创建符号链接:`ln -s ../../skills/gitlink-xxx gitlink-xxx`
|
||||
4. 更新本文件的 Skill 映射表
|
||||
|
||||
### 关键参考文档
|
||||
- `doc/design.md` — CLI 设计文档
|
||||
- `doc/sub-task34-交接文档.md` — 子任务三、四交接文档
|
||||
- `my_docs/summary.md` — 子任务一 P1-P4 改进总结
|
||||
- `skills/README.md` — Skills 开发规范
|
||||
- `skills/gitlink-shared/SKILL.md` — 共享基础(认证、安全规则)
|
||||
41
Dockerfile
41
Dockerfile
|
|
@ -1,41 +0,0 @@
|
|||
# ============================================================
|
||||
# 多阶段构建:gitlink-cli 子赛题四网页终端
|
||||
# ============================================================
|
||||
# 阶段1 builder —— Go 静态编译
|
||||
# ============================================================
|
||||
FROM golang:1.26-alpine AS builder
|
||||
|
||||
ENV GOPROXY=https://goproxy.cn,direct
|
||||
WORKDIR /src
|
||||
|
||||
# 先拷依赖清单,利用 Docker 层缓存
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
|
||||
COPY . .
|
||||
# modernc.org/sqlite 是 pure-Go,CGO_ENABLED=0 即可编译纯静态二进制
|
||||
RUN CGO_ENABLED=0 GOOS=linux go build -ldflags="-s -w" -o /out/gitlink-cli .
|
||||
|
||||
# ============================================================
|
||||
# 阶段2 runtime —— Python + Go 二进制
|
||||
# ============================================================
|
||||
FROM python:3.12-slim
|
||||
|
||||
# Go CLI 放入 PATH
|
||||
COPY --from=builder /out/gitlink-cli /usr/local/bin/gitlink-cli
|
||||
|
||||
# 科研算法层:先拷 requirements.txt 安装依赖(利用层缓存),再拷源码
|
||||
# pip 先升级自身,再用清华镜像(带 retry + trusted-host 防证书/网络抖动)
|
||||
COPY scripts/research/requirements.txt /app/scripts/research/requirements.txt
|
||||
RUN pip install --no-cache-dir --upgrade pip && \
|
||||
pip install --no-cache-dir --default-timeout=300 --retries 5 \
|
||||
-i https://pypi.tuna.tsinghua.edu.cn/simple \
|
||||
--trusted-host pypi.tuna.tsinghua.edu.cn \
|
||||
-r /app/scripts/research/requirements.txt
|
||||
COPY scripts/research/ /app/scripts/research/
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# 子赛题四网页终端 HTTP 服务
|
||||
EXPOSE 8080
|
||||
ENTRYPOINT ["gitlink-cli", "server", "--port", "8080", "--research-dir", "/app/scripts/research", "--work-dir", "/app/research-output"]
|
||||
49
Makefile
49
Makefile
|
|
@ -3,7 +3,9 @@ BINARY := gitlink-cli
|
|||
VERSION ?= $(shell git describe --tags --always --dirty 2>/dev/null || echo "dev")
|
||||
LDFLAGS := -s -w -X '$(MODULE)/cmd.Version=$(VERSION)'
|
||||
|
||||
.PHONY: build install clean test test-cover lint ci
|
||||
PLATFORMS := darwin/amd64 darwin/arm64 linux/amd64 linux/arm64 windows/amd64 windows/arm64
|
||||
|
||||
.PHONY: build install clean test lint cross-build dist checksums
|
||||
|
||||
build:
|
||||
go build -ldflags "$(LDFLAGS)" -o $(BINARY) .
|
||||
|
|
@ -13,18 +15,43 @@ install:
|
|||
|
||||
clean:
|
||||
rm -f $(BINARY)
|
||||
rm -rf dist/
|
||||
|
||||
test:
|
||||
go test -v -race ./...
|
||||
|
||||
test-cover:
|
||||
go test -v -race -coverprofile=coverage.out ./...
|
||||
go tool cover -func=coverage.out
|
||||
go test ./...
|
||||
|
||||
lint:
|
||||
golangci-lint run ./...
|
||||
|
||||
ci: lint test
|
||||
|
||||
vet:
|
||||
go vet ./...
|
||||
|
||||
# Cross-compile for all supported platforms
|
||||
cross-build:
|
||||
@mkdir -p dist
|
||||
@for pair in $(PLATFORMS); do \
|
||||
GOOS=$${pair%/*}; \
|
||||
GOARCH=$${pair#*/}; \
|
||||
OUT=$(BINARY); \
|
||||
if [ "$$GOOS" = "windows" ]; then OUT=$(BINARY).exe; fi; \
|
||||
echo "Building $$GOOS/$$GOARCH..."; \
|
||||
BUILD_DIR="dist/$(BINARY)_$(VERSION)_$${GOOS}_$${GOARCH}"; \
|
||||
mkdir -p "$$BUILD_DIR"; \
|
||||
CGO_ENABLED=0 GOOS=$$GOOS GOARCH=$$GOARCH \
|
||||
go build -ldflags "$(LDFLAGS)" -o "$$BUILD_DIR/$$OUT" .; \
|
||||
if [ "$$GOOS" = "windows" ]; then \
|
||||
(cd "$$BUILD_DIR" && zip -q "../$(BINARY)_$(VERSION)_$${GOOS}_$${GOARCH}.zip" "$$OUT"); \
|
||||
else \
|
||||
tar -czf "dist/$(BINARY)_$(VERSION)_$${GOOS}_$${GOARCH}.tar.gz" -C "$$BUILD_DIR" "$$OUT"; \
|
||||
fi; \
|
||||
rm -rf "$$BUILD_DIR"; \
|
||||
done
|
||||
@echo "Build complete:"
|
||||
@ls -lh dist/*.tar.gz dist/*.zip 2>/dev/null
|
||||
|
||||
# Generate SHA256 checksums for all archives in dist/
|
||||
checksums: cross-build
|
||||
@cd dist && \
|
||||
sha256sum *.tar.gz *.zip 2>/dev/null > checksums-sha256.txt && \
|
||||
echo "Checksums written to dist/checksums-sha256.txt" && \
|
||||
cat checksums-sha256.txt
|
||||
|
||||
# Full distribution build: cross-compile + checksums
|
||||
dist: checksums
|
||||
|
|
|
|||
368
README.md
368
README.md
|
|
@ -5,7 +5,7 @@
|
|||
[](https://golang.org)
|
||||
[](https://www.npmjs.com/package/@gitlink-ai/cli)
|
||||
|
||||
The official [GitLink](https://www.gitlink.org.cn) CLI tool — built for humans and AI Agents. Supports **macOS, Linux, and Windows**. Covers repository management, wiki pages, issue tracking, pull requests, webhooks, member collaboration, CI/CD, and AI-powered workflows, with 40+ commands and AI Agent [Skills](./skills/).
|
||||
The official [GitLink](https://www.gitlink.org.cn) CLI tool — built for humans and AI Agents. Supports **macOS, Linux, and Windows**. Covers repository management, issue tracking, pull requests, webhooks, CI/CD, and AI-powered workflows, with 40+ commands and 13 AI Agent [Skills](./skills/).
|
||||
|
||||
**[中文文档](./README.zh-CN.md)**
|
||||
|
||||
|
|
@ -13,77 +13,22 @@ The official [GitLink](https://www.gitlink.org.cn) CLI tool — built for humans
|
|||
|
||||
## Contributors
|
||||
|
||||
<div style="display: flex; gap: 16px; flex-wrap: wrap; align-items: flex-start;">
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/wangyue111" title="wangyue111"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/W/43_254_70/120.png" width="40" height="40" alt="wangyue111" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/wangyue111">wangyue111</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/wbtiger" title="tigerwang"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/T/14_168_39/120.png" width="40" height="40" alt="wbtiger" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/wbtiger">wbtiger</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/Mengz" title="Mengz"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/M/166_152_185/120.png" width="40" height="40" alt="Mengz" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/Mengz">Mengz</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/yangsai" title="杨赛"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/Y/94_150_149/120.png" width="40" height="40" alt="yangsai" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/yangsai">yangsai</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/mengcheng" title="camelliamc"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/M/206_114_54/120.png" width="40" height="40" alt="mengcheng" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/mengcheng">mengcheng</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/muel" title="赵奕程"><img src="https://www.gitlink.org.cn/images/avatars/User/149182?t=1779603476" width="40" height="40" alt="muel" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/muel">muel</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/Leo77" title="Leo77"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/L/173_120_149/120.png" width="40" height="40" alt="Leo77" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/Leo77">Leo77</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/yingjie" title="yingjie"><img src="https://www.gitlink.org.cn/images/avatars/User/145288?t=1765791899" width="40" height="40" alt="yingjie" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/yingjie">yingjie</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/topshare" title="Kevin Zhang"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/K/65_152_142/120.png" width="40" height="40" alt="topshare" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/topshare">topshare</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/dtwdtw" title="dtwdtw"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/D/53_166_51/120.png" width="40" height="40" alt="dtwdtw" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/dtwdtw">dtwdtw</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/recorder" title="recorder"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/R/141_201_87/120.png" width="40" height="40" alt="recorder" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/recorder">recorder</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/puygob236" title="Jiachen Li"><img src="https://www.gitlink.org.cn/images/avatars/User/149183?t=1778815174" width="40" height="40" alt="puygob236" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/puygob236">puygob236</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/co63oc" title="co63oc"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/C/205_201_141/120.png" width="40" height="40" alt="co63oc" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/co63oc">co63oc</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/lindiwen23" title="lindiwen23"><img src="https://www.gitlink.org.cn/images/avatars/User/141609?t=1748270628" width="40" height="40" alt="lindiwen23" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/lindiwen23">lindiwen23</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/ohanabi" title="ohanabi"><img src="https://www.gitlink.org.cn/images/avatars/User/148166?t=1778230283" width="40" height="40" alt="ohanabi" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/ohanabi">ohanabi</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/jiangtx" title="jiangtx"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/J/67_157_94/120.png" width="40" height="40" alt="jiangtx" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/jiangtx">jiangtx</a></sub>
|
||||
</div>
|
||||
<div style="display: flex; gap: 20px; flex-wrap: wrap; align-items: center;">
|
||||
<a href="https://www.gitlink.org.cn/wangyue111" title="wangyue111"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/W/43_254_70/120.png" width="40" height="40" alt="wangyue111" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/wbtiger" title="tigerwang"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/T/14_168_39/120.png" width="40" height="40" alt="wbtiger" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/Mengz" title="Mengz"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/M/166_152_185/120.png" width="40" height="40" alt="Mengz" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/yangsai" title="杨赛"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/Y/94_150_149/120.png" width="40" height="40" alt="yangsai" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/mengcheng" title="camelliamc"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/M/206_114_54/120.png" width="40" height="40" alt="mengcheng" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/muel" title="赵奕程"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/Z/144_206_212/120.png" width="40" height="40" alt="muel" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/Leo77" title="Leo77"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/L/173_120_149/120.png" width="40" height="40" alt="Leo77" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/yingjie" title="yingjie"><img src="https://www.gitlink.org.cn/images/avatars/User/145288?t=1765791899" width="40" height="40" alt="yingjie" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/topshare" title="Kevin Zhang"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/K/65_152_142/120.png" width="40" height="40" alt="topshare" style="border-radius: 50%;"></a>
|
||||
</div>
|
||||
|
||||
## Why gitlink-cli?
|
||||
|
||||
- **Agent-Native Design** — Structured [Skills](./skills/) out of the box, compatible with Claude Code, OpenClaw, and other AI platforms — Agents can operate GitLink with zero extra setup
|
||||
- **Wide Coverage** — Repository, Wiki, Issue, PR, Webhook, Member, Branch, Release, CI, Pipeline, Org, Search, and User workflows are covered by high-level commands
|
||||
- **Agent-Native Design** — 13 structured [Skills](./skills/) out of the box, compatible with Claude Code, OpenClaw, and other AI platforms — Agents can operate GitLink with zero extra setup
|
||||
- **Wide Coverage** — Repository, Issue, PR, Webhook, Branch, Release, CI, Org, Search, User — all core domains covered
|
||||
- **AI-Friendly & Optimized** — Every command is tested with real Agents, featuring concise parameters, smart defaults, and structured output
|
||||
- **Cross-Platform** — Runs on macOS, Linux, and Windows (x64/arm64), install via `npm install -g @gitlink-ai/cli` in one command, binary auto-downloaded
|
||||
- **Open Source, Zero Barriers** — MulanPSL-2.0 license, ready to use, just `npm install`
|
||||
|
|
@ -95,17 +40,13 @@ The official [GitLink](https://www.gitlink.org.cn) CLI tool — built for humans
|
|||
|
||||
| Category | Capabilities |
|
||||
|----------|-------------|
|
||||
| 📦 Repo | List, create, fork, delete repositories, view repo info, insights, and interactions |
|
||||
| 📚 Wiki | List, view, create, update, and delete wiki pages |
|
||||
| 📦 Repo | List, create, fork, delete repositories, view repo info |
|
||||
| 🐛 Issue | Create, update, close, batch close, comment on issues |
|
||||
| 🔖 Label | Create, list, update, delete issue labels |
|
||||
| 🔀 PR | Create, merge, review pull requests, view changed files |
|
||||
| 👥 Member | List, add, remove repository members, change roles, create and accept invite links |
|
||||
| 🌿 Branch | Create, delete, list, protect, unprotect branches |
|
||||
| 🏷️ Release | Create, edit, update, view, delete releases |
|
||||
| 🏷️ Release | Create, view, delete releases |
|
||||
| 🏢 Org | Manage organizations, members, teams |
|
||||
| 🔧 CI | View builds, logs, CI/CD operations |
|
||||
| ⚙️ Pipeline | Run, inspect, enable, disable, delete pipeline workflows and logs |
|
||||
| 🔔 Webhook | Manage repo webhooks and test deliveries |
|
||||
| 🔍 Search | Search repositories, users |
|
||||
| 👤 User | View user profiles and info |
|
||||
|
|
@ -129,7 +70,7 @@ The official [GitLink](https://www.gitlink.org.cn) CLI tool — built for humans
|
|||
**From npm (recommended):**
|
||||
|
||||
```bash
|
||||
# One command: installs CLI binary + AI Agent Skills
|
||||
# One command: installs CLI binary + all 13 AI Agent Skills
|
||||
npm install -g @gitlink-ai/cli
|
||||
```
|
||||
|
||||
|
|
@ -210,36 +151,6 @@ gitlink-cli repo +list
|
|||
# View repository info
|
||||
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
|
||||
|
||||
# List contributors
|
||||
gitlink-cli repo +contributors --owner Gitlink --repo forgeplus
|
||||
|
||||
# Show contributor code-line stats for a branch, tag, or commit
|
||||
gitlink-cli repo +contributor-stats --owner Gitlink --repo forgeplus --ref master --pass-year 1
|
||||
|
||||
# Show repository code stats
|
||||
gitlink-cli repo +code-stats --owner Gitlink --repo forgeplus --ref master
|
||||
|
||||
# List watchers and stargazers in a time range
|
||||
gitlink-cli repo +watchers --owner Gitlink --repo forgeplus --start-at 1714521600 --end-at 1717200000
|
||||
gitlink-cli repo +stargazers --owner Gitlink --repo forgeplus --start-at 1714521600 --end-at 1717200000
|
||||
|
||||
# Preview and apply repository interaction actions
|
||||
gitlink-cli repo +follow --owner Gitlink --repo forgeplus --dry-run
|
||||
gitlink-cli repo +follow --owner Gitlink --repo forgeplus
|
||||
gitlink-cli repo +unfollow --owner Gitlink --repo forgeplus --project-id 123
|
||||
gitlink-cli repo +like --owner Gitlink --repo forgeplus
|
||||
gitlink-cli repo +unlike --owner Gitlink --repo forgeplus --project-id 123
|
||||
|
||||
# Create a repository
|
||||
gitlink-cli repo +create -n my-project -d "Project description"
|
||||
|
||||
|
|
@ -247,27 +158,6 @@ gitlink-cli repo +create -n my-project -d "Project description"
|
|||
gitlink-cli repo +fork --owner Gitlink --repo forgeplus
|
||||
```
|
||||
|
||||
### Wiki Management
|
||||
|
||||
```bash
|
||||
# List wiki pages
|
||||
gitlink-cli wiki +list --owner Gitlink --repo forgeplus
|
||||
|
||||
# View a wiki page
|
||||
gitlink-cli wiki +view --owner Gitlink --repo forgeplus --page Home
|
||||
|
||||
# Create a wiki page from inline content
|
||||
gitlink-cli wiki +create --owner Gitlink --repo forgeplus \
|
||||
--page Home --title Home --content "Welcome to the project wiki"
|
||||
|
||||
# Update a wiki page from a Markdown file
|
||||
gitlink-cli wiki +update --owner Gitlink --repo forgeplus \
|
||||
--page Home --file docs/wiki-home.md --message "Update Home"
|
||||
|
||||
# Delete a wiki page
|
||||
gitlink-cli wiki +delete --owner Gitlink --repo forgeplus --page Home
|
||||
```
|
||||
|
||||
### Webhook Management
|
||||
|
||||
```bash
|
||||
|
|
@ -285,28 +175,6 @@ gitlink-cli webhook +test --owner Gitlink --repo forgeplus --id 68
|
|||
gitlink-cli webhook +tasks --owner Gitlink --repo forgeplus --id 68
|
||||
```
|
||||
|
||||
### Member Management
|
||||
|
||||
```bash
|
||||
# List repository members
|
||||
gitlink-cli member +list --owner Gitlink --repo forgeplus
|
||||
|
||||
# Add a member
|
||||
gitlink-cli member +add --owner Gitlink --repo forgeplus --user-id 101
|
||||
|
||||
# Preview batch add without changing data
|
||||
gitlink-cli member +batch-add --owner Gitlink --repo forgeplus --user-ids 101,102 --dry-run
|
||||
|
||||
# Batch add members from a CSV file
|
||||
gitlink-cli member +batch-add --owner Gitlink --repo forgeplus --from members.csv
|
||||
|
||||
# Change a member role
|
||||
gitlink-cli member +role --owner Gitlink --repo forgeplus --user-id 101 --role Developer
|
||||
|
||||
# Create an invite link
|
||||
gitlink-cli member +invite-link --owner Gitlink --repo forgeplus --role developer --apply true
|
||||
```
|
||||
|
||||
### Issue Management
|
||||
|
||||
```bash
|
||||
|
|
@ -316,15 +184,9 @@ gitlink-cli issue +list --owner Gitlink --repo forgeplus
|
|||
# Create an issue
|
||||
gitlink-cli issue +create --owner Gitlink --repo forgeplus -t "Bug: Login failed" -b "Steps to reproduce..."
|
||||
|
||||
# Create an issue with metadata
|
||||
gitlink-cli issue +create --owner Gitlink --repo forgeplus -t "Bug: Login failed" --priority-id 3 --tag-ids 4,5 --assigner-ids 7
|
||||
|
||||
# View an issue
|
||||
gitlink-cli issue +view --owner Gitlink --repo forgeplus -i 123
|
||||
|
||||
# Update issue metadata
|
||||
gitlink-cli issue +update --owner Gitlink --repo forgeplus --number 123 --priority-id 4 --branch bugfix/login --due-date 2026-06-15
|
||||
|
||||
# Close an issue
|
||||
gitlink-cli issue +close --owner Gitlink --repo forgeplus -i 123
|
||||
|
||||
|
|
@ -336,45 +198,6 @@ gitlink-cli issue +batch-close --owner Gitlink --repo forgeplus --from issues.cs
|
|||
|
||||
# Add a comment
|
||||
gitlink-cli issue +comment --owner Gitlink --repo forgeplus -i 123 -b "Fixed"
|
||||
|
||||
# List issue assigners
|
||||
gitlink-cli issue +assigners --owner Gitlink --repo forgeplus
|
||||
|
||||
# List issue authors
|
||||
gitlink-cli issue +authors --owner Gitlink --repo forgeplus
|
||||
|
||||
# List issue priorities
|
||||
gitlink-cli issue +priorities --owner Gitlink --repo forgeplus
|
||||
|
||||
# List issue tags
|
||||
gitlink-cli issue +tags --owner Gitlink --repo forgeplus --only-name
|
||||
|
||||
# List issue statuses
|
||||
gitlink-cli issue +statuses --owner Gitlink --repo forgeplus
|
||||
```
|
||||
|
||||
`issue +view`, `issue +update`, `issue +close`, and `issue +comment` prefer
|
||||
`--number` / `-n` for the issue number shown in the web URL. `--id` / `-i`
|
||||
is accepted as a compatibility alias for the same web issue number, not the
|
||||
global database ID.
|
||||
|
||||
### Label Management
|
||||
|
||||
```bash
|
||||
# List issue labels
|
||||
gitlink-cli label +list --owner Gitlink --repo forgeplus
|
||||
|
||||
# Filter labels by keyword
|
||||
gitlink-cli label +list --owner Gitlink --repo forgeplus -k bug
|
||||
|
||||
# Create a label (color defaults to #1E90FF)
|
||||
gitlink-cli label +create --owner Gitlink --repo forgeplus -n bug -d "Something is broken" -c "#FF0000"
|
||||
|
||||
# Update a label (unspecified fields are preserved)
|
||||
gitlink-cli label +update --owner Gitlink --repo forgeplus -i 42 -c "#00FF00"
|
||||
|
||||
# Delete a label
|
||||
gitlink-cli label +delete --owner Gitlink --repo forgeplus -i 42
|
||||
```
|
||||
|
||||
### Pull Requests
|
||||
|
|
@ -395,9 +218,6 @@ gitlink-cli pr +view --owner Gitlink --repo forgeplus -i 42
|
|||
# Merge a PR
|
||||
gitlink-cli pr +merge --owner Gitlink --repo forgeplus -i 42
|
||||
|
||||
# Reopen a closed PR
|
||||
gitlink-cli pr +reopen --owner Gitlink --repo forgeplus -i 42
|
||||
|
||||
# View changed files
|
||||
gitlink-cli pr +files --owner Gitlink --repo forgeplus -i 42
|
||||
|
||||
|
|
@ -440,18 +260,11 @@ gitlink-cli branch +unprotect --name main
|
|||
# List releases
|
||||
gitlink-cli release +list --owner Gitlink --repo forgeplus
|
||||
|
||||
# Create a release with release notes and optional assets
|
||||
gitlink-cli release +create --owner Gitlink --repo forgeplus -t v1.0.0 -n "v1.0.0 Stable" -b "Changelog..." --attachment-ids 12,34
|
||||
# Create a release
|
||||
gitlink-cli release +create --owner Gitlink --repo forgeplus -t v1.0.0 -n "v1.0.0 Stable" -b "Changelog..."
|
||||
|
||||
# View a release
|
||||
gitlink-cli release +view --owner Gitlink --repo forgeplus -i <version_id>
|
||||
|
||||
# Get edit data and update while preserving unspecified fields
|
||||
gitlink-cli release +edit --owner Gitlink --repo forgeplus -i <version_id>
|
||||
gitlink-cli release +update --owner Gitlink --repo forgeplus -i <version_id> -b "Updated changelog" --dry-run
|
||||
|
||||
# Preview release deletion before executing it
|
||||
gitlink-cli release +delete --owner Gitlink --repo forgeplus -i <version_id> --dry-run
|
||||
```
|
||||
|
||||
### CI/CD Operations
|
||||
|
|
@ -467,28 +280,6 @@ gitlink-cli ci +log --owner Gitlink --repo forgeplus -i <build_id>
|
|||
gitlink-cli ci +restart --owner Gitlink --repo forgeplus -i <build_id>
|
||||
```
|
||||
|
||||
### Pipeline Operations
|
||||
|
||||
```bash
|
||||
# List platform pipelines
|
||||
gitlink-cli pipeline +list --owner-id 123 --page 1 --limit 20
|
||||
|
||||
# List repository pipeline runs
|
||||
gitlink-cli pipeline +runs --owner Gitlink --repo forgeplus --ref master --workflow build.yml
|
||||
|
||||
# Start a pipeline workflow, previewing the request first
|
||||
gitlink-cli pipeline +run --owner Gitlink --repo forgeplus --ref master --workflow build.yml --dry-run
|
||||
|
||||
# Inspect pipeline details and logs
|
||||
gitlink-cli pipeline +view --owner Gitlink --repo forgeplus --id 7
|
||||
gitlink-cli pipeline +logs --owner Gitlink --repo forgeplus --run-id 99 --id 7 --index 43
|
||||
gitlink-cli pipeline +results --owner Gitlink --repo forgeplus --run-id 99
|
||||
|
||||
# Toggle or delete pipeline workflows, previewing destructive writes first
|
||||
gitlink-cli pipeline +disable --owner Gitlink --repo forgeplus --id 7 --workflow build.yml --dry-run
|
||||
gitlink-cli pipeline +delete --owner Gitlink --repo forgeplus --id 7 --dry-run
|
||||
```
|
||||
|
||||
### Search
|
||||
|
||||
```bash
|
||||
|
|
@ -499,105 +290,6 @@ gitlink-cli search +repos -k "machine learning"
|
|||
gitlink-cli search +users -k "zhangsan"
|
||||
```
|
||||
|
||||
### Workflow Agent Commands
|
||||
|
||||
`workflow` provides rule-based repository analysis for maintainers and AI Agents. It currently supports:
|
||||
|
||||
- `workflow +triage`
|
||||
- `workflow +health`
|
||||
- `workflow +pr-summary`
|
||||
- `workflow +repo-report`
|
||||
|
||||
`workflow +pr-summary` defaults to `table` when `--format` is omitted.
|
||||
`workflow +repo-report` defaults to `markdown` when `--format` is omitted.
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
# Triage with local parameters
|
||||
gitlink-cli workflow +triage --title "Install failed on Windows" --body "go install failed with error" --format table
|
||||
|
||||
# Triage with JSON output
|
||||
gitlink-cli workflow +triage --title "Token leaked in logs" --body "The access token appears in command output" --format json
|
||||
|
||||
# Triage with Chinese markdown output
|
||||
gitlink-cli workflow +triage \
|
||||
--title "安装失败,无法登录" \
|
||||
--body "运行命令时报错" \
|
||||
--lang zh-CN \
|
||||
--format markdown
|
||||
|
||||
# Triage from a local JSON file
|
||||
gitlink-cli workflow +triage --from shortcuts/workflow/testdata/issue_bug.json --format json
|
||||
|
||||
# Triage by read-only GitLink fetch
|
||||
gitlink-cli workflow +triage --owner Gitlink --repo gitlink-cli --state open --limit 5 --format table
|
||||
|
||||
# Health for a healthy repository
|
||||
gitlink-cli workflow +health \
|
||||
--repository Gitlink/gitlink-cli \
|
||||
--open-issues 3 \
|
||||
--open-prs 1 \
|
||||
--has-readme \
|
||||
--has-license \
|
||||
--has-contributing \
|
||||
--agent-readiness-known \
|
||||
--agent-readiness-score 9 \
|
||||
--format table
|
||||
|
||||
# Health for a risky repository
|
||||
gitlink-cli workflow +health \
|
||||
--repository demo/repo \
|
||||
--open-issues 60 \
|
||||
--stale-issues 25 \
|
||||
--open-prs 12 \
|
||||
--stale-prs 6 \
|
||||
--recent-activity-known \
|
||||
--recent-activity-days 120 \
|
||||
--release-known=false \
|
||||
--format json
|
||||
|
||||
# Health with Chinese markdown output
|
||||
gitlink-cli workflow +health \
|
||||
--repository Gitlink/gitlink-cli \
|
||||
--open-issues 3 \
|
||||
--open-prs 1 \
|
||||
--has-readme \
|
||||
--has-license \
|
||||
--has-contributing \
|
||||
--lang zh-CN \
|
||||
--format markdown
|
||||
|
||||
# Health by read-only GitLink fetch
|
||||
gitlink-cli workflow +health --owner Gitlink --repo gitlink-cli --stale-days 30 --format table
|
||||
|
||||
# PR review summary by read-only GitLink fetch
|
||||
gitlink-cli workflow +pr-summary --owner Gitlink --repo gitlink-cli --number 1 --format markdown
|
||||
|
||||
# PR review summary from a local JSON file
|
||||
gitlink-cli workflow +pr-summary --from shortcuts/workflow/testdata/pr_summary.json --format json
|
||||
|
||||
# Repository workflow report by read-only GitLink fetch
|
||||
gitlink-cli workflow +repo-report --owner Gitlink --repo gitlink-cli --format markdown
|
||||
|
||||
# Repository workflow report from a local JSON file
|
||||
gitlink-cli workflow +repo-report --from shortcuts/workflow/testdata/repo_report.json --format json
|
||||
```
|
||||
|
||||
Output formats:
|
||||
|
||||
- `json` for scripts and AI Agents
|
||||
- `table` for terminal review
|
||||
- `markdown` for Issue comments, PR comments, release notes, and competition write-ups
|
||||
|
||||
Safety:
|
||||
|
||||
- Current workflow commands use local analysis by default and can also read GitLink data in read-only fetch mode.
|
||||
- They do not modify remote GitLink data.
|
||||
- They do not depend on LLM APIs.
|
||||
- `workflow +pr-summary` does not comment, approve, reject, or merge pull requests.
|
||||
- `workflow +repo-report` aggregates health, issue triage, and PR review summary signals without remote writes.
|
||||
|
||||
### Raw API
|
||||
|
||||
For endpoints not covered by shortcuts, use the Raw API directly:
|
||||
|
|
@ -609,12 +301,6 @@ gitlink-cli api GET /users/me
|
|||
# POST request
|
||||
gitlink-cli api POST /Gitlink/forgeplus/issues --body '{"subject":"test","description":"..."}'
|
||||
|
||||
# POST request with body from a file
|
||||
gitlink-cli api POST /Gitlink/forgeplus/issues --body-file issue.json
|
||||
|
||||
# POST request with body from stdin
|
||||
Get-Content issue.json | gitlink-cli api POST /Gitlink/forgeplus/issues --body-stdin
|
||||
|
||||
# With query parameters
|
||||
gitlink-cli api GET /Gitlink/forgeplus/commits --query 'page=1&limit=5'
|
||||
```
|
||||
|
|
@ -625,7 +311,7 @@ gitlink-cli api GET /Gitlink/forgeplus/commits --query 'page=1&limit=5'
|
|||
|-----------|-------------|---------|
|
||||
| `--owner` | Repository owner | `--owner Gitlink` |
|
||||
| `--repo` | Repository name | `--repo forgeplus` |
|
||||
| `--format` | Output format (json/table/yaml; workflow also supports markdown) | `--format json` |
|
||||
| `--format` | Output format (json/table/yaml) | `--format json` |
|
||||
| `--debug` | Enable debug output | `--debug` |
|
||||
|
||||
**Automatic context resolution:** When running inside a git repository, `--owner` and `--repo` are automatically resolved from `git remote origin`.
|
||||
|
|
@ -652,28 +338,24 @@ git push gitlink
|
|||
|
||||
## AI Agent Skills
|
||||
|
||||
The `skills/` directory contains Agent Skill files for AI-automated GitLink operations.
|
||||
The `skills/` directory contains 12 Agent Skill files for AI-automated GitLink operations.
|
||||
|
||||
See [skills/README.md](skills/README.md) for details.
|
||||
|
||||
| Skill | Description |
|
||||
|-------|-------------|
|
||||
| `gitlink-shared` | Authentication, global parameters, safety rules, API notes |
|
||||
| `gitlink-repo` | Repository operations (create, view, delete, fork, insights, etc.) |
|
||||
| `gitlink-wiki` | Wiki operations (list, view, create, update, delete) |
|
||||
| `gitlink-repo` | Repository operations (create, view, delete, fork, etc.) |
|
||||
| `gitlink-issue` | Issue operations (create, update, close, comment, etc.) |
|
||||
| `gitlink-pr` | Pull request operations (create, merge, review, etc.) |
|
||||
| `gitlink-member` | Repository member and invite link management |
|
||||
| `gitlink-branch` | Branch management (create, delete, list, protect, unprotect) |
|
||||
| `gitlink-release` | Release management (create, edit, update, view, delete, etc.) |
|
||||
| `gitlink-release` | Release management (create, view, delete, etc.) |
|
||||
| `gitlink-ci` | CI/CD operations (builds, logs, etc.) |
|
||||
| `gitlink-pipeline` | Pipeline workflow operations (runs, logs, enable, disable, delete, etc.) |
|
||||
| `gitlink-search` | Search (repositories, users, etc.) |
|
||||
| `gitlink-org` | Organization management (members, teams, etc.) |
|
||||
| `gitlink-user` | User management (profile info, etc.) |
|
||||
| `gitlink-pm` | Project management (sprints, kanban, weekly reports, etc.) |
|
||||
| `gitlink-workflow` | AI-powered workflows (issue triage, PR review, release notes, etc.) |
|
||||
| `gitlink-health` | Project health analysis (PR/Issue metrics aggregation, health reports) |
|
||||
|
||||
## Project Structure
|
||||
|
||||
|
|
@ -696,12 +378,10 @@ gitlink-cli/
|
|||
│ ├── repo/ # Repository shortcuts
|
||||
│ ├── issue/ # Issue shortcuts
|
||||
│ ├── pr/ # PR shortcuts
|
||||
│ ├── member/ # Repository member shortcuts
|
||||
│ ├── branch/ # Branch shortcuts
|
||||
│ ├── release/ # Release shortcuts
|
||||
│ ├── org/ # Organization shortcuts
|
||||
│ ├── ci/ # CI shortcuts
|
||||
│ ├── pipeline/ # Pipeline shortcuts
|
||||
│ ├── search/ # Search shortcuts
|
||||
│ ├── user/ # User shortcuts
|
||||
│ └── register.go # Registration entry point
|
||||
|
|
@ -780,9 +460,7 @@ Reinstall first:
|
|||
npm install -g @gitlink-ai/cli
|
||||
```
|
||||
|
||||
If the error persists, check whether the release page contains the asset for your platform,
|
||||
for example `gitlink-cli_<version>_windows_amd64.zip` on Windows x64.
|
||||
You can also download the binary manually from the release page or build from source with `go install .`.
|
||||
If the error persists, check whether the release page contains the asset for your platform, for example `gitlink-cli_<version>_windows_amd64.zip` on Windows x64. You can also download the binary manually from the release page or build from source with `go install .`.
|
||||
|
||||
### Q: Where are credentials stored on Windows?
|
||||
|
||||
|
|
|
|||
259
README.zh-CN.md
259
README.zh-CN.md
|
|
@ -5,7 +5,7 @@
|
|||
[](https://golang.org)
|
||||
[](https://www.npmjs.com/package/@gitlink-ai/cli)
|
||||
|
||||
[GitLink(确实开源)](https://www.gitlink.org.cn) 官方 CLI 工具 — 为人类和 AI Agent 双重设计。支持 **macOS、Linux、Windows**,覆盖仓库管理、Wiki、Issue 追踪、Pull Request、Webhook、成员协作、CI/CD 和 AI 自动化工作流,包含 40+ 命令和 AI Agent [Skills](./skills/)。
|
||||
[GitLink(确实开源)](https://www.gitlink.org.cn) 官方 CLI 工具 — 为人类和 AI Agent 双重设计。支持 **macOS、Linux、Windows**,覆盖仓库管理、Issue 追踪、Pull Request、Webhook、CI/CD 和 AI 自动化工作流,包含 40+ 命令和 13 个 AI Agent [Skills](./skills/)。
|
||||
|
||||
**[English](./README.md)**
|
||||
|
||||
|
|
@ -13,77 +13,22 @@
|
|||
|
||||
## 贡献者
|
||||
|
||||
<div style="display: flex; gap: 16px; flex-wrap: wrap; align-items: flex-start;">
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/wangyue111" title="wangyue111"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/W/43_254_70/120.png" width="40" height="40" alt="wangyue111" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/wangyue111">wangyue111</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/wbtiger" title="tigerwang"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/T/14_168_39/120.png" width="40" height="40" alt="wbtiger" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/wbtiger">wbtiger</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/Mengz" title="Mengz"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/M/166_152_185/120.png" width="40" height="40" alt="Mengz" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/Mengz">Mengz</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/yangsai" title="杨赛"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/Y/94_150_149/120.png" width="40" height="40" alt="yangsai" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/yangsai">yangsai</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/mengcheng" title="camelliamc"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/M/206_114_54/120.png" width="40" height="40" alt="mengcheng" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/mengcheng">mengcheng</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/muel" title="赵奕程"><img src="https://www.gitlink.org.cn/images/avatars/User/149182?t=1779603476" width="40" height="40" alt="muel" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/muel">muel</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/Leo77" title="Leo77"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/L/173_120_149/120.png" width="40" height="40" alt="Leo77" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/Leo77">Leo77</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/yingjie" title="yingjie"><img src="https://www.gitlink.org.cn/images/avatars/User/145288?t=1765791899" width="40" height="40" alt="yingjie" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/yingjie">yingjie</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/topshare" title="Kevin Zhang"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/K/65_152_142/120.png" width="40" height="40" alt="topshare" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/topshare">topshare</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/dtwdtw" title="dtwdtw"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/D/53_166_51/120.png" width="40" height="40" alt="dtwdtw" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/dtwdtw">dtwdtw</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/recorder" title="recorder"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/R/141_201_87/120.png" width="40" height="40" alt="recorder" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/recorder">recorder</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/puygob236" title="Jiachen Li"><img src="https://www.gitlink.org.cn/images/avatars/User/149183?t=1778815174" width="40" height="40" alt="puygob236" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/puygob236">puygob236</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/co63oc" title="co63oc"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/C/205_201_141/120.png" width="40" height="40" alt="co63oc" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/co63oc">co63oc</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/lindiwen23" title="lindiwen23"><img src="https://www.gitlink.org.cn/images/avatars/User/141609?t=1748270628" width="40" height="40" alt="lindiwen23" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/lindiwen23">lindiwen23</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/ohanabi" title="ohanabi"><img src="https://www.gitlink.org.cn/images/avatars/User/148166?t=1778230283" width="40" height="40" alt="ohanabi" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/ohanabi">ohanabi</a></sub>
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://www.gitlink.org.cn/jiangtx" title="jiangtx"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/J/67_157_94/120.png" width="40" height="40" alt="jiangtx" style="border-radius: 50%;"></a>
|
||||
<br><sub><a href="https://www.gitlink.org.cn/jiangtx">jiangtx</a></sub>
|
||||
</div>
|
||||
<div style="display: flex; gap: 20px; flex-wrap: wrap; align-items: center;">
|
||||
<a href="https://www.gitlink.org.cn/wangyue111" title="wangyue111"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/W/43_254_70/120.png" width="40" height="40" alt="wangyue111" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/wbtiger" title="tigerwang"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/T/14_168_39/120.png" width="40" height="40" alt="wbtiger" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/Mengz" title="Mengz"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/M/166_152_185/120.png" width="40" height="40" alt="Mengz" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/yangsai" title="杨赛"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/Y/94_150_149/120.png" width="40" height="40" alt="yangsai" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/mengcheng" title="camelliamc"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/M/206_114_54/120.png" width="40" height="40" alt="mengcheng" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/muel" title="赵奕程"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/Z/144_206_212/120.png" width="40" height="40" alt="muel" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/Leo77" title="Leo77"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/L/173_120_149/120.png" width="40" height="40" alt="Leo77" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/yingjie" title="yingjie"><img src="https://www.gitlink.org.cn/images/avatars/User/145288?t=1765791899" width="40" height="40" alt="yingjie" style="border-radius: 50%;"></a>
|
||||
<a href="https://www.gitlink.org.cn/topshare" title="Kevin Zhang"><img src="https://www.gitlink.org.cn/system/lets/letter_avatars/2/K/65_152_142/120.png" width="40" height="40" alt="topshare" style="border-radius: 50%;"></a>
|
||||
</div>
|
||||
|
||||
## 为什么选择 gitlink-cli?
|
||||
|
||||
- **Agent-Native 设计** — 开箱即用结构化 [Skills](./skills/),兼容 Claude Code — Agent 零配置即可操作 GitLink
|
||||
- **广泛覆盖** — 仓库、Wiki、Issue、PR、Webhook、成员、分支、Release、CI、Pipeline、组织、搜索、用户等常用工作流均提供高层命令
|
||||
- **Agent-Native 设计** — 开箱即用 13 个结构化 [Skills](./skills/),兼容 Claude Code — Agent 零配置即可操作 GitLink
|
||||
- **广泛覆盖** — 仓库、Issue、PR、Webhook、分支、Release、CI、组织、搜索、用户 — 核心功能全覆盖
|
||||
- **AI 友好 & 优化** — 每条命令都经过真实 Agent 测试,简洁参数、智能默认值、结构化输出
|
||||
- **跨平台** — macOS、Linux、Windows (x64/arm64) 全支持,`npm` 一条命令安装
|
||||
- **开源零门槛** — 木兰宽松许可证第2版(MulanPSL-2.0),`npm install` 即用
|
||||
|
|
@ -95,17 +40,13 @@
|
|||
|
||||
| 分类 | 能力 |
|
||||
|------|------|
|
||||
| 📦 仓库 | 列出、创建、Fork、删除仓库,查看仓库信息、洞察数据和互动状态 |
|
||||
| 📚 Wiki | 列出、查看、创建、更新、删除 Wiki 页面 |
|
||||
| 📦 仓库 | 列出、创建、Fork、删除仓库,查看仓库信息 |
|
||||
| 🐛 Issue | 创建、更新、关闭、批量关闭、评论 Issue |
|
||||
| 🔖 标签 | 创建、列出、更新、删除 Issue 标签 |
|
||||
| 🔀 PR | 创建、合并、Review Pull Request,查看变更文件 |
|
||||
| 👥 成员 | 列出、添加、移除仓库成员,调整角色,生成和接受邀请链接 |
|
||||
| 🌿 分支 | 创建、删除、保护分支 |
|
||||
| 🏷️ 发布 | 创建、编辑、更新、查看、删除 Release |
|
||||
| 🏷️ 发布 | 创建、查看、删除 Release |
|
||||
| 🏢 组织 | 管理组织、成员、团队 |
|
||||
| 🔧 CI | 查看构建、日志、CI/CD 操作 |
|
||||
| ⚙️ Pipeline | 运行、查看、启停、删除流水线工作流并查询日志 |
|
||||
| 🔍 搜索 | 搜索仓库、用户 |
|
||||
| 👤 用户 | 查看用户资料和信息 |
|
||||
| 📋 项目管理 | Sprint 管理、看板、周报 |
|
||||
|
|
@ -221,36 +162,6 @@ gitlink-cli repo +list
|
|||
# 查看仓库信息
|
||||
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
|
||||
|
||||
# 列出贡献者
|
||||
gitlink-cli repo +contributors --owner Gitlink --repo forgeplus
|
||||
|
||||
# 查看分支、标签或提交的贡献者代码行统计
|
||||
gitlink-cli repo +contributor-stats --owner Gitlink --repo forgeplus --ref master --pass-year 1
|
||||
|
||||
# 查看仓库代码统计
|
||||
gitlink-cli repo +code-stats --owner Gitlink --repo forgeplus --ref master
|
||||
|
||||
# 按时间范围查看关注者和点赞者
|
||||
gitlink-cli repo +watchers --owner Gitlink --repo forgeplus --start-at 1714521600 --end-at 1717200000
|
||||
gitlink-cli repo +stargazers --owner Gitlink --repo forgeplus --start-at 1714521600 --end-at 1717200000
|
||||
|
||||
# 预览并执行仓库互动操作
|
||||
gitlink-cli repo +follow --owner Gitlink --repo forgeplus --dry-run
|
||||
gitlink-cli repo +follow --owner Gitlink --repo forgeplus
|
||||
gitlink-cli repo +unfollow --owner Gitlink --repo forgeplus --project-id 123
|
||||
gitlink-cli repo +like --owner Gitlink --repo forgeplus
|
||||
gitlink-cli repo +unlike --owner Gitlink --repo forgeplus --project-id 123
|
||||
|
||||
# 创建仓库
|
||||
gitlink-cli repo +create -n my-project -d "项目描述"
|
||||
|
||||
|
|
@ -258,27 +169,6 @@ gitlink-cli repo +create -n my-project -d "项目描述"
|
|||
gitlink-cli repo +fork --owner Gitlink --repo forgeplus
|
||||
```
|
||||
|
||||
### Wiki 管理
|
||||
|
||||
```bash
|
||||
# 列出 Wiki 页面
|
||||
gitlink-cli wiki +list --owner Gitlink --repo forgeplus
|
||||
|
||||
# 查看 Wiki 页面
|
||||
gitlink-cli wiki +view --owner Gitlink --repo forgeplus --page Home
|
||||
|
||||
# 使用命令行内容创建 Wiki 页面
|
||||
gitlink-cli wiki +create --owner Gitlink --repo forgeplus \
|
||||
--page Home --title Home --content "欢迎来到项目 Wiki"
|
||||
|
||||
# 使用 Markdown 文件更新 Wiki 页面
|
||||
gitlink-cli wiki +update --owner Gitlink --repo forgeplus \
|
||||
--page Home --file docs/wiki-home.md --message "更新 Home"
|
||||
|
||||
# 删除 Wiki 页面
|
||||
gitlink-cli wiki +delete --owner Gitlink --repo forgeplus --page Home
|
||||
```
|
||||
|
||||
### Webhook 管理
|
||||
|
||||
```bash
|
||||
|
|
@ -296,28 +186,6 @@ gitlink-cli webhook +test --owner Gitlink --repo forgeplus --id 68
|
|||
gitlink-cli webhook +tasks --owner Gitlink --repo forgeplus --id 68
|
||||
```
|
||||
|
||||
### 成员管理
|
||||
|
||||
```bash
|
||||
# 列出仓库成员
|
||||
gitlink-cli member +list --owner Gitlink --repo forgeplus
|
||||
|
||||
# 添加成员
|
||||
gitlink-cli member +add --owner Gitlink --repo forgeplus --user-id 101
|
||||
|
||||
# 预览批量添加成员,不修改数据
|
||||
gitlink-cli member +batch-add --owner Gitlink --repo forgeplus --user-ids 101,102 --dry-run
|
||||
|
||||
# 从 CSV 文件批量添加成员
|
||||
gitlink-cli member +batch-add --owner Gitlink --repo forgeplus --from members.csv
|
||||
|
||||
# 调整成员权限
|
||||
gitlink-cli member +role --owner Gitlink --repo forgeplus --user-id 101 --role Developer
|
||||
|
||||
# 生成邀请链接
|
||||
gitlink-cli member +invite-link --owner Gitlink --repo forgeplus --role developer --apply true
|
||||
```
|
||||
|
||||
### Issue 管理
|
||||
|
||||
```bash
|
||||
|
|
@ -327,15 +195,9 @@ gitlink-cli issue +list --owner Gitlink --repo forgeplus
|
|||
# 创建 Issue
|
||||
gitlink-cli issue +create --owner Gitlink --repo forgeplus -t "Bug: 登录失败" -b "复现步骤..."
|
||||
|
||||
# 创建带元数据的 Issue
|
||||
gitlink-cli issue +create --owner Gitlink --repo forgeplus -t "Bug: 登录失败" --priority-id 3 --tag-ids 4,5 --assigner-ids 7
|
||||
|
||||
# 查看 Issue
|
||||
gitlink-cli issue +view --owner Gitlink --repo forgeplus -i 123
|
||||
|
||||
# 更新 Issue 元数据
|
||||
gitlink-cli issue +update --owner Gitlink --repo forgeplus --number 123 --priority-id 4 --branch bugfix/login --due-date 2026-06-15
|
||||
|
||||
# 关闭 Issue
|
||||
gitlink-cli issue +close --owner Gitlink --repo forgeplus -i 123
|
||||
|
||||
|
|
@ -347,44 +209,6 @@ gitlink-cli issue +batch-close --owner Gitlink --repo forgeplus --from issues.cs
|
|||
|
||||
# 添加评论
|
||||
gitlink-cli issue +comment --owner Gitlink --repo forgeplus -i 123 -b "已修复"
|
||||
|
||||
# 列出 Issue 负责人
|
||||
gitlink-cli issue +assigners --owner Gitlink --repo forgeplus
|
||||
|
||||
# 列出 Issue 发布人
|
||||
gitlink-cli issue +authors --owner Gitlink --repo forgeplus
|
||||
|
||||
# 列出 Issue 优先级
|
||||
gitlink-cli issue +priorities --owner Gitlink --repo forgeplus
|
||||
|
||||
# 列出 Issue 标签
|
||||
gitlink-cli issue +tags --owner Gitlink --repo forgeplus --only-name
|
||||
|
||||
# 列出 Issue 状态
|
||||
gitlink-cli issue +statuses --owner Gitlink --repo forgeplus
|
||||
```
|
||||
|
||||
`issue +view`、`issue +update`、`issue +close` 和 `issue +comment` 推荐使用
|
||||
`--number` / `-n` 传网页 URL 中的 Issue 编号。`--id` / `-i` 是同一网页 Issue
|
||||
编号的兼容别名,不是数据库内部 ID。
|
||||
|
||||
### 标签管理
|
||||
|
||||
```bash
|
||||
# 列出 Issue 标签
|
||||
gitlink-cli label +list --owner Gitlink --repo forgeplus
|
||||
|
||||
# 按关键词筛选标签
|
||||
gitlink-cli label +list --owner Gitlink --repo forgeplus -k bug
|
||||
|
||||
# 创建标签(颜色默认 #1E90FF)
|
||||
gitlink-cli label +create --owner Gitlink --repo forgeplus -n bug -d "功能缺陷" -c "#FF0000"
|
||||
|
||||
# 更新标签(未指定的字段会被保留)
|
||||
gitlink-cli label +update --owner Gitlink --repo forgeplus -i 42 -c "#00FF00"
|
||||
|
||||
# 删除标签
|
||||
gitlink-cli label +delete --owner Gitlink --repo forgeplus -i 42
|
||||
```
|
||||
|
||||
### Pull Request
|
||||
|
|
@ -405,9 +229,6 @@ gitlink-cli pr +view --owner Gitlink --repo forgeplus -i 42
|
|||
# 合并 PR
|
||||
gitlink-cli pr +merge --owner Gitlink --repo forgeplus -i 42
|
||||
|
||||
# 重开已关闭的 PR
|
||||
gitlink-cli pr +reopen --owner Gitlink --repo forgeplus -i 42
|
||||
|
||||
# 查看 PR 变更文件
|
||||
gitlink-cli pr +files --owner Gitlink --repo forgeplus -i 42
|
||||
|
||||
|
|
@ -431,40 +252,11 @@ gitlink-cli pr +review --owner Gitlink --repo forgeplus -i 42 --status approved
|
|||
# 列出 Release
|
||||
gitlink-cli release +list --owner Gitlink --repo forgeplus
|
||||
|
||||
# 创建 Release,可附带附件 ID
|
||||
gitlink-cli release +create --owner Gitlink --repo forgeplus -t v1.0.0 -n "v1.0.0 正式版" -b "更新内容..." --attachment-ids 12,34
|
||||
# 创建 Release
|
||||
gitlink-cli release +create --owner Gitlink --repo forgeplus -t v1.0.0 -n "v1.0.0 正式版" -b "更新内容..."
|
||||
|
||||
# 查看 Release
|
||||
gitlink-cli release +view --owner Gitlink --repo forgeplus -i <version_id>
|
||||
|
||||
# 获取编辑数据并保留未传字段更新
|
||||
gitlink-cli release +edit --owner Gitlink --repo forgeplus -i <version_id>
|
||||
gitlink-cli release +update --owner Gitlink --repo forgeplus -i <version_id> -b "更新后的内容" --dry-run
|
||||
|
||||
# 删除前先预览请求
|
||||
gitlink-cli release +delete --owner Gitlink --repo forgeplus -i <version_id> --dry-run
|
||||
```
|
||||
|
||||
### 流水线管理
|
||||
|
||||
```bash
|
||||
# 列出平台流水线
|
||||
gitlink-cli pipeline +list --owner-id 123 --page 1 --limit 20
|
||||
|
||||
# 列出仓库流水线运行记录
|
||||
gitlink-cli pipeline +runs --owner Gitlink --repo forgeplus --ref master --workflow build.yml
|
||||
|
||||
# 运行流水线工作流,先用 dry-run 预览请求
|
||||
gitlink-cli pipeline +run --owner Gitlink --repo forgeplus --ref master --workflow build.yml --dry-run
|
||||
|
||||
# 查看流水线详情、日志和运行结果
|
||||
gitlink-cli pipeline +view --owner Gitlink --repo forgeplus --id 7
|
||||
gitlink-cli pipeline +logs --owner Gitlink --repo forgeplus --run-id 99 --id 7 --index 43
|
||||
gitlink-cli pipeline +results --owner Gitlink --repo forgeplus --run-id 99
|
||||
|
||||
# 启停或删除流水线工作流,写入/删除前先预览
|
||||
gitlink-cli pipeline +disable --owner Gitlink --repo forgeplus --id 7 --workflow build.yml --dry-run
|
||||
gitlink-cli pipeline +delete --owner Gitlink --repo forgeplus --id 7 --dry-run
|
||||
```
|
||||
|
||||
### 搜索
|
||||
|
|
@ -488,12 +280,6 @@ gitlink-cli api GET /users/me
|
|||
# POST 请求
|
||||
gitlink-cli api POST /Gitlink/forgeplus/issues --body '{"subject":"test","description":"..."}'
|
||||
|
||||
# 从文件读取 JSON body
|
||||
gitlink-cli api POST /Gitlink/forgeplus/issues --body-file issue.json
|
||||
|
||||
# 从 stdin 读取 JSON body
|
||||
Get-Content issue.json | gitlink-cli api POST /Gitlink/forgeplus/issues --body-stdin
|
||||
|
||||
# 带查询参数
|
||||
gitlink-cli api GET /Gitlink/forgeplus/commits --query 'page=1&limit=5'
|
||||
```
|
||||
|
|
@ -531,22 +317,19 @@ git push gitlink
|
|||
|
||||
## AI Agent Skills
|
||||
|
||||
`skills/` 目录包含 Claude Code Agent Skill 文件,支持 AI 自动化操作 GitLink 平台。
|
||||
`skills/` 目录包含 13 个 Claude Code Agent Skill 文件,支持 AI 自动化操作 GitLink 平台。
|
||||
|
||||
详见 [skills/README.md](skills/README.md)
|
||||
|
||||
| Skill | 说明 |
|
||||
|-------|------|
|
||||
| `gitlink-shared` | 认证、全局参数、安全规则、API 注意事项 |
|
||||
| `gitlink-repo` | 仓库操作(创建、查看、删除、Fork、洞察数据等) |
|
||||
| `gitlink-wiki` | Wiki 操作(列出、查看、创建、更新、删除) |
|
||||
| `gitlink-repo` | 仓库操作(创建、查看、删除、Fork 等) |
|
||||
| `gitlink-issue` | Issue 操作(创建、更新、关闭、评论等) |
|
||||
| `gitlink-pr` | Pull Request 操作(创建、合并、Review 等) |
|
||||
| `gitlink-member` | 仓库成员与邀请链接管理 |
|
||||
| `gitlink-release` | 发布管理(创建、编辑、更新、查看、删除等) |
|
||||
| `gitlink-release` | 发布管理(创建、查看、删除等) |
|
||||
| `gitlink-org` | 组织管理(成员、团队等) |
|
||||
| `gitlink-ci` | CI/CD 操作(构建、日志等) |
|
||||
| `gitlink-pipeline` | 流水线工作流操作(运行、日志、启停、删除等) |
|
||||
| `gitlink-search` | 搜索功能(仓库、用户等) |
|
||||
| `gitlink-user` | 用户管理(个人信息等) |
|
||||
| `gitlink-pm` | 项目管理(Sprint、看板、周报等) |
|
||||
|
|
@ -573,12 +356,10 @@ gitlink-cli/
|
|||
│ ├── repo/ # 仓库 shortcuts
|
||||
│ ├── issue/ # Issue shortcuts
|
||||
│ ├── pr/ # PR shortcuts
|
||||
│ ├── member/ # 仓库成员 shortcuts
|
||||
│ ├── branch/ # 分支 shortcuts
|
||||
│ ├── release/ # Release shortcuts
|
||||
│ ├── org/ # 组织 shortcuts
|
||||
│ ├── ci/ # CI shortcuts
|
||||
│ ├── pipeline/ # Pipeline shortcuts
|
||||
│ ├── search/ # 搜索 shortcuts
|
||||
│ ├── user/ # 用户 shortcuts
|
||||
│ └── register.go # 注册入口
|
||||
|
|
|
|||
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"version": "0.1.13",
|
||||
"description": "CLI tool for GitLink platform",
|
||||
"homepage": "https://www.gitlink.org.cn/Gitlink/gitlink-cli",
|
||||
"license": "MulanPSL-2.0",
|
||||
"architecture": {
|
||||
"64bit": {
|
||||
"url": "https://github.com/gitlink-org/gitlink-cli/releases/download/v0.1.13/gitlink-cli_0.1.13_windows_amd64.zip",
|
||||
"hash": "PLACEHOLDER_SHA256"
|
||||
},
|
||||
"arm64": {
|
||||
"url": "https://github.com/gitlink-org/gitlink-cli/releases/download/v0.1.13/gitlink-cli_0.1.13_windows_arm64.zip",
|
||||
"hash": "PLACEHOLDER_SHA256"
|
||||
}
|
||||
},
|
||||
"bin": "gitlink-cli.exe",
|
||||
"checkver": {
|
||||
"github": "https://github.com/gitlink-org/gitlink-cli"
|
||||
},
|
||||
"autoupdate": {
|
||||
"architecture": {
|
||||
"64bit": {
|
||||
"url": "https://github.com/gitlink-org/gitlink-cli/releases/download/v$version/gitlink-cli_$version_windows_amd64.zip"
|
||||
},
|
||||
"arm64": {
|
||||
"url": "https://github.com/gitlink-org/gitlink-cli/releases/download/v$version/gitlink-cli_$version_windows_arm64.zip"
|
||||
}
|
||||
},
|
||||
"hash": {
|
||||
"url": "https://github.com/gitlink-org/gitlink-cli/releases/download/v$version/checksums-sha256.txt"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>gitlink-cli</id>
|
||||
<version>0.1.13</version>
|
||||
<title>GitLink CLI</title>
|
||||
<authors>GitLink</authors>
|
||||
<projectUrl>https://www.gitlink.org.cn/Gitlink/gitlink-cli</projectUrl>
|
||||
<licenseUrl>https://opensource.org/licenses/MulanPSL-2.0</licenseUrl>
|
||||
<description>CLI tool for GitLink platform</description>
|
||||
<tags>gitlink cli devops</tags>
|
||||
</metadata>
|
||||
<files>
|
||||
<file src="tools/**" target="tools" />
|
||||
</files>
|
||||
</package>
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
$ErrorActionPreference = 'Stop'
|
||||
$packageName = 'gitlink-cli'
|
||||
$version = '0.1.13'
|
||||
$url = "https://github.com/gitlink-org/gitlink-cli/releases/download/v$version/gitlink-cli_$version_windows_amd64.zip"
|
||||
$checksum = 'PLACEHOLDER_SHA256'
|
||||
$installDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
|
||||
$packageArgs = @{
|
||||
packageName = $packageName
|
||||
url = $url
|
||||
checksum = $checksum
|
||||
checksumType = 'sha256'
|
||||
unzipLocation = $installDir
|
||||
}
|
||||
Install-ChocolateyZipPackage @packageArgs
|
||||
|
|
@ -1,119 +0,0 @@
|
|||
package alias
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
"gopkg.in/yaml.v3"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/internal/config"
|
||||
)
|
||||
|
||||
// AliasConfig represents the aliases section of the CLI config.
|
||||
type AliasConfig struct {
|
||||
Aliases map[string]string `yaml:"aliases,omitempty"`
|
||||
}
|
||||
|
||||
// NewAliasCmd creates the alias command with subcommands.
|
||||
func NewAliasCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "alias",
|
||||
Short: "管理命令别名(把长命令变短)",
|
||||
Long: `管理 gitlink-cli 的命令别名。
|
||||
|
||||
别名允许你为常用命令创建简短的名称,例如:
|
||||
gitlink-cli alias +set rl "repo +list"
|
||||
之后可以使用: gitlink-cli rl
|
||||
|
||||
别名存储在 ~/.config/gitlink-cli/aliases.yaml 中。`,
|
||||
Example: ` gitlink-cli alias +list
|
||||
gitlink-cli alias +set rl "repo +list"
|
||||
gitlink-cli alias +set ri "repo +info --owner Gitlink --repo gitlink-cli"
|
||||
gitlink-cli alias +delete rl`,
|
||||
}
|
||||
|
||||
cmd.AddCommand(
|
||||
&cobra.Command{
|
||||
Use: "+list",
|
||||
Short: "列出所有已定义的别名",
|
||||
Long: "列出所有已定义的命令别名。如果没有任何别名,会给出创建提示。",
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
aliases, _ := loadAliases()
|
||||
if len(aliases) == 0 {
|
||||
fmt.Println("(未定义任何别名)")
|
||||
fmt.Println("使用 alias +set <名称> <命令> 来创建别名")
|
||||
return nil
|
||||
}
|
||||
for k, v := range aliases {
|
||||
fmt.Printf(" %-15s → %s\n", k, v)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
&cobra.Command{
|
||||
Use: "+set <name> <command>",
|
||||
Short: "设置别名",
|
||||
Long: "为一条命令设置别名。如果别名已存在,会被覆盖。",
|
||||
Args: cobra.ExactArgs(2),
|
||||
Example: ` gitlink-cli alias +set rl "repo +list"
|
||||
gitlink-cli alias +set ri "repo +info"`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
aliases, _ := loadAliases()
|
||||
aliases[args[0]] = args[1]
|
||||
if err := saveAliases(aliases); err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Printf("别名已设置: %s → %s\n", args[0], args[1])
|
||||
return nil
|
||||
},
|
||||
},
|
||||
&cobra.Command{
|
||||
Use: "+delete <name>",
|
||||
Short: "删除别名",
|
||||
Long: "删除一个已定义的命令别名。",
|
||||
Args: cobra.ExactArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
aliases, _ := loadAliases()
|
||||
if _, ok := aliases[args[0]]; !ok {
|
||||
return fmt.Errorf("别名 %s 不存在", args[0])
|
||||
}
|
||||
delete(aliases, args[0])
|
||||
if err := saveAliases(aliases); err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Printf("别名已删除: %s\n", args[0])
|
||||
return nil
|
||||
},
|
||||
},
|
||||
)
|
||||
return cmd
|
||||
}
|
||||
|
||||
func aliasesPath() string {
|
||||
return config.ConfigDir() + "/aliases.yaml"
|
||||
}
|
||||
|
||||
func loadAliases() (map[string]string, error) {
|
||||
data, err := os.ReadFile(aliasesPath())
|
||||
if err != nil {
|
||||
return make(map[string]string), nil
|
||||
}
|
||||
var ac AliasConfig
|
||||
if err := yaml.Unmarshal(data, &ac); err != nil {
|
||||
return make(map[string]string), nil
|
||||
}
|
||||
if ac.Aliases == nil {
|
||||
ac.Aliases = make(map[string]string)
|
||||
}
|
||||
return ac.Aliases, nil
|
||||
}
|
||||
|
||||
func saveAliases(a map[string]string) error {
|
||||
data, err := yaml.Marshal(AliasConfig{Aliases: a})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
os.MkdirAll(config.ConfigDir(), 0700)
|
||||
return os.WriteFile(aliasesPath(), data, 0600)
|
||||
}
|
||||
|
|
@ -1,193 +0,0 @@
|
|||
package alias
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
func TestLoadAliasesEmpty(t *testing.T) {
|
||||
// 设置临时配置目录
|
||||
tmpDir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", tmpDir)
|
||||
|
||||
aliases, err := loadAliases()
|
||||
if err != nil {
|
||||
t.Fatalf("loadAliases failed: %v", err)
|
||||
}
|
||||
if len(aliases) != 0 {
|
||||
t.Fatalf("expected empty aliases, got %d", len(aliases))
|
||||
}
|
||||
}
|
||||
|
||||
func TestSaveAndLoadAliases(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", tmpDir)
|
||||
|
||||
// 保存
|
||||
original := map[string]string{
|
||||
"rl": "repo +list",
|
||||
"ri": "repo +info",
|
||||
}
|
||||
if err := saveAliases(original); err != nil {
|
||||
t.Fatalf("saveAliases failed: %v", err)
|
||||
}
|
||||
|
||||
// 加载
|
||||
loaded, err := loadAliases()
|
||||
if err != nil {
|
||||
t.Fatalf("loadAliases failed: %v", err)
|
||||
}
|
||||
if len(loaded) != 2 {
|
||||
t.Fatalf("expected 2 aliases, got %d", len(loaded))
|
||||
}
|
||||
if loaded["rl"] != "repo +list" {
|
||||
t.Errorf("expected rl -> repo +list, got %s", loaded["rl"])
|
||||
}
|
||||
if loaded["ri"] != "repo +info" {
|
||||
t.Errorf("expected ri -> repo +info, got %s", loaded["ri"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestSaveAliasesOverwrite(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", tmpDir)
|
||||
|
||||
// 第一次保存
|
||||
saveAliases(map[string]string{"rl": "repo +list"})
|
||||
|
||||
// 覆盖保存
|
||||
saveAliases(map[string]string{"rl": "repo +list --owner Gitlink"})
|
||||
|
||||
loaded, _ := loadAliases()
|
||||
if loaded["rl"] != "repo +list --owner Gitlink" {
|
||||
t.Errorf("alias should be overwritten, got %s", loaded["rl"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadAliasesInvalidYAML(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", tmpDir)
|
||||
|
||||
// 写入无效 YAML
|
||||
os.WriteFile(tmpDir+"/aliases.yaml", []byte("{{invalid yaml}}"), 0600)
|
||||
|
||||
aliases, err := loadAliases()
|
||||
if err != nil {
|
||||
t.Fatalf("should not error on invalid YAML, got: %v", err)
|
||||
}
|
||||
if len(aliases) != 0 {
|
||||
t.Fatalf("should return empty map on invalid YAML, got %d", len(aliases))
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewAliasCmd(t *testing.T) {
|
||||
cmd := NewAliasCmd()
|
||||
if cmd.Use != "alias" {
|
||||
t.Errorf("expected Use 'alias', got %s", cmd.Use)
|
||||
}
|
||||
if !cmd.HasSubCommands() {
|
||||
t.Error("alias command should have subcommands")
|
||||
}
|
||||
subcmds := cmd.Commands()
|
||||
if len(subcmds) != 3 {
|
||||
t.Fatalf("expected 3 subcommands, got %d", len(subcmds))
|
||||
}
|
||||
}
|
||||
|
||||
func TestAliasListSubcommand(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", tmpDir)
|
||||
|
||||
cmd := NewAliasCmd()
|
||||
// 找到 +list 子命令
|
||||
var listCmd *cobra.Command
|
||||
for _, sub := range cmd.Commands() {
|
||||
if sub.Use == "+list" {
|
||||
listCmd = sub
|
||||
break
|
||||
}
|
||||
}
|
||||
if listCmd == nil {
|
||||
t.Fatal("+list subcommand not found")
|
||||
}
|
||||
|
||||
// 无别名时运行
|
||||
buf := new(bytes.Buffer)
|
||||
listCmd.SetOut(buf)
|
||||
listCmd.SetArgs([]string{})
|
||||
if err := listCmd.Execute(); err != nil {
|
||||
t.Fatalf("list failed: %v", err)
|
||||
}
|
||||
if !strings.Contains(buf.String(), "未定义任何别名") {
|
||||
t.Errorf("expected hint for no aliases, got: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestAliasSetAndDeleteSubcommands(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", tmpDir)
|
||||
|
||||
cmd := NewAliasCmd()
|
||||
|
||||
// 找到 +set 子命令
|
||||
var setCmd, deleteCmd *cobra.Command
|
||||
for _, sub := range cmd.Commands() {
|
||||
if strings.HasPrefix(sub.Use, "+set") {
|
||||
setCmd = sub
|
||||
}
|
||||
if strings.HasPrefix(sub.Use, "+delete") {
|
||||
deleteCmd = sub
|
||||
}
|
||||
}
|
||||
|
||||
// +set
|
||||
setCmd.SetArgs([]string{"rl", "repo +list"})
|
||||
if err := setCmd.Execute(); err != nil {
|
||||
t.Fatalf("set failed: %v", err)
|
||||
}
|
||||
|
||||
// 验证文件写入
|
||||
aliases, _ := loadAliases()
|
||||
if aliases["rl"] != "repo +list" {
|
||||
t.Fatalf("alias not saved correctly: %v", aliases)
|
||||
}
|
||||
|
||||
// +delete
|
||||
deleteCmd.SetArgs([]string{"rl"})
|
||||
if err := deleteCmd.Execute(); err != nil {
|
||||
t.Fatalf("delete failed: %v", err)
|
||||
}
|
||||
|
||||
// 验证已删除
|
||||
aliases, _ = loadAliases()
|
||||
if _, ok := aliases["rl"]; ok {
|
||||
t.Fatal("alias should have been deleted")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAliasDeleteNonExistent(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", tmpDir)
|
||||
|
||||
cmd := NewAliasCmd()
|
||||
var deleteCmd *cobra.Command
|
||||
for _, sub := range cmd.Commands() {
|
||||
if strings.HasPrefix(sub.Use, "+delete") {
|
||||
deleteCmd = sub
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
deleteCmd.SetArgs([]string{"nonexistent"})
|
||||
err := deleteCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error when deleting nonexistent alias")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "不存在") {
|
||||
t.Errorf("error should mention alias does not exist: %v", err)
|
||||
}
|
||||
}
|
||||
185
cmd/api/api.go
185
cmd/api/api.go
|
|
@ -2,114 +2,42 @@ package api
|
|||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/url"
|
||||
"os"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/cmd/cmdutil"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/client"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/context"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/i18n"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/output"
|
||||
)
|
||||
|
||||
// apiOwnerPlaceholder and apiRepoPlaceholder match the REST-style :owner / :repo
|
||||
// path placeholders used throughout the GitLink API docs and shortcut commands.
|
||||
var (
|
||||
apiOwnerPlaceholder = regexp.MustCompile(`:owner\b`)
|
||||
apiRepoPlaceholder = regexp.MustCompile(`:repo\b`)
|
||||
)
|
||||
|
||||
func NewAPICmd(translators ...*i18n.Translator) *cobra.Command {
|
||||
tr := i18n.Default()
|
||||
if len(translators) > 0 && translators[0] != nil {
|
||||
tr = translators[0]
|
||||
}
|
||||
func NewAPICmd() *cobra.Command {
|
||||
apiCmd := &cobra.Command{
|
||||
Use: "api (<METHOD> <PATH> | --batch-file <FILE>)",
|
||||
Short: tr.T("cmd.api.short"),
|
||||
Long: tr.T("cmd.api.long"),
|
||||
Use: "api <METHOD> <PATH>",
|
||||
Short: "Make raw API requests to GitLink",
|
||||
Long: `Send arbitrary HTTP requests to the GitLink API. Authentication is injected automatically.`,
|
||||
Example: ` gitlink-cli api GET /users/me
|
||||
gitlink-cli api GET /projects --query 'page=1&limit=10'
|
||||
gitlink-cli api POST /:owner/:repo/issues --body '{"subject":"Bug","description":"..."}'
|
||||
gitlink-cli api POST /:owner/:repo/issues --body-file issue.json
|
||||
gitlink-cli api --batch-file plan.json --dry-run
|
||||
gitlink-cli api --batch-file plan.json --var owner=Gitlink --var repo=gitlink-cli`,
|
||||
Args: validateAPIArgs,
|
||||
gitlink-cli api POST /:owner/:repo/issues --body '{"subject":"Bug","description":"..."}'`,
|
||||
Args: cobra.ExactArgs(2),
|
||||
RunE: runAPI,
|
||||
}
|
||||
|
||||
apiCmd.Flags().String("body", "", tr.T("flag.api.body"))
|
||||
apiCmd.Flags().String("body-file", "", tr.T("flag.api.body_file"))
|
||||
apiCmd.Flags().Bool("body-stdin", false, tr.T("flag.api.body_stdin"))
|
||||
apiCmd.Flags().String("query", "", tr.T("flag.api.query"))
|
||||
apiCmd.Flags().StringSlice("header", nil, tr.T("flag.api.header"))
|
||||
apiCmd.Flags().String("batch-file", "", tr.T("flag.api.batch_file"))
|
||||
apiCmd.Flags().Bool("dry-run", false, tr.T("flag.api.batch_dry_run"))
|
||||
apiCmd.Flags().Bool("continue-on-error", false, tr.T("flag.api.batch_continue_on_error"))
|
||||
apiCmd.Flags().StringArray("var", nil, tr.T("flag.api.batch_var"))
|
||||
apiCmd.Flags().String("body", "", "Request body (JSON string)")
|
||||
apiCmd.Flags().String("query", "", "Query parameters (key=val&key2=val2)")
|
||||
apiCmd.Flags().StringSlice("header", nil, "Additional headers (key:value)")
|
||||
|
||||
return apiCmd
|
||||
}
|
||||
|
||||
func validateAPIArgs(c *cobra.Command, args []string) error {
|
||||
batchFile, _ := c.Flags().GetString("batch-file")
|
||||
if batchFile != "" {
|
||||
if len(args) != 0 {
|
||||
return fmt.Errorf("api batch mode does not accept METHOD or PATH arguments")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
return cobra.ExactArgs(2)(c, args)
|
||||
}
|
||||
|
||||
// msysPathRe matches Windows drive-letter prefixes produced by MSYS2/Git Bash
|
||||
// path conversion, e.g. "C:/Program Files/Git/v1/owner/repo" for input "/v1/owner/repo".
|
||||
var msysPathRe = regexp.MustCompile(`^[A-Za-z]:/`)
|
||||
|
||||
// restoreAPIPath restores an API path polluted by MSYS2/Git Bash path
|
||||
// conversion on Windows, e.g. "C:/Program Files/Git/v1/owner/repo" -> "/v1/owner/repo".
|
||||
// If the path does not start with a drive letter, or no known API prefix is
|
||||
// found, the original path is returned unchanged.
|
||||
func restoreAPIPath(path string) string {
|
||||
if !msysPathRe.MatchString(path) {
|
||||
return path
|
||||
}
|
||||
// Pick the EARLIEST occurrence among known API prefixes, so a path like
|
||||
// ".../api/v1/users" restores to "/api/v1/users" rather than "/v1/users".
|
||||
bestIdx := -1
|
||||
for _, prefix := range []string{"/v1/", "/v2/", "/api/", "/users/", "/projects/"} {
|
||||
if idx := strings.Index(path, prefix); idx >= 0 && (bestIdx == -1 || idx < bestIdx) {
|
||||
bestIdx = idx
|
||||
}
|
||||
}
|
||||
if bestIdx >= 0 {
|
||||
return path[bestIdx:]
|
||||
}
|
||||
return path
|
||||
}
|
||||
|
||||
func runAPI(c *cobra.Command, args []string) error {
|
||||
batchFile, _ := c.Flags().GetString("batch-file")
|
||||
if batchFile != "" {
|
||||
return runAPIBatch(c, batchFile)
|
||||
}
|
||||
|
||||
method := strings.ToUpper(args[0])
|
||||
path := args[1]
|
||||
|
||||
// Fix MSYS2/Git Bash path auto-conversion on Windows first:
|
||||
// "/v1/owner/repo" is rewritten to "C:/Program Files/Git/v1/owner/repo".
|
||||
rawPath := restoreAPIPath(args[1])
|
||||
|
||||
path, err := resolveAPIPath(c, rawPath)
|
||||
if err != nil {
|
||||
return err
|
||||
if !strings.HasPrefix(path, "/") {
|
||||
path = "/" + path
|
||||
}
|
||||
|
||||
cli, err := client.New()
|
||||
|
|
@ -118,9 +46,12 @@ func runAPI(c *cobra.Command, args []string) error {
|
|||
}
|
||||
cli.Debug = cmdutil.Debug
|
||||
|
||||
body, err := readJSONBody(c)
|
||||
if err != nil {
|
||||
return err
|
||||
var body interface{}
|
||||
bodyStr, _ := c.Flags().GetString("body")
|
||||
if bodyStr != "" {
|
||||
if err := json.Unmarshal([]byte(bodyStr), &body); err != nil {
|
||||
return fmt.Errorf("invalid JSON body: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
var query url.Values
|
||||
|
|
@ -135,8 +66,7 @@ func runAPI(c *cobra.Command, args []string) error {
|
|||
|
||||
env, err := cli.Do(method, path, body, query)
|
||||
if err != nil {
|
||||
var apiErr *client.APIError
|
||||
if errors.As(err, &apiErr) {
|
||||
if apiErr, ok := err.(*client.APIError); ok {
|
||||
errEnv := output.ErrorEnvelope(apiErr.Code, apiErr.Message, "")
|
||||
return output.Print(errEnv, resolveFormat())
|
||||
}
|
||||
|
|
@ -146,83 +76,6 @@ func runAPI(c *cobra.Command, args []string) error {
|
|||
return output.Print(env, resolveFormat())
|
||||
}
|
||||
|
||||
// resolveAPIPath prepares a single-call path: it renders {{var}} templates
|
||||
// supplied via --var (consistent with batch mode), substitutes the REST-style
|
||||
// :owner / :repo placeholders (resolved from --owner/--repo or the git remote,
|
||||
// exactly like the shortcut commands), and ensures a leading slash.
|
||||
func resolveAPIPath(c *cobra.Command, rawPath string) (string, error) {
|
||||
path := rawPath
|
||||
|
||||
overrides, err := parseBatchVars(c)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
if len(overrides) > 0 {
|
||||
rendered, rerr := renderTemplate(path, overrides)
|
||||
if rerr != nil {
|
||||
return "", rerr
|
||||
}
|
||||
path = rendered
|
||||
}
|
||||
|
||||
if apiOwnerPlaceholder.MatchString(path) || apiRepoPlaceholder.MatchString(path) {
|
||||
owner, repo, rerr := context.ResolveOwnerRepo(cmdutil.Owner, cmdutil.Repo)
|
||||
if rerr != nil {
|
||||
return "", fmt.Errorf("path contains :owner/:repo placeholders but they could not be resolved: %w", rerr)
|
||||
}
|
||||
path = apiOwnerPlaceholder.ReplaceAllLiteralString(path, owner)
|
||||
path = apiRepoPlaceholder.ReplaceAllLiteralString(path, repo)
|
||||
}
|
||||
|
||||
if !strings.HasPrefix(path, "/") {
|
||||
path = "/" + path
|
||||
}
|
||||
return path, nil
|
||||
}
|
||||
|
||||
func readJSONBody(c *cobra.Command) (interface{}, error) {
|
||||
bodyStr, _ := c.Flags().GetString("body")
|
||||
bodyFile, _ := c.Flags().GetString("body-file")
|
||||
bodyStdin, _ := c.Flags().GetBool("body-stdin")
|
||||
|
||||
sources := 0
|
||||
if bodyStr != "" {
|
||||
sources++
|
||||
}
|
||||
if bodyFile != "" {
|
||||
sources++
|
||||
}
|
||||
if bodyStdin {
|
||||
sources++
|
||||
}
|
||||
if sources == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
if sources > 1 {
|
||||
return nil, fmt.Errorf("use only one of --body, --body-file, or --body-stdin")
|
||||
}
|
||||
|
||||
var data []byte
|
||||
var err error
|
||||
switch {
|
||||
case bodyStr != "":
|
||||
data = []byte(bodyStr)
|
||||
case bodyFile != "":
|
||||
data, err = os.ReadFile(bodyFile)
|
||||
case bodyStdin:
|
||||
data, err = io.ReadAll(c.InOrStdin())
|
||||
}
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read JSON body: %w", err)
|
||||
}
|
||||
|
||||
var body interface{}
|
||||
if err := json.Unmarshal(data, &body); err != nil {
|
||||
return nil, fmt.Errorf("invalid JSON body: %w", err)
|
||||
}
|
||||
return body, nil
|
||||
}
|
||||
|
||||
func resolveFormat() string {
|
||||
f := cmdutil.Format
|
||||
if f == "" {
|
||||
|
|
|
|||
|
|
@ -1,560 +0,0 @@
|
|||
package api
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/cmd/cmdutil"
|
||||
)
|
||||
|
||||
func TestResolveFormat(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
flagFormat string
|
||||
want string
|
||||
}{
|
||||
{"empty defaults to json", "", "json"},
|
||||
{"explicit json", "json", "json"},
|
||||
{"explicit yaml", "yaml", "yaml"},
|
||||
{"explicit table", "table", "table"},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
cmdutil.Format = tt.flagFormat
|
||||
if got := resolveFormat(); got != tt.want {
|
||||
t.Fatalf("resolveFormat = %q, want %q", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewAPICmd(t *testing.T) {
|
||||
cmd := NewAPICmd()
|
||||
if cmd.Use != "api (<METHOD> <PATH> | --batch-file <FILE>)" {
|
||||
t.Fatalf("Use = %q", cmd.Use)
|
||||
}
|
||||
if cmd.Short == "" {
|
||||
t.Fatal("Short is empty")
|
||||
}
|
||||
|
||||
// Verify flags exist
|
||||
flags := []string{"body", "query", "header", "batch-file", "dry-run", "continue-on-error", "var"}
|
||||
for _, f := range flags {
|
||||
if cmd.Flags().Lookup(f) == nil {
|
||||
t.Fatalf("flag %q not found", f)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func setupAPITest(t *testing.T, handler http.HandlerFunc) string {
|
||||
t.Helper()
|
||||
server := httptest.NewServer(handler)
|
||||
t.Cleanup(server.Close)
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
os.MkdirAll(dir, 0700)
|
||||
os.WriteFile(filepath.Join(dir, "config.yaml"), []byte("base_url: "+server.URL+"\ndefault_format: table\n"), 0600)
|
||||
return dir
|
||||
}
|
||||
|
||||
func TestRunAPIGet(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path != "/users/me.json" {
|
||||
t.Fatalf("unexpected path: %s", r.URL.Path)
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{"login": "testuser", "id": 42})
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"GET", "/users/me"})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("runAPI GET error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIPostWithBody(t *testing.T) {
|
||||
var gotBody map[string]interface{}
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != "POST" {
|
||||
t.Fatalf("expected POST, got %s", r.Method)
|
||||
}
|
||||
json.NewDecoder(r.Body).Decode(&gotBody)
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{"id": 1, "title": "new issue"})
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"POST", "/repos/owner/repo/issues"})
|
||||
cmd.Flags().Set("body", `{"title":"new issue","body":"test"}`)
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("runAPI POST error: %v", err)
|
||||
}
|
||||
if gotBody["title"] != "new issue" {
|
||||
t.Fatalf("body title = %q, want 'new issue'", gotBody["title"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIBadJSONBody(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
t.Fatal("should not reach server")
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"POST", "/repos/owner/repo/issues"})
|
||||
cmd.Flags().Set("body", `{bad json}`)
|
||||
err := cmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error for bad JSON body")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIBadQuery(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
t.Fatal("should not reach server")
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"GET", "/repos/owner/repo/issues"})
|
||||
cmd.Flags().Set("query", "key=%zz")
|
||||
err := cmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error for bad query string")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIPaginate(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
page := r.URL.Query().Get("page")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
switch page {
|
||||
case "1":
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||
"total_count": 3,
|
||||
"issues": []interface{}{
|
||||
map[string]interface{}{"id": 1},
|
||||
map[string]interface{}{"id": 2},
|
||||
},
|
||||
})
|
||||
default:
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||
"total_count": 3,
|
||||
"issues": []interface{}{
|
||||
map[string]interface{}{"id": 3},
|
||||
},
|
||||
})
|
||||
}
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"GET", "/owner/repo/issues", "--paginate", "--query", "limit=2"})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("runAPI paginate error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIPaginateRejectsNonGET(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
t.Fatal("server should not be reached")
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"POST", "/owner/repo/issues", "--paginate"})
|
||||
if err := cmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for --paginate with POST")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIPaginateRejectsBatchFile(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
t.Fatal("server should not be reached")
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"--batch-file", "plan.json", "--paginate"})
|
||||
if err := cmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for --paginate with --batch-file")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIHTTPError(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
w.Write([]byte("not found"))
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"GET", "/nonexistent"})
|
||||
// HTTP errors are caught and printed as error envelopes; runAPI does not return the error
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("runAPI HTTP error: %v (expected success with error envelope)", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIStatusError(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{"status": float64(401), "message": "Unauthorized"})
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"GET", "/users/me"})
|
||||
// Should print error envelope, not return a Go error (status check in Do() handles this)
|
||||
// Actually, HTTP 401 triggers APIError return from Do(), so this should error
|
||||
if err := cmd.Execute(); err != nil {
|
||||
// Expected — HTTP error
|
||||
t.Logf("got expected error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIDebug(t *testing.T) {
|
||||
var gotDebugHeader bool
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
gotDebugHeader = true
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{"ok": true})
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
cmdutil.Debug = true
|
||||
defer func() { cmdutil.Debug = false }()
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"GET", "/users/me"})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("runAPI debug error: %v", err)
|
||||
}
|
||||
if !gotDebugHeader {
|
||||
t.Fatal("server not reached")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPINoPrefix(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path != "/users/me.json" {
|
||||
t.Fatalf("unexpected path: %s", r.URL.Path)
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{"login": "testuser"})
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"GET", "users/me"})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("runAPI no-prefix error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIRendersOwnerRepoColonPlaceholders(t *testing.T) {
|
||||
oldOwner, oldRepo := cmdutil.Owner, cmdutil.Repo
|
||||
cmdutil.Owner, cmdutil.Repo = "Gitlink", "gitlink-cli"
|
||||
defer func() {
|
||||
cmdutil.Owner, cmdutil.Repo = oldOwner, oldRepo
|
||||
}()
|
||||
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path != "/Gitlink/gitlink-cli/issues.json" {
|
||||
t.Fatalf("unexpected path: %s", r.URL.Path)
|
||||
}
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{"ok": true})
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"GET", "/:owner/:repo/issues"})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("runAPI placeholder error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIRendersVarsInQueryAndBody(t *testing.T) {
|
||||
var gotBody map[string]interface{}
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path != "/v1/Gitlink/gitlink-cli/issues/42/journals.json" {
|
||||
t.Fatalf("unexpected path: %s", r.URL.Path)
|
||||
}
|
||||
if r.URL.Query().Get("notify") != "true" {
|
||||
t.Fatalf("notify query = %q", r.URL.Query().Get("notify"))
|
||||
}
|
||||
if err := json.NewDecoder(r.Body).Decode(&gotBody); err != nil {
|
||||
t.Fatalf("decode body: %v", err)
|
||||
}
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{"id": 99})
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
bodyPath := filepath.Join(t.TempDir(), "body.json")
|
||||
if err := os.WriteFile(bodyPath, []byte(`{"notes":"hello {{actor}}","meta":{"repo":"{{repo}}"}}`), 0600); err != nil {
|
||||
t.Fatalf("write body: %v", err)
|
||||
}
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{
|
||||
"POST", "/v1/{{owner}}/{{repo}}/issues/{{number}}/journals",
|
||||
"--query", "notify={{notify}}",
|
||||
"--body-file", bodyPath,
|
||||
"--var", "owner=Gitlink",
|
||||
"--var", "repo=gitlink-cli",
|
||||
"--var", "number=42",
|
||||
"--var", "notify=true",
|
||||
"--var", "actor=bot",
|
||||
})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("runAPI rendered vars error: %v", err)
|
||||
}
|
||||
if gotBody["notes"] != "hello bot" {
|
||||
t.Fatalf("notes = %#v", gotBody["notes"])
|
||||
}
|
||||
meta := gotBody["meta"].(map[string]interface{})
|
||||
if meta["repo"] != "gitlink-cli" {
|
||||
t.Fatalf("meta.repo = %#v", meta["repo"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIDryRunDoesNotReachServer(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
t.Fatal("dry-run should not reach server")
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{
|
||||
"POST", "/v1/{{owner}}/{{repo}}/issues",
|
||||
"--body", `{"subject":"{{title}}"}`,
|
||||
"--dry-run",
|
||||
"--var", "owner=Gitlink",
|
||||
"--var", "repo=gitlink-cli",
|
||||
"--var", "title=Bug report",
|
||||
})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("runAPI dry-run error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIMissingSingleRequestVar(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
t.Fatal("should not reach server")
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"GET", "/v1/{{owner}}/{{repo}}/issues/{{number}}"})
|
||||
if err := cmd.Execute(); err == nil {
|
||||
t.Fatal("expected missing variable error")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRenderBatchRequestsTemplateVars(t *testing.T) {
|
||||
requests, err := renderBatchRequests([]batchRequest{
|
||||
{
|
||||
Name: "comment-{{number}}",
|
||||
Method: "post",
|
||||
Path: "v1/{{owner}}/{{repo}}/issues/{{number}}/journals",
|
||||
Query: map[string]interface{}{
|
||||
"label": []interface{}{"{{label}}", "triage"},
|
||||
"page": float64(1),
|
||||
},
|
||||
Body: map[string]interface{}{
|
||||
"notes": "handled by {{actor}}",
|
||||
"meta": map[string]interface{}{"repo": "{{repo}}"},
|
||||
},
|
||||
},
|
||||
}, map[string]string{
|
||||
"owner": "Gitlink",
|
||||
"repo": "gitlink-cli",
|
||||
"number": "42",
|
||||
"label": "bug",
|
||||
"actor": "bot",
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("renderBatchRequests error: %v", err)
|
||||
}
|
||||
if len(requests) != 1 {
|
||||
t.Fatalf("len = %d, want 1", len(requests))
|
||||
}
|
||||
req := requests[0]
|
||||
if req.Name != "comment-42" {
|
||||
t.Fatalf("Name = %q", req.Name)
|
||||
}
|
||||
if req.Method != "POST" {
|
||||
t.Fatalf("Method = %q", req.Method)
|
||||
}
|
||||
if req.Path != "/v1/Gitlink/gitlink-cli/issues/42/journals" {
|
||||
t.Fatalf("Path = %q", req.Path)
|
||||
}
|
||||
if got := req.Query["label"]; len(got) != 2 || got[0] != "bug" || got[1] != "triage" {
|
||||
t.Fatalf("label query = %#v", got)
|
||||
}
|
||||
body := req.Body.(map[string]interface{})
|
||||
if body["notes"] != "handled by bot" {
|
||||
t.Fatalf("notes = %#v", body["notes"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestRenderBatchRequestsMissingVar(t *testing.T) {
|
||||
_, err := renderBatchRequests([]batchRequest{{Method: "GET", Path: "/{{missing}}"}}, nil)
|
||||
if err == nil {
|
||||
t.Fatal("expected missing variable error")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIBatchDryRunDoesNotReachServer(t *testing.T) {
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
t.Fatal("dry-run should not reach server")
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
plan := writeBatchPlan(t, map[string]interface{}{
|
||||
"vars": map[string]string{"owner": "Gitlink"},
|
||||
"requests": []map[string]interface{}{
|
||||
{"name": "me", "method": "GET", "path": "/users/me"},
|
||||
{"name": "repo", "method": "GET", "path": "/{{owner}}/gitlink-cli"},
|
||||
},
|
||||
})
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"--batch-file", plan, "--dry-run"})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("dry-run batch error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIBatchExecutesRequestsWithOverrides(t *testing.T) {
|
||||
var seen []string
|
||||
var gotBody map[string]interface{}
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
seen = append(seen, r.Method+" "+r.URL.String())
|
||||
switch r.URL.Path {
|
||||
case "/v1/Mengz/gitlink-cli/issues.json":
|
||||
if r.URL.Query().Get("state") != "open" {
|
||||
t.Fatalf("state query = %q", r.URL.Query().Get("state"))
|
||||
}
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{"issues": []interface{}{}})
|
||||
case "/v1/Mengz/gitlink-cli/issues/7/journals.json":
|
||||
if err := json.NewDecoder(r.Body).Decode(&gotBody); err != nil {
|
||||
t.Fatalf("decode body: %v", err)
|
||||
}
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{"id": 99})
|
||||
default:
|
||||
t.Fatalf("unexpected path: %s", r.URL.Path)
|
||||
}
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
plan := writeBatchPlan(t, map[string]interface{}{
|
||||
"vars": map[string]string{"owner": "Gitlink", "repo": "gitlink-cli", "issue": "7"},
|
||||
"requests": []map[string]interface{}{
|
||||
{
|
||||
"name": "list",
|
||||
"method": "GET",
|
||||
"path": "/v1/{{owner}}/{{repo}}/issues",
|
||||
"query": map[string]interface{}{"state": "open"},
|
||||
},
|
||||
{
|
||||
"name": "comment",
|
||||
"method": "POST",
|
||||
"path": "/v1/{{owner}}/{{repo}}/issues/{{issue}}/journals",
|
||||
"body": map[string]interface{}{"notes": "hello {{repo}}"},
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"--batch-file", plan, "--var", "owner=Mengz"})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("batch execute error: %v", err)
|
||||
}
|
||||
if len(seen) != 2 {
|
||||
t.Fatalf("requests = %d, want 2 (%v)", len(seen), seen)
|
||||
}
|
||||
if gotBody["notes"] != "hello gitlink-cli" {
|
||||
t.Fatalf("body notes = %#v", gotBody["notes"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIBatchStopsOnErrorByDefault(t *testing.T) {
|
||||
var seen []string
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
seen = append(seen, r.URL.Path)
|
||||
if r.URL.Path == "/fail.json" {
|
||||
http.Error(w, "boom", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{"ok": true})
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
plan := writeBatchPlan(t, map[string]interface{}{
|
||||
"requests": []map[string]interface{}{
|
||||
{"method": "GET", "path": "/ok"},
|
||||
{"method": "GET", "path": "/fail"},
|
||||
{"method": "GET", "path": "/never"},
|
||||
},
|
||||
})
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"--batch-file", plan})
|
||||
if err := cmd.Execute(); err == nil {
|
||||
t.Fatal("expected batch error")
|
||||
}
|
||||
if len(seen) != 2 {
|
||||
t.Fatalf("requests = %d, want 2 (%v)", len(seen), seen)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunAPIBatchContinueOnError(t *testing.T) {
|
||||
var seen []string
|
||||
setupAPITest(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
seen = append(seen, r.URL.Path)
|
||||
if r.URL.Path == "/fail.json" {
|
||||
http.Error(w, "boom", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
json.NewEncoder(w).Encode(map[string]interface{}{"ok": true})
|
||||
})
|
||||
cmdutil.Format = "json"
|
||||
|
||||
plan := writeBatchPlan(t, map[string]interface{}{
|
||||
"requests": []map[string]interface{}{
|
||||
{"method": "GET", "path": "/ok"},
|
||||
{"method": "GET", "path": "/fail"},
|
||||
{"method": "GET", "path": "/after"},
|
||||
},
|
||||
})
|
||||
|
||||
cmd := NewAPICmd()
|
||||
cmd.SetArgs([]string{"--batch-file", plan, "--continue-on-error"})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("batch should continue: %v", err)
|
||||
}
|
||||
if len(seen) != 3 {
|
||||
t.Fatalf("requests = %d, want 3 (%v)", len(seen), seen)
|
||||
}
|
||||
}
|
||||
|
||||
func writeBatchPlan(t *testing.T, payload interface{}) string {
|
||||
t.Helper()
|
||||
data, err := json.Marshal(payload)
|
||||
if err != nil {
|
||||
t.Fatalf("marshal plan: %v", err)
|
||||
}
|
||||
path := filepath.Join(t.TempDir(), "plan.json")
|
||||
if err := os.WriteFile(path, data, 0600); err != nil {
|
||||
t.Fatalf("write plan: %v", err)
|
||||
}
|
||||
return path
|
||||
}
|
||||
351
cmd/api/batch.go
351
cmd/api/batch.go
|
|
@ -1,351 +0,0 @@
|
|||
package api
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"os"
|
||||
"regexp"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/cmd/cmdutil"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/client"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/output"
|
||||
)
|
||||
|
||||
type batchPlan struct {
|
||||
Vars map[string]string `json:"vars"`
|
||||
Requests []batchRequest `json:"requests"`
|
||||
}
|
||||
|
||||
type batchRequest struct {
|
||||
Name string `json:"name"`
|
||||
Method string `json:"method"`
|
||||
Path string `json:"path"`
|
||||
Query map[string]interface{} `json:"query"`
|
||||
Body interface{} `json:"body"`
|
||||
}
|
||||
|
||||
type renderedBatchRequest struct {
|
||||
Index int `json:"index" yaml:"index"`
|
||||
Name string `json:"name,omitempty" yaml:"name,omitempty"`
|
||||
Method string `json:"method" yaml:"method"`
|
||||
Path string `json:"path" yaml:"path"`
|
||||
Query url.Values `json:"query,omitempty" yaml:"query,omitempty"`
|
||||
Body interface{} `json:"body,omitempty" yaml:"body,omitempty"`
|
||||
}
|
||||
|
||||
type batchResult struct {
|
||||
Index int `json:"index" yaml:"index"`
|
||||
Name string `json:"name,omitempty" yaml:"name,omitempty"`
|
||||
Method string `json:"method" yaml:"method"`
|
||||
Path string `json:"path" yaml:"path"`
|
||||
OK bool `json:"ok" yaml:"ok"`
|
||||
Error string `json:"error,omitempty" yaml:"error,omitempty"`
|
||||
Data interface{} `json:"data,omitempty" yaml:"data,omitempty"`
|
||||
}
|
||||
|
||||
type batchSummary struct {
|
||||
DryRun bool `json:"dry_run" yaml:"dry_run"`
|
||||
ContinueOnError bool `json:"continue_on_error" yaml:"continue_on_error"`
|
||||
Total int `json:"total" yaml:"total"`
|
||||
Succeeded int `json:"succeeded" yaml:"succeeded"`
|
||||
Failed int `json:"failed" yaml:"failed"`
|
||||
Variables map[string]string `json:"variables,omitempty" yaml:"variables,omitempty"`
|
||||
Requests []renderedBatchRequest `json:"requests,omitempty" yaml:"requests,omitempty"`
|
||||
Results []batchResult `json:"results,omitempty" yaml:"results,omitempty"`
|
||||
}
|
||||
|
||||
var templatePattern = regexp.MustCompile(`\{\{\s*([A-Za-z0-9_.-]+)\s*\}\}`)
|
||||
|
||||
func runAPIBatch(c *cobra.Command, batchFile string) error {
|
||||
if hasSingleRequestInput(c) {
|
||||
return fmt.Errorf("use batch flags separately from --body, --body-file, --body-stdin, --query, or --header")
|
||||
}
|
||||
|
||||
dryRun, _ := c.Flags().GetBool("dry-run")
|
||||
continueOnError, _ := c.Flags().GetBool("continue-on-error")
|
||||
overrides, err := parseBatchVars(c)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
plan, err := readBatchPlan(batchFile)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
vars := mergeBatchVars(plan.Vars, overrides)
|
||||
requests, err := renderBatchRequests(plan.Requests, vars)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if dryRun {
|
||||
return output.Print(output.SuccessEnvelope(batchSummary{
|
||||
DryRun: true,
|
||||
ContinueOnError: continueOnError,
|
||||
Total: len(requests),
|
||||
Variables: sortedVars(vars),
|
||||
Requests: requests,
|
||||
}, nil), resolveFormat())
|
||||
}
|
||||
|
||||
cli, err := client.New()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
cli.Debug = cmdutil.Debug
|
||||
|
||||
summary := batchSummary{
|
||||
DryRun: false,
|
||||
ContinueOnError: continueOnError,
|
||||
Total: len(requests),
|
||||
Variables: sortedVars(vars),
|
||||
Results: make([]batchResult, 0, len(requests)),
|
||||
}
|
||||
for _, req := range requests {
|
||||
result := batchResult{
|
||||
Index: req.Index,
|
||||
Name: req.Name,
|
||||
Method: req.Method,
|
||||
Path: req.Path,
|
||||
}
|
||||
env, callErr := cli.Do(req.Method, req.Path, req.Body, req.Query)
|
||||
if callErr != nil {
|
||||
summary.Failed++
|
||||
result.OK = false
|
||||
result.Error = apiBatchErrorMessage(callErr)
|
||||
summary.Results = append(summary.Results, result)
|
||||
if !continueOnError {
|
||||
_ = output.Print(output.SuccessEnvelope(summary, nil), resolveFormat())
|
||||
return callErr
|
||||
}
|
||||
continue
|
||||
}
|
||||
summary.Succeeded++
|
||||
result.OK = true
|
||||
if env != nil {
|
||||
result.Data = env.Data
|
||||
}
|
||||
summary.Results = append(summary.Results, result)
|
||||
}
|
||||
|
||||
return output.Print(output.SuccessEnvelope(summary, nil), resolveFormat())
|
||||
}
|
||||
|
||||
func hasSingleRequestInput(c *cobra.Command) bool {
|
||||
body, _ := c.Flags().GetString("body")
|
||||
bodyFile, _ := c.Flags().GetString("body-file")
|
||||
bodyStdin, _ := c.Flags().GetBool("body-stdin")
|
||||
query, _ := c.Flags().GetString("query")
|
||||
headers, _ := c.Flags().GetStringSlice("header")
|
||||
return body != "" || bodyFile != "" || bodyStdin || query != "" || len(headers) > 0
|
||||
}
|
||||
|
||||
func parseBatchVars(c *cobra.Command) (map[string]string, error) {
|
||||
raw, _ := c.Flags().GetStringArray("var")
|
||||
vars := make(map[string]string, len(raw))
|
||||
for _, item := range raw {
|
||||
key, value, ok := strings.Cut(item, "=")
|
||||
key = strings.TrimSpace(key)
|
||||
if !ok || key == "" {
|
||||
return nil, fmt.Errorf("invalid --var %q, want key=value", item)
|
||||
}
|
||||
vars[key] = value
|
||||
}
|
||||
return vars, nil
|
||||
}
|
||||
|
||||
func readBatchPlan(path string) (*batchPlan, error) {
|
||||
data, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read batch file: %w", err)
|
||||
}
|
||||
var plan batchPlan
|
||||
if err := json.Unmarshal(data, &plan); err != nil {
|
||||
return nil, fmt.Errorf("invalid batch file JSON: %w", err)
|
||||
}
|
||||
if len(plan.Requests) == 0 {
|
||||
return nil, fmt.Errorf("batch file must contain at least one request")
|
||||
}
|
||||
return &plan, nil
|
||||
}
|
||||
|
||||
func mergeBatchVars(planVars, overrides map[string]string) map[string]string {
|
||||
vars := make(map[string]string, len(planVars)+len(overrides))
|
||||
for key, value := range planVars {
|
||||
vars[key] = value
|
||||
}
|
||||
for key, value := range overrides {
|
||||
vars[key] = value
|
||||
}
|
||||
return vars
|
||||
}
|
||||
|
||||
func renderBatchRequests(requests []batchRequest, vars map[string]string) ([]renderedBatchRequest, error) {
|
||||
rendered := make([]renderedBatchRequest, 0, len(requests))
|
||||
for i, req := range requests {
|
||||
method := strings.ToUpper(strings.TrimSpace(req.Method))
|
||||
if method == "" {
|
||||
return nil, fmt.Errorf("request %d method is required", i+1)
|
||||
}
|
||||
path, err := renderTemplate(req.Path, vars)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("request %d path: %w", i+1, err)
|
||||
}
|
||||
path = strings.TrimSpace(path)
|
||||
if path == "" {
|
||||
return nil, fmt.Errorf("request %d path is required", i+1)
|
||||
}
|
||||
if !strings.HasPrefix(path, "/") {
|
||||
path = "/" + path
|
||||
}
|
||||
query, err := renderBatchQuery(req.Query, vars)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("request %d query: %w", i+1, err)
|
||||
}
|
||||
body, err := renderBatchValue(req.Body, vars)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("request %d body: %w", i+1, err)
|
||||
}
|
||||
name, err := renderTemplate(req.Name, vars)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("request %d name: %w", i+1, err)
|
||||
}
|
||||
rendered = append(rendered, renderedBatchRequest{
|
||||
Index: i + 1,
|
||||
Name: name,
|
||||
Method: method,
|
||||
Path: path,
|
||||
Query: query,
|
||||
Body: body,
|
||||
})
|
||||
}
|
||||
return rendered, nil
|
||||
}
|
||||
|
||||
func renderBatchQuery(raw map[string]interface{}, vars map[string]string) (url.Values, error) {
|
||||
if len(raw) == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
query := url.Values{}
|
||||
keys := make([]string, 0, len(raw))
|
||||
for key := range raw {
|
||||
keys = append(keys, key)
|
||||
}
|
||||
sort.Strings(keys)
|
||||
for _, key := range keys {
|
||||
renderedKey, err := renderTemplate(key, vars)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
values, err := renderQueryValues(raw[key], vars)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("%s: %w", key, err)
|
||||
}
|
||||
for _, value := range values {
|
||||
query.Add(renderedKey, value)
|
||||
}
|
||||
}
|
||||
return query, nil
|
||||
}
|
||||
|
||||
func renderQueryValues(raw interface{}, vars map[string]string) ([]string, error) {
|
||||
switch value := raw.(type) {
|
||||
case nil:
|
||||
return []string{""}, nil
|
||||
case string:
|
||||
rendered, err := renderTemplate(value, vars)
|
||||
return []string{rendered}, err
|
||||
case []interface{}:
|
||||
values := make([]string, 0, len(value))
|
||||
for _, item := range value {
|
||||
itemValues, err := renderQueryValues(item, vars)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
values = append(values, itemValues...)
|
||||
}
|
||||
return values, nil
|
||||
default:
|
||||
return []string{fmt.Sprint(value)}, nil
|
||||
}
|
||||
}
|
||||
|
||||
func renderBatchValue(raw interface{}, vars map[string]string) (interface{}, error) {
|
||||
switch value := raw.(type) {
|
||||
case nil:
|
||||
return nil, nil
|
||||
case string:
|
||||
return renderTemplate(value, vars)
|
||||
case []interface{}:
|
||||
items := make([]interface{}, 0, len(value))
|
||||
for _, item := range value {
|
||||
rendered, err := renderBatchValue(item, vars)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
items = append(items, rendered)
|
||||
}
|
||||
return items, nil
|
||||
case map[string]interface{}:
|
||||
obj := make(map[string]interface{}, len(value))
|
||||
for key, item := range value {
|
||||
renderedKey, err := renderTemplate(key, vars)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
rendered, err := renderBatchValue(item, vars)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
obj[renderedKey] = rendered
|
||||
}
|
||||
return obj, nil
|
||||
default:
|
||||
return raw, nil
|
||||
}
|
||||
}
|
||||
|
||||
func renderTemplate(value string, vars map[string]string) (string, error) {
|
||||
var missing []string
|
||||
rendered := templatePattern.ReplaceAllStringFunc(value, func(match string) string {
|
||||
parts := templatePattern.FindStringSubmatch(match)
|
||||
if len(parts) != 2 {
|
||||
return match
|
||||
}
|
||||
replacement, ok := vars[parts[1]]
|
||||
if !ok {
|
||||
missing = append(missing, parts[1])
|
||||
return match
|
||||
}
|
||||
return replacement
|
||||
})
|
||||
if len(missing) > 0 {
|
||||
sort.Strings(missing)
|
||||
return "", fmt.Errorf("missing template variable(s): %s", strings.Join(missing, ", "))
|
||||
}
|
||||
return rendered, nil
|
||||
}
|
||||
|
||||
func sortedVars(vars map[string]string) map[string]string {
|
||||
if len(vars) == 0 {
|
||||
return nil
|
||||
}
|
||||
copyVars := make(map[string]string, len(vars))
|
||||
for key, value := range vars {
|
||||
copyVars[key] = value
|
||||
}
|
||||
return copyVars
|
||||
}
|
||||
|
||||
func apiBatchErrorMessage(err error) string {
|
||||
var apiErr *client.APIError
|
||||
if errors.As(err, &apiErr) {
|
||||
return apiErr.Message
|
||||
}
|
||||
return err.Error()
|
||||
}
|
||||
269
cmd/auth/auth.go
269
cmd/auth/auth.go
|
|
@ -2,283 +2,186 @@ package auth
|
|||
|
||||
import (
|
||||
"bufio"
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"os/signal"
|
||||
"strings"
|
||||
"syscall"
|
||||
"time"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
"golang.org/x/term"
|
||||
|
||||
internalAuth "github.com/gitlink-org/gitlink-cli/internal/auth"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/i18n"
|
||||
)
|
||||
|
||||
const envTokenVar = "GITLINK_TOKEN"
|
||||
|
||||
var (
|
||||
storeToken = internalAuth.StoreToken
|
||||
loadToken = internalAuth.LoadToken
|
||||
)
|
||||
|
||||
func NewAuthCmd(translators ...*i18n.Translator) *cobra.Command {
|
||||
tr := i18n.Default()
|
||||
if len(translators) > 0 && translators[0] != nil {
|
||||
tr = translators[0]
|
||||
}
|
||||
func NewAuthCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "auth",
|
||||
Short: tr.T("cmd.auth.short"),
|
||||
Short: "Authentication commands",
|
||||
}
|
||||
cmd.AddCommand(newLoginCmd(tr))
|
||||
cmd.AddCommand(newLogoutCmd(tr))
|
||||
cmd.AddCommand(newStatusCmd(tr))
|
||||
cmd.AddCommand(newCheckinCmd(tr))
|
||||
cmd.AddCommand(newLoginCmd())
|
||||
cmd.AddCommand(newLogoutCmd())
|
||||
cmd.AddCommand(newStatusCmd())
|
||||
cmd.AddCommand(newRefreshCmd())
|
||||
return cmd
|
||||
}
|
||||
|
||||
func newLoginCmd(tr *i18n.Translator) *cobra.Command {
|
||||
func newLoginCmd() *cobra.Command {
|
||||
var tokenMode bool
|
||||
var oauthMode bool
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "login",
|
||||
Short: tr.T("cmd.auth.login.short"),
|
||||
Short: "Login to GitLink",
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if tokenMode {
|
||||
return loginWithToken(cmd.InOrStdin(), cmd.OutOrStdout(), tr)
|
||||
return loginWithToken()
|
||||
}
|
||||
return loginWithPassword(cmd.InOrStdin(), cmd.OutOrStdout(), tr)
|
||||
if oauthMode {
|
||||
return loginWithOAuth()
|
||||
}
|
||||
return loginWithPassword()
|
||||
},
|
||||
}
|
||||
cmd.Flags().BoolVar(&tokenMode, "token", false, tr.T("flag.auth.token"))
|
||||
cmd.Flags().BoolVar(&tokenMode, "token", false, "Login by pasting an existing token")
|
||||
cmd.Flags().BoolVar(&oauthMode, "oauth", false, "Login using OAuth2 password grant")
|
||||
return cmd
|
||||
}
|
||||
|
||||
func loginWithPassword(in io.Reader, out io.Writer, tr *i18n.Translator) error {
|
||||
reader := bufio.NewReader(in)
|
||||
if _, err := fmt.Fprint(out, tr.T("prompt.auth.username")); err != nil {
|
||||
return err
|
||||
}
|
||||
func loginWithPassword() error {
|
||||
reader := bufio.NewReader(os.Stdin)
|
||||
|
||||
fmt.Print("Username/Email/Phone: ")
|
||||
username, _ := reader.ReadString('\n')
|
||||
username = strings.TrimSpace(username)
|
||||
|
||||
if _, err := fmt.Fprint(out, tr.T("prompt.auth.password")); err != nil {
|
||||
return err
|
||||
}
|
||||
passwordBytes, err := readPassword(in, reader)
|
||||
fmt.Print("Password: ")
|
||||
passwordBytes, err := term.ReadPassword(int(syscall.Stdin))
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to read password: %w", err)
|
||||
}
|
||||
if _, err := fmt.Fprintln(out); err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Println()
|
||||
password := string(passwordBytes)
|
||||
|
||||
result, err := internalAuth.Login(username, password)
|
||||
if err != nil {
|
||||
return errors.New(tr.Tf("error.auth.login_failed", i18n.Args{"message": err.Error()}))
|
||||
return fmt.Errorf("login failed: %w", err)
|
||||
}
|
||||
|
||||
_, err = fmt.Fprintln(out, tr.Tf("success.auth.logged_in_as", i18n.Args{"login": result.Login}))
|
||||
return err
|
||||
fmt.Printf("✓ Logged in as %s\n", result.Login)
|
||||
return nil
|
||||
}
|
||||
|
||||
func readPassword(in io.Reader, reader *bufio.Reader) ([]byte, error) {
|
||||
if file, ok := in.(*os.File); ok {
|
||||
fd := int(file.Fd())
|
||||
if term.IsTerminal(fd) {
|
||||
return term.ReadPassword(fd)
|
||||
}
|
||||
}
|
||||
password, err := reader.ReadString('\n')
|
||||
if err != nil && err != io.EOF {
|
||||
return nil, err
|
||||
}
|
||||
return []byte(strings.TrimRight(password, "\r\n")), nil
|
||||
}
|
||||
|
||||
func loginWithToken(in io.Reader, out io.Writer, tr *i18n.Translator) error {
|
||||
reader := bufio.NewReader(in)
|
||||
if _, err := fmt.Fprint(out, tr.T("prompt.auth.token")); err != nil {
|
||||
return err
|
||||
}
|
||||
func loginWithToken() error {
|
||||
reader := bufio.NewReader(os.Stdin)
|
||||
fmt.Print("Paste your token: ")
|
||||
token, _ := reader.ReadString('\n')
|
||||
token = strings.TrimSpace(token)
|
||||
|
||||
if token == "" {
|
||||
return errors.New(tr.T("error.auth.token_empty"))
|
||||
return fmt.Errorf("token cannot be empty")
|
||||
}
|
||||
|
||||
if err := storeToken(token); err != nil {
|
||||
return errors.New(tr.Tf("error.auth.store_token_failed", i18n.Args{"message": err.Error()}))
|
||||
if err := internalAuth.StoreToken(token); err != nil {
|
||||
return fmt.Errorf("failed to store token: %w", err)
|
||||
}
|
||||
|
||||
_, err := fmt.Fprintln(out, tr.T("success.auth.token_saved"))
|
||||
return err
|
||||
fmt.Println("✓ Token saved")
|
||||
return nil
|
||||
}
|
||||
|
||||
func newLogoutCmd(tr *i18n.Translator) *cobra.Command {
|
||||
func newLogoutCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "logout",
|
||||
Short: tr.T("cmd.auth.logout.short"),
|
||||
Short: "Logout from GitLink",
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if err := internalAuth.DeleteToken(); err != nil {
|
||||
return errors.New(tr.Tf("error.auth.delete_token_failed", i18n.Args{"message": err.Error()}))
|
||||
return fmt.Errorf("failed to delete token: %w", err)
|
||||
}
|
||||
_, err := fmt.Fprintln(cmd.OutOrStdout(), tr.T("success.auth.logged_out"))
|
||||
return err
|
||||
fmt.Println("✓ Logged out")
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func newStatusCmd(tr *i18n.Translator) *cobra.Command {
|
||||
func newStatusCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "status",
|
||||
Short: tr.T("cmd.auth.status.short"),
|
||||
Short: "Show authentication status",
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
out := cmd.OutOrStdout()
|
||||
// Check env var token first
|
||||
if envToken := os.Getenv(envTokenVar); envToken != "" {
|
||||
if _, err := fmt.Fprintln(out, tr.Tf("success.auth.logged_in_via_env", i18n.Args{"env": envTokenVar})); err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Printf("✓ Logged in via %s environment variable\n", envTokenVar)
|
||||
}
|
||||
|
||||
token, err := loadToken()
|
||||
token, err := internalAuth.LoadToken()
|
||||
if err != nil || token == "" {
|
||||
if os.Getenv(envTokenVar) == "" {
|
||||
if _, err := fmt.Fprintln(out, tr.T("warning.auth.not_logged_in")); err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := fmt.Fprintln(out, tr.T("output.auth.login_hint")); err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := fmt.Fprintln(out, tr.Tf("output.auth.env_hint", i18n.Args{"env": envTokenVar})); err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Println("✗ Not logged in")
|
||||
fmt.Println(" Run: gitlink-cli auth login")
|
||||
fmt.Printf(" Or set %s environment variable\n", envTokenVar)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
user, err := internalAuth.GetCurrentUser()
|
||||
if err != nil {
|
||||
_, err := fmt.Fprintln(out, tr.Tf("warning.auth.token_unverified", i18n.Args{"message": err.Error()}))
|
||||
return err
|
||||
fmt.Printf("✓ Token stored (but cannot verify: %v)\n", err)
|
||||
return nil
|
||||
}
|
||||
|
||||
login, _ := user["login"].(string)
|
||||
name, _ := user["name"].(string)
|
||||
if login != "" {
|
||||
text := tr.Tf("success.auth.logged_in_as", i18n.Args{"login": login})
|
||||
fmt.Printf("✓ Logged in as %s", login)
|
||||
if name != "" {
|
||||
text = fmt.Sprintf("%s (%s)", text, name)
|
||||
fmt.Printf(" (%s)", name)
|
||||
}
|
||||
_, err := fmt.Fprintln(out, text)
|
||||
return err
|
||||
fmt.Println()
|
||||
} else {
|
||||
fmt.Println("✓ Token stored (user info unavailable)")
|
||||
}
|
||||
_, err = fmt.Fprintln(out, tr.T("warning.auth.user_unavailable"))
|
||||
return err
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func newCheckinCmd(tr *i18n.Translator) *cobra.Command {
|
||||
var intervalMinutes int
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "checkin",
|
||||
Short: tr.T("cmd.auth.checkin.short"),
|
||||
Long: tr.T("cmd.auth.checkin.long"),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return runCheckin(cmd.OutOrStdout(), intervalMinutes, tr)
|
||||
},
|
||||
}
|
||||
cmd.Flags().IntVarP(&intervalMinutes, "time", "t", 30, tr.T("flag.auth.checkin.time"))
|
||||
return cmd
|
||||
}
|
||||
|
||||
func runCheckin(out io.Writer, intervalMinutes int, tr *i18n.Translator) error {
|
||||
// Check if user is logged in
|
||||
token, err := loadToken()
|
||||
if err != nil || token == "" {
|
||||
if os.Getenv(envTokenVar) == "" {
|
||||
return errors.New(tr.T("error.auth.not_logged_in"))
|
||||
}
|
||||
}
|
||||
|
||||
// Convert minutes to duration
|
||||
interval := time.Duration(intervalMinutes) * time.Minute
|
||||
|
||||
// Print startup message
|
||||
fmt.Fprintln(out, tr.Tf("output.auth.checkin.start", i18n.Args{"interval": intervalMinutes}))
|
||||
fmt.Fprintln(out, tr.T("output.auth.checkin.stop_hint"))
|
||||
|
||||
// Setup signal handling for graceful shutdown
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
defer cancel()
|
||||
|
||||
sigChan := make(chan os.Signal, 1)
|
||||
signal.Notify(sigChan, os.Interrupt, syscall.SIGTERM)
|
||||
|
||||
go func() {
|
||||
<-sigChan
|
||||
fmt.Fprintln(out, "\n"+tr.T("output.auth.checkin.stopping"))
|
||||
cancel()
|
||||
}()
|
||||
|
||||
// Create ticker
|
||||
ticker := time.NewTicker(interval)
|
||||
defer ticker.Stop()
|
||||
|
||||
// Do first check immediately
|
||||
if err := doCheckin(out, tr, interval); err != nil {
|
||||
fmt.Fprintln(out, tr.Tf("error.auth.checkin.failed", i18n.Args{"message": err.Error()}))
|
||||
}
|
||||
|
||||
// Then check periodically
|
||||
for {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
fmt.Fprintln(out, tr.T("output.auth.checkin.stopped"))
|
||||
return nil
|
||||
case <-ticker.C:
|
||||
if err := doCheckin(out, tr, interval); err != nil {
|
||||
fmt.Fprintln(out, tr.Tf("error.auth.checkin.failed", i18n.Args{"message": err.Error()}))
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func doCheckin(out io.Writer, tr *i18n.Translator, interval time.Duration) error {
|
||||
timestamp := time.Now().Format("2006-01-02 15:04:05")
|
||||
fmt.Fprintf(out, "[%s] "+tr.T("output.auth.checkin.checking")+"\n", timestamp)
|
||||
func loginWithOAuth() error {
|
||||
reader := bufio.NewReader(os.Stdin)
|
||||
|
||||
user, err := internalAuth.GetCurrentUser()
|
||||
fmt.Print("Username: ")
|
||||
username, _ := reader.ReadString('\n')
|
||||
username = strings.TrimSpace(username)
|
||||
|
||||
fmt.Print("Password: ")
|
||||
passwordBytes, err := term.ReadPassword(int(syscall.Stdin))
|
||||
if err != nil {
|
||||
return err
|
||||
return fmt.Errorf("failed to read password: %w", err)
|
||||
}
|
||||
fmt.Println()
|
||||
password := string(passwordBytes)
|
||||
|
||||
result, err := internalAuth.LoginOAuth(username, password)
|
||||
if err != nil {
|
||||
return fmt.Errorf("OAuth2 login failed: %w", err)
|
||||
}
|
||||
|
||||
login, _ := user["login"].(string)
|
||||
name, _ := user["name"].(string)
|
||||
|
||||
if login != "" {
|
||||
msg := tr.Tf("output.auth.checkin.success", i18n.Args{"login": login})
|
||||
if name != "" {
|
||||
msg = fmt.Sprintf("%s (%s)", msg, name)
|
||||
}
|
||||
fmt.Fprintf(out, "[%s] %s\n", timestamp, msg)
|
||||
} else {
|
||||
fmt.Fprintf(out, "[%s] "+tr.T("output.auth.checkin.success_no_user")+"\n", timestamp)
|
||||
}
|
||||
|
||||
// Print next refresh time
|
||||
nextTime := time.Now().Add(interval).Format("2006-01-02 15:04:05")
|
||||
fmt.Fprintln(out, tr.Tf("output.auth.checkin.interval", i18n.Args{"time": nextTime}))
|
||||
|
||||
fmt.Printf("✓ Logged in as %s\n", result.Login)
|
||||
return nil
|
||||
}
|
||||
|
||||
func newRefreshCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "refresh",
|
||||
Short: "Refresh OAuth2 token",
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
result, err := internalAuth.RefreshOAuthToken()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to refresh token: %w", err)
|
||||
}
|
||||
fmt.Printf("✓ Token refreshed for %s (expires in %d seconds)\n", result.Login, result.ExpiresIn)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,243 +0,0 @@
|
|||
package auth
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
"github.com/zalando/go-keyring"
|
||||
|
||||
internalAuth "github.com/gitlink-org/gitlink-cli/internal/auth"
|
||||
)
|
||||
|
||||
func tempConfigDir(t *testing.T) string {
|
||||
t.Helper()
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
return dir
|
||||
}
|
||||
|
||||
func TestEnvTokenVar(t *testing.T) {
|
||||
if envTokenVar != "GITLINK_TOKEN" {
|
||||
t.Fatalf("envTokenVar = %q, want GITLINK_TOKEN", envTokenVar)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewAuthCmd(t *testing.T) {
|
||||
cmd := NewAuthCmd()
|
||||
if cmd.Use != "auth" {
|
||||
t.Fatalf("Use = %q, want auth", cmd.Use)
|
||||
}
|
||||
if cmd.Short == "" {
|
||||
t.Fatal("Short is empty")
|
||||
}
|
||||
|
||||
expectedSubs := map[string]bool{
|
||||
"login": false, "logout": false, "status": false, "checkin": false,
|
||||
}
|
||||
for _, sub := range cmd.Commands() {
|
||||
if _, ok := expectedSubs[sub.Use]; !ok {
|
||||
t.Fatalf("unexpected subcommand: %q", sub.Use)
|
||||
}
|
||||
if expectedSubs[sub.Use] {
|
||||
t.Fatalf("duplicate subcommand: %q", sub.Use)
|
||||
}
|
||||
expectedSubs[sub.Use] = true
|
||||
if sub.Short == "" {
|
||||
t.Fatalf("subcommand %q has empty Short", sub.Use)
|
||||
}
|
||||
}
|
||||
for name, found := range expectedSubs {
|
||||
if !found {
|
||||
t.Fatalf("missing subcommand: %q", name)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoginTokenFlag(t *testing.T) {
|
||||
cmd := NewAuthCmd()
|
||||
loginCmd := findSub(cmd, "login")
|
||||
if loginCmd == nil {
|
||||
t.Fatal("login subcommand not found")
|
||||
}
|
||||
if f := loginCmd.Flags().Lookup("token"); f == nil {
|
||||
t.Fatal("login command missing --token flag")
|
||||
}
|
||||
}
|
||||
|
||||
func TestStatusCmdNotLoggedIn(t *testing.T) {
|
||||
keyring.MockInitWithError(errors.New("keychain unavailable"))
|
||||
tempConfigDir(t)
|
||||
t.Setenv("GITLINK_TOKEN", "")
|
||||
_ = internalAuth.DeleteToken()
|
||||
|
||||
cmd := findSub(NewAuthCmd(), "status")
|
||||
if cmd == nil {
|
||||
t.Fatal("status subcommand not found")
|
||||
}
|
||||
if err := cmd.RunE(cmd, nil); err != nil {
|
||||
t.Fatalf("status error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestStatusCmdEnvToken(t *testing.T) {
|
||||
keyring.MockInitWithError(errors.New("keychain unavailable"))
|
||||
tempConfigDir(t)
|
||||
t.Setenv("GITLINK_TOKEN", "env-token-123")
|
||||
_ = internalAuth.DeleteToken()
|
||||
|
||||
cmd := findSub(NewAuthCmd(), "status")
|
||||
cmd.RunE(cmd, nil)
|
||||
}
|
||||
|
||||
func TestStatusCmdStoredToken(t *testing.T) {
|
||||
keyring.MockInitWithError(errors.New("keychain unavailable"))
|
||||
dir := tempConfigDir(t)
|
||||
t.Setenv("GITLINK_TOKEN", "")
|
||||
|
||||
os.MkdirAll(dir, 0700)
|
||||
os.WriteFile(filepath.Join(dir, "credentials"), []byte("cookie:test=abc"), 0600)
|
||||
|
||||
cmd := findSub(NewAuthCmd(), "status")
|
||||
cmd.RunE(cmd, nil)
|
||||
}
|
||||
|
||||
func TestStatusCmdEnvAndStoredToken(t *testing.T) {
|
||||
keyring.MockInitWithError(errors.New("keychain unavailable"))
|
||||
dir := tempConfigDir(t)
|
||||
t.Setenv("GITLINK_TOKEN", "env-token")
|
||||
|
||||
os.MkdirAll(dir, 0700)
|
||||
os.WriteFile(filepath.Join(dir, "credentials"), []byte("stored-token"), 0600)
|
||||
|
||||
cmd := findSub(NewAuthCmd(), "status")
|
||||
if err := cmd.RunE(cmd, nil); err != nil {
|
||||
t.Fatalf("status error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestStatusCmdStoredTokenButLoadFails(t *testing.T) {
|
||||
keyring.MockInitWithError(errors.New("keychain unavailable"))
|
||||
tempConfigDir(t)
|
||||
t.Setenv("GITLINK_TOKEN", "")
|
||||
// Do not create credentials; LoadToken should return empty.
|
||||
|
||||
cmd := findSub(NewAuthCmd(), "status")
|
||||
if err := cmd.RunE(cmd, nil); err != nil {
|
||||
t.Fatalf("status error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLogoutCmdNoStoredToken(t *testing.T) {
|
||||
keyring.MockInitWithError(errors.New("keychain unavailable"))
|
||||
tempConfigDir(t)
|
||||
t.Setenv("GITLINK_TOKEN", "")
|
||||
// Do not create credentials; logout should be idempotent.
|
||||
|
||||
cmd := findSub(NewAuthCmd(), "logout")
|
||||
if err := cmd.RunE(cmd, nil); err != nil {
|
||||
t.Fatalf("logout should succeed without stored token: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLogoutCmd(t *testing.T) {
|
||||
keyring.MockInitWithError(errors.New("keychain unavailable"))
|
||||
dir := tempConfigDir(t)
|
||||
t.Setenv("GITLINK_TOKEN", "")
|
||||
|
||||
// Store a token first so DeleteToken has something to delete
|
||||
os.MkdirAll(dir, 0700)
|
||||
os.WriteFile(filepath.Join(dir, "credentials"), []byte("some-token"), 0600)
|
||||
|
||||
cmd := findSub(NewAuthCmd(), "logout")
|
||||
if cmd == nil {
|
||||
t.Fatal("logout subcommand not found")
|
||||
}
|
||||
if err := cmd.RunE(cmd, nil); err != nil {
|
||||
t.Fatalf("logout error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoginWithToken(t *testing.T) {
|
||||
keyring.MockInitWithError(errors.New("keychain unavailable"))
|
||||
dir := tempConfigDir(t)
|
||||
t.Setenv("GITLINK_TOKEN", "")
|
||||
|
||||
// Mock stdin
|
||||
oldStdin := os.Stdin
|
||||
r, w, _ := os.Pipe()
|
||||
os.Stdin = r
|
||||
defer func() { os.Stdin = oldStdin }()
|
||||
|
||||
go func() {
|
||||
w.Write([]byte("test-token-123\n"))
|
||||
w.Close()
|
||||
}()
|
||||
|
||||
cmd := findSub(NewAuthCmd(), "login")
|
||||
if cmd == nil {
|
||||
t.Fatal("login subcommand not found")
|
||||
}
|
||||
cmd.Flags().Set("token", "true")
|
||||
err := cmd.RunE(cmd, nil)
|
||||
if err != nil {
|
||||
t.Fatalf("login --token error: %v", err)
|
||||
}
|
||||
|
||||
// Verify token was saved to file
|
||||
data, err := os.ReadFile(filepath.Join(dir, "credentials"))
|
||||
if err != nil {
|
||||
t.Fatalf("read credentials: %v", err)
|
||||
}
|
||||
if string(data) != "test-token-123" {
|
||||
t.Fatalf("token = %q, want test-token-123", string(data))
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoginWithTokenEmpty(t *testing.T) {
|
||||
keyring.MockInitWithError(errors.New("keychain unavailable"))
|
||||
tempConfigDir(t)
|
||||
t.Setenv("GITLINK_TOKEN", "")
|
||||
|
||||
oldStdin := os.Stdin
|
||||
r, w, _ := os.Pipe()
|
||||
os.Stdin = r
|
||||
defer func() { os.Stdin = oldStdin }()
|
||||
|
||||
go func() {
|
||||
w.Write([]byte("\n"))
|
||||
w.Close()
|
||||
}()
|
||||
|
||||
cmd := findSub(NewAuthCmd(), "login")
|
||||
cmd.Flags().Set("token", "true")
|
||||
err := cmd.RunE(cmd, nil)
|
||||
if err == nil {
|
||||
t.Fatal("expected error for empty token")
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoginWithPasswordNoTerminal(t *testing.T) {
|
||||
keyring.MockInitWithError(errors.New("keychain unavailable"))
|
||||
tempConfigDir(t)
|
||||
t.Setenv("GITLINK_TOKEN", "")
|
||||
|
||||
// term.ReadPassword will fail because test has no terminal
|
||||
cmd := findSub(NewAuthCmd(), "login")
|
||||
// Don't set --token, so it goes to loginWithPassword
|
||||
err := cmd.RunE(cmd, nil)
|
||||
if err == nil {
|
||||
t.Fatal("expected error when terminal unavailable (ReadPassword fails)")
|
||||
}
|
||||
}
|
||||
|
||||
func findSub(cmd *cobra.Command, name string) *cobra.Command {
|
||||
for _, sub := range cmd.Commands() {
|
||||
if sub.Use == name {
|
||||
return sub
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
|
@ -1,58 +0,0 @@
|
|||
package browse
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os/exec"
|
||||
"runtime"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/internal/context"
|
||||
)
|
||||
|
||||
// NewBrowseCmd creates the browse command for opening GitLink pages in a browser.
|
||||
func NewBrowseCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "browse [resource]",
|
||||
Short: "在浏览器中打开 GitLink 页面",
|
||||
Long: `打开当前仓库(或指定资源)的 GitLink 页面。
|
||||
|
||||
如果不带参数,打开当前仓库主页。
|
||||
资源格式: issues/42, pulls/42, wiki
|
||||
|
||||
浏览器打开命令:
|
||||
- macOS: open
|
||||
- Windows: start
|
||||
- Linux: xdg-open`,
|
||||
Example: ` gitlink-cli browse
|
||||
gitlink-cli browse issues/42
|
||||
gitlink-cli browse pulls/128
|
||||
gitlink-cli browse wiki`,
|
||||
Args: cobra.MaximumNArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
owner, repo, err := context.ResolveOwnerRepo("", "")
|
||||
if err != nil {
|
||||
return fmt.Errorf("无法推断仓库信息: %w", err)
|
||||
}
|
||||
url := fmt.Sprintf("https://gitlink.org.cn/%s/%s", owner, repo)
|
||||
if len(args) > 0 {
|
||||
url += "/" + args[0]
|
||||
}
|
||||
fmt.Printf("正在打开: %s\n", url)
|
||||
return openBrowser(url)
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func openBrowser(url string) error {
|
||||
var cmd *exec.Cmd
|
||||
switch runtime.GOOS {
|
||||
case "darwin":
|
||||
cmd = exec.Command("open", url)
|
||||
case "windows":
|
||||
cmd = exec.Command("cmd", "/c", "start", url)
|
||||
default:
|
||||
cmd = exec.Command("xdg-open", url)
|
||||
}
|
||||
return cmd.Start()
|
||||
}
|
||||
|
|
@ -1,58 +0,0 @@
|
|||
package browse
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestNewBrowseCmd(t *testing.T) {
|
||||
cmd := NewBrowseCmd()
|
||||
if cmd.Use != "browse [resource]" {
|
||||
t.Errorf("expected Use 'browse [resource]', got %s", cmd.Use)
|
||||
}
|
||||
if cmd.Short == "" {
|
||||
t.Error("Short description should not be empty")
|
||||
}
|
||||
if cmd.Long == "" {
|
||||
t.Error("Long description should not be empty")
|
||||
}
|
||||
}
|
||||
|
||||
func TestBrowseCmdHasCorrectArgs(t *testing.T) {
|
||||
cmd := NewBrowseCmd()
|
||||
// MaximumNArgs(1) should allow 0 or 1 args
|
||||
if err := cmd.Args(cmd, []string{}); err != nil {
|
||||
t.Errorf("should accept 0 args: %v", err)
|
||||
}
|
||||
if err := cmd.Args(cmd, []string{"issues/42"}); err != nil {
|
||||
t.Errorf("should accept 1 arg: %v", err)
|
||||
}
|
||||
if err := cmd.Args(cmd, []string{"a", "b"}); err == nil {
|
||||
t.Error("should reject more than 1 arg")
|
||||
}
|
||||
}
|
||||
|
||||
func TestBrowseCmdSubcommandStructure(t *testing.T) {
|
||||
cmd := NewBrowseCmd()
|
||||
// browse 不应该有子命令
|
||||
if cmd.HasSubCommands() {
|
||||
t.Error("browse should not have subcommands")
|
||||
}
|
||||
}
|
||||
|
||||
func TestBrowseCmdExample(t *testing.T) {
|
||||
cmd := NewBrowseCmd()
|
||||
if cmd.Example == "" {
|
||||
t.Error("Example should not be empty")
|
||||
}
|
||||
if !strings.Contains(cmd.Example, "browse") {
|
||||
t.Error("Example should contain 'browse'")
|
||||
}
|
||||
}
|
||||
|
||||
func TestOpenBrowserReturnsNoError(t *testing.T) {
|
||||
// openBrowser 在所有平台都应该返回 nil 或一个 error
|
||||
// 在无头环境下可能会失败,但不应该 panic
|
||||
_ = openBrowser("https://gitlink.org.cn")
|
||||
// 只要不 panic 就行
|
||||
}
|
||||
|
|
@ -1,68 +0,0 @@
|
|||
package cmd
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestNewRootCmdDefaults(t *testing.T) {
|
||||
root, err := NewRootCmd(RootOptions{Version: "test"}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if root.Use != "gitlink-cli" {
|
||||
t.Fatalf("Use = %q", root.Use)
|
||||
}
|
||||
if !root.SilenceUsage {
|
||||
t.Fatal("expected SilenceUsage=true")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRootHelp(t *testing.T) {
|
||||
root, err := NewRootCmd(RootOptions{Version: "test", Args: []string{"--help"}}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatalf("help command error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestVersionCmd(t *testing.T) {
|
||||
root, err := NewRootCmd(RootOptions{Version: "test", Args: []string{"version"}}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatalf("version command error: %v", err)
|
||||
}
|
||||
if got := strings.TrimSpace(out.String()); got != "gitlink-cli test" {
|
||||
t.Fatalf("version output = %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRootCmdHasSubcommands(t *testing.T) {
|
||||
root, err := NewRootCmd(RootOptions{Version: "test"}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
names := map[string]bool{}
|
||||
for _, sub := range root.Commands() {
|
||||
names[sub.Name()] = true
|
||||
}
|
||||
for _, want := range []string{"auth", "completion", "config", "doctor", "version"} {
|
||||
if !names[want] {
|
||||
t.Fatalf("missing subcommand: %s", want)
|
||||
}
|
||||
}
|
||||
if len(root.Commands()) < 4 {
|
||||
t.Fatalf("expected at least 4 subcommands, got %d", len(root.Commands()))
|
||||
}
|
||||
}
|
||||
|
|
@ -2,9 +2,10 @@ package cmdutil
|
|||
|
||||
// Global flags shared across all commands.
|
||||
var (
|
||||
Owner string
|
||||
Repo string
|
||||
Format string
|
||||
Debug bool
|
||||
Lang string
|
||||
Owner string
|
||||
Repo string
|
||||
Format string
|
||||
Debug bool
|
||||
ColorMode string
|
||||
AutoConfirm bool
|
||||
)
|
||||
|
|
|
|||
|
|
@ -1,71 +0,0 @@
|
|||
package cmd
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestCompletionCmdGeneratesSupportedShells(t *testing.T) {
|
||||
cases := []struct {
|
||||
shell string
|
||||
want string
|
||||
}{
|
||||
{shell: "bash", want: "__gitlink-cli"},
|
||||
{shell: "zsh", want: "#compdef gitlink-cli"},
|
||||
{shell: "fish", want: "complete -c gitlink-cli"},
|
||||
{shell: "powershell", want: "Register-ArgumentCompleter"},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
root, err := NewRootCmd(RootOptions{Version: "test", Args: []string{"completion", tc.shell}}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatalf("%s completion error: %v", tc.shell, err)
|
||||
}
|
||||
if !strings.Contains(out.String(), tc.want) {
|
||||
t.Fatalf("%s completion missing %q, got:\n%s", tc.shell, tc.want, out.String()[:min(len(out.String()), 400)])
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestCompletionCmdNoDescriptions(t *testing.T) {
|
||||
root, err := NewRootCmd(RootOptions{
|
||||
Version: "test",
|
||||
Args: []string{"completion", "bash", "--no-descriptions"},
|
||||
}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if strings.Contains(out.String(), "GitLink CLI - command-line tool for GitLink") {
|
||||
t.Fatalf("expected descriptions to be omitted")
|
||||
}
|
||||
}
|
||||
|
||||
func TestCompletionCmdRejectsUnsupportedShell(t *testing.T) {
|
||||
root, err := NewRootCmd(RootOptions{Version: "test", Args: []string{"completion", "xonsh"}}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
err = root.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected unsupported shell error")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "invalid argument") {
|
||||
t.Fatalf("expected invalid argument error, got %q", err.Error())
|
||||
}
|
||||
}
|
||||
|
|
@ -1,80 +1,59 @@
|
|||
package config
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
internalConfig "github.com/gitlink-org/gitlink-cli/internal/config"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/i18n"
|
||||
)
|
||||
|
||||
func NewConfigCmd(translators ...*i18n.Translator) *cobra.Command {
|
||||
tr := i18n.Default()
|
||||
if len(translators) > 0 && translators[0] != nil {
|
||||
tr = translators[0]
|
||||
}
|
||||
func NewConfigCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "config",
|
||||
Short: tr.T("cmd.config.short"),
|
||||
Short: "Manage gitlink-cli configuration",
|
||||
}
|
||||
cmd.AddCommand(newInitCmd(tr))
|
||||
cmd.AddCommand(newSetCmd(tr))
|
||||
cmd.AddCommand(newGetCmd(tr))
|
||||
cmd.AddCommand(newListCmd(tr))
|
||||
cmd.AddCommand(newInitCmd())
|
||||
cmd.AddCommand(newSetCmd())
|
||||
cmd.AddCommand(newGetCmd())
|
||||
cmd.AddCommand(newListCmd())
|
||||
return cmd
|
||||
}
|
||||
|
||||
func newInitCmd(translators ...*i18n.Translator) *cobra.Command {
|
||||
tr := i18n.Default()
|
||||
if len(translators) > 0 && translators[0] != nil {
|
||||
tr = translators[0]
|
||||
}
|
||||
func newInitCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "init",
|
||||
Short: tr.T("cmd.config.init.short"),
|
||||
Short: "Initialize configuration file",
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
cfg := internalConfig.DefaultConfig()
|
||||
if err := internalConfig.Save(cfg); err != nil {
|
||||
return errors.New(tr.Tf("error.config.save_failed", i18n.Args{"message": err.Error()}))
|
||||
return fmt.Errorf("failed to save config: %w", err)
|
||||
}
|
||||
_, err := fmt.Fprintln(cmd.OutOrStdout(), tr.Tf("success.config.initialized", i18n.Args{"path": internalConfig.ConfigPath()}))
|
||||
return err
|
||||
fmt.Printf("✓ Config initialized at %s\n", internalConfig.ConfigPath())
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func newSetCmd(translators ...*i18n.Translator) *cobra.Command {
|
||||
tr := i18n.Default()
|
||||
if len(translators) > 0 && translators[0] != nil {
|
||||
tr = translators[0]
|
||||
}
|
||||
func newSetCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "set <key> <value>",
|
||||
Short: tr.T("cmd.config.set.short"),
|
||||
Short: "Set a configuration value",
|
||||
Args: cobra.ExactArgs(2),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if err := internalConfig.Set(args[0], args[1]); err != nil {
|
||||
return err
|
||||
}
|
||||
_, err := fmt.Fprintln(cmd.OutOrStdout(), tr.Tf("success.config.set", i18n.Args{
|
||||
"key": args[0],
|
||||
"value": args[1],
|
||||
}))
|
||||
return err
|
||||
fmt.Printf("✓ %s = %s\n", args[0], args[1])
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func newGetCmd(translators ...*i18n.Translator) *cobra.Command {
|
||||
tr := i18n.Default()
|
||||
if len(translators) > 0 && translators[0] != nil {
|
||||
tr = translators[0]
|
||||
}
|
||||
func newGetCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "get <key>",
|
||||
Short: tr.T("cmd.config.get.short"),
|
||||
Short: "Get a configuration value",
|
||||
Args: cobra.ExactArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
val, err := internalConfig.Get(args[0])
|
||||
|
|
@ -82,49 +61,30 @@ func newGetCmd(translators ...*i18n.Translator) *cobra.Command {
|
|||
return err
|
||||
}
|
||||
if val == "" {
|
||||
_, err := fmt.Fprintf(cmd.OutOrStdout(), "%s: %s\n", args[0], tr.T("output.config.not_set"))
|
||||
return err
|
||||
fmt.Printf("%s: (not set)\n", args[0])
|
||||
} else {
|
||||
fmt.Printf("%s: %s\n", args[0], val)
|
||||
}
|
||||
_, err = fmt.Fprintf(cmd.OutOrStdout(), "%s: %s\n", args[0], val)
|
||||
return err
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func newListCmd(translators ...*i18n.Translator) *cobra.Command {
|
||||
tr := i18n.Default()
|
||||
if len(translators) > 0 && translators[0] != nil {
|
||||
tr = translators[0]
|
||||
}
|
||||
func newListCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "list",
|
||||
Short: tr.T("cmd.config.list.short"),
|
||||
Short: "List all configuration values",
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
cfg, err := internalConfig.Load()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
out := cmd.OutOrStdout()
|
||||
if _, err := fmt.Fprintf(out, "base_url: %s\n", cfg.BaseURL); err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := fmt.Fprintf(out, "default_format: %s\n", cfg.Format); err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := fmt.Fprintf(out, "editor: %s\n", cfg.Editor); err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := fmt.Fprintf(out, "pager: %s\n", cfg.Pager); err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := fmt.Fprintf(out, "lang: %s\n", cfg.Lang); err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := fmt.Fprintln(out); err != nil {
|
||||
return err
|
||||
}
|
||||
_, err = fmt.Fprintln(out, tr.Tf("output.config.file", i18n.Args{"path": internalConfig.ConfigPath()}))
|
||||
return err
|
||||
fmt.Printf("base_url: %s\n", cfg.BaseURL)
|
||||
fmt.Printf("default_format: %s\n", cfg.Format)
|
||||
fmt.Printf("editor: %s\n", cfg.Editor)
|
||||
fmt.Printf("pager: %s\n", cfg.Pager)
|
||||
fmt.Printf("\nConfig file: %s\n", internalConfig.ConfigPath())
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,217 +0,0 @@
|
|||
package config
|
||||
|
||||
import (
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
func TestNewConfigCmd(t *testing.T) {
|
||||
cmd := NewConfigCmd()
|
||||
if cmd.Use != "config" {
|
||||
t.Fatalf("Use = %q, want config", cmd.Use)
|
||||
}
|
||||
if cmd.Short == "" {
|
||||
t.Fatal("Short is empty")
|
||||
}
|
||||
|
||||
expectedSubs := map[string]bool{
|
||||
"init": false, "set <key> <value>": false, "get <key>": false, "list": false,
|
||||
}
|
||||
for _, sub := range cmd.Commands() {
|
||||
if _, ok := expectedSubs[sub.Use]; !ok {
|
||||
t.Fatalf("unexpected subcommand: %q", sub.Use)
|
||||
}
|
||||
if expectedSubs[sub.Use] {
|
||||
t.Fatalf("duplicate subcommand: %q", sub.Use)
|
||||
}
|
||||
expectedSubs[sub.Use] = true
|
||||
if sub.Short == "" {
|
||||
t.Fatalf("subcommand %q has empty Short", sub.Use)
|
||||
}
|
||||
}
|
||||
for name, found := range expectedSubs {
|
||||
if !found {
|
||||
t.Fatalf("missing subcommand: %q", name)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestSetCmdArgs(t *testing.T) {
|
||||
cmd := findSub(NewConfigCmd(), "set <key> <value>")
|
||||
if cmd == nil {
|
||||
t.Fatal("set subcommand not found")
|
||||
}
|
||||
if cmd.Args == nil {
|
||||
t.Fatal("set should require exact args")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetCmdArgs(t *testing.T) {
|
||||
cmd := findSub(NewConfigCmd(), "get <key>")
|
||||
if cmd == nil {
|
||||
t.Fatal("get subcommand not found")
|
||||
}
|
||||
if cmd.Args == nil {
|
||||
t.Fatal("get should require exact args")
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigInitRun(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
|
||||
cmd := findSub(NewConfigCmd(), "init")
|
||||
cmd.SetArgs([]string{})
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatalf("init error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigSetAndGet(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
|
||||
// Init first
|
||||
initCmd := findSub(NewConfigCmd(), "init")
|
||||
initCmd.SetArgs([]string{})
|
||||
if err := initCmd.Execute(); err != nil {
|
||||
t.Fatalf("init error: %v", err)
|
||||
}
|
||||
|
||||
// Set a value
|
||||
setCmd := findSub(NewConfigCmd(), "set <key> <value>")
|
||||
setCmd.SetArgs([]string{"base_url", "https://example.com"})
|
||||
if err := setCmd.Execute(); err != nil {
|
||||
t.Fatalf("set error: %v", err)
|
||||
}
|
||||
|
||||
// Get it back
|
||||
getCmd := findSub(NewConfigCmd(), "get <key>")
|
||||
getCmd.SetArgs([]string{"base_url"})
|
||||
if err := getCmd.Execute(); err != nil {
|
||||
t.Fatalf("get error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigGetNotSet(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
os.WriteFile(dir+"/config.yaml", []byte("base_url: https://example.com\n"), 0644)
|
||||
|
||||
getCmd := findSub(NewConfigCmd(), "get <key>")
|
||||
getCmd.SetArgs([]string{"editor"})
|
||||
if err := getCmd.Execute(); err != nil {
|
||||
t.Fatalf("get not-set error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigList(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
|
||||
initCmd := findSub(NewConfigCmd(), "init")
|
||||
initCmd.SetArgs([]string{})
|
||||
if err := initCmd.Execute(); err != nil {
|
||||
t.Fatalf("init error: %v", err)
|
||||
}
|
||||
|
||||
listCmd := findSub(NewConfigCmd(), "list")
|
||||
listCmd.SetArgs([]string{})
|
||||
if err := listCmd.Execute(); err != nil {
|
||||
t.Fatalf("list error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigInitRunE(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
|
||||
cmd := newInitCmd()
|
||||
if err := cmd.RunE(cmd, nil); err != nil {
|
||||
t.Fatalf("init RunE error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigSetRunE(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
|
||||
// Init first so config file exists
|
||||
initCmd := newInitCmd()
|
||||
if err := initCmd.RunE(initCmd, nil); err != nil {
|
||||
t.Fatalf("init error: %v", err)
|
||||
}
|
||||
|
||||
cmd := newSetCmd()
|
||||
if err := cmd.RunE(cmd, []string{"base_url", "https://example.com"}); err != nil {
|
||||
t.Fatalf("set RunE error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigSetRunENoConfig(t *testing.T) {
|
||||
// Set without init should still work — Load returns defaults, Save creates dir
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
cmd := newSetCmd()
|
||||
if err := cmd.RunE(cmd, []string{"base_url", "https://example.com"}); err != nil {
|
||||
t.Fatalf("set RunE error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigGetRunE(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
|
||||
initCmd := newInitCmd()
|
||||
initCmd.RunE(initCmd, nil)
|
||||
|
||||
cmd := newGetCmd()
|
||||
if err := cmd.RunE(cmd, []string{"base_url"}); err != nil {
|
||||
t.Fatalf("get RunE error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigGetRunENotSet(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
os.WriteFile(dir+"/config.yaml", []byte("base_url: https://example.com\n"), 0644)
|
||||
|
||||
cmd := newGetCmd()
|
||||
if err := cmd.RunE(cmd, []string{"editor"}); err != nil {
|
||||
t.Fatalf("get RunE not-set error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigListRunE(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
|
||||
initCmd := newInitCmd()
|
||||
initCmd.RunE(initCmd, nil)
|
||||
|
||||
cmd := newListCmd()
|
||||
if err := cmd.RunE(cmd, nil); err != nil {
|
||||
t.Fatalf("list RunE error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigListRunENoConfig(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("GITLINK_CONFIG_DIR", dir)
|
||||
// Don't init — Load returns defaults for missing file, so this should work
|
||||
cmd := newListCmd()
|
||||
if err := cmd.RunE(cmd, nil); err != nil {
|
||||
t.Fatalf("list RunE error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func findSub(cmd *cobra.Command, name string) *cobra.Command {
|
||||
for _, sub := range cmd.Commands() {
|
||||
if sub.Use == name {
|
||||
return sub
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
208
cmd/do.go
208
cmd/do.go
|
|
@ -1,208 +0,0 @@
|
|||
package cmd
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"os/exec"
|
||||
"strings"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
// NLCommand 自然语言命令路由
|
||||
// 用法: gitlink-cli do "列出issue" 或 gitlink-cli do wiki
|
||||
// 关键词匹配 → 推荐命令 + 显示参数 + 简短/完全示例
|
||||
// 输入模块名(如 wiki)→ 列出该模块全部命令
|
||||
|
||||
func newDoCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: `do "自然语言描述或模块名"`,
|
||||
Short: "Natural language command helper (e.g. do \"list issues\" or do wiki)",
|
||||
Long: `用自然语言描述你想做的事,自动匹配命令并显示参数。
|
||||
也可以直接输入模块名查看该模块全部命令。
|
||||
|
||||
示例:
|
||||
gitlink-cli do 列出issue # 匹配到 issue +list
|
||||
gitlink-cli do wiki # 列出 wiki 全部命令
|
||||
gitlink-cli do 创建标签 # 匹配到 label +create`,
|
||||
Args: cobra.MinimumNArgs(1),
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
input := strings.ToLower(strings.Join(args, " "))
|
||||
input = strings.TrimSpace(input)
|
||||
exePath, _ := os.Executable()
|
||||
|
||||
// 1. 先检查是否是模块名(如 wiki/issue/pr/label...)
|
||||
modules := []string{"wiki", "issue", "pr", "label", "notification", "snippet",
|
||||
"repo", "release", "branch", "member", "milestone", "webhook",
|
||||
"ci", "search", "org", "user", "compare", "workflow"}
|
||||
for _, mod := range modules {
|
||||
if input == mod {
|
||||
fmt.Printf("📦 %s 模块全部命令:\n", mod)
|
||||
fmt.Println(strings.Repeat("=", 50))
|
||||
helpCmd := exec.Command(exePath, mod, "--help")
|
||||
helpCmd.Stdout = os.Stdout
|
||||
helpCmd.Stderr = os.Stderr
|
||||
helpCmd.Run()
|
||||
fmt.Println(strings.Repeat("=", 50))
|
||||
fmt.Println("\n💡 选择一个命令运行,例如:")
|
||||
fmt.Printf(" gitlink-cli %s +list\n", mod)
|
||||
fmt.Printf(" gitlink-cli %s +list --owner ylly --repo gitlink-cli --format json (完全版)\n", mod)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// 2. 关键词匹配
|
||||
matched := matchNL(input)
|
||||
if matched == "" {
|
||||
fmt.Println("❌ 未识别。试试这些:")
|
||||
fmt.Println(" 输入模块名(wiki/issue/pr/label/notification/snippet/repo...)")
|
||||
fmt.Println(" 或描述操作(列出issue/创建标签/登录/搜索仓库...)")
|
||||
fmt.Println("\n示例:")
|
||||
fmt.Println(" gitlink-cli do wiki # 查看 wiki 全部命令")
|
||||
fmt.Println(" gitlink-cli do 列出issue # 匹配 issue +list")
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
parts := strings.Fields(matched)
|
||||
fmt.Printf("✅ 匹配到命令: %s\n\n", matched)
|
||||
|
||||
// 显示该命令的 --help
|
||||
if len(parts) >= 2 {
|
||||
group := parts[0]
|
||||
sub := parts[1]
|
||||
fmt.Println("📋 命令参数说明:")
|
||||
fmt.Println(strings.Repeat("-", 50))
|
||||
helpCmd := exec.Command(exePath, group, sub, "--help")
|
||||
helpCmd.Stdout = os.Stdout
|
||||
helpCmd.Stderr = os.Stderr
|
||||
helpCmd.Run()
|
||||
fmt.Println(strings.Repeat("-", 50))
|
||||
|
||||
// 显示简短版 + 完全版示例
|
||||
fmt.Println("\n💡 命令示例:")
|
||||
fmt.Printf(" 简短版(在自己的仓库目录里):\n")
|
||||
fmt.Printf(" gitlink-cli %s\n", matched)
|
||||
fmt.Printf(" 完全版(任何目录都能用):\n")
|
||||
fmt.Printf(" gitlink-cli %s --owner ylly --repo gitlink-cli --format json\n", matched)
|
||||
} else {
|
||||
// auth login / auth status 等无子命令的
|
||||
fmt.Printf("\n💡 运行:gitlink-cli %s\n", matched)
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// matchNL 关键词匹配自然语言 → 命令
|
||||
func matchNL(input string) string {
|
||||
type rule struct {
|
||||
keywords []string
|
||||
cmd string
|
||||
}
|
||||
rules := []rule{
|
||||
// Issue
|
||||
{[]string{"issue", "疑修", "问题", "list", "列", "查看"}, "issue +list"},
|
||||
{[]string{"issue", "create", "新建", "创建", "提"}, "issue +create"},
|
||||
{[]string{"issue", "view", "详情", "看"}, "issue +view"},
|
||||
{[]string{"issue", "close", "关闭"}, "issue +close"},
|
||||
{[]string{"issue", "update", "更新", "修改"}, "issue +update"},
|
||||
{[]string{"issue", "comment", "评论", "回复"}, "issue +comment"},
|
||||
{[]string{"issue", "batch", "批量", "关闭"}, "issue +batch-close"},
|
||||
{[]string{"issue", "assigners", "负责人", "分配", "候选"}, "issue +assigners"},
|
||||
{[]string{"issue", "authors", "作者"}, "issue +authors"},
|
||||
// PR
|
||||
{[]string{"pr", "pull", "合并请求", "merge", "list"}, "pr +list"},
|
||||
{[]string{"pr", "create", "新建", "提交"}, "pr +create"},
|
||||
{[]string{"pr", "view", "详情", "看"}, "pr +view"},
|
||||
{[]string{"pr", "merge", "合并"}, "pr +merge"},
|
||||
{[]string{"pr", "diff", "差异", "变更"}, "pr +diff"},
|
||||
{[]string{"pr", "files", "文件", "变更文件"}, "pr +files"},
|
||||
{[]string{"pr", "review", "审查", "review"}, "pr +review"},
|
||||
{[]string{"pr", "close", "关闭"}, "pr +close"},
|
||||
{[]string{"pr", "reopen", "重开", "重新打开"}, "pr +reopen"},
|
||||
// Label
|
||||
{[]string{"label", "tag", "标签", "list"}, "label +list"},
|
||||
{[]string{"label", "tag", "标签", "create", "新建", "创建"}, "label +create"},
|
||||
{[]string{"label", "tag", "标签", "update", "更新", "修改"}, "label +update"},
|
||||
{[]string{"label", "tag", "标签", "delete", "删除"}, "label +delete"},
|
||||
{[]string{"label", "tag", "标签", "batch", "批量"}, "label +batch-create"},
|
||||
// Wiki
|
||||
{[]string{"wiki", "文档", "知识库", "list"}, "wiki +list"},
|
||||
{[]string{"wiki", "文档", "create", "新建", "创建"}, "wiki +create"},
|
||||
{[]string{"wiki", "文档", "view", "查看"}, "wiki +view"},
|
||||
{[]string{"wiki", "文档", "update", "更新"}, "wiki +update"},
|
||||
{[]string{"wiki", "文档", "delete", "删除"}, "wiki +delete"},
|
||||
// Release
|
||||
{[]string{"release", "发布", "版本", "list"}, "release +list"},
|
||||
{[]string{"release", "发布", "create", "新建"}, "release +create"},
|
||||
{[]string{"release", "发布", "view", "查看"}, "release +view"},
|
||||
// Repo
|
||||
{[]string{"repo", "仓库", "info", "信息"}, "repo +info"},
|
||||
{[]string{"repo", "仓库", "create", "新建", "创建"}, "repo +create"},
|
||||
{[]string{"repo", "仓库", "readme"}, "repo +readme"},
|
||||
{[]string{"repo", "仓库", "fork", "复刻"}, "repo +fork"},
|
||||
{[]string{"repo", "仓库", "list", "列"}, "repo +list"},
|
||||
// Auth
|
||||
{[]string{"auth", "login", "登录", "认证"}, "auth login"},
|
||||
{[]string{"auth", "status", "状态"}, "auth status"},
|
||||
// Snippet
|
||||
{[]string{"snippet", "片段", "代码片段", "list"}, "snippet +list"},
|
||||
{[]string{"snippet", "片段", "代码片段", "create", "新建", "保存"}, "snippet +create"},
|
||||
{[]string{"snippet", "片段", "代码片段", "view", "查看"}, "snippet +view"},
|
||||
{[]string{"snippet", "片段", "代码片段", "delete", "删除"}, "snippet +delete"},
|
||||
// Notification
|
||||
{[]string{"notification", "通知", "消息", "list"}, "notification +list"},
|
||||
{[]string{"notification", "通知", "read", "已读"}, "notification +read"},
|
||||
{[]string{"notification", "通知", "delete", "删除"}, "notification +delete"},
|
||||
// Member
|
||||
{[]string{"member", "成员", "list"}, "member +list"},
|
||||
{[]string{"member", "成员", "add", "添加"}, "member +add"},
|
||||
{[]string{"member", "成员", "invite", "邀请"}, "member +invite-link"},
|
||||
// Branch
|
||||
{[]string{"branch", "分支", "list"}, "branch +list"},
|
||||
{[]string{"branch", "分支", "create", "新建"}, "branch +create"},
|
||||
// CI
|
||||
{[]string{"ci", "构建", "流水线", "list"}, "ci +list"},
|
||||
{[]string{"ci", "构建", "log", "日志"}, "ci +logs"},
|
||||
// Search
|
||||
{[]string{"search", "搜索", "查找", "repos"}, "search +repos"},
|
||||
{[]string{"search", "搜索", "查找", "user", "用户"}, "search +users"},
|
||||
// Milestone
|
||||
{[]string{"milestone", "里程碑", "list"}, "milestone +list"},
|
||||
{[]string{"milestone", "里程碑", "create", "新建"}, "milestone +create"},
|
||||
// Webhook
|
||||
{[]string{"webhook", "钩子", "list"}, "webhook +list"},
|
||||
{[]string{"webhook", "钩子", "create", "新建"}, "webhook +create"},
|
||||
}
|
||||
|
||||
bestMatch := ""
|
||||
bestScore := 0
|
||||
for _, r := range rules {
|
||||
score := 0
|
||||
for _, kw := range r.keywords {
|
||||
if strings.Contains(input, kw) {
|
||||
score++
|
||||
}
|
||||
}
|
||||
if score >= 2 && score > bestScore {
|
||||
bestScore = score
|
||||
bestMatch = r.cmd
|
||||
}
|
||||
}
|
||||
|
||||
// 降级:只匹配1个关键词
|
||||
if bestMatch == "" {
|
||||
for _, r := range rules {
|
||||
for _, kw := range r.keywords {
|
||||
if strings.Contains(input, kw) {
|
||||
bestMatch = r.cmd
|
||||
break
|
||||
}
|
||||
}
|
||||
if bestMatch != "" {
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return bestMatch
|
||||
}
|
||||
|
|
@ -1,319 +0,0 @@
|
|||
package doctor
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/url"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/cmd/cmdutil"
|
||||
internalAuth "github.com/gitlink-org/gitlink-cli/internal/auth"
|
||||
internalConfig "github.com/gitlink-org/gitlink-cli/internal/config"
|
||||
repoContext "github.com/gitlink-org/gitlink-cli/internal/context"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/i18n"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/output"
|
||||
)
|
||||
|
||||
const (
|
||||
statusOK = "ok"
|
||||
statusWarning = "warning"
|
||||
statusError = "error"
|
||||
statusSkipped = "skipped"
|
||||
)
|
||||
|
||||
var (
|
||||
loadConfig = internalConfig.Load
|
||||
loadToken = internalAuth.LoadToken
|
||||
getCurrentUser = internalAuth.GetCurrentUser
|
||||
resolveOwnerRepo = repoContext.ResolveOwnerRepo
|
||||
statFile = os.Stat
|
||||
lookupEnv = os.LookupEnv
|
||||
)
|
||||
|
||||
type Report struct {
|
||||
OK bool `json:"ok"`
|
||||
Summary Summary `json:"summary"`
|
||||
Checks []Check `json:"checks"`
|
||||
Actions []string `json:"actions,omitempty"`
|
||||
}
|
||||
|
||||
type Summary struct {
|
||||
OK int `json:"ok"`
|
||||
Warning int `json:"warning"`
|
||||
Error int `json:"error"`
|
||||
Skipped int `json:"skipped"`
|
||||
Total int `json:"total"`
|
||||
}
|
||||
|
||||
type Check struct {
|
||||
Name string `json:"name"`
|
||||
Status string `json:"status"`
|
||||
Message string `json:"message"`
|
||||
Suggestion string `json:"suggestion,omitempty"`
|
||||
Details map[string]interface{} `json:"details,omitempty"`
|
||||
}
|
||||
|
||||
func NewDoctorCmd(translators ...*i18n.Translator) *cobra.Command {
|
||||
tr := i18n.Default()
|
||||
if len(translators) > 0 && translators[0] != nil {
|
||||
tr = translators[0]
|
||||
}
|
||||
|
||||
var skipNetwork bool
|
||||
cmd := &cobra.Command{
|
||||
Use: "doctor",
|
||||
Short: tr.T("cmd.doctor.short"),
|
||||
Long: tr.T("cmd.doctor.long"),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
report := Run(skipNetwork, tr)
|
||||
return output.PrintTo(cmd.OutOrStdout(), output.SuccessEnvelope(report, nil), resolveFormat())
|
||||
},
|
||||
}
|
||||
cmd.Flags().BoolVar(&skipNetwork, "skip-network", false, tr.T("flag.doctor.skip_network"))
|
||||
return cmd
|
||||
}
|
||||
|
||||
func Run(skipNetwork bool, tr *i18n.Translator) Report {
|
||||
if tr == nil {
|
||||
tr = i18n.Default()
|
||||
}
|
||||
|
||||
checks := make([]Check, 0, 5)
|
||||
cfg, cfgErr := loadConfig()
|
||||
checks = append(checks, checkConfigFile(tr, cfgErr))
|
||||
checks = append(checks, checkConfigValues(tr, cfg, cfgErr))
|
||||
checks = append(checks, checkAuthToken(tr))
|
||||
checks = append(checks, checkRepoContext(tr))
|
||||
checks = append(checks, checkAuthenticatedUser(tr, skipNetwork, cfgErr))
|
||||
|
||||
report := Report{OK: true, Checks: checks}
|
||||
seenActions := map[string]bool{}
|
||||
for _, check := range checks {
|
||||
report.Summary.Total++
|
||||
switch check.Status {
|
||||
case statusOK:
|
||||
report.Summary.OK++
|
||||
case statusWarning:
|
||||
report.Summary.Warning++
|
||||
case statusError:
|
||||
report.OK = false
|
||||
report.Summary.Error++
|
||||
case statusSkipped:
|
||||
report.Summary.Skipped++
|
||||
}
|
||||
if check.Suggestion != "" && !seenActions[check.Suggestion] {
|
||||
report.Actions = append(report.Actions, check.Suggestion)
|
||||
seenActions[check.Suggestion] = true
|
||||
}
|
||||
}
|
||||
return report
|
||||
}
|
||||
|
||||
func checkConfigFile(tr *i18n.Translator, cfgErr error) Check {
|
||||
path := internalConfig.ConfigPath()
|
||||
info, err := statFile(path)
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return Check{
|
||||
Name: "config_file",
|
||||
Status: statusWarning,
|
||||
Message: tr.T("output.doctor.config_file.missing"),
|
||||
Suggestion: "gitlink-cli config init",
|
||||
Details: map[string]interface{}{"path": path},
|
||||
}
|
||||
}
|
||||
return Check{
|
||||
Name: "config_file",
|
||||
Status: statusError,
|
||||
Message: tr.Tf("output.doctor.config_file.unreadable", i18n.Args{"message": err.Error()}),
|
||||
Suggestion: tr.T("output.doctor.suggestion.check_config_permissions"),
|
||||
Details: map[string]interface{}{"path": path},
|
||||
}
|
||||
}
|
||||
if cfgErr != nil {
|
||||
return Check{
|
||||
Name: "config_file",
|
||||
Status: statusError,
|
||||
Message: tr.Tf("output.doctor.config_file.invalid", i18n.Args{"message": cfgErr.Error()}),
|
||||
Suggestion: tr.T("output.doctor.suggestion.fix_config_yaml"),
|
||||
Details: map[string]interface{}{"path": path},
|
||||
}
|
||||
}
|
||||
return Check{
|
||||
Name: "config_file",
|
||||
Status: statusOK,
|
||||
Message: tr.T("output.doctor.config_file.ok"),
|
||||
Details: map[string]interface{}{
|
||||
"path": path,
|
||||
"size": info.Size(),
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func checkConfigValues(tr *i18n.Translator, cfg *internalConfig.Config, cfgErr error) Check {
|
||||
if cfgErr != nil || cfg == nil {
|
||||
return Check{
|
||||
Name: "config_values",
|
||||
Status: statusSkipped,
|
||||
Message: tr.T("output.doctor.config_values.skipped"),
|
||||
Suggestion: tr.T("output.doctor.suggestion.fix_config_yaml"),
|
||||
}
|
||||
}
|
||||
|
||||
details := map[string]interface{}{
|
||||
"base_url": cfg.BaseURL,
|
||||
"default_format": cfg.Format,
|
||||
}
|
||||
if err := validateBaseURL(cfg.BaseURL); err != nil {
|
||||
return Check{
|
||||
Name: "config_values",
|
||||
Status: statusError,
|
||||
Message: tr.Tf("output.doctor.config_values.bad_base_url", i18n.Args{"message": err.Error()}),
|
||||
Suggestion: "gitlink-cli config set base_url https://www.gitlink.org.cn/api",
|
||||
Details: details,
|
||||
}
|
||||
}
|
||||
if !validFormat(cfg.Format) {
|
||||
return Check{
|
||||
Name: "config_values",
|
||||
Status: statusWarning,
|
||||
Message: tr.Tf("output.doctor.config_values.bad_format", i18n.Args{"format": cfg.Format}),
|
||||
Suggestion: "gitlink-cli config set default_format table",
|
||||
Details: details,
|
||||
}
|
||||
}
|
||||
return Check{
|
||||
Name: "config_values",
|
||||
Status: statusOK,
|
||||
Message: tr.T("output.doctor.config_values.ok"),
|
||||
Details: details,
|
||||
}
|
||||
}
|
||||
|
||||
func checkAuthToken(tr *i18n.Translator) Check {
|
||||
if token, ok := lookupEnv("GITLINK_TOKEN"); ok && strings.TrimSpace(token) != "" {
|
||||
return Check{
|
||||
Name: "auth_token",
|
||||
Status: statusOK,
|
||||
Message: tr.T("output.doctor.auth_token.env"),
|
||||
Details: map[string]interface{}{"source": "env"},
|
||||
}
|
||||
}
|
||||
token, err := loadToken()
|
||||
if err != nil || strings.TrimSpace(token) == "" {
|
||||
return Check{
|
||||
Name: "auth_token",
|
||||
Status: statusWarning,
|
||||
Message: tr.T("output.doctor.auth_token.missing"),
|
||||
Suggestion: "gitlink-cli auth login",
|
||||
}
|
||||
}
|
||||
source := "token"
|
||||
if strings.HasPrefix(token, "cookie:") {
|
||||
source = "cookie"
|
||||
}
|
||||
return Check{
|
||||
Name: "auth_token",
|
||||
Status: statusOK,
|
||||
Message: tr.T("output.doctor.auth_token.stored"),
|
||||
Details: map[string]interface{}{"source": source},
|
||||
}
|
||||
}
|
||||
|
||||
func checkRepoContext(tr *i18n.Translator) Check {
|
||||
owner, repo, err := resolveOwnerRepo(cmdutil.Owner, cmdutil.Repo)
|
||||
if err != nil {
|
||||
return Check{
|
||||
Name: "repo_context",
|
||||
Status: statusWarning,
|
||||
Message: tr.Tf("output.doctor.repo_context.missing", i18n.Args{"message": err.Error()}),
|
||||
Suggestion: tr.T("output.doctor.suggestion.pass_owner_repo"),
|
||||
}
|
||||
}
|
||||
return Check{
|
||||
Name: "repo_context",
|
||||
Status: statusOK,
|
||||
Message: tr.Tf("output.doctor.repo_context.ok", i18n.Args{"owner": owner, "repo": repo}),
|
||||
Details: map[string]interface{}{
|
||||
"owner": owner,
|
||||
"repo": repo,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func checkAuthenticatedUser(tr *i18n.Translator, skipNetwork bool, cfgErr error) Check {
|
||||
if skipNetwork {
|
||||
return Check{
|
||||
Name: "api_auth",
|
||||
Status: statusSkipped,
|
||||
Message: tr.T("output.doctor.api_auth.skipped"),
|
||||
}
|
||||
}
|
||||
if cfgErr != nil {
|
||||
return Check{
|
||||
Name: "api_auth",
|
||||
Status: statusSkipped,
|
||||
Message: tr.T("output.doctor.api_auth.config_skipped"),
|
||||
Suggestion: tr.T("output.doctor.suggestion.fix_config_yaml"),
|
||||
}
|
||||
}
|
||||
|
||||
user, err := getCurrentUser()
|
||||
if err != nil {
|
||||
return Check{
|
||||
Name: "api_auth",
|
||||
Status: statusError,
|
||||
Message: tr.Tf("output.doctor.api_auth.failed", i18n.Args{"message": err.Error()}),
|
||||
Suggestion: "gitlink-cli auth login",
|
||||
}
|
||||
}
|
||||
login, _ := user["login"].(string)
|
||||
if login == "" {
|
||||
return Check{
|
||||
Name: "api_auth",
|
||||
Status: statusWarning,
|
||||
Message: tr.T("output.doctor.api_auth.no_login"),
|
||||
Suggestion: tr.T("output.doctor.suggestion.check_token"),
|
||||
}
|
||||
}
|
||||
return Check{
|
||||
Name: "api_auth",
|
||||
Status: statusOK,
|
||||
Message: tr.Tf("output.doctor.api_auth.ok", i18n.Args{"login": login}),
|
||||
Details: map[string]interface{}{
|
||||
"login": login,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func validateBaseURL(value string) error {
|
||||
u, err := url.Parse(value)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if u.Scheme != "http" && u.Scheme != "https" {
|
||||
return fmt.Errorf("scheme must be http or https")
|
||||
}
|
||||
if u.Host == "" {
|
||||
return fmt.Errorf("host is required")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func validFormat(value string) bool {
|
||||
switch value {
|
||||
case "json", "table", "yaml":
|
||||
return true
|
||||
default:
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
func resolveFormat() string {
|
||||
if cmdutil.Format != "" {
|
||||
return cmdutil.Format
|
||||
}
|
||||
return "json"
|
||||
}
|
||||
|
|
@ -1,200 +0,0 @@
|
|||
package doctor
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/cmd/cmdutil"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/i18n"
|
||||
)
|
||||
|
||||
func TestDoctorSkipNetworkReportsLocalChecks(t *testing.T) {
|
||||
withDoctorTestState(t)
|
||||
writeConfig(t, "base_url: https://www.gitlink.org.cn/api\ndefault_format: json\n")
|
||||
t.Setenv("GITLINK_TOKEN", "secret-token")
|
||||
resolveOwnerRepo = func(owner, repo string) (string, string, error) {
|
||||
return "Gitlink", "gitlink-cli", nil
|
||||
}
|
||||
|
||||
report := Run(true, i18n.Default())
|
||||
if !report.OK {
|
||||
t.Fatalf("expected report OK, got %+v", report)
|
||||
}
|
||||
assertCheck(t, report, "config_file", statusOK)
|
||||
assertCheck(t, report, "config_values", statusOK)
|
||||
assertCheck(t, report, "auth_token", statusOK)
|
||||
assertCheck(t, report, "repo_context", statusOK)
|
||||
assertCheck(t, report, "api_auth", statusSkipped)
|
||||
if report.Summary.Total != 5 {
|
||||
t.Fatalf("summary total = %d, want 5", report.Summary.Total)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorInvalidConfigDoesNotPanic(t *testing.T) {
|
||||
withDoctorTestState(t)
|
||||
writeConfig(t, "base_url: [broken\n")
|
||||
resolveOwnerRepo = func(owner, repo string) (string, string, error) {
|
||||
return "Gitlink", "gitlink-cli", nil
|
||||
}
|
||||
|
||||
report := Run(true, i18n.Default())
|
||||
if report.OK {
|
||||
t.Fatalf("expected report not OK, got %+v", report)
|
||||
}
|
||||
assertCheck(t, report, "config_file", statusError)
|
||||
assertCheck(t, report, "config_values", statusSkipped)
|
||||
}
|
||||
|
||||
func TestDoctorInvalidBaseURL(t *testing.T) {
|
||||
withDoctorTestState(t)
|
||||
writeConfig(t, "base_url: gitlink.local/api\ndefault_format: table\n")
|
||||
resolveOwnerRepo = func(owner, repo string) (string, string, error) {
|
||||
return "Gitlink", "gitlink-cli", nil
|
||||
}
|
||||
|
||||
report := Run(true, i18n.Default())
|
||||
if report.OK {
|
||||
t.Fatalf("expected invalid base_url to mark report not OK")
|
||||
}
|
||||
check := assertCheck(t, report, "config_values", statusError)
|
||||
if check.Suggestion == "" {
|
||||
t.Fatalf("expected config_values suggestion")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorMissingRepoContextIsWarning(t *testing.T) {
|
||||
withDoctorTestState(t)
|
||||
writeConfig(t, "base_url: https://www.gitlink.org.cn/api\ndefault_format: table\n")
|
||||
resolveOwnerRepo = func(owner, repo string) (string, string, error) {
|
||||
return "", "", errors.New("no origin remote")
|
||||
}
|
||||
|
||||
report := Run(true, i18n.Default())
|
||||
assertCheck(t, report, "auth_token", statusWarning)
|
||||
check := assertCheck(t, report, "repo_context", statusWarning)
|
||||
if check.Suggestion == "" {
|
||||
t.Fatalf("expected repo_context suggestion")
|
||||
}
|
||||
if !report.OK {
|
||||
t.Fatalf("warnings should not make report fail: %+v", report)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorNetworkCheckCanSucceed(t *testing.T) {
|
||||
withDoctorTestState(t)
|
||||
writeConfig(t, "base_url: https://www.gitlink.org.cn/api\ndefault_format: table\n")
|
||||
resolveOwnerRepo = func(owner, repo string) (string, string, error) {
|
||||
return "Gitlink", "gitlink-cli", nil
|
||||
}
|
||||
getCurrentUser = func() (map[string]interface{}, error) {
|
||||
return map[string]interface{}{"login": "Mengz"}, nil
|
||||
}
|
||||
|
||||
report := Run(false, i18n.Default())
|
||||
assertCheck(t, report, "api_auth", statusOK)
|
||||
if !report.OK {
|
||||
t.Fatalf("expected report OK, got %+v", report)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorCommandPrintsJSONEnvelope(t *testing.T) {
|
||||
withDoctorTestState(t)
|
||||
writeConfig(t, "base_url: https://www.gitlink.org.cn/api\ndefault_format: json\n")
|
||||
resolveOwnerRepo = func(owner, repo string) (string, string, error) {
|
||||
return "Gitlink", "gitlink-cli", nil
|
||||
}
|
||||
|
||||
cmd := NewDoctorCmd(i18n.Default())
|
||||
cmd.SetArgs([]string{"--skip-network"})
|
||||
var out bytes.Buffer
|
||||
cmd.SetOut(&out)
|
||||
if err := cmd.Execute(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var env struct {
|
||||
OK bool `json:"ok"`
|
||||
Data json.RawMessage `json:"data"`
|
||||
}
|
||||
if err := json.Unmarshal(out.Bytes(), &env); err != nil {
|
||||
t.Fatalf("invalid JSON output: %v\n%s", err, out.String())
|
||||
}
|
||||
if !env.OK || len(env.Data) == 0 {
|
||||
t.Fatalf("unexpected envelope: %+v", env)
|
||||
}
|
||||
}
|
||||
|
||||
func withDoctorTestState(t *testing.T) {
|
||||
t.Helper()
|
||||
|
||||
oldLoadConfig := loadConfig
|
||||
oldLoadToken := loadToken
|
||||
oldGetCurrentUser := getCurrentUser
|
||||
oldResolveOwnerRepo := resolveOwnerRepo
|
||||
oldStatFile := statFile
|
||||
oldLookupEnv := lookupEnv
|
||||
oldFormat := cmdutil.Format
|
||||
oldOwner := cmdutil.Owner
|
||||
oldRepo := cmdutil.Repo
|
||||
|
||||
t.Setenv("GITLINK_CONFIG_DIR", t.TempDir())
|
||||
t.Setenv("GITLINK_TOKEN", "")
|
||||
cmdutil.Format = "json"
|
||||
cmdutil.Owner = ""
|
||||
cmdutil.Repo = ""
|
||||
loadConfig = oldLoadConfig
|
||||
loadToken = func() (string, error) { return "", os.ErrNotExist }
|
||||
getCurrentUser = func() (map[string]interface{}, error) {
|
||||
return nil, errors.New("unexpected network call")
|
||||
}
|
||||
resolveOwnerRepo = oldResolveOwnerRepo
|
||||
statFile = oldStatFile
|
||||
lookupEnv = func(key string) (string, bool) {
|
||||
if key == "GITLINK_TOKEN" {
|
||||
value := os.Getenv(key)
|
||||
return value, value != ""
|
||||
}
|
||||
return os.LookupEnv(key)
|
||||
}
|
||||
|
||||
t.Cleanup(func() {
|
||||
loadConfig = oldLoadConfig
|
||||
loadToken = oldLoadToken
|
||||
getCurrentUser = oldGetCurrentUser
|
||||
resolveOwnerRepo = oldResolveOwnerRepo
|
||||
statFile = oldStatFile
|
||||
lookupEnv = oldLookupEnv
|
||||
cmdutil.Format = oldFormat
|
||||
cmdutil.Owner = oldOwner
|
||||
cmdutil.Repo = oldRepo
|
||||
})
|
||||
}
|
||||
|
||||
func writeConfig(t *testing.T, content string) {
|
||||
t.Helper()
|
||||
dir := os.Getenv("GITLINK_CONFIG_DIR")
|
||||
if err := os.MkdirAll(dir, 0700); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(dir, "config.yaml"), []byte(content), 0600); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
||||
func assertCheck(t *testing.T, report Report, name, status string) Check {
|
||||
t.Helper()
|
||||
for _, check := range report.Checks {
|
||||
if check.Name == name {
|
||||
if check.Status != status {
|
||||
t.Fatalf("%s status = %s, want %s; check=%+v", name, check.Status, status, check)
|
||||
}
|
||||
return check
|
||||
}
|
||||
}
|
||||
t.Fatalf("missing check %q in %+v", name, report.Checks)
|
||||
return Check{}
|
||||
}
|
||||
|
|
@ -1,90 +0,0 @@
|
|||
package cmd
|
||||
|
||||
import (
|
||||
"strings"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
internalConfig "github.com/gitlink-org/gitlink-cli/internal/config"
|
||||
)
|
||||
|
||||
// expandAlias rewrites args when the first positional token names a saved alias.
|
||||
// Built-in commands always take precedence, so an alias can never shadow a real
|
||||
// command; a colliding alias simply never expands.
|
||||
func expandAlias(root *cobra.Command, args []string) ([]string, bool) {
|
||||
if len(args) == 0 {
|
||||
return args, false
|
||||
}
|
||||
name := args[0]
|
||||
if name == "" || strings.HasPrefix(name, "-") {
|
||||
return args, false
|
||||
}
|
||||
if isBuiltinCommand(root, name) {
|
||||
return args, false
|
||||
}
|
||||
|
||||
cfg, err := internalConfig.Load()
|
||||
if err != nil {
|
||||
return args, false
|
||||
}
|
||||
expansion, ok := cfg.Aliases[name]
|
||||
if !ok {
|
||||
return args, false
|
||||
}
|
||||
parts := splitArgs(expansion)
|
||||
if len(parts) == 0 {
|
||||
return args, false
|
||||
}
|
||||
return append(parts, args[1:]...), true
|
||||
}
|
||||
|
||||
func isBuiltinCommand(root *cobra.Command, name string) bool {
|
||||
for _, c := range root.Commands() {
|
||||
if c.Name() == name {
|
||||
return true
|
||||
}
|
||||
for _, alias := range c.Aliases {
|
||||
if alias == name {
|
||||
return true
|
||||
}
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// splitArgs breaks an alias expansion into argv tokens, honoring single and
|
||||
// double quotes so expansions can carry multi-word flag values.
|
||||
func splitArgs(s string) []string {
|
||||
var args []string
|
||||
var buf strings.Builder
|
||||
inWord := false
|
||||
var quote rune
|
||||
|
||||
for _, r := range s {
|
||||
switch {
|
||||
case quote != 0:
|
||||
if r == quote {
|
||||
quote = 0
|
||||
} else {
|
||||
buf.WriteRune(r)
|
||||
}
|
||||
inWord = true
|
||||
case r == '\'' || r == '"':
|
||||
quote = r
|
||||
inWord = true
|
||||
case r == ' ' || r == '\t' || r == '\n':
|
||||
if inWord {
|
||||
args = append(args, buf.String())
|
||||
buf.Reset()
|
||||
inWord = false
|
||||
}
|
||||
default:
|
||||
buf.WriteRune(r)
|
||||
inWord = true
|
||||
}
|
||||
}
|
||||
if inWord {
|
||||
args = append(args, buf.String())
|
||||
}
|
||||
return args
|
||||
}
|
||||
|
|
@ -1,68 +0,0 @@
|
|||
package cmd
|
||||
|
||||
import (
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
internalConfig "github.com/gitlink-org/gitlink-cli/internal/config"
|
||||
)
|
||||
|
||||
func TestSplitArgs(t *testing.T) {
|
||||
cases := []struct {
|
||||
in string
|
||||
want []string
|
||||
}{
|
||||
{"", nil},
|
||||
{"pr +view", []string{"pr", "+view"}},
|
||||
{" issue +list ", []string{"issue", "+list"}},
|
||||
{`pr +view --title "needs review"`, []string{"pr", "+view", "--title", "needs review"}},
|
||||
{`repo +create --name 'my repo'`, []string{"repo", "+create", "--name", "my repo"}},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
if got := splitArgs(tc.in); !reflect.DeepEqual(got, tc.want) {
|
||||
t.Fatalf("splitArgs(%q) = %#v, want %#v", tc.in, got, tc.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestExpandAlias(t *testing.T) {
|
||||
t.Setenv("GITLINK_CONFIG_DIR", t.TempDir())
|
||||
|
||||
cfg := internalConfig.DefaultConfig()
|
||||
cfg.Aliases = map[string]string{
|
||||
"co": "pr +view",
|
||||
"config": "should never expand",
|
||||
}
|
||||
if err := internalConfig.Save(cfg); err != nil {
|
||||
t.Fatalf("Save error: %v", err)
|
||||
}
|
||||
|
||||
root := &cobra.Command{Use: "gitlink-cli"}
|
||||
root.AddCommand(&cobra.Command{Use: "config"})
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
args []string
|
||||
want []string
|
||||
expand bool
|
||||
}{
|
||||
{"alias match", []string{"co", "42"}, []string{"pr", "+view", "42"}, true},
|
||||
{"builtin wins", []string{"config", "list"}, nil, false},
|
||||
{"flag first", []string{"--lang", "zh-CN"}, nil, false},
|
||||
{"unknown token", []string{"nope"}, nil, false},
|
||||
{"empty args", nil, nil, false},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
got, ok := expandAlias(root, tc.args)
|
||||
if ok != tc.expand {
|
||||
t.Fatalf("expandAlias ok = %v, want %v", ok, tc.expand)
|
||||
}
|
||||
if tc.expand && !reflect.DeepEqual(got, tc.want) {
|
||||
t.Fatalf("expandAlias = %#v, want %#v", got, tc.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts"
|
||||
)
|
||||
|
||||
// TestAllCommandsExecuteWithoutPanic 验证所有注册的命令都能安全执行:
|
||||
// 不 panic、恢复 stdout、且产生输出或合理的错误。
|
||||
// 这是回归测试,防止之前 "选择命令后无输出" 的 nil-Client panic 复发。
|
||||
func TestAllCommandsExecuteWithoutPanic(t *testing.T) {
|
||||
all := shortcuts.GetAllShortcuts()
|
||||
if len(all) == 0 {
|
||||
t.Fatal("GetAllShortcuts returned empty registry")
|
||||
}
|
||||
|
||||
exec := &Executor{}
|
||||
totalCommands := 0
|
||||
silentFailures := 0
|
||||
|
||||
for group, shortcuts := range all {
|
||||
for _, s := range shortcuts {
|
||||
if s.Run == nil {
|
||||
continue
|
||||
}
|
||||
totalCommands++
|
||||
// 用空参数执行;需要 owner/repo/必填参数的命令会返回错误,这是正常的
|
||||
out, err := exec.Execute(s, map[string]string{})
|
||||
|
||||
// 断言1:不能既无输出又无错误(静默失败)
|
||||
if strings.TrimSpace(out) == "" && err == nil {
|
||||
silentFailures++
|
||||
t.Errorf("[%s +%s] 静默失败:无输出且无错误", group, s.Name)
|
||||
}
|
||||
|
||||
// 断言2:错误信息不应包含 "panic"(说明 recover 被触发,命令有 bug)
|
||||
if err != nil && strings.Contains(err.Error(), "panic") {
|
||||
t.Errorf("[%s +%s] 命令 panic: %v", group, s.Name, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
t.Logf("测试了 %d 个命令,%d 个静默失败", totalCommands, silentFailures)
|
||||
if totalCommands < 50 {
|
||||
t.Errorf("命令总数 %d 偏少,预期至少 50 个", totalCommands)
|
||||
}
|
||||
}
|
||||
|
||||
// TestAllCommandsHaveMetadata 验证所有命令都有名称、描述和 Run 函数。
|
||||
func TestAllCommandsHaveMetadata(t *testing.T) {
|
||||
all := shortcuts.GetAllShortcuts()
|
||||
for group, shortcuts := range all {
|
||||
if len(shortcuts) == 0 {
|
||||
t.Errorf("命令组 %q 没有任何子命令", group)
|
||||
}
|
||||
for _, s := range shortcuts {
|
||||
if s.Name == "" {
|
||||
t.Errorf("[%s] 有命令名称为空", group)
|
||||
}
|
||||
if s.Description == "" {
|
||||
t.Errorf("[%s +%s] 描述为空", group, s.Name)
|
||||
}
|
||||
if s.Run == nil {
|
||||
t.Errorf("[%s +%s] Run 函数为空", group, s.Name)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts"
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
|
||||
)
|
||||
|
||||
// TestE2E_ExecutingRealCommandProducesOutput is an end-to-end regression for
|
||||
// "selecting a command shows no output". It drives the real shortcut registry
|
||||
// (repo +list) through the executor and asserts that Execute returns either
|
||||
// captured stdout OR a non-nil error — never both empty, which is what left
|
||||
// the REPL silent before the RuntimeContext fix.
|
||||
func TestE2E_ExecutingRealCommandProducesOutput(t *testing.T) {
|
||||
all := shortcuts.GetAllShortcuts()
|
||||
s, ok := findShortcut(all, "repo", "list")
|
||||
if !ok {
|
||||
t.Fatal("repo +list not found in registry")
|
||||
}
|
||||
if s.Run == nil {
|
||||
t.Fatal("repo +list has no Run function")
|
||||
}
|
||||
|
||||
exec := &Executor{}
|
||||
// repo +list needs an owner; without --owner it tries git remote detection.
|
||||
// Either way the executor must return something (output or error), not hang.
|
||||
out, err := exec.Execute(s, map[string]string{})
|
||||
|
||||
// The contract: Execute never returns (empty, nil) for a real command —
|
||||
// either it produced output, or it returned an error explaining the failure.
|
||||
if out == "" && err == nil {
|
||||
t.Fatal("Execute returned empty output AND nil error — REPL would show nothing (regression)")
|
||||
}
|
||||
|
||||
// A non-empty result (output or error message) proves the command actually
|
||||
// ran through a properly-initialized RuntimeContext instead of panicking.
|
||||
t.Logf("output=%q err=%v", out, err)
|
||||
_ = common.RuntimeContext{} // keep import
|
||||
_ = strings.TrimSpace
|
||||
}
|
||||
|
|
@ -0,0 +1,398 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/internal/client"
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
|
||||
)
|
||||
|
||||
// Executor runs shortcut commands and captures their stdout output.
|
||||
type Executor struct{}
|
||||
|
||||
// Execute runs the given shortcut with the provided arguments, capturing
|
||||
// anything written to os.Stdout during execution and returning it as a string.
|
||||
//
|
||||
// It builds the RuntimeContext via common.NewRuntimeContext so that Client,
|
||||
// Format, Owner and Repo are properly initialized — a bare
|
||||
// `&RuntimeContext{Args: args}` would leave Client nil and panic as soon as a
|
||||
// command calls ctx.CallAPI. A deferred recover guards against panics raised
|
||||
// inside the command so the REPL is never left with stdout pointing at a
|
||||
// closed pipe.
|
||||
func (e *Executor) Execute(s *common.Shortcut, args map[string]string) (output string, err error) {
|
||||
// Guard against panics inside the command: always restore stdout even if
|
||||
// s.Run panics, and surface the panic as a regular error so the REPL can
|
||||
// display it instead of hanging with a corrupted stdout.
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
output = ""
|
||||
err = fmt.Errorf("command panicked: %v", r)
|
||||
}
|
||||
}()
|
||||
|
||||
// Save original stdout
|
||||
oldStdout := os.Stdout
|
||||
|
||||
// Create a pipe: writes go to w, reads come from r
|
||||
r, w, perr := os.Pipe()
|
||||
if perr != nil {
|
||||
return "", fmt.Errorf("failed to create pipe: %w", perr)
|
||||
}
|
||||
|
||||
// Redirect stdout to the write end of the pipe
|
||||
os.Stdout = w
|
||||
|
||||
// Channel to signal that the goroutine has finished reading
|
||||
done := make(chan struct{})
|
||||
var buf bytes.Buffer
|
||||
|
||||
// Read from the pipe in a goroutine so that writes don't block
|
||||
go func() {
|
||||
io.Copy(&buf, r)
|
||||
close(done)
|
||||
}()
|
||||
|
||||
// Build a fully-initialized context (Client/Format/Owner/Repo).
|
||||
ctx, cerr := common.NewRuntimeContext(args)
|
||||
if cerr != nil {
|
||||
// Restore stdout and drain the pipe before returning.
|
||||
os.Stdout = oldStdout
|
||||
w.Close()
|
||||
<-done
|
||||
return "", fmt.Errorf("failed to initialize runtime context: %w", cerr)
|
||||
}
|
||||
|
||||
// Execute the shortcut's Run function. Recover protects the path so that
|
||||
// a panic still leaves the deferred cleanup below runnable.
|
||||
runErr := safeRun(s, ctx)
|
||||
|
||||
// Close the writer to signal EOF to the reader goroutine, wait for it to
|
||||
// finish copying into the buffer, then restore stdout.
|
||||
w.Close()
|
||||
<-done
|
||||
os.Stdout = oldStdout
|
||||
|
||||
return buf.String(), runErr
|
||||
}
|
||||
|
||||
// safeRun invokes a shortcut's Run function and converts any panic into an
|
||||
// error, so a panicking command cannot crash the executor goroutine or leave
|
||||
// os.Stdout redirected at a closed pipe.
|
||||
func safeRun(s *common.Shortcut, ctx *common.RuntimeContext) (err error) {
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
err = fmt.Errorf("command panicked: %v", r)
|
||||
}
|
||||
}()
|
||||
return s.Run(ctx)
|
||||
}
|
||||
|
||||
// parseDirectCommand parses a direct command string like "issue +list --state open"
|
||||
// into its components: group, cmd (without +), flagStr, and whether parsing succeeded.
|
||||
func parseDirectCommand(input string) (group, cmd, flagStr string, ok bool) {
|
||||
input = strings.TrimSpace(input)
|
||||
if input == "" {
|
||||
return "", "", "", false
|
||||
}
|
||||
|
||||
parts := strings.Fields(input)
|
||||
if len(parts) < 2 {
|
||||
return "", "", "", false
|
||||
}
|
||||
|
||||
group = parts[0]
|
||||
rawCmd := parts[1]
|
||||
|
||||
if !strings.HasPrefix(rawCmd, "+") {
|
||||
return "", "", "", false
|
||||
}
|
||||
cmd = strings.TrimPrefix(rawCmd, "+")
|
||||
|
||||
if len(parts) > 2 {
|
||||
flagStr = strings.Join(parts[2:], " ")
|
||||
}
|
||||
|
||||
return group, cmd, flagStr, true
|
||||
}
|
||||
|
||||
// parseFlagString parses a flag string like "--title hello -n 42" into a map.
|
||||
// shortMap is used to expand short flag names to their long equivalents.
|
||||
func parseFlagString(flagStr string, shortMap map[string]string) map[string]string {
|
||||
result := make(map[string]string)
|
||||
|
||||
if flagStr == "" {
|
||||
return result
|
||||
}
|
||||
|
||||
parts := strings.Fields(flagStr)
|
||||
|
||||
for i := 0; i < len(parts); i++ {
|
||||
part := parts[i]
|
||||
|
||||
if strings.HasPrefix(part, "--") {
|
||||
// Long flag
|
||||
flagPart := strings.TrimPrefix(part, "--")
|
||||
|
||||
if strings.Contains(flagPart, "=") {
|
||||
// --flag=value format
|
||||
kv := strings.SplitN(flagPart, "=", 2)
|
||||
result[kv[0]] = kv[1]
|
||||
} else if i+1 < len(parts) && !strings.HasPrefix(parts[i+1], "-") {
|
||||
// --flag value format
|
||||
result[flagPart] = parts[i+1]
|
||||
i++
|
||||
} else {
|
||||
// --flag without value (boolean-like)
|
||||
result[flagPart] = "true"
|
||||
}
|
||||
} else if strings.HasPrefix(part, "-") && len(part) > 1 {
|
||||
// Short flag
|
||||
shortName := strings.TrimPrefix(part, "-")
|
||||
|
||||
// Expand short name to long name if mapping exists
|
||||
longName := shortName
|
||||
if mapped, ok := shortMap[shortName]; ok {
|
||||
longName = mapped
|
||||
}
|
||||
|
||||
if i+1 < len(parts) && !strings.HasPrefix(parts[i+1], "-") {
|
||||
result[longName] = parts[i+1]
|
||||
i++
|
||||
} else {
|
||||
result[longName] = "true"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return result
|
||||
}
|
||||
|
||||
// findShortcut looks up a shortcut by group and command name in the registry.
|
||||
func findShortcut(all map[string][]*common.Shortcut, group, cmd string) (*common.Shortcut, bool) {
|
||||
shortcuts, ok := all[group]
|
||||
if !ok {
|
||||
return nil, false
|
||||
}
|
||||
|
||||
for _, s := range shortcuts {
|
||||
if s.Name == cmd {
|
||||
return s, true
|
||||
}
|
||||
}
|
||||
|
||||
return nil, false
|
||||
}
|
||||
|
||||
// buildShortMap creates a mapping from short flag names to long flag names.
|
||||
func buildShortMap(s *common.Shortcut) map[string]string {
|
||||
m := make(map[string]string)
|
||||
for _, f := range s.Flags {
|
||||
if f.Short != "" {
|
||||
m[f.Short] = f.Name
|
||||
}
|
||||
}
|
||||
return m
|
||||
}
|
||||
|
||||
// missingRequiredFlags returns the names (with -- prefix) of flags that are
|
||||
// marked as required but not present in args.
|
||||
func missingRequiredFlags(s *common.Shortcut, args map[string]string) []string {
|
||||
var missing []string
|
||||
for _, f := range s.Flags {
|
||||
if f.Required {
|
||||
if _, ok := args[f.Name]; !ok {
|
||||
missing = append(missing, "--"+f.Name)
|
||||
}
|
||||
}
|
||||
}
|
||||
return missing
|
||||
}
|
||||
|
||||
// commandSuggestions maps (group, command) to command-specific fix suggestions shown
|
||||
// in the interactive REPL when a command fails with an API error.
|
||||
var commandSuggestions = map[string]map[string]string{
|
||||
"ci": {
|
||||
"builds": "请确认仓库已启用 CI 引擎(gitlink ci +enable),且存在构建记录",
|
||||
"runs": "请确认仓库已启用 CI 引擎,且存在运行记录",
|
||||
"run-results": "请确认仓库已启用 CI 引擎,且存在运行结果",
|
||||
"logs": "请确认构建编号正确且构建已完成",
|
||||
"restart": "请确认构建编号正确且状态允许重新构建",
|
||||
"stop": "请确认构建编号正确且构建处于运行中",
|
||||
"pipelines": "请确认仓库已配置 CI 流水线模板",
|
||||
"run-pipeline": "请确认流水线名称正确且仓库已启用 CI 引擎",
|
||||
"pipeline-detail": "请确认流水线 ID 正确",
|
||||
"delete-pipeline": "请确认流水线 ID 正确",
|
||||
"disable": "仓库可能已禁用 CI,无需重复操作",
|
||||
"enable": "仓库可能已启用 CI,无需重复操作",
|
||||
"run-log": "请确认运行 ID 正确且运行已完成",
|
||||
},
|
||||
"issue": {
|
||||
"list": "请确认 owner/repo 参数正确",
|
||||
"create": "请确认标题和必填参数已填写",
|
||||
"view": "请确认 Issue 编号正确",
|
||||
"update": "请确认 Issue 编号和更新参数正确",
|
||||
"close": "请确认 Issue 编号正确,且你有关闭权限",
|
||||
"delete": "请确认 Issue 编号正确,此操作不可恢复",
|
||||
"comment": "请确认 Issue 编号正确且评论内容不为空",
|
||||
"comments": "请确认 Issue 编号正确",
|
||||
"update-comment": "请确认评论 ID 正确",
|
||||
"delete-comment": "请确认评论 ID 正确",
|
||||
"reply-comment": "请确认评论 ID 正确",
|
||||
"batch-close": "请确认 Issue 编号正确,且你有批量关闭权限",
|
||||
"batch-update": "请确认 Issue 编号和更新参数正确",
|
||||
"batch-destroy": "请确认 Issue 编号正确,此操作不可恢复",
|
||||
},
|
||||
"pr": {
|
||||
"list": "请确认 owner/repo 参数正确",
|
||||
"create": "请确认源分支和目标分支正确",
|
||||
"view": "请确认 PR 编号正确",
|
||||
"merge": "请确认 PR 已通过 CI 检查且无合并冲突",
|
||||
"close": "请确认 PR 编号正确",
|
||||
"reopen": "请确认 PR 编号正确且 PR 当前为关闭状态",
|
||||
"update": "请确认 PR 编号和更新参数正确",
|
||||
"comment": "请确认 PR 编号正确且评论内容不为空",
|
||||
"files": "请确认 PR 编号正确",
|
||||
"versions": "请确认 PR 编号正确",
|
||||
"version-diff": "请确认 PR 编号正确",
|
||||
"reviews": "请确认 PR 编号正确",
|
||||
"review": "请确认 PR 编号正确且你已被列为审查者",
|
||||
"comments": "请确认 PR 编号正确",
|
||||
"create-comment": "请确认 PR 编号正确且评论内容不为空",
|
||||
"update-comment": "请确认评论 ID 正确",
|
||||
"delete-comment": "请确认评论 ID 正确",
|
||||
"commits": "请确认 PR 编号正确",
|
||||
"batch-close": "请确认 PR 编号正确,且你有批量关闭权限",
|
||||
"batch-merge": "请确认 PR 已通过 CI 检查且无合并冲突",
|
||||
},
|
||||
"release": {
|
||||
"list": "请确认 owner/repo 参数正确",
|
||||
"create": "请确认标签名和版本号正确,仓库默认分支可能存在",
|
||||
"view": "请确认 Release ID 或标签名正确",
|
||||
"delete": "请确认 Release ID 正确,此操作不可恢复",
|
||||
"edit": "请确认 Release ID 和更新参数正确",
|
||||
"update": "请确认 Release ID 和更新参数正确",
|
||||
},
|
||||
"branch": {
|
||||
"list": "请确认 owner/repo 参数正确",
|
||||
"create": "请确认源分支名正确,默认分支名可能不匹配",
|
||||
"delete": "请确认分支名正确,此操作不可恢复",
|
||||
"protect": "请确认分支名正确",
|
||||
"unprotect": "请确认分支名正确",
|
||||
"all": "请确认 owner/repo 参数正确",
|
||||
"default": "请确认仓库存在且可见",
|
||||
"restore": "请确认分支名正确且分支已被删除",
|
||||
"batch-delete": "请确认分支名正确,此操作不可恢复",
|
||||
"batch-protect": "请确认分支名正确",
|
||||
},
|
||||
"repo": {
|
||||
"list": "请确认用户/组织名正确",
|
||||
"info": "请确认 owner/repo 参数正确",
|
||||
"create": "请确认仓库名合法且不与其他仓库冲突",
|
||||
"fork": "请确认源仓库存在且可见",
|
||||
"delete": "请确认仓库名正确,此操作不可恢复",
|
||||
"update": "请确认更新参数正确",
|
||||
"about": "请确认 owner/repo 参数正确",
|
||||
"menu": "请确认 owner/repo 参数正确",
|
||||
"units-get": "请确认 owner/repo 参数正确",
|
||||
"units-set": "请确认仓库单元设置值有效",
|
||||
"edit-detail": "请确认更新参数正确",
|
||||
"simple": "请确认 owner/repo 参数正确",
|
||||
"code-stats": "请确认 owner/repo 参数正确",
|
||||
"languages": "请确认 owner/repo 参数正确",
|
||||
"contributors": "请确认 owner/repo 参数正确",
|
||||
"contributors-stat": "请确认 owner/repo 参数正确",
|
||||
"recommend": "该功能可能需要特定权限",
|
||||
"star": "请确认 owner/repo 参数正确",
|
||||
"unstar": "请确认 owner/repo 参数正确",
|
||||
"watch": "请确认 owner/repo 参数正确",
|
||||
"unwatch": "请确认 owner/repo 参数正确",
|
||||
"stargazers": "请确认 owner/repo 参数正确",
|
||||
"watchers": "请确认 owner/repo 参数正确",
|
||||
"transfer": "请确认目标所有者正确,且你有仓库转让权限",
|
||||
"cancel-transfer": "请确认存在待处理的转让请求",
|
||||
"transfer-orgs": "请确认你的组织列表中存在目标组织",
|
||||
"invite-link": "请确认 owner/repo 参数正确",
|
||||
"join": "请确认邀请链接有效",
|
||||
"quit": "请确认 owner/repo 参数正确",
|
||||
"migrate": "请确认源仓库地址正确且可访问",
|
||||
"sync-mirror": "请确认仓库为镜像仓库",
|
||||
"topics": "请确认 owner/repo 参数正确",
|
||||
"create-topic": "请确认标签名合法",
|
||||
"delete-topic": "请确认标签名正确",
|
||||
},
|
||||
}
|
||||
|
||||
// formatInteractiveError wraps a command execution error for display in the
|
||||
// interactive REPL. It hides raw HTTP/API technical details and provides
|
||||
// command-specific suggestions. The original error is appended in a dim line.
|
||||
func formatInteractiveError(group string, s *common.Shortcut, err error) string {
|
||||
var apiErr *client.APIError
|
||||
if errors.As(err, &apiErr) {
|
||||
return formatAPIError(group, s, apiErr)
|
||||
}
|
||||
return fmt.Sprintf("✗ %s +%s 执行失败\n 原因:%v", group, s.Name, err)
|
||||
}
|
||||
|
||||
// formatAPIError builds a user-friendly error message from an APIError.
|
||||
func formatAPIError(group string, s *common.Shortcut, e *client.APIError) string {
|
||||
var sb strings.Builder
|
||||
|
||||
sb.WriteString(fmt.Sprintf("✗ %s +%s 执行失败", group, s.Name))
|
||||
|
||||
// Reason — use the API message directly, it's already Chinese in most cases
|
||||
reason := e.Message
|
||||
if reason == "" {
|
||||
reason = fmt.Sprintf("服务器返回错误码 [%v]", e.Code)
|
||||
}
|
||||
sb.WriteString(fmt.Sprintf("\n 原因:%s", reason))
|
||||
|
||||
// Suggestion — command-specific first, then generic fallback
|
||||
if suggestion := lookupSuggestion(group, s.Name); suggestion != "" {
|
||||
sb.WriteString(fmt.Sprintf("\n 建议:%s", suggestion))
|
||||
}
|
||||
|
||||
// Original error in dim text
|
||||
sb.WriteString(fmt.Sprintf("\n [原始: %s]", e.Error()))
|
||||
|
||||
return sb.String()
|
||||
}
|
||||
|
||||
// lookupSuggestion returns a command-specific suggestion, or empty string.
|
||||
func lookupSuggestion(group, cmd string) string {
|
||||
if cmds, ok := commandSuggestions[group]; ok {
|
||||
if suggestion, ok := cmds[cmd]; ok {
|
||||
return suggestion
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// formatCommandDisplay formats a command for display, e.g. "issue +create --title hello --body world".
|
||||
func formatCommandDisplay(group string, s *common.Shortcut, args map[string]string) string {
|
||||
var b strings.Builder
|
||||
b.WriteString(group)
|
||||
b.WriteString(" +")
|
||||
b.WriteString(s.Name)
|
||||
|
||||
// Sort flag names for deterministic output
|
||||
keys := make([]string, 0, len(args))
|
||||
for k := range args {
|
||||
keys = append(keys, k)
|
||||
}
|
||||
sort.Strings(keys)
|
||||
|
||||
for _, k := range keys {
|
||||
b.WriteString(" --")
|
||||
b.WriteString(k)
|
||||
b.WriteString(" ")
|
||||
b.WriteString(args[k])
|
||||
}
|
||||
|
||||
return b.String()
|
||||
}
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
|
||||
)
|
||||
|
||||
// TestExecutor_UsesRealRuntimeContext verifies that Execute builds the
|
||||
// RuntimeContext via NewRuntimeContext (which initializes Client/Format/etc.)
|
||||
// rather than a bare struct literal that leaves Client == nil.
|
||||
//
|
||||
// Regression: previously Execute did `&common.RuntimeContext{Args: args}`,
|
||||
// so any command calling ctx.CallAPI panicked with a nil pointer dereference
|
||||
// inside the executor goroutine, which swallowed the execResultMsg and left
|
||||
// the REPL showing no output at all.
|
||||
func TestExecutor_UsesRealRuntimeContext(t *testing.T) {
|
||||
called := false
|
||||
s := &common.Shortcut{
|
||||
Name: "probe",
|
||||
Run: func(ctx *common.RuntimeContext) error {
|
||||
called = true
|
||||
// A real command uses ctx.Client / ctx.Format. If Execute built the
|
||||
// context correctly, Client must be non-nil and Format non-empty.
|
||||
if ctx.Client == nil {
|
||||
t.Error("ctx.Client is nil — Execute did not use NewRuntimeContext")
|
||||
}
|
||||
if ctx.Format == "" {
|
||||
t.Error("ctx.Format is empty — Execute did not initialize format")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
exec := &Executor{}
|
||||
out, err := exec.Execute(s, map[string]string{})
|
||||
if err != nil {
|
||||
t.Fatalf("Execute() error = %v", err)
|
||||
}
|
||||
if !called {
|
||||
t.Fatal("Run was not invoked")
|
||||
}
|
||||
if out != "" {
|
||||
t.Fatalf("expected empty output, got %q", out)
|
||||
}
|
||||
}
|
||||
|
||||
// TestExecutor_PanicDoesNotCorruptStdout verifies that if a command panics,
|
||||
// Execute recovers, returns the panic as an error, and — critically — restores
|
||||
// os.Stdout so the REPL is not left with stdout pointing at a closed pipe.
|
||||
func TestExecutor_PanicDoesNotCorruptStdout(t *testing.T) {
|
||||
original := os.Stdout
|
||||
s := &common.Shortcut{
|
||||
Name: "boom",
|
||||
Run: func(ctx *common.RuntimeContext) error {
|
||||
panic("simulated command failure")
|
||||
},
|
||||
}
|
||||
|
||||
exec := &Executor{}
|
||||
_, err := exec.Execute(s, map[string]string{})
|
||||
if err == nil {
|
||||
t.Fatal("expected Execute to return an error for a panicking command")
|
||||
}
|
||||
if os.Stdout != original {
|
||||
t.Fatal("os.Stdout was not restored after a panic — REPL would be left broken")
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,296 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
|
||||
)
|
||||
|
||||
// TestExecutor_CaptureOutput verifies that Execute captures stdout output
|
||||
// even when the Run function writes directly to os.Stdout.
|
||||
func TestExecutor_CaptureOutput(t *testing.T) {
|
||||
e := &Executor{}
|
||||
s := &common.Shortcut{
|
||||
Name: "test",
|
||||
Description: "test command",
|
||||
Run: func(ctx *common.RuntimeContext) error {
|
||||
// Do nothing — output should be empty
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
output, err := e.Execute(s, map[string]string{})
|
||||
if err != nil {
|
||||
t.Fatalf("Execute returned error: %v", err)
|
||||
}
|
||||
if output != "" {
|
||||
t.Fatalf("expected empty output, got %q", output)
|
||||
}
|
||||
}
|
||||
|
||||
// TestExecutor_CaptureOutputPrints verifies that stdout written inside Run
|
||||
// is captured and returned as a string.
|
||||
func TestExecutor_CaptureOutputPrints(t *testing.T) {
|
||||
e := &Executor{}
|
||||
s := &common.Shortcut{
|
||||
Name: "test",
|
||||
Description: "test command",
|
||||
Run: func(ctx *common.RuntimeContext) error {
|
||||
fmt.Fprint(os.Stdout, "hello from command")
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
output, err := e.Execute(s, map[string]string{})
|
||||
if err != nil {
|
||||
t.Fatalf("Execute returned error: %v", err)
|
||||
}
|
||||
if output != "hello from command" {
|
||||
t.Fatalf("expected %q, got %q", "hello from command", output)
|
||||
}
|
||||
}
|
||||
|
||||
// TestExecutor_RestoresStdout verifies that os.Stdout is restored after Execute.
|
||||
func TestExecutor_RestoresStdout(t *testing.T) {
|
||||
original := os.Stdout
|
||||
e := &Executor{}
|
||||
s := &common.Shortcut{
|
||||
Name: "test",
|
||||
Description: "test command",
|
||||
Run: func(ctx *common.RuntimeContext) error {
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
_, _ = e.Execute(s, map[string]string{})
|
||||
|
||||
if os.Stdout != original {
|
||||
t.Fatal("os.Stdout was not restored after Execute")
|
||||
}
|
||||
}
|
||||
|
||||
// TestParseDirectCommand uses table-driven tests for parseDirectCommand.
|
||||
func TestParseDirectCommand(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
input string
|
||||
group string
|
||||
cmd string
|
||||
flagStr string
|
||||
ok bool
|
||||
}{
|
||||
{
|
||||
name: "empty string",
|
||||
input: "",
|
||||
ok: false,
|
||||
},
|
||||
{
|
||||
name: "single word only",
|
||||
input: "issue",
|
||||
ok: false,
|
||||
},
|
||||
{
|
||||
name: "second word without plus",
|
||||
input: "issue list",
|
||||
ok: false,
|
||||
},
|
||||
{
|
||||
name: "two words with plus",
|
||||
input: "issue +list",
|
||||
group: "issue",
|
||||
cmd: "list",
|
||||
flagStr: "",
|
||||
ok: true,
|
||||
},
|
||||
{
|
||||
name: "with flags",
|
||||
input: "issue +list --state open",
|
||||
group: "issue",
|
||||
cmd: "list",
|
||||
flagStr: "--state open",
|
||||
ok: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
group, cmd, flagStr, ok := parseDirectCommand(tt.input)
|
||||
if ok != tt.ok {
|
||||
t.Errorf("ok = %v, want %v", ok, tt.ok)
|
||||
}
|
||||
if ok {
|
||||
if group != tt.group {
|
||||
t.Errorf("group = %q, want %q", group, tt.group)
|
||||
}
|
||||
if cmd != tt.cmd {
|
||||
t.Errorf("cmd = %q, want %q", cmd, tt.cmd)
|
||||
}
|
||||
if flagStr != tt.flagStr {
|
||||
t.Errorf("flagStr = %q, want %q", flagStr, tt.flagStr)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestParseFlags uses table-driven tests for parseFlagString.
|
||||
func TestParseFlags(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
flagStr string
|
||||
shortMap map[string]string
|
||||
want map[string]string
|
||||
}{
|
||||
{
|
||||
name: "long flags only",
|
||||
flagStr: "--title hello --body world",
|
||||
shortMap: map[string]string{},
|
||||
want: map[string]string{
|
||||
"title": "hello",
|
||||
"body": "world",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "short flag expanded",
|
||||
flagStr: "-n 42",
|
||||
shortMap: map[string]string{"n": "number"},
|
||||
want: map[string]string{
|
||||
"number": "42",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "equals syntax",
|
||||
flagStr: "--title=hello",
|
||||
shortMap: map[string]string{},
|
||||
want: map[string]string{
|
||||
"title": "hello",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got := parseFlagString(tt.flagStr, tt.shortMap)
|
||||
if len(got) != len(tt.want) {
|
||||
t.Fatalf("got %d flags, want %d flags: %v", len(got), len(tt.want), got)
|
||||
}
|
||||
for k, v := range tt.want {
|
||||
if got[k] != v {
|
||||
t.Errorf("flag %q = %q, want %q", k, got[k], v)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestFindShortcut covers three scenarios: found, wrong group, wrong cmd.
|
||||
func TestFindShortcut(t *testing.T) {
|
||||
listShortcut := &common.Shortcut{Name: "list", Description: "list issues"}
|
||||
createShortcut := &common.Shortcut{Name: "create", Description: "create issue"}
|
||||
all := map[string][]*common.Shortcut{
|
||||
"issue": {listShortcut, createShortcut},
|
||||
"pr": {{Name: "list", Description: "list PRs"}},
|
||||
}
|
||||
|
||||
// Scenario 1: found
|
||||
s, ok := findShortcut(all, "issue", "list")
|
||||
if !ok {
|
||||
t.Fatal("expected to find issue +list")
|
||||
}
|
||||
if s != listShortcut {
|
||||
t.Fatal("returned wrong shortcut")
|
||||
}
|
||||
|
||||
// Scenario 2: group not found
|
||||
_, ok = findShortcut(all, "repo", "list")
|
||||
if ok {
|
||||
t.Fatal("expected not found for unknown group")
|
||||
}
|
||||
|
||||
// Scenario 3: group found but cmd not found
|
||||
_, ok = findShortcut(all, "issue", "close")
|
||||
if ok {
|
||||
t.Fatal("expected not found for unknown cmd in valid group")
|
||||
}
|
||||
}
|
||||
|
||||
// TestBuildShortMap verifies short-to-long flag mapping construction.
|
||||
func TestBuildShortMap(t *testing.T) {
|
||||
s := &common.Shortcut{
|
||||
Name: "list",
|
||||
Flags: []common.Flag{
|
||||
{Name: "state", Short: "s"},
|
||||
{Name: "number", Short: "n"},
|
||||
{Name: "verbose"},
|
||||
},
|
||||
}
|
||||
|
||||
m := buildShortMap(s)
|
||||
if len(m) != 2 {
|
||||
t.Fatalf("expected 2 entries in short map, got %d", len(m))
|
||||
}
|
||||
if m["s"] != "state" {
|
||||
t.Errorf("short 's' = %q, want 'state'", m["s"])
|
||||
}
|
||||
if m["n"] != "number" {
|
||||
t.Errorf("short 'n' = %q, want 'number'", m["n"])
|
||||
}
|
||||
}
|
||||
|
||||
// TestMissingRequiredFlags checks that required-but-missing flags are reported.
|
||||
func TestMissingRequiredFlags(t *testing.T) {
|
||||
s := &common.Shortcut{
|
||||
Name: "create",
|
||||
Flags: []common.Flag{
|
||||
{Name: "title", Required: true},
|
||||
{Name: "body", Required: true},
|
||||
{Name: "state", Required: false},
|
||||
},
|
||||
}
|
||||
|
||||
// Provide title but not body
|
||||
args := map[string]string{"title": "hello"}
|
||||
missing := missingRequiredFlags(s, args)
|
||||
|
||||
if len(missing) != 1 {
|
||||
t.Fatalf("expected 1 missing flag, got %d: %v", len(missing), missing)
|
||||
}
|
||||
if missing[0] != "--body" {
|
||||
t.Errorf("missing flag = %q, want '--body'", missing[0])
|
||||
}
|
||||
|
||||
// Provide all required
|
||||
args2 := map[string]string{"title": "hello", "body": "world"}
|
||||
missing2 := missingRequiredFlags(s, args2)
|
||||
if len(missing2) != 0 {
|
||||
t.Fatalf("expected 0 missing flags, got %d: %v", len(missing2), missing2)
|
||||
}
|
||||
}
|
||||
|
||||
// TestFormatCommandDisplay verifies the display string format.
|
||||
func TestFormatCommandDisplay(t *testing.T) {
|
||||
s := &common.Shortcut{
|
||||
Name: "create",
|
||||
Description: "create an issue",
|
||||
}
|
||||
args := map[string]string{
|
||||
"title": "hello",
|
||||
"body": "world",
|
||||
}
|
||||
|
||||
got := formatCommandDisplay("issue", s, args)
|
||||
|
||||
// The order of flags may vary, so check that all parts are present
|
||||
if !strings.HasPrefix(got, "issue +create") {
|
||||
t.Fatalf("expected prefix 'issue +create', got %q", got)
|
||||
}
|
||||
if !strings.Contains(got, "--title hello") {
|
||||
t.Fatalf("expected '--title hello' in output, got %q", got)
|
||||
}
|
||||
if !strings.Contains(got, "--body world") {
|
||||
t.Fatalf("expected '--body world' in output, got %q", got)
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,317 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/charmbracelet/bubbles/textinput"
|
||||
tea "github.com/charmbracelet/bubbletea"
|
||||
"github.com/charmbracelet/lipgloss"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
|
||||
)
|
||||
|
||||
// formField represents a single field in the argument form.
|
||||
type formField struct {
|
||||
flag common.Flag
|
||||
input textinput.Model
|
||||
boolValue bool
|
||||
isBool bool
|
||||
}
|
||||
|
||||
// formModel is the parameter form sub-component.
|
||||
type formModel struct {
|
||||
group string
|
||||
shortcut *common.Shortcut
|
||||
fields []formField
|
||||
focusIdx int
|
||||
submitted bool
|
||||
cancelled bool
|
||||
values map[string]string
|
||||
width int
|
||||
height int
|
||||
errors []string
|
||||
}
|
||||
|
||||
var formTitleStyle = lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("12"))
|
||||
var formErrorStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("9")).Bold(true)
|
||||
var formHelpStyle = lipgloss.NewStyle().Faint(true)
|
||||
var formHintStyle = lipgloss.NewStyle().Faint(true).Foreground(lipgloss.Color("11"))
|
||||
var formLabelStyle = lipgloss.NewStyle().Bold(true)
|
||||
var formRequiredMark = lipgloss.NewStyle().Foreground(lipgloss.Color("9")).Bold(true)
|
||||
var formRequiredTag = lipgloss.NewStyle().Foreground(lipgloss.Color("9")).Faint(true)
|
||||
var formOptionalTag = lipgloss.NewStyle().Faint(true)
|
||||
var formDefaultTag = lipgloss.NewStyle().Foreground(lipgloss.Color("3")).Faint(true)
|
||||
|
||||
// newFormModel creates a new form model from a shortcut's flags.
|
||||
func newFormModel(group string, shortcut *common.Shortcut, width, height int, prefill map[string]string) formModel {
|
||||
fields := make([]formField, 0, len(shortcut.Flags))
|
||||
|
||||
for _, f := range shortcut.Flags {
|
||||
if f.Bool {
|
||||
// Bool field: no text input, just toggle
|
||||
val := f.Default
|
||||
if v, ok := prefill[f.Name]; ok {
|
||||
val = v
|
||||
}
|
||||
fields = append(fields, formField{
|
||||
flag: f,
|
||||
boolValue: val == "true",
|
||||
isBool: true,
|
||||
})
|
||||
} else {
|
||||
// Text field
|
||||
ti := textinput.New()
|
||||
ti.Placeholder = f.Usage
|
||||
if f.Default != "" {
|
||||
ti.Placeholder = f.Default
|
||||
}
|
||||
ti.Width = width - 30
|
||||
if ti.Width < 20 {
|
||||
ti.Width = 20
|
||||
}
|
||||
|
||||
// Pre-fill from provided values
|
||||
if v, ok := prefill[f.Name]; ok {
|
||||
ti.SetValue(v)
|
||||
}
|
||||
|
||||
fields = append(fields, formField{
|
||||
flag: f,
|
||||
input: ti,
|
||||
isBool: false,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
m := formModel{
|
||||
group: group,
|
||||
shortcut: shortcut,
|
||||
fields: fields,
|
||||
width: width,
|
||||
height: height,
|
||||
errors: []string{},
|
||||
}
|
||||
|
||||
// Focus the first non-bool field, or first field
|
||||
m.focusFirstField()
|
||||
return m
|
||||
}
|
||||
|
||||
// focusFirstField sets focus to the first focusable field.
|
||||
func (m *formModel) focusFirstField() {
|
||||
for i := range m.fields {
|
||||
m.focusIdx = i
|
||||
if !m.fields[i].isBool {
|
||||
m.fields[i].input.Focus()
|
||||
}
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// validate checks that all required fields have values.
|
||||
func (m formModel) validate() []string {
|
||||
var errs []string
|
||||
for _, f := range m.fields {
|
||||
if f.flag.Required {
|
||||
if f.isBool {
|
||||
// Bool fields are always valid
|
||||
continue
|
||||
}
|
||||
if strings.TrimSpace(f.input.Value()) == "" {
|
||||
errs = append(errs, fmt.Sprintf("--%s 为必填参数,不能为空", f.flag.Name))
|
||||
}
|
||||
}
|
||||
}
|
||||
return errs
|
||||
}
|
||||
|
||||
// collectValues gathers all field values into a map.
|
||||
func (m *formModel) collectValues() map[string]string {
|
||||
values := make(map[string]string)
|
||||
for _, f := range m.fields {
|
||||
if f.isBool {
|
||||
if f.boolValue {
|
||||
values[f.flag.Name] = "true"
|
||||
}
|
||||
} else {
|
||||
v := f.input.Value()
|
||||
if v == "" && f.flag.Default != "" {
|
||||
v = f.flag.Default
|
||||
}
|
||||
if v != "" {
|
||||
values[f.flag.Name] = v
|
||||
}
|
||||
}
|
||||
}
|
||||
return values
|
||||
}
|
||||
|
||||
// Update handles messages for the form.
|
||||
func (m formModel) Update(msg tea.Msg) (formModel, tea.Cmd) {
|
||||
switch msg := msg.(type) {
|
||||
case tea.KeyMsg:
|
||||
switch msg.Type {
|
||||
case tea.KeyEsc:
|
||||
m.cancelled = true
|
||||
return m, nil
|
||||
|
||||
case tea.KeyTab, tea.KeyDown:
|
||||
m.nextField()
|
||||
return m, nil
|
||||
|
||||
case tea.KeyShiftTab, tea.KeyUp:
|
||||
m.prevField()
|
||||
return m, nil
|
||||
|
||||
case tea.KeyEnter:
|
||||
if len(m.fields) > 0 && m.fields[m.focusIdx].isBool {
|
||||
m.fields[m.focusIdx].boolValue = !m.fields[m.focusIdx].boolValue
|
||||
return m, nil
|
||||
}
|
||||
// Validate
|
||||
errs := m.validate()
|
||||
if len(errs) > 0 {
|
||||
m.errors = errs
|
||||
return m, nil
|
||||
}
|
||||
m.values = m.collectValues()
|
||||
m.submitted = true
|
||||
return m, nil
|
||||
|
||||
case tea.KeySpace:
|
||||
if len(m.fields) > 0 && m.fields[m.focusIdx].isBool {
|
||||
m.fields[m.focusIdx].boolValue = !m.fields[m.focusIdx].boolValue
|
||||
return m, nil
|
||||
}
|
||||
// Fall through to text input
|
||||
}
|
||||
|
||||
// Forward to focused text input
|
||||
if len(m.fields) > 0 && !m.fields[m.focusIdx].isBool {
|
||||
var cmd tea.Cmd
|
||||
m.fields[m.focusIdx].input, cmd = m.fields[m.focusIdx].input.Update(msg)
|
||||
return m, cmd
|
||||
}
|
||||
}
|
||||
|
||||
return m, nil
|
||||
}
|
||||
|
||||
// nextField moves focus to the next field.
|
||||
func (m *formModel) nextField() {
|
||||
if len(m.fields) == 0 {
|
||||
return
|
||||
}
|
||||
// Blur current
|
||||
if !m.fields[m.focusIdx].isBool {
|
||||
m.fields[m.focusIdx].input.Blur()
|
||||
}
|
||||
m.focusIdx = (m.focusIdx + 1) % len(m.fields)
|
||||
// Focus new
|
||||
if !m.fields[m.focusIdx].isBool {
|
||||
m.fields[m.focusIdx].input.Focus()
|
||||
}
|
||||
}
|
||||
|
||||
// prevField moves focus to the previous field.
|
||||
func (m *formModel) prevField() {
|
||||
if len(m.fields) == 0 {
|
||||
return
|
||||
}
|
||||
// Blur current
|
||||
if !m.fields[m.focusIdx].isBool {
|
||||
m.fields[m.focusIdx].input.Blur()
|
||||
}
|
||||
m.focusIdx--
|
||||
if m.focusIdx < 0 {
|
||||
m.focusIdx = len(m.fields) - 1
|
||||
}
|
||||
// Focus new
|
||||
if !m.fields[m.focusIdx].isBool {
|
||||
m.fields[m.focusIdx].input.Focus()
|
||||
}
|
||||
}
|
||||
|
||||
// fieldMetaTag builds the metadata tag string for a flag (required/optional, default).
|
||||
func fieldMetaTag(f formField) string {
|
||||
var parts []string
|
||||
if f.flag.Required {
|
||||
parts = append(parts, formRequiredTag.Render("[必填]"))
|
||||
} else {
|
||||
parts = append(parts, formOptionalTag.Render("[可选]"))
|
||||
}
|
||||
if !f.isBool && f.flag.Default != "" {
|
||||
parts = append(parts, formDefaultTag.Render(fmt.Sprintf("默认=%s", f.flag.Default)))
|
||||
}
|
||||
return strings.Join(parts, " ")
|
||||
}
|
||||
|
||||
// View renders the form.
|
||||
func (m formModel) View() string {
|
||||
var sb strings.Builder
|
||||
|
||||
// Title
|
||||
title := formTitleStyle.Render(fmt.Sprintf("%s +%s", m.group, m.shortcut.Name))
|
||||
sb.WriteString(title)
|
||||
sb.WriteString("\n\n")
|
||||
|
||||
// Fields
|
||||
for i, f := range m.fields {
|
||||
label := f.flag.Name
|
||||
if f.flag.Required {
|
||||
label = label + formRequiredMark.Render(" *")
|
||||
}
|
||||
meta := fieldMetaTag(f)
|
||||
|
||||
if f.isBool {
|
||||
// Bool field
|
||||
check := "[ ]"
|
||||
if f.boolValue {
|
||||
check = "[✓]"
|
||||
}
|
||||
line := fmt.Sprintf(" %s %s %s", check, label, meta)
|
||||
if i == m.focusIdx {
|
||||
line = selectedStyle.Render(line)
|
||||
}
|
||||
sb.WriteString(line)
|
||||
sb.WriteString("\n")
|
||||
if f.flag.Usage != "" {
|
||||
sb.WriteString(formHintStyle.Render(fmt.Sprintf(" %s", f.flag.Usage)))
|
||||
sb.WriteString("\n")
|
||||
}
|
||||
} else {
|
||||
// Text field — show label with meta on first line, input on second
|
||||
// First line: name * [必填] 默认=1
|
||||
header := fmt.Sprintf(" %s %s:", label, meta)
|
||||
if i == m.focusIdx {
|
||||
header = formLabelStyle.Render(header)
|
||||
}
|
||||
sb.WriteString(header)
|
||||
sb.WriteString("\n")
|
||||
// Second line: input field, indented
|
||||
sb.WriteString(fmt.Sprintf(" %s", f.input.View()))
|
||||
sb.WriteString("\n")
|
||||
if f.flag.Usage != "" {
|
||||
sb.WriteString(formHintStyle.Render(fmt.Sprintf(" %s", f.flag.Usage)))
|
||||
sb.WriteString("\n")
|
||||
}
|
||||
}
|
||||
sb.WriteString("\n")
|
||||
}
|
||||
|
||||
// Errors
|
||||
if len(m.errors) > 0 {
|
||||
sb.WriteString("\n")
|
||||
for _, e := range m.errors {
|
||||
sb.WriteString(formErrorStyle.Render(fmt.Sprintf(" ✗ %s", e)))
|
||||
sb.WriteString("\n")
|
||||
}
|
||||
}
|
||||
|
||||
// Help
|
||||
sb.WriteString("\n")
|
||||
sb.WriteString(formHelpStyle.Render(" Enter submit · Tab/↑↓ next field · Shift+Tab prev field · Space toggle bool · Esc cancel"))
|
||||
|
||||
return sb.String()
|
||||
}
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/cmd/cmdutil"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/context"
|
||||
)
|
||||
|
||||
// NewInteractiveCmd creates the Cobra command for the interactive REPL.
|
||||
func NewInteractiveCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "interactive",
|
||||
Short: "Start interactive REPL with command palette",
|
||||
Long: `Start an interactive REPL session with a command palette.
|
||||
|
||||
Type / to open the command palette with fuzzy search.
|
||||
Use arrow keys to navigate, Enter to select, Tab to fill parameters.
|
||||
Type "exit" or press Ctrl+D to quit.`,
|
||||
Aliases: []string{"i"},
|
||||
Example: ` gitlink interactive
|
||||
gitlink i`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
// 交互模式默认用表格输出,更易阅读;用户显式指定 --format 时优先采用用户的值。
|
||||
if cmdutil.Format == "" {
|
||||
cmdutil.Format = "table"
|
||||
}
|
||||
owner, repo, err := context.ResolveOwnerRepo(cmdutil.Owner, cmdutil.Repo)
|
||||
if err != nil {
|
||||
owner = cmdutil.Owner
|
||||
repo = cmdutil.Repo
|
||||
}
|
||||
return Run(owner, repo)
|
||||
},
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
tea "github.com/charmbracelet/bubbletea"
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
|
||||
)
|
||||
|
||||
// makeShortcutForViewport builds a minimal shortcut so formatCommandDisplay has
|
||||
// something to render in the display header line of the output viewer.
|
||||
func makeShortcutForViewport() *common.Shortcut {
|
||||
return &common.Shortcut{
|
||||
Name: "list",
|
||||
}
|
||||
}
|
||||
|
||||
// TestLongOutputEntersViewport verifies that when command output exceeds the
|
||||
// available terminal height, the REPL switches into the scrollable output
|
||||
// viewer (stateOutput) instead of falling back to the inline input state.
|
||||
func TestLongOutputEntersViewport(t *testing.T) {
|
||||
m := newReplModel("owner", "repo")
|
||||
// Small terminal: m.height-4 == 1 line of room, so any multi-line output
|
||||
// must overflow into the viewport.
|
||||
m.height = 5
|
||||
m.width = 80
|
||||
m.state = stateExecuting
|
||||
|
||||
longOutput := strings.Repeat("line of output\n", 20)
|
||||
msg := execResultMsg{
|
||||
group: "issue",
|
||||
shortcut: makeShortcutForViewport(),
|
||||
args: map[string]string{},
|
||||
output: longOutput,
|
||||
err: nil,
|
||||
}
|
||||
|
||||
newModel, _ := m.Update(msg)
|
||||
repl, ok := newModel.(replModel)
|
||||
if !ok {
|
||||
t.Fatalf("expected replModel, got %T", newModel)
|
||||
}
|
||||
|
||||
if repl.state != stateOutput {
|
||||
t.Fatalf("expected stateOutput for long output, got %v", repl.state)
|
||||
}
|
||||
if repl.viewport.Height != m.height-2 {
|
||||
t.Fatalf("expected viewport height %d, got %d", m.height-2, repl.viewport.Height)
|
||||
}
|
||||
}
|
||||
|
||||
// TestShortOutputStaysInput verifies that short command output keeps the
|
||||
// existing behaviour: store lastOutput and return to stateInput.
|
||||
func TestShortOutputStaysInput(t *testing.T) {
|
||||
m := newReplModel("owner", "repo")
|
||||
m.height = 40 // plenty of room
|
||||
m.width = 80
|
||||
m.state = stateExecuting
|
||||
|
||||
shortOutput := "only one line"
|
||||
msg := execResultMsg{
|
||||
group: "issue",
|
||||
shortcut: makeShortcutForViewport(),
|
||||
args: map[string]string{},
|
||||
output: shortOutput,
|
||||
err: nil,
|
||||
}
|
||||
|
||||
newModel, _ := m.Update(msg)
|
||||
repl, ok := newModel.(replModel)
|
||||
if !ok {
|
||||
t.Fatalf("expected replModel, got %T", newModel)
|
||||
}
|
||||
|
||||
if repl.state != stateInput {
|
||||
t.Fatalf("expected stateInput for short output, got %v", repl.state)
|
||||
}
|
||||
if repl.lastOutput == "" {
|
||||
t.Fatalf("expected lastOutput to be set for short output")
|
||||
}
|
||||
if !strings.Contains(repl.lastOutput, shortOutput) {
|
||||
t.Fatalf("expected lastOutput to contain %q, got %q", shortOutput, repl.lastOutput)
|
||||
}
|
||||
}
|
||||
|
||||
// TestViewportQuitReturnsToInput verifies that pressing 'q' in the output
|
||||
// viewer returns the REPL to the input state.
|
||||
func TestViewportQuitReturnsToInput(t *testing.T) {
|
||||
m := newReplModel("owner", "repo")
|
||||
m.state = stateOutput
|
||||
|
||||
keyQ := tea.KeyMsg{Type: tea.KeyRunes, Runes: []rune{'q'}}
|
||||
newModel, _ := m.Update(keyQ)
|
||||
|
||||
repl, ok := newModel.(replModel)
|
||||
if !ok {
|
||||
t.Fatalf("expected replModel, got %T", newModel)
|
||||
}
|
||||
if repl.state != stateInput {
|
||||
t.Fatalf("expected stateInput after pressing 'q', got %v", repl.state)
|
||||
}
|
||||
}
|
||||
|
||||
// TestViewportEscReturnsToInput verifies that Esc also exits the output viewer.
|
||||
func TestViewportEscReturnsToInput(t *testing.T) {
|
||||
m := newReplModel("owner", "repo")
|
||||
m.state = stateOutput
|
||||
|
||||
keyEsc := tea.KeyMsg{Type: tea.KeyEsc}
|
||||
newModel, _ := m.Update(keyEsc)
|
||||
|
||||
repl, ok := newModel.(replModel)
|
||||
if !ok {
|
||||
t.Fatalf("expected replModel, got %T", newModel)
|
||||
}
|
||||
if repl.state != stateInput {
|
||||
t.Fatalf("expected stateInput after pressing Esc, got %v", repl.state)
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,305 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/charmbracelet/bubbles/list"
|
||||
"github.com/charmbracelet/bubbles/textinput"
|
||||
tea "github.com/charmbracelet/bubbletea"
|
||||
"github.com/charmbracelet/lipgloss"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
|
||||
)
|
||||
|
||||
// paletteLevel tracks which level of the palette we are browsing.
|
||||
type paletteLevel int
|
||||
|
||||
const (
|
||||
levelGroup paletteLevel = iota // browsing command groups
|
||||
levelCommand // browsing commands within a group
|
||||
)
|
||||
|
||||
// PaletteResult holds the user's selection from the palette.
|
||||
type PaletteResult struct {
|
||||
Group string
|
||||
Shortcut *common.Shortcut
|
||||
}
|
||||
|
||||
// commandItem implements list.Item and list.DefaultItem.
|
||||
type commandItem struct {
|
||||
title string
|
||||
description string
|
||||
shortcut *common.Shortcut // nil for group items
|
||||
group string // empty for group items
|
||||
}
|
||||
|
||||
func (i commandItem) Title() string { return i.title }
|
||||
func (i commandItem) Description() string { return i.description }
|
||||
func (i commandItem) FilterValue() string { return i.title + " " + i.description }
|
||||
|
||||
// paletteModel is the command palette sub-component.
|
||||
type paletteModel struct {
|
||||
level paletteLevel
|
||||
search textinput.Model
|
||||
list list.Model
|
||||
groups map[string][]*common.Shortcut
|
||||
descs map[string]string
|
||||
groupKeys []string
|
||||
selected string // currently selected group name (when levelCommand)
|
||||
result *PaletteResult
|
||||
quitting bool
|
||||
width int
|
||||
height int
|
||||
}
|
||||
|
||||
var paletteTitleStyle = lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("12"))
|
||||
var selectedStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("10")).Bold(true)
|
||||
var paletteHelpStyle = lipgloss.NewStyle().Faint(true)
|
||||
|
||||
// newPaletteModel creates a new palette model.
|
||||
func newPaletteModel(groups map[string][]*common.Shortcut, descs map[string]string, width, height int) paletteModel {
|
||||
search := textinput.New()
|
||||
search.Prompt = "> "
|
||||
search.Placeholder = "Search..."
|
||||
search.Focus()
|
||||
search.Width = width - 4
|
||||
|
||||
// Sort group keys for deterministic ordering
|
||||
keys := make([]string, 0, len(groups))
|
||||
for k := range groups {
|
||||
keys = append(keys, k)
|
||||
}
|
||||
sort.Strings(keys)
|
||||
|
||||
// Build group items
|
||||
items := make([]list.Item, 0, len(keys))
|
||||
for _, k := range keys {
|
||||
desc := descs[k]
|
||||
items = append(items, commandItem{
|
||||
title: k,
|
||||
description: desc,
|
||||
})
|
||||
}
|
||||
|
||||
delegate := list.NewDefaultDelegate()
|
||||
l := list.New(items, delegate, width, height-4)
|
||||
l.SetShowTitle(false)
|
||||
l.SetShowStatusBar(false)
|
||||
l.SetShowHelp(false)
|
||||
l.SetShowFilter(false)
|
||||
l.SetFilteringEnabled(false)
|
||||
|
||||
return paletteModel{
|
||||
level: levelGroup,
|
||||
search: search,
|
||||
list: l,
|
||||
groups: groups,
|
||||
descs: descs,
|
||||
groupKeys: keys,
|
||||
width: width,
|
||||
height: height,
|
||||
}
|
||||
}
|
||||
|
||||
// switchToCommands switches the list to show commands for the given group.
|
||||
func (m *paletteModel) switchToCommands(group string) {
|
||||
m.selected = group
|
||||
m.level = levelCommand
|
||||
|
||||
shortcuts := m.groups[group]
|
||||
items := make([]list.Item, 0, len(shortcuts))
|
||||
for _, s := range shortcuts {
|
||||
items = append(items, commandItem{
|
||||
title: "+" + s.Name,
|
||||
description: s.Description,
|
||||
shortcut: s,
|
||||
group: group,
|
||||
})
|
||||
}
|
||||
m.list.SetItems(items)
|
||||
m.list.ResetSelected()
|
||||
m.search.SetValue("")
|
||||
}
|
||||
|
||||
// backToGroups returns to the group list.
|
||||
func (m *paletteModel) backToGroups() {
|
||||
m.level = levelGroup
|
||||
m.selected = ""
|
||||
|
||||
items := make([]list.Item, 0, len(m.groupKeys))
|
||||
for _, k := range m.groupKeys {
|
||||
items = append(items, commandItem{
|
||||
title: k,
|
||||
description: m.descs[k],
|
||||
})
|
||||
}
|
||||
m.list.SetItems(items)
|
||||
m.list.ResetSelected()
|
||||
m.search.SetValue("")
|
||||
}
|
||||
|
||||
// filterItems filters the current list items by the given query.
|
||||
func (m *paletteModel) filterItems(query string) {
|
||||
var items []list.Item
|
||||
|
||||
if m.level == levelGroup {
|
||||
for _, k := range m.groupKeys {
|
||||
desc := m.descs[k]
|
||||
if matchesQuery(k, desc, query) {
|
||||
items = append(items, commandItem{
|
||||
title: k,
|
||||
description: desc,
|
||||
})
|
||||
}
|
||||
}
|
||||
} else {
|
||||
shortcuts := m.groups[m.selected]
|
||||
for _, s := range shortcuts {
|
||||
name := "+" + s.Name
|
||||
if matchesQuery(name, s.Description, query) {
|
||||
items = append(items, commandItem{
|
||||
title: name,
|
||||
description: s.Description,
|
||||
shortcut: s,
|
||||
group: m.selected,
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if items == nil {
|
||||
items = []list.Item{}
|
||||
}
|
||||
m.list.SetItems(items)
|
||||
m.list.ResetSelected()
|
||||
}
|
||||
|
||||
// matchesQuery checks if the query is a subsequence (fzy-style fuzzy match)
|
||||
// of either the title or the description, case-insensitively. An empty query
|
||||
// matches everything.
|
||||
func matchesQuery(title, description, query string) bool {
|
||||
return subsequenceMatch(query, title) || subsequenceMatch(query, description)
|
||||
}
|
||||
|
||||
// subsequenceMatch returns true if every character of query appears in target
|
||||
// in the same order (not necessarily contiguously), ignoring case. An empty
|
||||
// query always matches.
|
||||
func subsequenceMatch(query, target string) bool {
|
||||
query = strings.ToLower(query)
|
||||
target = strings.ToLower(target)
|
||||
if query == "" {
|
||||
return true
|
||||
}
|
||||
i := 0
|
||||
for j := 0; j < len(target) && i < len(query); j++ {
|
||||
if target[j] == query[i] {
|
||||
i++
|
||||
}
|
||||
}
|
||||
return i == len(query)
|
||||
}
|
||||
|
||||
// Update handles messages for the palette.
|
||||
func (m paletteModel) Update(msg tea.Msg) (paletteModel, tea.Cmd) {
|
||||
switch msg := msg.(type) {
|
||||
case tea.KeyMsg:
|
||||
switch msg.Type {
|
||||
case tea.KeyEsc:
|
||||
if m.level == levelCommand {
|
||||
m.backToGroups()
|
||||
return m, nil
|
||||
}
|
||||
// levelGroup: signal the outer REPL to return to stateInput, not quit
|
||||
m.quitting = true
|
||||
return m, nil
|
||||
|
||||
case tea.KeyEnter:
|
||||
selected := m.list.SelectedItem()
|
||||
if selected == nil {
|
||||
return m, nil
|
||||
}
|
||||
item := selected.(commandItem)
|
||||
if m.level == levelGroup {
|
||||
m.switchToCommands(item.title)
|
||||
return m, nil
|
||||
}
|
||||
// levelCommand: set result
|
||||
m.result = &PaletteResult{
|
||||
Group: m.selected,
|
||||
Shortcut: item.shortcut,
|
||||
}
|
||||
return m, nil
|
||||
|
||||
case tea.KeyUp, tea.KeyDown:
|
||||
var cmd tea.Cmd
|
||||
m.list, cmd = m.list.Update(msg)
|
||||
return m, cmd
|
||||
|
||||
default:
|
||||
// Forward to search input
|
||||
var cmd tea.Cmd
|
||||
m.search, cmd = m.search.Update(msg)
|
||||
m.filterItems(m.search.Value())
|
||||
return m, cmd
|
||||
}
|
||||
|
||||
case tea.WindowSizeMsg:
|
||||
m.width = msg.Width
|
||||
m.height = msg.Height
|
||||
m.list.SetWidth(msg.Width)
|
||||
m.list.SetHeight(msg.Height - 4)
|
||||
m.search.Width = msg.Width - 4
|
||||
}
|
||||
|
||||
return m, nil
|
||||
}
|
||||
|
||||
// View renders the palette.
|
||||
func (m paletteModel) View() string {
|
||||
if m.quitting {
|
||||
return ""
|
||||
}
|
||||
|
||||
var title string
|
||||
if m.level == levelGroup {
|
||||
title = paletteTitleStyle.Render("Command Palette — Select a group")
|
||||
} else {
|
||||
title = paletteTitleStyle.Render(fmt.Sprintf("Command Palette — %s", m.selected))
|
||||
}
|
||||
|
||||
searchView := m.search.View()
|
||||
|
||||
// Render list items manually for better control
|
||||
var items strings.Builder
|
||||
listItems := m.list.Items()
|
||||
idx := m.list.Index()
|
||||
|
||||
for i, item := range listItems {
|
||||
ci := item.(commandItem)
|
||||
if i == idx {
|
||||
items.WriteString(selectedStyle.Render(fmt.Sprintf(" ❯ %s", ci.title)))
|
||||
if ci.description != "" {
|
||||
items.WriteString(" ")
|
||||
items.WriteString(paletteHelpStyle.Render(ci.description))
|
||||
}
|
||||
} else {
|
||||
items.WriteString(fmt.Sprintf(" %s", ci.title))
|
||||
if ci.description != "" {
|
||||
items.WriteString(" ")
|
||||
items.WriteString(paletteHelpStyle.Render(ci.description))
|
||||
}
|
||||
}
|
||||
items.WriteString("\n")
|
||||
}
|
||||
|
||||
if len(listItems) == 0 {
|
||||
items.WriteString(paletteHelpStyle.Render(" No matches found"))
|
||||
items.WriteString("\n")
|
||||
}
|
||||
|
||||
help := paletteHelpStyle.Render("Enter select · Esc back · ↑↓ navigate · type to search")
|
||||
|
||||
return fmt.Sprintf("%s\n%s\n%s\n%s", title, searchView, items.String(), help)
|
||||
}
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
tea "github.com/charmbracelet/bubbletea"
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
|
||||
)
|
||||
|
||||
// TestPaletteSelectionOpensFormForOptionalFlags 验证:选中一个"只有可选参数、
|
||||
// 无必填参数"的命令(如 branch +batch-protect 的 names/from 二选一)时,
|
||||
// 仍然弹出参数表单,而非直接执行导致 "no ... provided" 错误。
|
||||
//
|
||||
// 回归:之前 updatePalette 只在有缺失的 Required flag 时才弹表单,
|
||||
// 导致 names/from 这类"至少一个"型参数(无法单独标 Required)的命令
|
||||
// 被直接执行,用户没机会输入参数。
|
||||
func TestPaletteSelectionOpensFormForOptionalFlags(t *testing.T) {
|
||||
// 构造一个模拟 branch +batch-protect 的 shortcut:所有 flag 都非必填。
|
||||
shortcuts := map[string][]*common.Shortcut{
|
||||
"branch": {
|
||||
{
|
||||
Name: "batch-protect",
|
||||
Description: "批量保护分支",
|
||||
Flags: []common.Flag{
|
||||
{Name: "names", Usage: "分支名(逗号分隔)"}, // 无 Required
|
||||
{Name: "from", Usage: "文件路径"}, // 无 Required
|
||||
},
|
||||
Run: func(ctx *common.RuntimeContext) error { return nil },
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
m := newReplModel("owner", "repo")
|
||||
// 注入测试 registry
|
||||
m.shortcuts = shortcuts
|
||||
|
||||
// 1) 输入 / 触发命令面板
|
||||
m2, _ := m.Update(tea.KeyMsg{Type: tea.KeyRunes, Runes: []rune{'/'}})
|
||||
repl := m2.(replModel)
|
||||
if repl.state != statePalette {
|
||||
t.Fatalf("输入 / 后应在 statePalette,实际 %v", repl.state)
|
||||
}
|
||||
|
||||
// 2) 模拟用户选中 branch 组
|
||||
repl.palette.result = &PaletteResult{
|
||||
Group: "branch",
|
||||
Shortcut: shortcuts["branch"][0],
|
||||
}
|
||||
|
||||
// 3) 派发一条任意消息触发 updatePalette 的结果检查
|
||||
m3, _ := repl.Update(tea.KeyMsg{Type: tea.KeyEnter})
|
||||
final := m3.(replModel)
|
||||
|
||||
if final.state != stateForm {
|
||||
t.Fatalf("选中带可选参数的命令应进入 stateForm,实际 %v(命令被直接执行了,用户没机会填参数)", final.state)
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,433 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/charmbracelet/bubbles/spinner"
|
||||
"github.com/charmbracelet/bubbles/textinput"
|
||||
"github.com/charmbracelet/bubbles/viewport"
|
||||
tea "github.com/charmbracelet/bubbletea"
|
||||
"github.com/charmbracelet/lipgloss"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts"
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
|
||||
)
|
||||
|
||||
// replState tracks the current state of the REPL.
|
||||
type replState int
|
||||
|
||||
const (
|
||||
stateInput replState = iota // waiting for user text input
|
||||
statePalette // command palette is active
|
||||
stateForm // parameter form is active
|
||||
stateExecuting // executing a command
|
||||
stateError // showing an error
|
||||
stateOutput // scrolling through long command output
|
||||
)
|
||||
|
||||
// execResultMsg is sent when command execution completes.
|
||||
type execResultMsg struct {
|
||||
group string
|
||||
shortcut *common.Shortcut
|
||||
args map[string]string
|
||||
output string
|
||||
err error
|
||||
}
|
||||
|
||||
// replModel is the main REPL state machine.
|
||||
type replModel struct {
|
||||
state replState
|
||||
input textinput.Model
|
||||
palette paletteModel
|
||||
form formModel
|
||||
executor Executor
|
||||
shortcuts map[string][]*common.Shortcut
|
||||
descs map[string]string
|
||||
lastOutput string
|
||||
lastError string
|
||||
spinner spinner.Model
|
||||
viewport viewport.Model // 可滚动查看器,用于浏览超出一屏的长输出
|
||||
owner string
|
||||
repo string
|
||||
width int
|
||||
height int
|
||||
quitting bool
|
||||
showWelcome bool
|
||||
}
|
||||
|
||||
var promptStyle = lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("6"))
|
||||
var successStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("10"))
|
||||
var errorStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("9")).Bold(true)
|
||||
var welcomeStyle = lipgloss.NewStyle().Faint(true)
|
||||
|
||||
// newReplModel creates a new REPL model.
|
||||
func newReplModel(owner, repo string) replModel {
|
||||
ti := textinput.New()
|
||||
ti.Prompt = buildPrompt(owner, repo)
|
||||
ti.Focus()
|
||||
ti.Width = 60
|
||||
|
||||
sp := spinner.New()
|
||||
sp.Spinner = spinner.Dot
|
||||
sp.Style = lipgloss.NewStyle().Foreground(lipgloss.Color("6"))
|
||||
|
||||
return replModel{
|
||||
state: stateInput,
|
||||
input: ti,
|
||||
executor: Executor{},
|
||||
shortcuts: shortcuts.GetAllShortcuts(),
|
||||
descs: shortcuts.GetDescriptions(),
|
||||
spinner: sp,
|
||||
owner: owner,
|
||||
repo: repo,
|
||||
showWelcome: true,
|
||||
}
|
||||
}
|
||||
|
||||
// buildPrompt creates the prompt string.
|
||||
func buildPrompt(owner, repo string) string {
|
||||
if owner != "" && repo != "" {
|
||||
return fmt.Sprintf("gitlink (%s/%s)> ", owner, repo)
|
||||
}
|
||||
return "gitlink> "
|
||||
}
|
||||
|
||||
// Init initializes the REPL.
|
||||
func (m replModel) Init() tea.Cmd {
|
||||
return textinput.Blink
|
||||
}
|
||||
|
||||
// Update is the main message dispatcher.
|
||||
func (m replModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
switch msg.(type) {
|
||||
case tea.WindowSizeMsg:
|
||||
wmsg := msg.(tea.WindowSizeMsg)
|
||||
m.width = wmsg.Width
|
||||
m.height = wmsg.Height
|
||||
// 保持 viewport 尺寸与终端同步(底部留 2 行给提示符/帮助行)。
|
||||
m.viewport.Width = wmsg.Width
|
||||
m.viewport.Height = wmsg.Height - 2
|
||||
return m, nil
|
||||
}
|
||||
|
||||
switch m.state {
|
||||
case stateInput:
|
||||
return m.updateInput(msg)
|
||||
case statePalette:
|
||||
return m.updatePalette(msg)
|
||||
case stateForm:
|
||||
return m.updateForm(msg)
|
||||
case stateExecuting:
|
||||
return m.updateExecuting(msg)
|
||||
case stateError:
|
||||
return m.updateError(msg)
|
||||
case stateOutput:
|
||||
return m.updateOutput(msg)
|
||||
}
|
||||
|
||||
return m, nil
|
||||
}
|
||||
|
||||
// updateInput handles the text input state.
|
||||
func (m replModel) updateInput(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
keyMsg, isKey := msg.(tea.KeyMsg)
|
||||
if isKey {
|
||||
switch keyMsg.Type {
|
||||
case tea.KeyRunes:
|
||||
// Trigger the command palette immediately when the user types "/"
|
||||
// as the first character of a fresh input — no Enter required.
|
||||
if m.input.Value() == "" && len(keyMsg.Runes) > 0 && keyMsg.Runes[0] == '/' {
|
||||
m.showWelcome = false
|
||||
m.input.SetValue("")
|
||||
m.palette = newPaletteModel(m.shortcuts, m.descs, m.width, m.height)
|
||||
// Carry any extra characters typed alongside "/" as the initial query.
|
||||
if len(keyMsg.Runes) > 1 {
|
||||
query := string(keyMsg.Runes[1:])
|
||||
m.palette.search.SetValue(query)
|
||||
m.palette.filterItems(query)
|
||||
}
|
||||
m.state = statePalette
|
||||
return m, nil
|
||||
}
|
||||
|
||||
case tea.KeyEnter:
|
||||
val := strings.TrimSpace(m.input.Value())
|
||||
m.input.SetValue("")
|
||||
m.showWelcome = false
|
||||
|
||||
if val == "" {
|
||||
return m, nil
|
||||
}
|
||||
|
||||
// Exit commands
|
||||
if val == "exit" || val == "quit" {
|
||||
m.quitting = true
|
||||
return m, tea.Quit
|
||||
}
|
||||
|
||||
// Palette mode (also reachable via "/query" + Enter)
|
||||
if strings.HasPrefix(val, "/") {
|
||||
m.palette = newPaletteModel(m.shortcuts, m.descs, m.width, m.height)
|
||||
if len(val) > 1 {
|
||||
query := val[1:]
|
||||
m.palette.search.SetValue(query)
|
||||
m.palette.filterItems(query)
|
||||
}
|
||||
m.state = statePalette
|
||||
return m, nil
|
||||
}
|
||||
|
||||
// Direct command: "group +cmd ..."
|
||||
group, cmd, flagStr, ok := parseDirectCommand(val)
|
||||
if ok {
|
||||
s, found := findShortcut(m.shortcuts, group, cmd)
|
||||
if !found {
|
||||
m.lastError = fmt.Sprintf("Unknown command: %s +%s", group, cmd)
|
||||
m.state = stateError
|
||||
return m, nil
|
||||
}
|
||||
|
||||
shortMap := buildShortMap(s)
|
||||
args := parseFlagString(flagStr, shortMap)
|
||||
missing := missingRequiredFlags(s, args)
|
||||
|
||||
if len(missing) > 0 {
|
||||
// Show form with prefilled values
|
||||
m.form = newFormModel(group, s, m.width, m.height, args)
|
||||
m.state = stateForm
|
||||
return m, nil
|
||||
}
|
||||
|
||||
// Execute directly
|
||||
m.state = stateExecuting
|
||||
return m, m.executeCommand(group, s, args)
|
||||
}
|
||||
|
||||
// Unrecognized input
|
||||
m.lastError = fmt.Sprintf("Unknown input: %q\nType a command like \"issue +list\" or \"/\" to open the command palette.", val)
|
||||
m.state = stateError
|
||||
return m, nil
|
||||
|
||||
case tea.KeyCtrlD, tea.KeyCtrlC:
|
||||
m.quitting = true
|
||||
return m, tea.Quit
|
||||
}
|
||||
}
|
||||
|
||||
// Forward to text input
|
||||
var cmd tea.Cmd
|
||||
m.input, cmd = m.input.Update(msg)
|
||||
return m, cmd
|
||||
}
|
||||
|
||||
// executeCommand returns a tea.Cmd that runs a shortcut asynchronously.
|
||||
func (m replModel) executeCommand(group string, s *common.Shortcut, args map[string]string) tea.Cmd {
|
||||
return func() tea.Msg {
|
||||
output, err := m.executor.Execute(s, args)
|
||||
return execResultMsg{
|
||||
group: group,
|
||||
shortcut: s,
|
||||
args: args,
|
||||
output: output,
|
||||
err: err,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// updatePalette delegates to the palette sub-component.
|
||||
func (m replModel) updatePalette(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
var cmd tea.Cmd
|
||||
m.palette, cmd = m.palette.Update(msg)
|
||||
|
||||
if m.palette.quitting {
|
||||
m.palette.quitting = false
|
||||
m.state = stateInput
|
||||
return m, textinput.Blink
|
||||
}
|
||||
|
||||
if m.palette.result != nil {
|
||||
result := m.palette.result
|
||||
s := result.Shortcut
|
||||
|
||||
// Open the form whenever the command has ANY flags — not just required
|
||||
// ones. Many commands have "at-least-one-of" parameters (e.g. branch
|
||||
// +batch-protect needs --names OR --from) that can't be marked Required
|
||||
// individually, so skipping the form for "optional-only" commands left
|
||||
// users unable to supply them and the command failed at runtime.
|
||||
// Commands with no flags at all execute directly.
|
||||
if len(s.Flags) > 0 {
|
||||
m.form = newFormModel(result.Group, s, m.width, m.height, nil)
|
||||
m.state = stateForm
|
||||
return m, nil
|
||||
}
|
||||
|
||||
// No flags → execute directly
|
||||
m.state = stateExecuting
|
||||
return m, tea.Batch(m.executeCommand(result.Group, s, map[string]string{}), m.spinner.Tick)
|
||||
}
|
||||
|
||||
return m, cmd
|
||||
}
|
||||
|
||||
// updateForm delegates to the form sub-component.
|
||||
func (m replModel) updateForm(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
var cmd tea.Cmd
|
||||
m.form, cmd = m.form.Update(msg)
|
||||
|
||||
if m.form.cancelled {
|
||||
m.form.cancelled = false
|
||||
m.state = stateInput
|
||||
return m, textinput.Blink
|
||||
}
|
||||
|
||||
if m.form.submitted {
|
||||
args := m.form.values
|
||||
group := m.form.group
|
||||
s := m.form.shortcut
|
||||
m.form.submitted = false
|
||||
m.state = stateExecuting
|
||||
return m, m.executeCommand(group, s, args)
|
||||
}
|
||||
|
||||
return m, cmd
|
||||
}
|
||||
|
||||
// updateExecuting waits for the execResultMsg.
|
||||
func (m replModel) updateExecuting(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
switch msg := msg.(type) {
|
||||
case execResultMsg:
|
||||
if msg.err != nil {
|
||||
m.lastError = formatInteractiveError(msg.group, msg.shortcut, msg.err)
|
||||
m.lastOutput = ""
|
||||
m.state = stateError
|
||||
return m, nil
|
||||
}
|
||||
display := formatCommandDisplay(msg.group, msg.shortcut, msg.args)
|
||||
content := fmt.Sprintf(" ✓ 执行: %s\n\n%s", display, msg.output)
|
||||
// 输出超过可用高度(留 4 行给提示符与边距)时进入可滚动查看器,
|
||||
// 否则保持原行为:直接显示在输入状态。
|
||||
lineCount := strings.Count(content, "\n") + 1
|
||||
if m.height > 0 && lineCount > m.height-4 {
|
||||
m.viewport = viewport.New(m.width, m.height-2)
|
||||
m.viewport.SetContent(content)
|
||||
m.viewport.GotoTop()
|
||||
m.lastOutput = ""
|
||||
m.lastError = ""
|
||||
m.state = stateOutput
|
||||
return m, nil
|
||||
}
|
||||
m.lastOutput = content
|
||||
m.lastError = ""
|
||||
m.state = stateInput
|
||||
m.input.Focus()
|
||||
return m, textinput.Blink
|
||||
|
||||
case spinner.TickMsg:
|
||||
var cmd tea.Cmd
|
||||
m.spinner, cmd = m.spinner.Update(msg)
|
||||
return m, cmd
|
||||
}
|
||||
|
||||
return m, nil
|
||||
}
|
||||
|
||||
// updateError waits for Enter to return to input state.
|
||||
func (m replModel) updateError(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
keyMsg, isKey := msg.(tea.KeyMsg)
|
||||
if isKey {
|
||||
switch keyMsg.Type {
|
||||
case tea.KeyEnter, tea.KeyEsc:
|
||||
m.lastError = ""
|
||||
m.state = stateInput
|
||||
m.input.Focus()
|
||||
return m, textinput.Blink
|
||||
case tea.KeyCtrlD, tea.KeyCtrlC:
|
||||
m.quitting = true
|
||||
return m, tea.Quit
|
||||
}
|
||||
}
|
||||
return m, nil
|
||||
}
|
||||
|
||||
// updateOutput 处理输出查看器状态:用方向键/PageUp/PageDown 浏览长输出,
|
||||
// 按 q 或 Esc 返回输入状态。
|
||||
func (m replModel) updateOutput(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
switch msg := msg.(type) {
|
||||
case tea.KeyMsg:
|
||||
switch msg.Type {
|
||||
case tea.KeyEsc, tea.KeyCtrlC:
|
||||
m.state = stateInput
|
||||
m.input.Focus()
|
||||
return m, textinput.Blink
|
||||
case tea.KeyRunes:
|
||||
// q / Q 返回输入
|
||||
if len(msg.Runes) > 0 && (msg.Runes[0] == 'q' || msg.Runes[0] == 'Q') {
|
||||
m.state = stateInput
|
||||
m.input.Focus()
|
||||
return m, textinput.Blink
|
||||
}
|
||||
}
|
||||
}
|
||||
// 其余按键(方向键、PageUp/Down、Home/End)转发给 viewport,
|
||||
// viewport 内置响应这些按键,无需手动处理。
|
||||
var cmd tea.Cmd
|
||||
m.viewport, cmd = m.viewport.Update(msg)
|
||||
return m, cmd
|
||||
}
|
||||
|
||||
// View renders the REPL based on current state.
|
||||
func (m replModel) View() string {
|
||||
if m.quitting {
|
||||
return ""
|
||||
}
|
||||
|
||||
switch m.state {
|
||||
case stateInput:
|
||||
var sb strings.Builder
|
||||
if m.showWelcome {
|
||||
sb.WriteString(welcomeStyle.Render("Welcome to gitlink-cli interactive mode."))
|
||||
sb.WriteString("\n")
|
||||
sb.WriteString(welcomeStyle.Render("Type / to open the command palette, \"exit\" or Ctrl+D to quit."))
|
||||
sb.WriteString("\n\n")
|
||||
}
|
||||
if m.lastOutput != "" {
|
||||
sb.WriteString(successStyle.Render(m.lastOutput))
|
||||
sb.WriteString("\n")
|
||||
}
|
||||
sb.WriteString(m.input.View())
|
||||
return sb.String()
|
||||
|
||||
case statePalette:
|
||||
return m.palette.View()
|
||||
|
||||
case stateForm:
|
||||
return m.form.View()
|
||||
|
||||
case stateExecuting:
|
||||
return fmt.Sprintf("\n %s Executing command...\n", m.spinner.View())
|
||||
|
||||
case stateError:
|
||||
var sb strings.Builder
|
||||
sb.WriteString("\n")
|
||||
sb.WriteString(errorStyle.Render(m.lastError))
|
||||
sb.WriteString("\n\n")
|
||||
sb.WriteString(formHelpStyle.Render(" Press Enter to continue"))
|
||||
sb.WriteString("\n")
|
||||
return sb.String()
|
||||
|
||||
case stateOutput:
|
||||
return m.viewport.View() + "\n" +
|
||||
formHelpStyle.Render(" ↑↓/PgUp/PgDn 滚动 q/Esc 返回")
|
||||
}
|
||||
|
||||
return ""
|
||||
}
|
||||
|
||||
// Run starts the interactive REPL.
|
||||
func Run(owner, repo string) error {
|
||||
m := newReplModel(owner, repo)
|
||||
p := tea.NewProgram(m, tea.WithAltScreen())
|
||||
_, err := p.Run()
|
||||
return err
|
||||
}
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
package interactive
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
tea "github.com/charmbracelet/bubbletea"
|
||||
)
|
||||
|
||||
// TestSlashTriggersPaletteImmediately verifies that typing "/" as the first
|
||||
// character (KeyRunes) switches the REPL into the palette state without
|
||||
// requiring Enter. This is the regression test for the bug where the
|
||||
// command palette never appeared.
|
||||
func TestSlashTriggersPaletteImmediately(t *testing.T) {
|
||||
m := newReplModel("owner", "repo")
|
||||
if m.state != stateInput {
|
||||
t.Fatalf("expected initial state stateInput, got %v", m.state)
|
||||
}
|
||||
|
||||
// Simulate the user pressing the "/" key.
|
||||
// bubbletea delivers printable chars as KeyRunes with the runes populated.
|
||||
keySlash := tea.KeyMsg{Type: tea.KeyRunes, Runes: []rune{'/'}}
|
||||
newModel, _ := m.Update(keySlash)
|
||||
|
||||
repl, ok := newModel.(replModel)
|
||||
if !ok {
|
||||
t.Fatalf("expected replModel, got %T", newModel)
|
||||
}
|
||||
if repl.state != statePalette {
|
||||
t.Fatalf("expected state statePalette after typing '/', got %v", repl.state)
|
||||
}
|
||||
}
|
||||
|
||||
// TestSlashWithQueryCarriesIntoSearch verifies "/iss" pre-fills the palette search.
|
||||
func TestSlashWithQueryCarriesIntoSearch(t *testing.T) {
|
||||
m := newReplModel("owner", "repo")
|
||||
|
||||
keySlashQuery := tea.KeyMsg{Type: tea.KeyRunes, Runes: []rune{'/', 'i', 's', 's'}}
|
||||
newModel, _ := m.Update(keySlashQuery)
|
||||
|
||||
repl, ok := newModel.(replModel)
|
||||
if !ok {
|
||||
t.Fatalf("expected replModel, got %T", newModel)
|
||||
}
|
||||
if repl.state != statePalette {
|
||||
t.Fatalf("expected state statePalette, got %v", repl.state)
|
||||
}
|
||||
if got := repl.palette.search.Value(); got != "iss" {
|
||||
t.Fatalf("expected palette search 'iss', got %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestNonSlashInputStaysInInputState verifies ordinary text doesn't open the palette.
|
||||
func TestNonSlashInputStaysInInputState(t *testing.T) {
|
||||
m := newReplModel("owner", "repo")
|
||||
|
||||
keyA := tea.KeyMsg{Type: tea.KeyRunes, Runes: []rune{'a'}}
|
||||
newModel, _ := m.Update(keyA)
|
||||
|
||||
repl, ok := newModel.(replModel)
|
||||
if !ok {
|
||||
t.Fatalf("expected replModel, got %T", newModel)
|
||||
}
|
||||
if repl.state != stateInput {
|
||||
t.Fatalf("typing 'a' should stay in stateInput, got %v", repl.state)
|
||||
}
|
||||
}
|
||||
135
cmd/root.go
135
cmd/root.go
|
|
@ -1,133 +1,64 @@
|
|||
package cmd
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
aliasCmd "github.com/gitlink-org/gitlink-cli/cmd/alias"
|
||||
apiCmd "github.com/gitlink-org/gitlink-cli/cmd/api"
|
||||
browseCmd "github.com/gitlink-org/gitlink-cli/cmd/browse"
|
||||
statusCmd "github.com/gitlink-org/gitlink-cli/cmd/status"
|
||||
authCmd "github.com/gitlink-org/gitlink-cli/cmd/auth"
|
||||
"github.com/gitlink-org/gitlink-cli/cmd/cmdutil"
|
||||
authCmd "github.com/gitlink-org/gitlink-cli/cmd/auth"
|
||||
apiCmd "github.com/gitlink-org/gitlink-cli/cmd/api"
|
||||
configCmd "github.com/gitlink-org/gitlink-cli/cmd/config"
|
||||
internalConfig "github.com/gitlink-org/gitlink-cli/internal/config"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/i18n"
|
||||
interactiveCmd "github.com/gitlink-org/gitlink-cli/cmd/interactive"
|
||||
"github.com/gitlink-org/gitlink-cli/shortcuts"
|
||||
)
|
||||
|
||||
var Version = "dev"
|
||||
|
||||
type RootOptions struct {
|
||||
Version string
|
||||
Args []string
|
||||
Env map[string]string
|
||||
ConfigLang string
|
||||
var colorMode string
|
||||
|
||||
var rootCmd = &cobra.Command{
|
||||
Use: "gitlink-cli",
|
||||
Short: "GitLink CLI — command-line tool for gitlink.org.cn",
|
||||
Long: `gitlink-cli is a command-line interface for the GitLink (确实开源) platform, providing repository management, issue tracking, pull requests, CI/CD, and AI-powered workflows.`,
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
PersistentPreRun: func(cmd *cobra.Command, args []string) {
|
||||
cmdutil.ColorMode = colorMode
|
||||
},
|
||||
}
|
||||
|
||||
func NewRootCmd(opts RootOptions, tr *i18n.Translator) (*cobra.Command, error) {
|
||||
if tr == nil {
|
||||
var err error
|
||||
tr, err = newTranslator(opts.Args, opts.Env, opts.ConfigLang)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
func init() {
|
||||
rootCmd.PersistentFlags().StringVar(&cmdutil.Owner, "owner", "", "Repository owner (auto-detected from git remote)")
|
||||
rootCmd.PersistentFlags().StringVar(&cmdutil.Repo, "repo", "", "Repository name (auto-detected from git remote)")
|
||||
rootCmd.PersistentFlags().StringVar(&cmdutil.Format, "format", "", "Output format: json, table, yaml (default: table)")
|
||||
rootCmd.PersistentFlags().BoolVar(&cmdutil.Debug, "debug", false, "Enable debug output")
|
||||
rootCmd.PersistentFlags().StringVar(&colorMode, "color", "auto", "Color output: auto, always, never")
|
||||
rootCmd.PersistentFlags().BoolVar(&cmdutil.AutoConfirm, "yes", false, "Skip confirmation prompts")
|
||||
|
||||
version := opts.Version
|
||||
if version == "" {
|
||||
version = Version
|
||||
}
|
||||
rootCmd.AddCommand(authCmd.NewAuthCmd())
|
||||
rootCmd.AddCommand(apiCmd.NewAPICmd())
|
||||
rootCmd.AddCommand(configCmd.NewConfigCmd())
|
||||
rootCmd.AddCommand(versionCmd)
|
||||
|
||||
rootCmd := &cobra.Command{
|
||||
Use: "gitlink-cli",
|
||||
Short: tr.T("cmd.root.short"),
|
||||
Long: tr.T("cmd.root.long"),
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
}
|
||||
shortcuts.RegisterAll(rootCmd)
|
||||
|
||||
rootCmd.PersistentFlags().StringVar(&cmdutil.Owner, "owner", "", tr.T("flag.owner"))
|
||||
rootCmd.PersistentFlags().StringVar(&cmdutil.Repo, "repo", "", tr.T("flag.repo"))
|
||||
rootCmd.PersistentFlags().StringVar(&cmdutil.Format, "format", "", tr.T("flag.format"))
|
||||
rootCmd.PersistentFlags().BoolVar(&cmdutil.Debug, "debug", false, tr.T("flag.debug"))
|
||||
rootCmd.PersistentFlags().StringVar(&cmdutil.Lang, "lang", "", tr.T("flag.lang"))
|
||||
|
||||
rootCmd.AddCommand(authCmd.NewAuthCmd(tr))
|
||||
rootCmd.AddCommand(apiCmd.NewAPICmd(tr))
|
||||
rootCmd.AddCommand(configCmd.NewConfigCmd(tr))
|
||||
rootCmd.AddCommand(newVersionCmd(version, tr))
|
||||
rootCmd.AddCommand(aliasCmd.NewAliasCmd())
|
||||
rootCmd.AddCommand(browseCmd.NewBrowseCmd())
|
||||
rootCmd.AddCommand(statusCmd.NewStatusCmd())
|
||||
|
||||
shortcuts.RegisterAll(rootCmd, tr)
|
||||
|
||||
if opts.Args != nil {
|
||||
rootCmd.SetArgs(opts.Args)
|
||||
}
|
||||
return rootCmd, nil
|
||||
rootCmd.AddCommand(interactiveCmd.NewInteractiveCmd())
|
||||
}
|
||||
|
||||
func newVersionCmd(version string, tr *i18n.Translator) *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "version",
|
||||
Short: tr.T("cmd.version.short"),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
_, err := fmt.Fprintln(cmd.OutOrStdout(), tr.Tf("output.version", i18n.Args{"version": version}))
|
||||
return err
|
||||
},
|
||||
}
|
||||
var versionCmd = &cobra.Command{
|
||||
Use: "version",
|
||||
Short: "Print version information",
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
fmt.Printf("gitlink-cli %s\n", Version)
|
||||
},
|
||||
}
|
||||
|
||||
func Execute() error {
|
||||
args := os.Args[1:]
|
||||
rootCmd, err := NewRootCmd(RootOptions{
|
||||
Version: Version,
|
||||
Args: args,
|
||||
}, nil)
|
||||
if err != nil {
|
||||
fmt.Fprintln(os.Stderr, err)
|
||||
return err
|
||||
}
|
||||
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
fmt.Fprintln(os.Stderr, err)
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func newTranslator(args []string, env map[string]string, configLang string) (*i18n.Translator, error) {
|
||||
available, err := i18n.AvailableLocales()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if env == nil {
|
||||
env = i18n.EnvMap()
|
||||
}
|
||||
if configLang == "" {
|
||||
configLang = loadConfigLangBestEffort()
|
||||
}
|
||||
resolved := i18n.ResolveLocaleDetailed(i18n.ResolveOptions{
|
||||
ExplicitLang: i18n.PreScanLang(args),
|
||||
Env: env,
|
||||
ConfigLang: configLang,
|
||||
}, available)
|
||||
if !resolved.Supported && (resolved.Source == "flag" || resolved.Source == "env") {
|
||||
tr := i18n.Default()
|
||||
return nil, errors.New(tr.Tf("error.unsupported_language", i18n.Args{"lang": resolved.Requested}))
|
||||
}
|
||||
return i18n.New(i18n.Options{Locale: resolved.Locale})
|
||||
}
|
||||
|
||||
func loadConfigLangBestEffort() string {
|
||||
cfg, err := internalConfig.Load()
|
||||
if err != nil {
|
||||
return ""
|
||||
}
|
||||
return cfg.Lang
|
||||
}
|
||||
|
|
|
|||
310
cmd/root_test.go
310
cmd/root_test.go
|
|
@ -1,310 +0,0 @@
|
|||
package cmd
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/internal/i18n"
|
||||
)
|
||||
|
||||
func TestRootHelpUsesSelectedLocale(t *testing.T) {
|
||||
tr, err := i18n.New(i18n.Options{Locale: "zh-CN"})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
root, err := NewRootCmd(RootOptions{Version: "test", Args: []string{"--help"}}, tr)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
help := out.String()
|
||||
if !strings.Contains(help, "用于管理 GitLink 上的仓库") {
|
||||
t.Fatalf("expected Chinese root long help, got:\n%s", help)
|
||||
}
|
||||
if !strings.Contains(help, "仓库操作") {
|
||||
t.Fatalf("expected Chinese shortcut group help, got:\n%s", help)
|
||||
}
|
||||
if !strings.Contains(help, "认证命令") || !strings.Contains(help, "管理 gitlink-cli 配置") {
|
||||
t.Fatalf("expected Chinese core command help, got:\n%s", help)
|
||||
}
|
||||
if !strings.Contains(help, "--lang") || !strings.Contains(help, "显示语言") {
|
||||
t.Fatalf("expected localized lang flag help, got:\n%s", help)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRootHelpUsesExplicitLang(t *testing.T) {
|
||||
root, err := NewRootCmd(RootOptions{Version: "test", Args: []string{"--lang", "zh-CN", "--help"}, Env: map[string]string{}}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
help := out.String()
|
||||
for _, want := range []string{"用于管理 GitLink", "显示语言", "仓库"} {
|
||||
if !strings.Contains(help, want) {
|
||||
t.Fatalf("expected %q in help, got:\n%s", want, help)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRootHelpUsesEnvLang(t *testing.T) {
|
||||
root, err := NewRootCmd(RootOptions{
|
||||
Version: "test",
|
||||
Args: []string{"repo", "--help"},
|
||||
Env: map[string]string{"GITLINK_LANG": "zh-CN"},
|
||||
}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
help := out.String()
|
||||
for _, want := range []string{"仓库操作", "仓库所有者", "仓库名称"} {
|
||||
if !strings.Contains(help, want) {
|
||||
t.Fatalf("expected %q in help, got:\n%s", want, help)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestExplicitLangOverridesConfigLang(t *testing.T) {
|
||||
root, err := NewRootCmd(RootOptions{
|
||||
Version: "test",
|
||||
Args: []string{"--lang", "en-US", "--help"},
|
||||
Env: map[string]string{},
|
||||
ConfigLang: "zh-CN",
|
||||
}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
help := out.String()
|
||||
if !strings.Contains(help, "Repository operations") {
|
||||
t.Fatalf("expected English help, got:\n%s", help)
|
||||
}
|
||||
if strings.Contains(help, "仓库操作") {
|
||||
t.Fatalf("expected explicit en-US to override config zh-CN, got:\n%s", help)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnsupportedExplicitLangReturnsError(t *testing.T) {
|
||||
_, err := NewRootCmd(RootOptions{
|
||||
Version: "test",
|
||||
Args: []string{"--lang", "fr-FR", "--help"},
|
||||
Env: map[string]string{},
|
||||
}, nil)
|
||||
if err == nil {
|
||||
t.Fatal("expected unsupported language error")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "unsupported language") {
|
||||
t.Fatalf("expected unsupported language error, got %q", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestRequireArgUsesLocalizedError(t *testing.T) {
|
||||
root, err := NewRootCmd(RootOptions{
|
||||
Version: "test",
|
||||
Args: []string{"--lang", "zh-CN", "repo", "+create"},
|
||||
Env: map[string]string{},
|
||||
}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
err = root.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected missing required flag error")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "缺少必需参数") {
|
||||
t.Fatalf("expected localized missing flag error, got %q", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestCoreCommandHelpUsesSelectedLocale(t *testing.T) {
|
||||
tr, err := i18n.New(i18n.Options{Locale: "zh-CN"})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
cases := []struct {
|
||||
args []string
|
||||
want []string
|
||||
}{
|
||||
{
|
||||
args: []string{"api", "--help"},
|
||||
want: []string{"向 GitLink API 发送任意 HTTP 请求", "--body", "请求体(JSON 字符串)"},
|
||||
},
|
||||
{
|
||||
args: []string{"auth", "login", "--help"},
|
||||
want: []string{"登录 GitLink", "--token", "通过粘贴已有 Token 登录"},
|
||||
},
|
||||
{
|
||||
args: []string{"config", "--help"},
|
||||
want: []string{"管理 gitlink-cli 配置", "初始化配置文件", "列出所有配置项"},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
root, err := NewRootCmd(RootOptions{Version: "test", Args: tc.args}, tr)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatalf("%v: %v", tc.args, err)
|
||||
}
|
||||
|
||||
help := out.String()
|
||||
for _, want := range tc.want {
|
||||
if !strings.Contains(help, want) {
|
||||
t.Fatalf("%v: expected %q in help, got:\n%s", tc.args, want, help)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestShortcutHelpUsesSelectedLocale(t *testing.T) {
|
||||
tr, err := i18n.New(i18n.Options{Locale: "zh-CN"})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
cases := []struct {
|
||||
args []string
|
||||
want []string
|
||||
}{
|
||||
{
|
||||
args: []string{"repo", "+create", "--help"},
|
||||
want: []string{"创建新仓库", "--name", "仓库名称", "--private", "设为私有仓库"},
|
||||
},
|
||||
{
|
||||
args: []string{"pr", "+review", "--help"},
|
||||
want: []string{"创建拉取请求评审", "--content", "评审内容", "--dry-run"},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
root, err := NewRootCmd(RootOptions{Version: "test", Args: tc.args}, tr)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatalf("%v: %v", tc.args, err)
|
||||
}
|
||||
|
||||
help := out.String()
|
||||
for _, want := range tc.want {
|
||||
if !strings.Contains(help, want) {
|
||||
t.Fatalf("%v: expected %q in help, got:\n%s", tc.args, want, help)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRemainingShortcutHelpUsesSelectedLocale(t *testing.T) {
|
||||
tr, err := i18n.New(i18n.Options{Locale: "zh-CN"})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
cases := []struct {
|
||||
args []string
|
||||
want []string
|
||||
}{
|
||||
{
|
||||
args: []string{"branch", "+create", "--help"},
|
||||
want: []string{"创建分支", "--from", "源分支或 Commit"},
|
||||
},
|
||||
{
|
||||
args: []string{"release", "+create", "--help"},
|
||||
want: []string{"创建发布", "--prerelease", "标记为预发布"},
|
||||
},
|
||||
{
|
||||
args: []string{"webhook", "+create", "--help"},
|
||||
want: []string{"创建仓库 Webhook", "--events", "逗号分隔的事件"},
|
||||
},
|
||||
{
|
||||
args: []string{"ci", "+logs", "--help"},
|
||||
want: []string{"查看构建日志", "--build", "构建编号"},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
root, err := NewRootCmd(RootOptions{Version: "test", Args: tc.args}, tr)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatalf("%v: %v", tc.args, err)
|
||||
}
|
||||
|
||||
help := out.String()
|
||||
for _, want := range tc.want {
|
||||
if !strings.Contains(help, want) {
|
||||
t.Fatalf("%v: expected %q in help, got:\n%s", tc.args, want, help)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestVersionUsesInjectedVersion(t *testing.T) {
|
||||
tr, err := i18n.New(i18n.Options{Locale: "en-US"})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
root, err := NewRootCmd(RootOptions{Version: "1.2.3", Args: []string{"version"}}, tr)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var out bytes.Buffer
|
||||
root.SetOut(&out)
|
||||
root.SetErr(&out)
|
||||
if err := root.Execute(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if got := strings.TrimSpace(out.String()); got != "gitlink-cli 1.2.3" {
|
||||
t.Fatalf("version output = %q", got)
|
||||
}
|
||||
}
|
||||
|
|
@ -1,589 +0,0 @@
|
|||
/*
|
||||
* 子赛题四「网页终端」HTTP 演示服务
|
||||
*
|
||||
* 前端搜索驱动界面 → 后端串行运行 Python 算法脚本
|
||||
* 支持 7 个科研分析维度(热点/画像/启发/谱系/合规/报告/可视化)
|
||||
* Python 子进程继承 GITLINK_TOKEN / DEEPSEEK_API_KEY 环境变量
|
||||
*
|
||||
* API:
|
||||
* GET /api/dimensions - 返回可用维度列表
|
||||
* POST /api/chain - 统一全链路分析入口
|
||||
* POST /api/run - 单场景执行(向后兼容)
|
||||
* GET /api/result/{key} - 查询缓存产物
|
||||
*/
|
||||
package server
|
||||
|
||||
import (
|
||||
"embed"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"net/http"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
//go:embed static/*
|
||||
var staticFS embed.FS
|
||||
|
||||
const defaultPort = 8080
|
||||
|
||||
// 场景定义:前端按钮 ↔ 后端 Python 脚本。
|
||||
type scenarioDef struct {
|
||||
Key string `json:"key"`
|
||||
Label string `json:"label"`
|
||||
Desc string `json:"desc"`
|
||||
Script string `json:"script"`
|
||||
Needs []string `json:"needs"` // 需要的输入: "owner","repo","keyword"
|
||||
Timeout int `json:"timeout_s"`
|
||||
}
|
||||
|
||||
var scenarios = []scenarioDef{
|
||||
{Key: "s1", Label: "S1 仓库洞悉", Desc: "科研项目演进谱系 + 创新点", Script: "lineage.py", Needs: []string{"owner", "repo"}, Timeout: 180},
|
||||
{Key: "s2", Label: "S2 知识图谱", Desc: "科研领域知识图谱(networkx)", Script: "graph_build.py", Needs: []string{"keyword"}, Timeout: 240},
|
||||
{Key: "s3", Label: "S3 合规复现", Desc: "许可证/密钥/复现性检查", Script: "repro.py", Needs: []string{"owner", "repo"}, Timeout: 120},
|
||||
{Key: "s4", Label: "S4 协作匹配", Desc: "学者×缺口 智能匹配", Script: "match.py", Needs: []string{"owner", "repo"}, Timeout: 180},
|
||||
{Key: "s5", Label: "S5 进度预警", Desc: "周报 + 风险预警", Script: "report.py", Needs: []string{"owner", "repo"}, Timeout: 180},
|
||||
{Key: "s6", Label: "S6 成果可视化", Desc: "交互图表(plotly)", Script: "visual.py", Needs: []string{"owner", "repo"}, Timeout: 240},
|
||||
{Key: "hotspot", Label: "🔥 热点追踪(关键词)", Desc: "关键词搜索:飙升项目+活跃讨论+主题热度+学者团队", Script: "hotspot.py", Needs: []string{"keyword"}, Timeout: 300},
|
||||
{Key: "hotspot-cat", Label: "🔥 热点追踪(分类精选)", Desc: "GitLink 官方分类精选 → 领域热点(缩范围)", Script: "hotspot.py", Needs: []string{"category"}, Timeout: 300},
|
||||
{Key: "profile", Label: "🪪 主体画像", Desc: "项目画像:主题/语言/贡献者/研究维度评分", Script: "profile.py", Needs: []string{"owner", "repo"}, Timeout: 150},
|
||||
{Key: "inspire", Label: "💡 创新启发", Desc: "缺口挖掘 + 合作者匹配 + LLM 研究方向建议", Script: "inspire.py", Needs: []string{"owner", "repo"}, Timeout: 240},
|
||||
{Key: "chain", Label: "🔬 全链路", Desc: "分类→热点→画像→启发→合规→分析(一条命令打通)", Script: "research.py", Needs: []string{"category"}, Timeout: 600},
|
||||
}
|
||||
|
||||
// dimensionDef 分析维度:前端展示用,对应一个 Python 脚本。
|
||||
type dimensionDef struct {
|
||||
Key string `json:"key"`
|
||||
Label string `json:"label"`
|
||||
Icon string `json:"icon"`
|
||||
Desc string `json:"desc"`
|
||||
Script string `json:"script"`
|
||||
Needs []string `json:"needs"` // 需要的参数: "keyword","category","owner","repo","owner_repo"
|
||||
Timeout int `json:"timeout_s"`
|
||||
}
|
||||
|
||||
var dimensions = []dimensionDef{
|
||||
{Key: "hotspot", Label: "科研热点分析", Icon: "🔥", Desc: "飙升项目 + 活跃讨论 + 主题热度 + 核心学者", Script: "hotspot.py", Needs: []string{"keyword_or_category"}, Timeout: 300},
|
||||
{Key: "profile", Label: "主体画像", Icon: "🪪", Desc: "项目/学者画像:主题向量/语言/研究维度评分", Script: "profile.py", Needs: []string{"owner_repo_or_category"}, Timeout: 150},
|
||||
{Key: "inspire", Label: "创新启发", Icon: "💡", Desc: "缺口挖掘 + 合作者匹配 + LLM 研究方向建议", Script: "inspire.py", Needs: []string{"owner_repo_or_category"}, Timeout: 240},
|
||||
{Key: "lineage", Label: "演进谱系", Icon: "🌳", Desc: "创新点识别 + 项目演化分支 + 贡献者参与分析", Script: "lineage.py", Needs: []string{"owner", "repo"}, Timeout: 180},
|
||||
{Key: "repro", Label: "合规复现", Icon: "✅", Desc: "许可证/依赖锁定/容器化/密钥泄漏/复现性评分", Script: "repro.py", Needs: []string{"owner", "repo"}, Timeout: 120},
|
||||
{Key: "report", Label: "进度报告", Icon: "📋", Desc: "周报 + 里程碑追踪 + 风险预警(交通灯系统)", Script: "report.py", Needs: []string{"owner", "repo"}, Timeout: 180},
|
||||
{Key: "visual", Label: "成果可视化", Icon: "📊", Desc: "交互式 Plotly 图表:时间线/热力图/语言饼图/Gantt", Script: "visual.py", Needs: []string{"owner", "repo"}, Timeout: 240},
|
||||
}
|
||||
|
||||
// chainRequest 统一分析请求。
|
||||
type chainRequest struct {
|
||||
Dimensions []string `json:"dimensions"` // 选中的维度 key 列表
|
||||
Keyword string `json:"keyword"`
|
||||
Owner string `json:"owner"`
|
||||
Repo string `json:"repo"`
|
||||
Category string `json:"category"`
|
||||
}
|
||||
|
||||
// dimensionResult 单个维度的运行结果。
|
||||
type dimensionResult struct {
|
||||
Key string `json:"key"`
|
||||
Label string `json:"label"`
|
||||
OK bool `json:"ok"`
|
||||
Error string `json:"error,omitempty"`
|
||||
Duration string `json:"duration"`
|
||||
Command string `json:"command"`
|
||||
Stdout string `json:"stdout"`
|
||||
OutDir string `json:"out_dir"`
|
||||
Artifacts map[string]string `json:"artifacts"`
|
||||
}
|
||||
|
||||
// chainResponse 统一分析 API 返回。
|
||||
type chainResponse struct {
|
||||
OK bool `json:"ok"`
|
||||
SessionID string `json:"session_id"`
|
||||
Duration string `json:"duration"`
|
||||
Results map[string]*dimensionResult `json:"results"`
|
||||
}
|
||||
|
||||
type Options struct {
|
||||
Port int
|
||||
ResearchDir string // scripts/research 目录
|
||||
WorkDir string // 产物输出根目录
|
||||
Token string // 可选鉴权 token
|
||||
LLMKey string // LLM API Key(内置到服务端,非前端输入)
|
||||
LLMBase string // LLM API Base URL
|
||||
LLMModel string // LLM Model 名称
|
||||
GitLinkToken string // GitLink API Token(内置,Python 子进程通过 GITLINK_TOKEN 使用)
|
||||
}
|
||||
|
||||
func NewServerCmd() *cobra.Command {
|
||||
opts := Options{Port: defaultPort, ResearchDir: "scripts/research", WorkDir: "research-output", LLMKey: "sk-52b7f7db19fe41118d3b931bded9403c", LLMBase: "https://api.deepseek.com/anthropic", LLMModel: "deepseek-v4-pro", GitLinkToken: "330e35fbb163da345df372b4cbe1cf973aae2b67"}
|
||||
cmd := &cobra.Command{
|
||||
Use: "server",
|
||||
Short: "启动子赛题四网页终端(HTTP 演示服务)",
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
return Run(opts)
|
||||
},
|
||||
}
|
||||
cmd.Flags().IntVarP(&opts.Port, "port", "p", defaultPort, "监听端口")
|
||||
cmd.Flags().StringVar(&opts.ResearchDir, "research-dir", "scripts/research", "scripts/research 目录")
|
||||
cmd.Flags().StringVar(&opts.WorkDir, "work-dir", "research-output", "产物输出根目录")
|
||||
cmd.Flags().StringVar(&opts.Token, "token", "", "可选鉴权 token(亦可用 DEMO_TOKEN 环境变量)")
|
||||
cmd.Flags().StringVar(&opts.LLMKey, "llm-key", opts.LLMKey, "LLM API Key(默认内置)")
|
||||
cmd.Flags().StringVar(&opts.LLMBase, "llm-base", opts.LLMBase, "LLM API Base URL")
|
||||
cmd.Flags().StringVar(&opts.LLMModel, "llm-model", opts.LLMModel, "LLM Model 名称")
|
||||
cmd.Flags().StringVar(&opts.GitLinkToken, "gitlink-token", opts.GitLinkToken, "GitLink API Token(默认内置)")
|
||||
return cmd
|
||||
}
|
||||
|
||||
// Run 启动 HTTP 服务(阻塞)。
|
||||
func Run(opts Options) error {
|
||||
if t := os.Getenv("DEMO_TOKEN"); t != "" && opts.Token == "" {
|
||||
opts.Token = t
|
||||
}
|
||||
// LLM key 优先级:--llm-key > DEEPSEEK_API_KEY > LLM_API_KEY
|
||||
if opts.LLMKey == "" {
|
||||
if k := os.Getenv("DEEPSEEK_API_KEY"); k != "" {
|
||||
opts.LLMKey = k
|
||||
} else if k := os.Getenv("LLM_API_KEY"); k != "" {
|
||||
opts.LLMKey = k
|
||||
}
|
||||
}
|
||||
// GitLink token:内置默认值注入进程环境,子进程自动继承
|
||||
if opts.GitLinkToken != "" && os.Getenv("GITLINK_TOKEN") == "" {
|
||||
_ = os.Setenv("GITLINK_TOKEN", opts.GitLinkToken)
|
||||
}
|
||||
// 让 python 子进程复用本二进制(gitlink_data.cli_path 读 GITLINK_CLI),免去额外配置
|
||||
if os.Getenv("GITLINK_CLI") == "" {
|
||||
if exe, err := filepath.Abs(os.Args[0]); err == nil {
|
||||
_ = os.Setenv("GITLINK_CLI", exe)
|
||||
}
|
||||
}
|
||||
_ = os.MkdirAll(opts.WorkDir, 0o755)
|
||||
|
||||
mux := http.NewServeMux()
|
||||
h := &handler{opts: opts}
|
||||
|
||||
mux.HandleFunc("GET /api/scenarios", h.handleScenarios)
|
||||
mux.HandleFunc("POST /api/run", h.handleRun)
|
||||
mux.HandleFunc("GET /api/result/{key}", h.handleResult)
|
||||
mux.HandleFunc("GET /api/health", h.handleHealth)
|
||||
mux.HandleFunc("GET /api/dimensions", h.handleDimensions)
|
||||
mux.HandleFunc("POST /api/chain", h.handleChain)
|
||||
|
||||
sub, err := fs.Sub(staticFS, "static")
|
||||
if err != nil {
|
||||
return fmt.Errorf("static fs: %w", err)
|
||||
}
|
||||
mux.Handle("GET /", http.FileServer(http.FS(sub)))
|
||||
|
||||
addr := fmt.Sprintf(":%d", opts.Port)
|
||||
fmt.Fprintf(os.Stderr, "子赛题四 网页终端已启动: http://localhost%s\n", addr)
|
||||
fmt.Fprintf(os.Stderr, " research-dir=%s work-dir=%s auth=%v\n", opts.ResearchDir, opts.WorkDir, opts.Token != "")
|
||||
if opts.LLMKey != "" {
|
||||
fmt.Fprintf(os.Stderr, " LLM: enabled (model=%s)\n", opts.LLMModel)
|
||||
} else {
|
||||
fmt.Fprintf(os.Stderr, " LLM: disabled (no key)\n")
|
||||
}
|
||||
srv := &http.Server{Addr: addr, Handler: mux, ReadHeaderTimeout: 10 * time.Second}
|
||||
return srv.ListenAndServe()
|
||||
}
|
||||
|
||||
type handler struct {
|
||||
opts Options
|
||||
mu sync.Mutex // 串行化场景执行,避免并发打爆 GitLink API
|
||||
}
|
||||
|
||||
func (h *handler) authed(r *http.Request) bool {
|
||||
if h.opts.Token == "" {
|
||||
return true
|
||||
}
|
||||
return r.Header.Get("X-Demo-Token") == h.opts.Token
|
||||
}
|
||||
|
||||
func (h *handler) handleHealth(w http.ResponseWriter, r *http.Request) {
|
||||
writeJSON(w, map[string]any{"ok": true, "scenarios": len(scenarios), "dimensions": len(dimensions)})
|
||||
}
|
||||
|
||||
func (h *handler) handleDimensions(w http.ResponseWriter, r *http.Request) {
|
||||
if !h.authed(r) {
|
||||
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
writeJSON(w, map[string]any{"ok": true, "dimensions": dimensions})
|
||||
}
|
||||
|
||||
func (h *handler) handleScenarios(w http.ResponseWriter, r *http.Request) {
|
||||
if !h.authed(r) {
|
||||
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
writeJSON(w, map[string]any{"ok": true, "scenarios": scenarios})
|
||||
}
|
||||
|
||||
// handleResult 返回某场景最近一次运行的产物(供 result.html 独立结果页按 key 读取,
|
||||
// URL 可刷新/分享,便于演示讲解)。无需鉴权串行锁——只读已落盘产物。
|
||||
func (h *handler) handleResult(w http.ResponseWriter, r *http.Request) {
|
||||
if !h.authed(r) {
|
||||
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
key := r.PathValue("key")
|
||||
sc, ok := findScenario(key)
|
||||
if !ok {
|
||||
writeJSON(w, map[string]any{"ok": false, "error": "unknown scenario: " + key})
|
||||
return
|
||||
}
|
||||
outDir := filepath.Join(h.opts.WorkDir, sc.Key)
|
||||
writeJSON(w, map[string]any{
|
||||
"ok": true,
|
||||
"scenario": sc.Key,
|
||||
"label": sc.Label,
|
||||
"desc": sc.Desc,
|
||||
"artifacts": readArtifacts(outDir),
|
||||
})
|
||||
}
|
||||
|
||||
type runRequest struct {
|
||||
Scenario string `json:"scenario"`
|
||||
Owner string `json:"owner"`
|
||||
Repo string `json:"repo"`
|
||||
Keyword string `json:"keyword"`
|
||||
Category string `json:"category"`
|
||||
}
|
||||
|
||||
func (h *handler) handleRun(w http.ResponseWriter, r *http.Request) {
|
||||
if !h.authed(r) {
|
||||
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
var req runRequest
|
||||
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
||||
writeJSON(w, map[string]any{"ok": false, "error": "bad request: " + err.Error()})
|
||||
return
|
||||
}
|
||||
sc, ok := findScenario(req.Scenario)
|
||||
if !ok {
|
||||
writeJSON(w, map[string]any{"ok": false, "error": "unknown scenario: " + req.Scenario})
|
||||
return
|
||||
}
|
||||
for _, need := range sc.Needs {
|
||||
if (need == "keyword" && req.Keyword == "") ||
|
||||
(need == "owner" && req.Owner == "") ||
|
||||
(need == "repo" && req.Repo == "") ||
|
||||
(need == "category" && req.Category == "") {
|
||||
writeJSON(w, map[string]any{"ok": false, "error": "missing parameter: " + need})
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// 串行执行:一次只跑一个场景,保护 GitLink API。
|
||||
h.mu.Lock()
|
||||
defer h.mu.Unlock()
|
||||
|
||||
scriptPath := filepath.Join(h.opts.ResearchDir, sc.Script)
|
||||
outDir := filepath.Join(h.opts.WorkDir, sc.Key)
|
||||
_ = os.MkdirAll(outDir, 0o755)
|
||||
|
||||
argv := []string{scriptPath, "--out", outDir}
|
||||
if contains(sc.Needs, "owner") {
|
||||
argv = append(argv, "--owner", req.Owner, "--repo", req.Repo)
|
||||
}
|
||||
if contains(sc.Needs, "keyword") {
|
||||
argv = append(argv, "--keywords", req.Keyword)
|
||||
}
|
||||
if contains(sc.Needs, "category") {
|
||||
argv = append(argv, "--category", req.Category)
|
||||
}
|
||||
// chain 支持可选焦点仓(省略则自动取热点榜 top-1)
|
||||
if sc.Key == "chain" && req.Owner != "" && req.Repo != "" {
|
||||
argv = append(argv, "--repo", req.Owner+"/"+req.Repo)
|
||||
}
|
||||
|
||||
// python3 优先,回退 python
|
||||
py, err := pythonBin()
|
||||
if err != nil {
|
||||
writeJSON(w, map[string]any{"ok": false, "error": err.Error()})
|
||||
return
|
||||
}
|
||||
cmd := exec.Command(py, argv...)
|
||||
// 子进程复用本二进制(python 经 GITLINK_CLI 找 gitlink-cli);直接注入子进程 env,最稳。
|
||||
env := os.Environ()
|
||||
if !envHas(env, "GITLINK_CLI") {
|
||||
if exe, err := filepath.Abs(os.Args[0]); err == nil {
|
||||
env = append(env, "GITLINK_CLI="+exe)
|
||||
}
|
||||
}
|
||||
cmd.Env = env
|
||||
start := time.Now()
|
||||
out, err := cmd.CombinedOutput()
|
||||
dur := time.Since(start)
|
||||
resp := map[string]any{
|
||||
"ok": err == nil,
|
||||
"scenario": sc.Key,
|
||||
"command": py + " " + strings.Join(argv, " "),
|
||||
"duration": dur.Truncate(time.Millisecond).String(),
|
||||
"stdout": string(out),
|
||||
"out_dir": outDir,
|
||||
}
|
||||
if err != nil {
|
||||
resp["error"] = err.Error()
|
||||
}
|
||||
// 附带读取关键产物(json + 第一个 mmd + report.md),便于前端直接渲染
|
||||
resp["artifacts"] = readArtifacts(outDir)
|
||||
writeJSON(w, resp)
|
||||
}
|
||||
|
||||
// handleChain 统一全链路科研分析入口
|
||||
//
|
||||
// 接受维度 key 列表 + 关键词/分类/仓库参数,串行执行各 Python 脚本,
|
||||
// 聚合结果返回给前端 Tab 面板渲染。每个维度独立计时并记录成功/失败状态。
|
||||
// 复用全局 mutex 防止并发打爆 GitLink API。
|
||||
//
|
||||
// 参数:
|
||||
// w - HTTP ResponseWriter
|
||||
// r - HTTP Request(JSON body 为 chainRequest)
|
||||
//
|
||||
// 返回:
|
||||
// JSON chainResponse,包含 session_id、总耗时、各维度结果映射
|
||||
func (h *handler) handleChain(w http.ResponseWriter, r *http.Request) {
|
||||
if !h.authed(r) {
|
||||
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
var req chainRequest
|
||||
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
||||
writeJSON(w, chainResponse{OK: false, Results: map[string]*dimensionResult{"_error": {Key: "_error", Label: "parse error", OK: false, Error: "bad request: " + err.Error()}}})
|
||||
return
|
||||
}
|
||||
if len(req.Dimensions) == 0 {
|
||||
writeJSON(w, chainResponse{OK: false, Results: map[string]*dimensionResult{"_error": {Key: "_error", Label: "no dimensions", OK: false, Error: "至少选择一个分析维度"}}})
|
||||
return
|
||||
}
|
||||
|
||||
// 校验所有维度 key 合法
|
||||
for _, dk := range req.Dimensions {
|
||||
if _, ok := findDimension(dk); !ok {
|
||||
writeJSON(w, chainResponse{OK: false, Results: map[string]*dimensionResult{"_error": {Key: dk, Label: dk, OK: false, Error: "未知分析维度: " + dk}}})
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// 串行执行(复用 mutex 保护 GitLink API)
|
||||
h.mu.Lock()
|
||||
defer h.mu.Unlock()
|
||||
|
||||
sessionID := fmt.Sprintf("session_%s", time.Now().Format("20060102_150405"))
|
||||
results := make(map[string]*dimensionResult)
|
||||
totalStart := time.Now()
|
||||
|
||||
for _, dk := range req.Dimensions {
|
||||
dim, _ := findDimension(dk)
|
||||
dimArgs, err := buildDimensionArgs(dim, req)
|
||||
outDir := filepath.Join(h.opts.WorkDir, sessionID, dim.Key)
|
||||
_ = os.MkdirAll(outDir, 0o755)
|
||||
|
||||
dr := &dimensionResult{Key: dim.Key, Label: dim.Label, OutDir: outDir}
|
||||
|
||||
if err != nil {
|
||||
dr.OK = false
|
||||
dr.Error = err.Error()
|
||||
results[dim.Key] = dr
|
||||
continue
|
||||
}
|
||||
|
||||
py, err := pythonBin()
|
||||
if err != nil {
|
||||
dr.OK = false
|
||||
dr.Error = err.Error()
|
||||
results[dim.Key] = dr
|
||||
continue
|
||||
}
|
||||
|
||||
scriptPath := filepath.Join(h.opts.ResearchDir, dim.Script)
|
||||
argv := append([]string{scriptPath, "--out", outDir}, dimArgs...)
|
||||
cmd := exec.Command(py, argv...)
|
||||
env := os.Environ()
|
||||
if !envHas(env, "GITLINK_CLI") {
|
||||
if exe, e2 := filepath.Abs(os.Args[0]); e2 == nil {
|
||||
env = append(env, "GITLINK_CLI="+exe)
|
||||
}
|
||||
}
|
||||
// LLM key 注入子进程
|
||||
if h.opts.LLMKey != "" {
|
||||
if !envHas(env, "DEEPSEEK_API_KEY") && !envHas(env, "LLM_API_KEY") {
|
||||
env = append(env, "DEEPSEEK_API_KEY="+h.opts.LLMKey)
|
||||
}
|
||||
if !envHas(env, "DEEPSEEK_BASE_URL") && !envHas(env, "LLM_BASE_URL") {
|
||||
env = append(env, "DEEPSEEK_BASE_URL="+h.opts.LLMBase)
|
||||
}
|
||||
if !envHas(env, "DEEPSEEK_MODEL") && !envHas(env, "LLM_MODEL") {
|
||||
env = append(env, "DEEPSEEK_MODEL="+h.opts.LLMModel)
|
||||
}
|
||||
}
|
||||
cmd.Env = env
|
||||
|
||||
dr.Command = py + " " + strings.Join(argv, " ")
|
||||
dimStart := time.Now()
|
||||
out, runErr := cmd.CombinedOutput()
|
||||
dr.Duration = time.Since(dimStart).Truncate(time.Millisecond).String()
|
||||
dr.Stdout = string(out)
|
||||
dr.OK = runErr == nil
|
||||
if runErr != nil {
|
||||
dr.Error = runErr.Error()
|
||||
}
|
||||
dr.Artifacts = readArtifacts(outDir)
|
||||
results[dim.Key] = dr
|
||||
}
|
||||
|
||||
resp := chainResponse{
|
||||
OK: true,
|
||||
SessionID: sessionID,
|
||||
Duration: time.Since(totalStart).Truncate(time.Millisecond).String(),
|
||||
Results: results,
|
||||
}
|
||||
writeJSON(w, resp)
|
||||
}
|
||||
|
||||
func findScenario(key string) (scenarioDef, bool) {
|
||||
for _, s := range scenarios {
|
||||
if s.Key == key || strings.EqualFold(s.Key, key) {
|
||||
return s, true
|
||||
}
|
||||
}
|
||||
return scenarioDef{}, false
|
||||
}
|
||||
|
||||
func findDimension(key string) (dimensionDef, bool) {
|
||||
for _, d := range dimensions {
|
||||
if d.Key == key || strings.EqualFold(d.Key, key) {
|
||||
return d, true
|
||||
}
|
||||
}
|
||||
return dimensionDef{}, false
|
||||
}
|
||||
|
||||
func readArtifacts(dir string) map[string]string {
|
||||
out := map[string]string{}
|
||||
// json 产物(取第一个 *.json)
|
||||
if entries, err := os.ReadDir(dir); err == nil {
|
||||
for _, e := range entries {
|
||||
if e.IsDir() {
|
||||
continue
|
||||
}
|
||||
name := e.Name()
|
||||
switch {
|
||||
case strings.HasSuffix(name, ".json"):
|
||||
b, _ := os.ReadFile(filepath.Join(dir, name))
|
||||
out["json"] = string(b)
|
||||
case strings.HasSuffix(name, ".mmd"):
|
||||
b, _ := os.ReadFile(filepath.Join(dir, name))
|
||||
out["mermaid"] = string(b)
|
||||
case name == "visual.html":
|
||||
b, _ := os.ReadFile(filepath.Join(dir, name))
|
||||
out["html"] = string(b)
|
||||
case strings.HasSuffix(name, ".md"):
|
||||
// 第一份 .md 报告(report.md / weekly_report.md / compliance_report.md)
|
||||
if _, ok := out["report"]; !ok {
|
||||
b, _ := os.ReadFile(filepath.Join(dir, name))
|
||||
out["report"] = string(b)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
func pythonBin() (string, error) {
|
||||
// 候选按 Linux 习惯 python3 优先,再 python / py(Windows)。
|
||||
// 必须实测能产出:Windows 的 WindowsApps\python3.exe 是 Store 桩,对 -c 也可能 exit 0 但不真正执行,
|
||||
// 故用「stdout 必须含 PYOK」来拦截桩。
|
||||
for _, name := range []string{"python3", "python", "py"} {
|
||||
path, err := exec.LookPath(name)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
if out, err := exec.Command(path, "-c", "print('PYOK')").Output(); err == nil &&
|
||||
strings.Contains(string(out), "PYOK") {
|
||||
return path, nil
|
||||
}
|
||||
}
|
||||
return "", fmt.Errorf("python 未安装;容器需内置 python3 并 pip install -r scripts/research/requirements.txt")
|
||||
}
|
||||
|
||||
func contains(xs []string, s string) bool {
|
||||
for _, x := range xs {
|
||||
if x == s {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// buildDimensionArgs 根据维度定义和请求参数构建 Python 脚本 CLI 参数。
|
||||
func buildDimensionArgs(dim dimensionDef, req chainRequest) ([]string, error) {
|
||||
argv := []string{} // script 在调用方追加
|
||||
hasKeyword := req.Keyword != ""
|
||||
hasCategory := req.Category != ""
|
||||
hasRepo := req.Owner != "" && req.Repo != ""
|
||||
|
||||
// 检查每个 need
|
||||
for _, need := range dim.Needs {
|
||||
switch need {
|
||||
case "keyword_or_category":
|
||||
if !hasKeyword && !hasCategory {
|
||||
return nil, fmt.Errorf("维度 %s 需要 --keywords 或 --category", dim.Key)
|
||||
}
|
||||
if hasCategory {
|
||||
argv = append(argv, "--category", req.Category)
|
||||
} else {
|
||||
argv = append(argv, "--keywords", req.Keyword)
|
||||
}
|
||||
case "keyword":
|
||||
if !hasKeyword {
|
||||
return nil, fmt.Errorf("维度 %s 需要 --keywords", dim.Key)
|
||||
}
|
||||
argv = append(argv, "--keywords", req.Keyword)
|
||||
case "owner_repo_or_category":
|
||||
if !hasRepo && !hasCategory {
|
||||
return nil, fmt.Errorf("维度 %s 需要 --owner/--repo 或 --category", dim.Key)
|
||||
}
|
||||
if hasCategory {
|
||||
argv = append(argv, "--category", req.Category)
|
||||
} else {
|
||||
argv = append(argv, "--owner", req.Owner, "--repo", req.Repo)
|
||||
}
|
||||
case "owner":
|
||||
if !hasRepo {
|
||||
return nil, fmt.Errorf("维度 %s 需要 --owner 和 --repo", dim.Key)
|
||||
}
|
||||
argv = append(argv, "--owner", req.Owner)
|
||||
case "repo":
|
||||
if !hasRepo {
|
||||
return nil, fmt.Errorf("维度 %s 需要 --repo", dim.Key)
|
||||
}
|
||||
argv = append(argv, "--repo", req.Repo)
|
||||
}
|
||||
}
|
||||
return argv, nil
|
||||
}
|
||||
|
||||
// envHas 报告环境变量切片里是否已含某 KEY(形如 "KEY=...")。
|
||||
func envHas(env []string, key string) bool {
|
||||
prefix := key + "="
|
||||
for _, e := range env {
|
||||
if strings.HasPrefix(e, prefix) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func writeJSON(w http.ResponseWriter, v any) {
|
||||
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||
_ = json.NewEncoder(w).Encode(v)
|
||||
}
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="zh-CN">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="refresh" content="0;url=index.html">
|
||||
<title>科研热点追踪 · GitLink Research Atlas</title>
|
||||
</head>
|
||||
<body style="font-family:-apple-system,'PingFang SC','Microsoft YaHei',sans-serif;text-align:center;padding:60px 20px;color:#475569">
|
||||
<p>🔥 热点追踪已整合到 <a href="index.html" style="color:#4F6BED;font-weight:600">全链路科研分析</a>。</p>
|
||||
<p style="font-size:13px;color:#94A3B8;margin-top:10px">正在跳转…</p>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,504 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="zh-CN">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>GitLink Research Atlas · 结果详情</title>
|
||||
<link rel="preconnect" href="https://fonts.googleapis.com">
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||||
<link href="https://fonts.googleapis.com/css2?family=Cormorant+Garamond:wght@500;600;700&family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@500;700&family=Noto+Serif+SC:wght@600;700&family=Noto+Sans+SC:wght@400;500;700&display=swap" rel="stylesheet">
|
||||
<script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
|
||||
<style>
|
||||
:root{
|
||||
--bg:#F7F9FC; --card:#FFFFFF; --ink:#1E2A44; --ink2:#475569; --mute:#94A3B8;
|
||||
--line:#E6EBF2; --indigo:#4F6BED; --coral:#F26B5E; --mint:#2EC4B6;
|
||||
--t-blue:#E8EEFF; --t-coral:#FFEDEA; --t-mint:#E6F7F4; --t-amber:#FEF3C7;
|
||||
--serif:"Cormorant Garamond","Noto Serif SC",Georgia,serif;
|
||||
--sans:"Inter","Noto Sans SC",-apple-system,"PingFang SC","Microsoft YaHei",sans-serif;
|
||||
--mono:"JetBrains Mono",ui-monospace,SFMono-Regular,Menlo,Consolas,monospace;
|
||||
--shadow:0 1px 2px rgba(30,42,68,.04),0 6px 18px rgba(30,42,68,.06);
|
||||
--shadow-sm:0 1px 2px rgba(30,42,68,.06);
|
||||
}
|
||||
*{box-sizing:border-box;margin:0;padding:0}
|
||||
html,body{height:auto;min-height:100%;margin:0}
|
||||
body{font-family:var(--sans);color:var(--ink);background:var(--bg);
|
||||
background-image:radial-gradient(1200px 480px at 80% -8%,#EAF0FF 0%,rgba(234,240,255,0) 60%),
|
||||
radial-gradient(900px 420px at 0% 0%,#FFF1EE 0%,rgba(255,241,238,0) 55%);
|
||||
-webkit-font-smoothing:antialiased}
|
||||
|
||||
/* ========== PRINT ========== */
|
||||
@media print{
|
||||
body{background:#fff!important}
|
||||
.no-print{display:none!important}
|
||||
.page-wrap{max-width:100%!important;box-shadow:none!important}
|
||||
}
|
||||
|
||||
/* ========== PAGE WRAPPER ========== */
|
||||
.page-wrap{max-width:1120px;margin:0 auto;padding:32px 40px 60px}
|
||||
@media(max-width:760px){.page-wrap{padding:20px 16px 40px}}
|
||||
|
||||
/* ========== HEADER ========== */
|
||||
.res-header{margin-bottom:32px}
|
||||
.res-header .back{display:inline-flex;align-items:center;gap:6px;font-size:13px;font-weight:600;
|
||||
color:var(--indigo);text-decoration:none;margin-bottom:16px;padding:6px 14px;border-radius:10px;
|
||||
background:var(--t-blue);transition:.15s}
|
||||
.res-header .back:hover{background:#D6DEFF}
|
||||
.res-header h1{font-family:var(--serif);font-weight:700;font-size:34px;line-height:1.2;letter-spacing:.3px;color:var(--ink)}
|
||||
.res-header .sub{font-size:15px;color:var(--ink2);margin-top:6px;line-height:1.5}
|
||||
.res-header .meta{display:flex;flex-wrap:wrap;gap:16px;margin-top:14px;align-items:center}
|
||||
.res-header .meta .chip{display:inline-flex;align-items:center;gap:6px;font-size:12px;font-weight:500;
|
||||
padding:5px 12px;border-radius:999px;background:var(--card);border:1px solid var(--line);color:var(--ink2);box-shadow:var(--shadow-sm)}
|
||||
.res-header .meta .chip b{font-family:var(--mono);font-weight:700;color:var(--ink)}
|
||||
.res-header .cmd-drawer{margin-top:14px;background:var(--ink);color:#CBD5E1;font-family:var(--mono);
|
||||
font-size:12px;padding:10px 16px;border-radius:10px;display:flex;align-items:center;gap:10px;overflow:hidden}
|
||||
.res-header .cmd-drawer .dots{display:flex;gap:6px;flex-shrink:0}
|
||||
.res-header .cmd-drawer .dots i{width:11px;height:11px;border-radius:50%;display:block}
|
||||
.res-header .cmd-drawer .cmd{flex:1;white-space:nowrap;overflow:hidden;text-overflow:ellipsis;color:#E2E8F0}
|
||||
|
||||
/* ========== SECTION TITLES ========== */
|
||||
.section{margin-top:36px}
|
||||
.section-title{font-family:var(--serif);font-weight:700;font-size:22px;color:var(--ink);margin-bottom:16px;
|
||||
padding-bottom:8px;border-bottom:2px solid var(--line)}
|
||||
.section-title .eyebrow{font-family:var(--mono);font-size:10px;letter-spacing:.16em;text-transform:uppercase;
|
||||
color:var(--mute);display:block;margin-bottom:4px}
|
||||
|
||||
/* ========== METRICS ROW ========== */
|
||||
.metrics-row{display:grid;grid-template-columns:repeat(4,1fr);gap:14px;margin-bottom:8px}
|
||||
@media(max-width:760px){.metrics-row{grid-template-columns:repeat(2,1fr)}}
|
||||
.metric-card{background:var(--card);border:1px solid var(--line);border-radius:12px;padding:18px;
|
||||
box-shadow:var(--shadow);text-align:center}
|
||||
.metric-card .label{font-size:12px;color:var(--ink2);font-weight:500;margin-bottom:8px}
|
||||
.metric-card .value{font-family:var(--mono);font-weight:700;font-size:32px;color:var(--ink);line-height:1}
|
||||
.metric-card .note{font-size:11px;color:var(--mute);margin-top:6px}
|
||||
|
||||
/* ========== KNOWLEDGE GRAPH ========== */
|
||||
.graph-container{background:var(--card);border:1px solid var(--line);border-radius:14px;box-shadow:var(--shadow);
|
||||
padding:20px;overflow:hidden}
|
||||
.graph-svg-wrap{width:100%;height:500px;position:relative;background:radial-gradient(500px 380px at 50% 45%,#F2F6FF 0%,rgba(255,255,255,0) 70%);
|
||||
border-radius:10px;overflow:hidden}
|
||||
.graph-svg-wrap svg{width:100%;height:100%;display:block}
|
||||
.g-edge{stroke:#9DB4F0;stroke-opacity:.55;stroke-width:1}
|
||||
.g-node circle{stroke:#fff;stroke-width:2;transition:.2s}
|
||||
.g-node:hover circle{filter:brightness(1.08)}
|
||||
.g-node text{font-family:var(--sans);font-size:11px;font-weight:600;fill:var(--ink);pointer-events:none;text-anchor:middle}
|
||||
.graph-legend{display:flex;flex-wrap:wrap;gap:14px;margin-top:14px;padding-top:12px;border-top:1px solid var(--line)}
|
||||
.graph-legend .leg-item{display:flex;align-items:center;gap:5px;font-size:12px;color:var(--ink2)}
|
||||
.graph-legend .leg-dot{width:10px;height:10px;border-radius:50%;flex-shrink:0}
|
||||
.graph-legend .leg-note{font-size:12px;color:var(--mute);margin-left:auto}
|
||||
|
||||
/* ========== VIZ IFRAME (S6) ========== */
|
||||
.viz-container{background:var(--card);border:1px solid var(--line);border-radius:14px;box-shadow:var(--shadow);
|
||||
padding:12px;overflow:hidden}
|
||||
.viz-container iframe{width:100%;height:520px;border:0;border-radius:10px;background:#fff}
|
||||
|
||||
/* ========== MERMAID ========== */
|
||||
.mmd-container{background:var(--card);border:1px solid var(--line);border-radius:14px;box-shadow:var(--shadow);
|
||||
padding:16px;overflow:auto;max-height:600px}
|
||||
|
||||
/* ========== RADAR / SCORE (S3) ========== */
|
||||
.score-display{display:flex;align-items:center;justify-content:center;gap:40px;padding:30px;
|
||||
background:var(--card);border:1px solid var(--line);border-radius:14px;box-shadow:var(--shadow);flex-wrap:wrap}
|
||||
.score-circle{width:140px;height:140px;border-radius:50%;display:flex;flex-direction:column;align-items:center;justify-content:center;
|
||||
position:relative;border:6px solid}
|
||||
.score-circle .val{font-family:var(--mono);font-weight:700;font-size:40px;line-height:1}
|
||||
.score-circle .label{font-size:13px;color:var(--ink2);margin-top:2px}
|
||||
.score-circle.repro{border-color:var(--mint);color:var(--mint);background:var(--t-mint)}
|
||||
.score-circle.compliance{border-color:var(--indigo);color:var(--indigo);background:var(--t-blue)}
|
||||
|
||||
/* ========== WEEKLY COMPARISON (S5) ========== */
|
||||
.weekly-bars{display:flex;flex-direction:column;gap:16px;padding:20px;
|
||||
background:var(--card);border:1px solid var(--line);border-radius:14px;box-shadow:var(--shadow)}
|
||||
.week-row{display:flex;align-items:center;gap:14px}
|
||||
.week-row .label{width:70px;font-size:13px;font-weight:600;color:var(--ink2);flex-shrink:0}
|
||||
.week-row .bar-bg{flex:1;height:28px;background:#F1F5F9;border-radius:8px;overflow:hidden;position:relative}
|
||||
.week-row .bar-fill{height:100%;border-radius:8px;transition:width .6s ease}
|
||||
.week-row .bar-fill.this-week{background:linear-gradient(90deg,var(--indigo),#7C8CF5)}
|
||||
.week-row .bar-fill.last-week{background:var(--line)}
|
||||
.week-row .bar-val{position:absolute;right:8px;top:50%;transform:translateY(-50%);font-family:var(--mono);font-size:12px;font-weight:600;color:var(--ink)}
|
||||
.risk-list{margin-top:20px;display:flex;flex-direction:column;gap:10px}
|
||||
.risk-item{padding:10px 14px;border-radius:10px;border-left:4px solid}
|
||||
.risk-item.critical{border-color:var(--coral);background:var(--t-coral)}
|
||||
.risk-item.warning{border-color:#F59E0B;background:var(--t-amber)}
|
||||
.risk-item .type{font-size:11px;font-family:var(--mono);color:var(--mute);text-transform:uppercase}
|
||||
.risk-item .msg{font-size:13px;color:var(--ink);margin-top:4px}
|
||||
.risk-item .suggestion{font-size:12px;color:var(--ink2);margin-top:4px;font-style:italic}
|
||||
|
||||
/* ========== REPORT (markdown) ========== */
|
||||
.report-content{background:var(--card);border:1px solid var(--line);border-radius:14px;box-shadow:var(--shadow);
|
||||
padding:28px 32px;line-height:1.75;font-size:14px;color:var(--ink)}
|
||||
.report-content h1{font-family:var(--serif);font-weight:700;font-size:26px;margin:24px 0 12px;padding-bottom:8px;border-bottom:2px solid var(--line)}
|
||||
.report-content h1:first-child{margin-top:0}
|
||||
.report-content h2{font-family:var(--serif);font-weight:700;font-size:20px;margin:20px 0 10px;color:var(--ink)}
|
||||
.report-content h3{font-weight:700;font-size:16px;margin:16px 0 8px;color:var(--ink2)}
|
||||
.report-content p{margin:10px 0}
|
||||
.report-content ul,.report-content ol{margin:8px 0;padding-left:24px}
|
||||
.report-content li{margin:4px 0}
|
||||
.report-content strong{font-weight:700;color:var(--ink)}
|
||||
.report-content code{font-family:var(--mono);font-size:12.5px;background:var(--t-blue);padding:2px 6px;border-radius:4px;color:var(--indigo)}
|
||||
.report-content table{width:100%;border-collapse:collapse;margin:12px 0;font-size:13px}
|
||||
.report-content th{background:var(--t-blue);font-weight:600;text-align:left;padding:8px 12px;border:1px solid var(--line)}
|
||||
.report-content td{padding:8px 12px;border:1px solid var(--line)}
|
||||
|
||||
/* ========== STRUCTURED CARDS ========== */
|
||||
.cards-grid{display:grid;grid-template-columns:repeat(auto-fill,minmax(320px,1fr));gap:16px;margin-top:20px}
|
||||
.conclusion-card{background:var(--card);border:1px solid var(--line);border-radius:12px;box-shadow:var(--shadow);
|
||||
padding:16px 18px;border-top:4px solid}
|
||||
.conclusion-card.innovation{border-top-color:var(--indigo)}
|
||||
.conclusion-card.risk{border-top-color:var(--coral)}
|
||||
.conclusion-card.collab{border-top-color:var(--mint)}
|
||||
.conclusion-card .card-title{font-weight:700;font-size:14px;color:var(--ink);margin-bottom:8px}
|
||||
.conclusion-card .card-body{font-size:13px;color:var(--ink2);line-height:1.55}
|
||||
.conclusion-card .card-body p{margin:4px 0}
|
||||
|
||||
/* ========== LOADING STATE ========== */
|
||||
.loading-state{display:flex;flex-direction:column;align-items:center;justify-content:center;padding:80px 20px;color:var(--mute);gap:16px}
|
||||
.spin-lg{width:40px;height:40px;border-radius:50%;border:4px solid var(--t-blue);border-top-color:var(--indigo);animation:rot .8s linear infinite}
|
||||
@keyframes rot{to{transform:rotate(360deg)}}
|
||||
|
||||
/* ========== ERROR ========== */
|
||||
.error-state{padding:60px 20px;text-align:center;color:var(--coral)}
|
||||
.error-state h2{font-family:var(--serif);font-size:24px;margin-bottom:12px}
|
||||
.error-state p{font-size:14px;color:var(--ink2);max-width:500px;margin:0 auto}
|
||||
|
||||
/* empty */
|
||||
.empty-state{padding:60px 20px;text-align:center;color:var(--mute)}
|
||||
.empty-state p{font-size:14px}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-wrap" id="app">
|
||||
<div class="loading-state"><div class="spin-lg"></div><div>正在加载结果…</div></div>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
mermaid.initialize({startOnLoad:false, theme:"base", securityLevel:"loose",
|
||||
themeVariables:{primaryColor:"#E8EEFF",primaryTextColor:"#1E2A44",primaryBorderColor:"#4F6BED",lineColor:"#9DB4F0",fontSize:"13px"}});
|
||||
|
||||
const NODE_COLOR={repo:"#4F6BED",scholar:"#3B82F6",team:"#6366F1",topic:"#06B6D4",method:"#6366F1",
|
||||
paper:"#8B5CF6",dataset:"#2EC4B6",model:"#4F6BED",experiment:"#F26B5E",
|
||||
reproduce:"#2EC4B6",license:"#64748B",trend:"#F26B5E",issue:"#F59E0B",pr:"#10B981",default:"#94A3B8"};
|
||||
const NODE_LABEL={repo:"仓库",scholar:"学者",topic:"主题",paper:"论文",dataset:"数据集",
|
||||
model:"模型",experiment:"实验",reproduce:"复现",license:"许可证",trend:"趋势",issue:"Issue",pr:"PR"};
|
||||
|
||||
function esc(s){return String(s).replace(/[&<>]/g,c=>({'&':'&','<':'<','>':'>'}[c]));}
|
||||
function token(){return localStorage.getItem("demo_token")||"";}
|
||||
function licOf(o){const l=o.license;if(!l)return o.license_id||"—";return typeof l==="string"?l:(l.id||l.name||l.spdx_id||l.identifier||"—");}
|
||||
|
||||
/* ========== Force layout (same as index) ========== */
|
||||
function forceLayout(nodes,edges,W,H,iters){
|
||||
const cx=W/2,cy=H/2;
|
||||
nodes.forEach(n=>{if(n.x==null){n.x=cx+(Math.random()-.5)*W*.5;n.y=cy+(Math.random()-.5)*H*.5;}});
|
||||
for(let it=0;it<iters;it++){
|
||||
for(const n of nodes){n._fx=0;n._fy=0;}
|
||||
for(let i=0;i<nodes.length;i++){for(let j=i+1;j<nodes.length;j++){
|
||||
let dx=nodes[i].x-nodes[j].x,dy=nodes[i].y-nodes[j].y,d2=dx*dx+dy*dy+.02,d=Math.sqrt(d2),f=2600/d2,fx=dx/d*f,fy=dy/d*f;
|
||||
nodes[i]._fx+=fx;nodes[i]._fy+=fy;nodes[j]._fx-=fx;nodes[j]._fy-=fy;}}
|
||||
for(const e of edges){const a=nodes.find(n=>n.id===e[0]),b=nodes.find(n=>n.id===e[1]);if(!a||!b)continue;
|
||||
let dx=b.x-a.x,dy=b.y-a.y,d=Math.sqrt(dx*dx+dy*dy)+.02,L=a.imp||b.imp?130:85,k=.04;
|
||||
let f=(d-L)*k,fx=dx/d*f,fy=dy/d*f;a._fx+=fx;a._fy+=fy;b._fx-=fx;b._fy-=fy;}
|
||||
for(const n of nodes){n._fx+=(cx-n.x)*.012;n._fy+=(cy-n.y)*.012;
|
||||
n.x+=Math.max(-14,Math.min(14,n._fx));n.y+=Math.max(-14,Math.min(14,n._fy));
|
||||
n.x=Math.max(45,Math.min(W-45,n.x));n.y=Math.max(38,Math.min(H-34,n.y));}}
|
||||
}
|
||||
|
||||
function drawGraphIn(containerId,data){
|
||||
const svg=document.getElementById(containerId); if(!svg) return;
|
||||
const W=svg.clientWidth||800,H=svg.clientHeight||500;
|
||||
svg.setAttribute("viewBox",`0 0 ${W} ${H}`);
|
||||
let nodes=(data.nodes||[]).map(n=>Object.assign({},n));
|
||||
let edges=(data.edges||[]).map(e=>Array.isArray(e)?e:[e.source||e.from,e.target||e.to]);
|
||||
if(nodes.length>40){
|
||||
const deg=new Map(nodes.map(n=>[n.id,0]));
|
||||
edges.forEach(e=>{deg.set(e[0],(deg.get(e[0])||0)+1);deg.set(e[1],(deg.get(e[1])||0)+1);});
|
||||
nodes.sort((a,b)=>(deg.get(b.id)||0)-(deg.get(a.id)||0));
|
||||
const keep=new Set(nodes.slice(0,40).map(n=>n.id));nodes=nodes.filter(n=>keep.has(n.id));edges=edges.filter(e=>keep.has(e[0])&&keep.has(e[1]));
|
||||
}
|
||||
forceLayout(nodes,edges,W,H,300);
|
||||
let s=`<defs><filter id="glow2"><feGaussianBlur stdDeviation="5" result="blur"/><feMerge><feMergeNode in="blur"/><feMergeNode in="SourceGraphic"/></feMerge></filter></defs>`;
|
||||
for(const e of edges){const a=nodes.find(n=>n.id===e[0]),b=nodes.find(n=>n.id===e[1]);if(!a||!b)continue;
|
||||
s+=`<line class="g-edge" x1="${a.x.toFixed(1)}" y1="${a.y.toFixed(1)}" x2="${b.x.toFixed(1)}" y2="${b.y.toFixed(1)}"/>`;}
|
||||
for(const n of nodes){const col=NODE_COLOR[n.type]||NODE_COLOR.default,r=n.imp?13:8;
|
||||
s+=`<g class="g-node" transform="translate(${n.x.toFixed(1)},${n.y.toFixed(1)})"><circle r="${r}" fill="${col}"${n.imp?' filter="url(#glow2)"':""}/><text y="${r+13}">${esc(n.label||n.id).slice(0,18)}</text></g>`;}
|
||||
svg.innerHTML=s;
|
||||
}
|
||||
|
||||
function buildGraphLegend(types){
|
||||
let h="";
|
||||
for(const t of [...types].sort()){
|
||||
h+=`<span class="leg-item"><span class="leg-dot" style="background:${NODE_COLOR[t]||NODE_COLOR.default}"></span>${NODE_LABEL[t]||t}</span>`;
|
||||
}
|
||||
return h;
|
||||
}
|
||||
|
||||
/* ========== Simple markdown to HTML ========== */
|
||||
function mdToHtml(md){
|
||||
if(!md) return "";
|
||||
let html=esc(md);
|
||||
// code blocks
|
||||
html=html.replace(/```(\w*)\n([\s\S]*?)```/g,'<pre><code>$2</code></pre>');
|
||||
// inline code
|
||||
html=html.replace(/`([^`]+)`/g,'<code>$1</code>');
|
||||
// tables
|
||||
html=html.replace(/^(\|.+\|)\n(\|[-:\s|]+\|)\n((?:\|.+\|\n?)*)/gm,function(_,hdr,sep,body){
|
||||
const ths=hdr.split("|").filter(c=>c.trim()).map(c=>`<th>${c.trim()}</th>`).join("");
|
||||
let rows="";
|
||||
body.trim().split("\n").forEach(row=>{
|
||||
const tds=row.split("|").filter(c=>c.trim()).map(c=>`<td>${c.trim()}</td>`).join("");
|
||||
rows+=`<tr>${tds}</tr>`;
|
||||
});
|
||||
return `<table><thead><tr>${ths}</tr></thead><tbody>${rows}</tbody></table>`;
|
||||
});
|
||||
// headings
|
||||
html=html.replace(/^### (.+)$/gm,'<h3>$1</h3>');
|
||||
html=html.replace(/^## (.+)$/gm,'<h2>$1</h2>');
|
||||
html=html.replace(/^# (.+)$/gm,'<h1>$1</h1>');
|
||||
// bold
|
||||
html=html.replace(/\*\*([^*]+)\*\*/g,'<strong>$1</strong>');
|
||||
// unordered lists
|
||||
html=html.replace(/^- (.+)$/gm,'<li>$1</li>');
|
||||
html=html.replace(/(<li>.*<\/li>\n?)+/g,'<ul>$&</ul>');
|
||||
// paragraphs (lines not inside tags)
|
||||
html=html.replace(/^(?!<[huplo])((?!<).+)$/gm,'<p>$1</p>');
|
||||
return html;
|
||||
}
|
||||
|
||||
/* ========== MAIN RENDER ========== */
|
||||
async function loadResult(){
|
||||
const params=new URLSearchParams(window.location.search);
|
||||
const scenario=params.get("scenario");
|
||||
if(!scenario){
|
||||
document.getElementById("app").innerHTML='<div class="error-state"><h2>缺少场景参数</h2><p>请从仪表盘点击场景,或手动打开 <code>result.html?scenario=s1</code></p></div>';
|
||||
return;
|
||||
}
|
||||
|
||||
let data;
|
||||
try{
|
||||
const r=await fetch("/api/result/"+encodeURIComponent(scenario),{headers:{"X-Demo-Token":token()}});
|
||||
data=await r.json();
|
||||
}catch(e){
|
||||
document.getElementById("app").innerHTML='<div class="error-state"><h2>加载失败</h2><p>'+esc(e.message)+'</p><a class="back" href="index.html">返回仪表盘</a></div>';
|
||||
return;
|
||||
}
|
||||
if(!data.ok){
|
||||
document.getElementById("app").innerHTML='<div class="error-state"><h2>'+esc(data.error||"数据未就绪")+'</h2><p>请先在仪表盘运行该场景以生成结果。</p><a class="back" href="index.html">返回仪表盘</a></div>';
|
||||
return;
|
||||
}
|
||||
|
||||
const art=data.artifacts||{};
|
||||
const obj=art.json?JSON.parse(art.json):null;
|
||||
const owner=params.get("owner")||val_from("owner")||"";
|
||||
const repo=params.get("repo")||val_from("repo")||"";
|
||||
const keyword=params.get("keyword")||val_from("keyword")||"";
|
||||
|
||||
render(data,obj,art,scenario,owner,repo,keyword);
|
||||
}
|
||||
|
||||
function val_from(name){try{return localStorage.getItem("atlas_"+name)||"";}catch(e){return"";}}
|
||||
|
||||
function render(data,obj,art,scenario,owner,repo,keyword){
|
||||
const label=data.label||scenario;
|
||||
const desc=data.desc||"";
|
||||
const now=new Date().toLocaleString("zh-CN");
|
||||
let h="";
|
||||
|
||||
// ---- HEADER ----
|
||||
h+=`<div class="res-header">
|
||||
<a class="back no-print" href="index.html">← 返回仪表盘</a>
|
||||
<h1>${esc(label)}</h1>
|
||||
<div class="sub">${esc(desc)}</div>
|
||||
<div class="meta">`;
|
||||
if(owner||repo) h+=`<span class="chip">仓库 <b>${esc(owner)}${repo?"/"+esc(repo):""}</b></span>`;
|
||||
if(keyword) h+=`<span class="chip">关键词 <b>${esc(keyword)}</b></span>`;
|
||||
h+=`<span class="chip">场景 <b>${esc(scenario)}</b></span>
|
||||
<span class="chip">生成于 ${esc(now)}</span>
|
||||
</div>
|
||||
<div class="cmd-drawer no-print">
|
||||
<div class="dots"><i style="background:#FF5F57"></i><i style="background:#FEBC2E"></i><i style="background:#28C840"></i></div>
|
||||
<span style="color:var(--mint)">atlas ❯</span>
|
||||
<span class="cmd">gitlink-cli research --scenario ${esc(scenario)} ${owner?"--repo "+esc(owner)+"/"+esc(repo):""} ${keyword?'-k "'+esc(keyword)+'"':""}</span>
|
||||
</div></div>`;
|
||||
|
||||
// ---- METRICS ROW ----
|
||||
const metrics=metricsFor(scenario,obj);
|
||||
if(metrics){
|
||||
h+=`<div class="section"><div class="section-title"><span class="eyebrow">Key Metrics</span>关键指标</div>
|
||||
<div class="metrics-row">${metrics}</div></div>`;
|
||||
}
|
||||
|
||||
// ---- MAIN VIZ ----
|
||||
h+=`<div class="section"><div class="section-title"><span class="eyebrow">Visualization</span>可视化</div>`;
|
||||
|
||||
// S2: Knowledge Graph
|
||||
if(scenario==="s2"&&obj&&obj.nodes&&obj.edges){
|
||||
const graphNodes=obj.nodes.map(n=>({id:n.id,type:n.type||"default",label:n.label||n.id,imp:false}));
|
||||
// highlight repo and high-degree nodes
|
||||
const deg=new Map();
|
||||
obj.edges.forEach(e=>{deg.set((e.source||e.from),(deg.get(e.source||e.from)||0)+1);deg.set((e.target||e.to),(deg.get(e.target||e.to)||0)+1);});
|
||||
graphNodes.forEach(n=>{if(n.type==="repo"||deg.get(n.id)>3)n.imp=true;});
|
||||
const graphEdges=obj.edges.map(e=>[e.source||e.from,e.target||e.to]);
|
||||
const types=new Set(graphNodes.map(n=>n.type));
|
||||
const gId="resGraph_"+Date.now();
|
||||
h+=`<div class="graph-container">
|
||||
<div class="graph-svg-wrap"><svg id="${gId}" preserveAspectRatio="xMidYMid meet"></svg></div>
|
||||
<div class="graph-legend">${buildGraphLegend(types)}
|
||||
<span class="leg-note">${esc(label)} — ${(obj.meta||{}).repo_count||graphNodes.length} 个仓库节点, ${(obj.meta||{}).edge_count||graphEdges.length} 条关联边</span>
|
||||
</div></div>`;
|
||||
// defer drawing
|
||||
setTimeout(()=>drawGraphIn(gId,{nodes:graphNodes,edges:graphEdges}),100);
|
||||
}
|
||||
// S6: plotly
|
||||
else if(scenario==="s6"&&art.html){
|
||||
const blob=URL.createObjectURL(new Blob([art.html],{type:"text/html"}));
|
||||
h+=`<div class="viz-container"><iframe src="${blob}"></iframe></div>`;
|
||||
}
|
||||
// S1/S4: mermaid
|
||||
else if((scenario==="s1"||scenario==="s4")&&art.mermaid){
|
||||
const mId="resMmd_"+Date.now();
|
||||
const mmd=art.mermaid.replace(/```mermaid|```/g,"");
|
||||
h+=`<div class="mmd-container"><div class="mermaid" id="${mId}">${esc(mmd)}</div></div>`;
|
||||
setTimeout(()=>{const el=document.getElementById(mId);if(el)el.removeAttribute("data-processed");
|
||||
mermaid.run({nodes:["#"+mId]}).catch(()=>{});},100);
|
||||
}
|
||||
// S3: radar / scores
|
||||
else if(scenario==="s3"&&obj){
|
||||
const rs=obj.repro_score||0;const cs=obj.compliance_score||0;
|
||||
h+=`<div class="score-display">
|
||||
<div class="score-circle repro"><span class="val">${rs}</span><span class="label">复现性 / 10</span></div>
|
||||
<div class="score-circle compliance"><span class="val">${cs}</span><span class="label">合规性 / 10</span></div>
|
||||
</div>`;
|
||||
}
|
||||
// S5: weekly comparison + risks
|
||||
else if(scenario==="s5"&&obj){
|
||||
const ws=obj.week_stats||{};
|
||||
const tw=ws.this_week||{};const lw=ws.last_week||{};
|
||||
const maxC=Math.max(tw.commits||0,lw.commits||0,1);
|
||||
const maxP=Math.max(tw.prs_merged||0,lw.prs_merged||0,1);
|
||||
const maxI=Math.max(tw.issues_closed||0,lw.issues_closed||0,1);
|
||||
h+=`<div class="weekly-bars">
|
||||
<div style="font-weight:700;font-size:14px;margin-bottom:8px;color:var(--ink)">本周 vs 上周 对比</div>
|
||||
<div class="week-row"><span class="label">Commits</span><div class="bar-bg"><div class="bar-fill last-week" style="width:${(lw.commits/maxC*100||0).toFixed(1)}%"><span class="bar-val">${lw.commits||0}</span></div><div class="bar-fill this-week" style="width:${(tw.commits/maxC*100||0).toFixed(1)}%;position:relative;margin-top:-28px"><span class="bar-val">${tw.commits||0}</span></div></div></div>
|
||||
<div class="week-row"><span class="label">PR merged</span><div class="bar-bg"><div class="bar-fill last-week" style="width:${(lw.prs_merged/maxP*100||0).toFixed(1)}%"><span class="bar-val">${lw.prs_merged||0}</span></div><div class="bar-fill this-week" style="width:${(tw.prs_merged/maxP*100||0).toFixed(1)}%;position:relative;margin-top:-28px"><span class="bar-val">${tw.prs_merged||0}</span></div></div></div>
|
||||
<div class="week-row"><span class="label">Issues</span><div class="bar-bg"><div class="bar-fill last-week" style="width:${(lw.issues_closed/maxI*100||0).toFixed(1)}%"><span class="bar-val">${lw.issues_closed||0}</span></div><div class="bar-fill this-week" style="width:${(tw.issues_closed/maxI*100||0).toFixed(1)}%;position:relative;margin-top:-28px"><span class="bar-val">${tw.issues_closed||0}</span></div></div></div>
|
||||
</div>`;
|
||||
// risk warnings
|
||||
const risks=obj.risk_warnings||[];
|
||||
if(risks.length){
|
||||
h+=`<div style="margin-top:20px;font-weight:700;font-size:14px;color:var(--ink)">风险预警</div><div class="risk-list">`;
|
||||
risks.forEach(r=>{const cls=r.level==="critical"?"critical":"warning";
|
||||
h+=`<div class="risk-item ${cls}"><div class="type">${esc(r.level||"")} · ${esc(r.type||"")}</div><div class="msg">${esc(r.message||"")}</div>${r.suggestion?`<div class="suggestion">${esc(r.suggestion)}</div>`:""}</div>`;});
|
||||
h+=`</div>`;
|
||||
}
|
||||
}
|
||||
else{
|
||||
h+=`<div class="empty-state"><p>该场景无可视化产物,详见下方报告。</p></div>`;
|
||||
}
|
||||
h+=`</div>`;
|
||||
|
||||
// ---- REPORT ----
|
||||
if(art.report){
|
||||
h+=`<div class="section"><div class="section-title"><span class="eyebrow">Full Report</span>完整报告</div>
|
||||
<div class="report-content">${mdToHtml(art.report)}</div></div>`;
|
||||
}
|
||||
|
||||
// ---- STRUCTURED CONCLUSION CARDS ----
|
||||
const conclusions=buildConclusionCards(scenario,obj);
|
||||
if(conclusions){
|
||||
h+=`<div class="section"><div class="section-title"><span class="eyebrow">Conclusions</span>结构化结论</div>
|
||||
<div class="cards-grid">${conclusions}</div></div>`;
|
||||
}
|
||||
|
||||
document.getElementById("app").innerHTML=h;
|
||||
}
|
||||
|
||||
/* ========== METRICS ========== */
|
||||
function metricCard(label,val,note){
|
||||
return `<div class="metric-card"><div class="label">${esc(label)}</div><div class="value">${esc(String(val))}</div><div class="note">${esc(note||"")}</div></div>`;
|
||||
}
|
||||
function metricsFor(key,o){
|
||||
if(!o) return "";
|
||||
const M=o.meta||{};
|
||||
switch(key){
|
||||
case "s1": return metricCard("commits",M.commit_count||0,"采样提交")+metricCard("merged PR",M.merged_pr_count||0,"已合并")+metricCard("docs",M.doc_count||0,"文档文件")+metricCard("创新点",(o.innovation_points||[]).length,"高影响合并");
|
||||
case "s2": return metricCard("repos",M.repo_count||(o.nodes||[]).length,"仓库节点")+metricCard("scholars",M.scholar_count||0,"学者")+metricCard("topics",M.topic_count||0,"主题方向")+metricCard("edges",M.edge_count||(o.edges||[]).length,"关系边");
|
||||
case "s3": return metricCard("复现性",(o.repro_score||0)+"/10","reproducibility")+metricCard("合规性",(o.compliance_score||0)+"/10","compliance")+metricCard("风险项",(o.risks||o.risk_items||[]).length,"项")+metricCard("许可证",esc(licOf(o)),"识别");
|
||||
case "s4": return metricCard("缺口主题",(o.gap_topics||[]).length,"gap topics")+metricCard("推荐候选",(o.candidates||[]).length,"candidates")+metricCard("最高匹配",o.candidates&&o.candidates[0]?o.candidates[0].score:0,"top score")+metricCard("候选池",o.meta&&o.meta.pool_size||0,"pool size");
|
||||
case "s5":{const tw=(o.week_stats&&o.week_stats.this_week)||{};return metricCard("本周 commits",tw.commits||0,"")+metricCard("预警",(o.risk_warnings||[]).length,"risks")+metricCard("PR 合并",tw.prs_merged||0,"")+metricCard("活跃度",(o.trend&&o.trend.activity_level)||"—","");}
|
||||
case "s6":{const tl=o.timeline||{};const sm=a=>(a||[]).reduce((x,y)=>x+(y||0),0);return metricCard("周数",(tl.labels||[]).length,"")+metricCard("commits",sm(tl.commits),"")+metricCard("PRs",sm(tl.prs),"")+metricCard("issues",sm(tl.issues),"");}
|
||||
}
|
||||
return "";
|
||||
}
|
||||
|
||||
/* ========== CONCLUSION CARDS ========== */
|
||||
function buildConclusionCards(key,o){
|
||||
if(!o) return "";
|
||||
let cards="";
|
||||
switch(key){
|
||||
case "s1":{
|
||||
const ips=o.innovation_points||[];
|
||||
if(ips.length){
|
||||
cards+=`<div class="conclusion-card innovation"><div class="card-title">💡 创新点 (${ips.length})</div><div class="card-body">`;
|
||||
ips.slice(0,8).forEach(i=>{cards+=`<p><strong>[${esc(i.category)}]</strong> ${esc(i.description)}<br><small style="color:var(--mute)">${esc(i.evidence||"")}</small></p>`;});
|
||||
cards+=`</div></div>`;
|
||||
}
|
||||
break;}
|
||||
case "s2":{
|
||||
const scholars=o.core_scholars||[];
|
||||
if(scholars.length){
|
||||
cards+=`<div class="conclusion-card collab"><div class="card-title">👥 核心学者</div><div class="card-body">`;
|
||||
scholars.slice(0,6).forEach(s=>{cards+=`<p><strong>${esc(s.login)}</strong> — ${s.repo_count} 个仓库</p>`;});
|
||||
cards+=`</div></div>`;
|
||||
}
|
||||
const topics=o.topic_heat||[];
|
||||
if(topics.length){
|
||||
cards+=`<div class="conclusion-card innovation"><div class="card-title">🔥 热门主题</div><div class="card-body">`;
|
||||
topics.slice(0,6).forEach(t=>{cards+=`<p><strong>${esc(t.topic)}</strong> — ${t.count} 个仓库</p>`;});
|
||||
cards+=`</div></div>`;
|
||||
}
|
||||
break;}
|
||||
case "s3":{
|
||||
const risks=o.risk_items||o.risks||[];
|
||||
if(risks.length){
|
||||
cards+=`<div class="conclusion-card risk"><div class="card-title">⚠️ 风险项 (${risks.length})</div><div class="card-body">`;
|
||||
risks.slice(0,8).forEach(r=>{
|
||||
const lvl=(r.level||"").includes("high")||r.severity==="P0"?"🔴":"🟡";
|
||||
cards+=`<p>${lvl} <strong>${esc(r.category||r.name||"")}</strong> — ${esc(r.detail||r.evidence||"")}</p>`;});
|
||||
cards+=`</div></div>`;
|
||||
}
|
||||
break;}
|
||||
case "s4":{
|
||||
const cands=o.candidates||[];
|
||||
if(cands.length){
|
||||
cards+=`<div class="conclusion-card collab"><div class="card-title">🤝 协作推荐 (${cands.length})</div><div class="card-body">`;
|
||||
cands.slice(0,6).forEach((c,i)=>{cards+=`<p><strong>#${i+1} ${esc(c.login)}</strong> (${c.score}分)<br><small>${(c.reasons||[]).join(";")}</small></p>`;});
|
||||
cards+=`</div></div>`;
|
||||
}
|
||||
const gaps=o.gap_topics||[];
|
||||
if(gaps.length){
|
||||
cards+=`<div class="conclusion-card innovation"><div class="card-title">🔎 缺口主题 (${gaps.length})</div><div class="card-body">`;
|
||||
gaps.slice(0,6).forEach(g=>{cards+=`<p>${esc(typeof g==="string"?g:(g.topic||g.name||JSON.stringify(g)))}</p>`;});
|
||||
cards+=`</div></div>`;
|
||||
}
|
||||
break;}
|
||||
case "s5":{
|
||||
const risks=o.risk_warnings||[];
|
||||
if(risks.length){
|
||||
cards+=`<div class="conclusion-card risk"><div class="card-title">⚠️ 风险预警 (${risks.length})</div><div class="card-body">`;
|
||||
risks.slice(0,6).forEach(w=>{cards+=`<p><strong>[${esc(w.type)}]</strong> ${esc(w.message)}${w.suggestion?"<br><small>"+esc(w.suggestion)+"</small>":""}</p>`;});
|
||||
cards+=`</div></div>`;
|
||||
}
|
||||
const trend=o.trend||{};
|
||||
cards+=`<div class="conclusion-card innovation"><div class="card-title">📈 活跃趋势</div><div class="card-body"><p>commit 变化: <strong>${trend.commit_delta_pct||"—"}</strong></p><p>活跃度: <strong>${esc(trend.activity_level||"—")}</strong></p></div></div>`;
|
||||
break;}
|
||||
case "s6":{
|
||||
const tl=o.timeline||{};
|
||||
cards+=`<div class="conclusion-card innovation"><div class="card-title">📊 数据概览</div><div class="card-body"><p>时间线: ${(tl.labels||[]).length} 周</p><p>语言分布: ${(o.language_pie||[]).length} 类</p><p>累计 commits: ${(tl.commits||[]).reduce((a,b)=>a+(b||0),0)}</p></div></div>`;
|
||||
break;}
|
||||
}
|
||||
return cards;
|
||||
}
|
||||
|
||||
/* go */
|
||||
loadResult();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,68 +0,0 @@
|
|||
package status
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/gitlink-org/gitlink-cli/internal/auth"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/config"
|
||||
"github.com/gitlink-org/gitlink-cli/internal/context"
|
||||
)
|
||||
|
||||
// NewStatusCmd creates the status command that displays login state and context.
|
||||
func NewStatusCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "status",
|
||||
Short: "显示当前登录状态和上下文信息",
|
||||
Long: `显示 gitlink-cli 的当前状态,包括:
|
||||
- 认证状态(是否已登录、Token 来源)
|
||||
- API 地址
|
||||
- 当前目录
|
||||
- 自动推断的仓库信息`,
|
||||
Example: ` gitlink-cli status`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
cfg, _ := config.Load()
|
||||
token, _ := auth.LoadToken()
|
||||
if token == "" {
|
||||
token = os.Getenv("GITLINK_TOKEN")
|
||||
}
|
||||
cwd, _ := os.Getwd()
|
||||
|
||||
fmt.Println("GitLink CLI 状态")
|
||||
fmt.Println("───────────────")
|
||||
|
||||
// 认证状态
|
||||
if token != "" {
|
||||
fmt.Println(" 认证状态: 已登录")
|
||||
fmt.Printf(" Token 来源: %s\n", tokenSource(token))
|
||||
} else {
|
||||
fmt.Println(" 认证状态: 未登录(运行 gitlink-cli auth login)")
|
||||
}
|
||||
|
||||
// API 地址
|
||||
fmt.Printf(" API 地址: %s\n", cfg.BaseURL)
|
||||
|
||||
// 当前目录
|
||||
fmt.Printf(" 当前目录: %s\n", cwd)
|
||||
|
||||
// 推断的仓库
|
||||
owner, repo, err := context.ResolveOwnerRepo("", "")
|
||||
if err == nil {
|
||||
fmt.Printf(" 推断仓库: %s/%s\n", owner, repo)
|
||||
} else {
|
||||
fmt.Println(" 推断仓库: (不在 Git 仓库中)")
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func tokenSource(token string) string {
|
||||
if token == os.Getenv("GITLINK_TOKEN") {
|
||||
return "环境变量 GITLINK_TOKEN"
|
||||
}
|
||||
return "keyring / 配置文件"
|
||||
}
|
||||
|
|
@ -1,58 +0,0 @@
|
|||
package status
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestNewStatusCmd(t *testing.T) {
|
||||
cmd := NewStatusCmd()
|
||||
if cmd.Use != "status" {
|
||||
t.Errorf("expected Use 'status', got %s", cmd.Use)
|
||||
}
|
||||
if cmd.Short == "" {
|
||||
t.Error("Short description should not be empty")
|
||||
}
|
||||
if cmd.Long == "" {
|
||||
t.Error("Long description should not be empty")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewStatusCmdExample(t *testing.T) {
|
||||
cmd := NewStatusCmd()
|
||||
if !strings.Contains(cmd.Example, "status") {
|
||||
t.Errorf("Example should contain 'status', got: %s", cmd.Example)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewStatusCmdHasNoSubcommands(t *testing.T) {
|
||||
cmd := NewStatusCmd()
|
||||
if cmd.HasSubCommands() {
|
||||
t.Error("status should not have subcommands")
|
||||
}
|
||||
}
|
||||
|
||||
func TestTokenSourceFromEnv(t *testing.T) {
|
||||
t.Setenv("GITLINK_TOKEN", "test-token-123")
|
||||
result := tokenSource("test-token-123")
|
||||
if result != "环境变量 GITLINK_TOKEN" {
|
||||
t.Errorf("expected env source, got: %s", result)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTokenSourceFromKeyring(t *testing.T) {
|
||||
// 不设置环境变量,或用不同的值
|
||||
t.Setenv("GITLINK_TOKEN", "")
|
||||
result := tokenSource("some-stored-token")
|
||||
if result != "keyring / 配置文件" {
|
||||
t.Errorf("expected keyring source, got: %s", result)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTokenSourceMismatch(t *testing.T) {
|
||||
t.Setenv("GITLINK_TOKEN", "env-token")
|
||||
result := tokenSource("different-token")
|
||||
if result != "keyring / 配置文件" {
|
||||
t.Errorf("should fallback to keyring when token differs from env, got: %s", result)
|
||||
}
|
||||
}
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
# demo/Dockerfile — GitLink CLI 演示网页后端
|
||||
# 多阶段:Go 编译 Linux 二进制 → Python 运行时跑 server.py
|
||||
# 构建上下文 = 仓库根(gitlink-cli/): docker build -f demo/Dockerfile -t gitlink-cli-demo .
|
||||
|
||||
# ---------- Stage 1: 编译 gitlink-cli(Linux) ----------
|
||||
FROM golang:1.26-alpine AS builder
|
||||
ENV GOPROXY=https://goproxy.cn,direct
|
||||
ENV CGO_ENABLED=0 GOOS=linux GOARCH=amd64
|
||||
WORKDIR /src
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
COPY . .
|
||||
RUN go build -ldflags="-s -w" -o /out/gitlink-cli .
|
||||
|
||||
# ---------- Stage 2: Python 运行时 ----------
|
||||
FROM python:3.11-alpine
|
||||
RUN apk add --no-cache git ca-certificates
|
||||
WORKDIR /app
|
||||
# 二进制
|
||||
COPY --from=builder /out/gitlink-cli /usr/local/bin/gitlink-cli
|
||||
# 演示网页 + Skills(server.py 要读 SKILL.md)
|
||||
COPY demo/ /app/demo/
|
||||
COPY skills/ /app/skills/
|
||||
ENV HOST=0.0.0.0
|
||||
ENV PORT=8000
|
||||
ENV GITLINK_BIN=/usr/local/bin/gitlink-cli
|
||||
EXPOSE 8000
|
||||
WORKDIR /app/demo/web
|
||||
CMD ["python3", "server.py"]
|
||||
100
demo/README.md
100
demo/README.md
|
|
@ -1,100 +0,0 @@
|
|||
# GitLink CLI · 演示网页(demo/)
|
||||
|
||||
> 一个**可交互演示站**,展示子任务一~四全部成果:25 域命令浏览器、48 Skill 卡片墙、pr-guard 工作流、科研四维画像。
|
||||
> 后端 `web/server.py`(Python 标准库,零依赖)能真跑 `gitlink-cli`;**访客自带 token,零凭据上云端**。
|
||||
|
||||
## 目录结构
|
||||
|
||||
```
|
||||
demo/
|
||||
├── web/ # 演示网页(核心)
|
||||
│ ├── server.py # Python 后端(/api/run /api/skill /api/analyze)
|
||||
│ ├── index.html # 前端单页(Tailwind+Chart.js CDN)
|
||||
│ └── README.md # 网页本地启动说明
|
||||
├── Dockerfile # demo 部署镜像(Go 编译 + Python 运行时)
|
||||
├── build-demo.sh # 本地一键产 Linux 二进制(测 Dockerfile 用)
|
||||
├── research-insight-workflow.sh # 任务四:科研画像端到端脚本
|
||||
├── pr-guard-workflow.sh # 任务三:质量看门人脚本
|
||||
├── live-demo.sh / snippet-live-demo.sh
|
||||
└── *.md # 各任务指南 + 验证记录 + 报告原件
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 一、本地跑(Windows / Linux / macOS)
|
||||
|
||||
```bash
|
||||
# 1. 编译 CLI(仓库根)
|
||||
cd gitlink-cli # 含 go.mod 的仓库根
|
||||
go build -o gitlink-cli . # Windows 产出 gitlink-cli.exe
|
||||
|
||||
# 2. 启动后端
|
||||
cd demo/web
|
||||
python server.py # → http://0.0.0.0:8000
|
||||
|
||||
# 3. 浏览器开 http://localhost:8000
|
||||
# 顶栏粘自己的 GitLink token → 平台命令真跑;snippet 等本地命令免 token
|
||||
```
|
||||
|
||||
> 二进制自动探测:`GITLINK_BIN` > 仓库根 `gitlink-cli[.exe]` > PATH。
|
||||
> 端口/主机:`PORT=9000 HOST=127.0.0.1 python server.py`。
|
||||
|
||||
---
|
||||
|
||||
## 二、云端部署(用你们已有服务器 121.41.222.73)
|
||||
|
||||
已配置好「**push 即上线**」:`.devops/自动构建部署.yml` 在 push 到 master 后,SSH 到服务器增量拉取并**自动构建启动两个服务**:
|
||||
|
||||
| 端口 | 服务 | 镜像 | 入口 |
|
||||
|:---:|------|------|------|
|
||||
| **:8080** | 任务四科研网页终端 | 根 `Dockerfile`(Go + Python) | `gitlink-cli server --port 8080`(调 `scripts/research/` 跑 S1–S6) |
|
||||
| **:8000** | 综合能力展示站(本 demo) | `demo/Dockerfile` | `python3 demo/web/server.py` |
|
||||
|
||||
```
|
||||
# ssh_cmd_0:根 Dockerfile → :8080(带 --env-file /root/.gitlink-env 注入 token)
|
||||
docker build -t gitlink-cli:latest . && docker run -d --name gitlink-cli -p 8080:8080 --env-file /root/.gitlink-env gitlink-cli:latest
|
||||
# ssh_cmd_1:demo Dockerfile → :8000(非阻塞,失败不影响 :8080)
|
||||
docker build -f demo/Dockerfile -t gitlink-cli-demo . && docker run -d --name gitlink-cli-demo -p 8000:8000 --restart unless-stopped gitlink-cli-demo
|
||||
```
|
||||
|
||||
**你只需(一次性服务器侧准备)**:
|
||||
1. 阿里云安全组/防火墙**开放 8080 + 8000** 两条入方向 TCP 规则。
|
||||
2. 在服务器建 `/root/.gitlink-env`,内容 `GITLINK_TOKEN=你的令牌`(供 :8080 科研终端调平台 API;:8000 展示站不需要,访客自带 token)。
|
||||
3. 之后每次 `git push origin master` → CI 自动重建双服务 → 直接打开网址:
|
||||
- 科研终端 `http://121.41.222.73:8080`
|
||||
- 综合展示 `http://121.41.222.73:8000`
|
||||
|
||||
> 手动部署(不走 CI):SSH 到服务器,`cd /root/gitlink-cli` 后分别跑上面两条 docker 命令。
|
||||
|
||||
### 镜像里有什么(demo/Dockerfile 多阶段)
|
||||
- Stage1 `golang:1.26-alpine`:`CGO_ENABLED=0 GOOS=linux go build` 产 Linux 二进制。
|
||||
- Stage2 `python:3.11-alpine`:装 `git`/`ca-certificates`,放二进制到 `/usr/local/bin/gitlink-cli`,拷 `demo/` 和 `skills/`,`ENV PORT=8000`,`CMD python3 demo/web/server.py`。
|
||||
|
||||
---
|
||||
|
||||
## 三、安全模型(为什么能放心公网开放)
|
||||
|
||||
| 点 | 做法 |
|
||||
|----|------|
|
||||
| 团队 token | **不烘焙**进镜像/代码。镜像里没有任何 GitLink 凭据。 |
|
||||
| 访客 token | 只存在访客自己的浏览器 localStorage,按请求传后端 → 注入子进程 `GITLINK_TOKEN` → 用完即弃,**不落盘、不写日志**。 |
|
||||
| 命令注入 | 后端白名单(仅 30 个 gitlink-cli 顶层域)+ subprocess 列表参数(不经 shell)+ 30s 超时。 |
|
||||
| 写操作 | CLI 写操作本就要 `--dry-run`/确认;演示页默认只点只读命令。 |
|
||||
|
||||
→ 公网开放的安全风险≈0:泄露的至多是访客自己输错的那一次请求。
|
||||
|
||||
---
|
||||
|
||||
## 四、访客怎么用(写进 PPT/答辩)
|
||||
|
||||
1. 打开 `http://121.41.222.73:8000`。
|
||||
2. 顶栏粘自己的 GitLink 个人访问令牌(GitLink → 个人中心 → 个人令牌)。
|
||||
3. 点「命令域」里任意动词 → 终端真跑;或点 Skill 卡片读 SKILL.md;或科研区「实拉分析」任一仓库。
|
||||
|
||||
---
|
||||
|
||||
## 五、其它 PaaS 部署(可选,不占你们服务器)
|
||||
|
||||
也可部署到 Render / Railway / Koyeb 等(需能跑 Docker):
|
||||
- 用 `demo/Dockerfile`,暴露端口环境变量 `PORT`(已支持)。
|
||||
- 这些平台默认按其给的端口注入 `PORT`,server.py 已读 `PORT` 环境变量,无需改。
|
||||
|
|
@ -1,96 +0,0 @@
|
|||
# Skills 功能验收演示文稿
|
||||
|
||||
> 用法:照此 5 分钟流程演示。**Demo 1 可现场实跑**(零依赖、最稳),其余讲解设计。
|
||||
> 配套:`snippet-live-demo.sh`(实演脚本)、`../Skills工作总结.md`(完整成果)
|
||||
|
||||
---
|
||||
|
||||
## 演示总览(5 分钟)
|
||||
|
||||
| 环节 | 时长 | 形式 | 目的 |
|
||||
|------|:----:|------|------|
|
||||
| 开场:Skills 是什么 | 30s | 口述 + 成果速览 | 讲清价值定位 |
|
||||
| **Demo 1 · snippet 实演** | 1.5min | **跑脚本** | 证明 Skill 真能驱动 CLI |
|
||||
| Demo 2 · onboarding 设计 | 1.5min | 打开 SKILL.md 讲 | 展示 AI 工作流设计深度 |
|
||||
| Demo 3 · digest/todo 体验优化 | 1min | 讲设计 + 分工 | 展示体验优化与去重思考 |
|
||||
| 收尾:成果 + 验证 | 30s | 数字 | 强化贡献 |
|
||||
|
||||
---
|
||||
|
||||
## 开场(30 秒)
|
||||
|
||||
> 一句话:**Skills 是写给 AI 的「菜谱」**——告诉 AI「什么场景、按什么顺序、调哪些 gitlink-cli 命令」。我们把 gitlink-cli 从「开发者工具」升级为「AI 可驱动的平台」。
|
||||
>
|
||||
> 本次新增 **5 个 Skill** + 补全 **28 个 examples** + snippet **7 命令端到端实测通过**。
|
||||
|
||||
---
|
||||
|
||||
## Demo 1 · snippet 现场实演(核心,必演)
|
||||
|
||||
```bash
|
||||
bash demo/snippet-live-demo.sh
|
||||
```
|
||||
|
||||
**脚本会演示的闭环**(每个场景都展示「🧑用户提问 → 🤖AI 读 SKILL.md 决策 → 执行命令 → 输出」):
|
||||
|
||||
| 场景 | 命令 | SKILL.md 规则 |
|
||||
|------|------|--------------|
|
||||
| 保存代码 | `snippet +create` | --title 必填、--tags 逗号分隔 |
|
||||
| 浏览 | `snippet +list` | 可按 tag/language 过滤 |
|
||||
| 检索 | `snippet +search` | 全文匹配 |
|
||||
| 详情 | `snippet +view` | 按 id |
|
||||
| 导出 | `snippet +export` | -o 写文件 |
|
||||
| 更新 | `snippet +update` | 至少一个字段 |
|
||||
| 删除 | `snippet +delete` | 不可逆,先确认 |
|
||||
|
||||
**讲解要点**:注意每个场景 AI 都先「读 SKILL.md 决策」再执行——这就是 Skills 的核心价值,**AI 不是瞎调命令,而是按菜谱编排**。输出严格符合 `{"ok":true,"data":{...}}` 格式。
|
||||
|
||||
---
|
||||
|
||||
## Demo 2 · onboarding 设计深度(展示 B 类工作流)
|
||||
|
||||
**操作**:打开 `gitlink-cli/gitlink-cli/skills/gitlink-onboarding/SKILL.md`
|
||||
|
||||
**重点讲三处**(评分重点):
|
||||
|
||||
1. **5 维度友好度评估表**(决策规则章节)——把「哪个 Issue 适合新人」从主观判断变成可量化打分:标题清晰度 / 描述完整度 / 代码定位 / 改动范围 / 难度标签。
|
||||
2. **4 个工作流**——项目概览 → 找任务 → 生成引导评论 → 贡献全流程(Fork→Branch→PR)。
|
||||
3. **引导评论输出模板**——AI 能自动生成「欢迎贡献 + 代码定位 + 修改步骤」的个性化评论。
|
||||
|
||||
> 一句话:A 类(命令包装)做不到「智能推荐 + 生成评论」,所以选 B 类(AI 工作流)。
|
||||
|
||||
---
|
||||
|
||||
## Demo 3 · digest / todo 体验优化(展示第二批 + 去重思考)
|
||||
|
||||
| Skill | 解决的痛点 | 与团队已有 Skill 的关系 |
|
||||
|-------|-----------|----------------------|
|
||||
| `gitlink-digest` | 信息太分散,看动态要挨个刷 | 与团队 `notification-digest` **分工**:它做通知中心,我做项目全景日报(Issue+PR+CI+活跃度) |
|
||||
| `gitlink-todo` | 没有「我的」视角,不知哪些在等我 | 团队**无对应**,真缺口 |
|
||||
|
||||
**去重思考(加分点)**:曾设计「僵尸唤醒 stale」,核查发现团队已有完整的 `gitlink-stale-issue-manager`(563 行),为避免重复造已删除——**体现对项目整体的理解和工程素养**。
|
||||
|
||||
---
|
||||
|
||||
## 收尾:成果 + 验证(30 秒)
|
||||
|
||||
| 指标 | 数据 |
|
||||
|------|------|
|
||||
| 新增 Skill | **5 个**(onboarding / auth / snippet / digest / todo) |
|
||||
| 补充 examples | **28 个**(23 个补已有 Skill + 5 个新增自带) |
|
||||
| 端到端实测 | snippet 全 7 命令通过 |
|
||||
| 命令可调用性 | 新增 Skill 全用已注册命令域,可真实调用 |
|
||||
|
||||
> 演示结束。完整设计详见 `Skills工作总结.md`。
|
||||
|
||||
---
|
||||
|
||||
## 答辩 Q&A 预备
|
||||
|
||||
| 可能的提问 | 回答要点 |
|
||||
|-----------|---------|
|
||||
| 工作边界? | 新增 5 个 Skill + 补 23 个 examples;团队原有 42 个(见总结第二节) |
|
||||
| 怎么证明 Skill 真能用? | 刚跑的 snippet 7 命令闭环;其余 4 个登录后可按 SKILL.md 工作流验证 |
|
||||
| 为什么 onboarding 选 B 类? | 需智能推荐 + 生成评论,A 类命令包装做不到 |
|
||||
| digest 和团队 notification-digest 重复吗? | 不重复,分工明确:通知中心 vs 项目全景日报 |
|
||||
| Skill 遵循什么规范? | 项目模板:YAML frontmatter + CRITICAL 三连 + 引用 gitlink-shared |
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
# 一键构建 demo 所需的 Linux gitlink-cli 二进制(本地测试 Dockerfile 用)
|
||||
# 用法:bash demo/build-demo.sh → 产物 demo/bin/gitlink-cli
|
||||
set -e
|
||||
DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
ROOT="$(cd "$DIR/.." && pwd)" # 仓库根
|
||||
OUT="$DIR/bin"
|
||||
mkdir -p "$OUT"
|
||||
echo "→ 在 $ROOT 编译 Linux amd64 二进制..."
|
||||
( cd "$ROOT" && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-s -w" -o "$OUT/gitlink-cli" . )
|
||||
echo "✓ 产出:$OUT/gitlink-cli"
|
||||
echo " 本地测容器:docker build -f $DIR/Dockerfile -t gitlink-cli-demo '$ROOT'"
|
||||
echo " docker run --rm -p 8000:8000 gitlink-cli-demo"
|
||||
|
|
@ -1,146 +0,0 @@
|
|||
# 4 个 Skill 登录实演指南(onboarding / digest / todo / auth)
|
||||
|
||||
> 用法:登录后,**在 Claude Code 里用自然语言触发**,让真 AI 读 SKILL.md 自主编排 —— 这是最强的实演证据。
|
||||
> 配套:`live-demo.sh`(辅助采集脚本,不想手敲命令时用)。
|
||||
|
||||
---
|
||||
|
||||
## 〇、前置准备
|
||||
|
||||
1. **登录**:`gitlink-cli auth login`(或 `--token`),用 `gitlink-cli auth status` 确认已登录
|
||||
2. **准备测试仓库**:用一个你自己的/有权限的公开仓库作为演示对象(避免在团队主仓库留痕)
|
||||
3. **开着 Claude Code**:在本仓库目录下启动,让 AI 能读到 `skills/*/SKILL.md`
|
||||
4. **安全原则**:只读命令随便跑;写操作(评论/关闭)让 AI 先 `--dry-run` 或确认
|
||||
|
||||
---
|
||||
|
||||
## 〇〇、推荐演示方式:自然语言触发真 AI(最有说服力)
|
||||
|
||||
> 不要告诉 AI 用哪个命令,只描述需求。看它是否**自主读 SKILL.md → 调对命令 → 输出符合模板**。
|
||||
> 这是"Skills 让 AI 能驱动 CLI"的活证据,比手敲命令强得多。
|
||||
|
||||
每个 Skill 下面都给:**① 触发语**(你对 AI 说这句)→ **② 预期 AI 行为** → **③ 手动备选**(想自己跑时)→ **④ 讲解要点**。
|
||||
|
||||
---
|
||||
|
||||
## 一、auth 实演(最简单,开场暖身)
|
||||
|
||||
**① 触发语**:
|
||||
> "检查一下我的 gitlink 登录状态"
|
||||
|
||||
**② 预期 AI 行为**:读 `auth/SKILL.md` → 调 `gitlink-cli auth status` → 报告登录用户、Token 有效期、存储位置。
|
||||
|
||||
**③ 手动备选**:
|
||||
```bash
|
||||
gitlink-cli auth status
|
||||
gitlink-cli auth login --token # 如需演示登录流程
|
||||
```
|
||||
|
||||
**④ 讲解要点**:
|
||||
- auth Skill 与 `gitlink-shared` 分工:shared 讲认证原理,auth 讲具体命令操作
|
||||
- 决策树:遇到 401 → 引导 `auth login`;403 → 查权限;CI 环境 → 用 `--token`
|
||||
- 演示 `logout` 后提醒:会清凭证,需重新登录
|
||||
|
||||
---
|
||||
|
||||
## 二、onboarding 实演(核心亮点:5 维度评估)
|
||||
|
||||
**① 触发语**:
|
||||
> "我想参与 <owner>/<repo> 这个项目,帮我找几个适合新手的任务"
|
||||
|
||||
**② 预期 AI 行为**:读 `onboarding/SKILL.md` →
|
||||
1. `search +issues --keyword "good first issue" --category opened`(找新手 Issue)
|
||||
2. `repo +info` + `repo +readme`(项目概览)
|
||||
3. 对候选 Issue 做 **5 维度友好度评估**(标题/描述/定位/范围/难度)
|
||||
4. 输出「推荐新手任务」清单 + 可选生成引导评论
|
||||
|
||||
**③ 手动备选**:
|
||||
```bash
|
||||
gitlink-cli search +issues --owner <owner> --repo <repo> --keyword "good first issue" --category opened
|
||||
gitlink-cli repo +info --owner <owner> --repo <repo>
|
||||
gitlink-cli repo +readme --owner <owner> --repo <repo>
|
||||
```
|
||||
|
||||
**④ 讲解要点**:
|
||||
- **5 维度评估表**是设计亮点:把"哪个 Issue 适合新人"从主观判断变成可量化打分(指着 AI 输出的评分讲)
|
||||
- 引导评论模板:AI 能生成「欢迎贡献 + 代码定位 + 修改步骤」个性化评论(写操作,会先确认)
|
||||
- 若无 good-first-issue 标签:AI 应从开放 Issue 推荐最简单的(决策规则)
|
||||
|
||||
---
|
||||
|
||||
## 三、digest 实演(亮点:跨源聚合成简报)
|
||||
|
||||
**① 触发语**:
|
||||
> "给我一份 <owner>/<repo> 的项目简报,今天有什么动态"
|
||||
|
||||
**② 预期 AI 行为**:读 `digest/SKILL.md` → 并行采集 → 聚合分类 →
|
||||
1. `issue +list --state open` + `pr +list`(Issue/PR 动态)
|
||||
2. `ci +builds`(CI 状态)
|
||||
3. `api GET "users/<me>/messages.json"`(通知)
|
||||
4. 按 🔴需关注 / 🟢新增 / 🔵进行中 / 📊指标 分类,输出 Markdown 简报
|
||||
|
||||
**③ 手动备选**:
|
||||
```bash
|
||||
gitlink-cli issue +list --state open --format json
|
||||
gitlink-cli pr +list --format json
|
||||
gitlink-cli ci +builds --owner <owner> --repo <repo> --format json
|
||||
gitlink-cli api GET "users/<me>/messages.json"
|
||||
```
|
||||
|
||||
**④ 讲解要点**:
|
||||
- **跨源聚合**是亮点:一份简报汇总 Issue/PR/CI/通知,不用挨个刷
|
||||
- 与团队 `notification-digest` 分工:它做通知中心(标记已读),digest 做项目全景(不做标记已读)—— 体现去重思考
|
||||
- 纯只读,安全可随时跑
|
||||
|
||||
---
|
||||
|
||||
## 四、todo 实演(亮点:补上「我的」视角)
|
||||
|
||||
**① 触发语**:
|
||||
> "我的待办有哪些?哪些 Issue/PR 在等我处理"
|
||||
|
||||
**② 预期 AI 行为**:读 `todo/SKILL.md` →
|
||||
1. `api GET "users/me"`(识别身份)
|
||||
2. `search +issues --assignee <me> --category opened`(分配我的)
|
||||
3. `api GET "users/<me>/messages.json"`(@我的)
|
||||
4. `pr +list`(我的 PR 状态)
|
||||
5. 按紧急度(@我 > 待 review > 指派)排序,输出待办清单
|
||||
|
||||
**③ 手动备选**:
|
||||
```bash
|
||||
gitlink-cli api GET "users/me" --format json
|
||||
gitlink-cli search +issues --assignee <me> --category opened
|
||||
gitlink-cli api GET "users/<me>/messages.json"
|
||||
```
|
||||
|
||||
**④ 讲解要点**:
|
||||
- **「我的」视角**是 gitlink 最缺的:跨 Issue/PR 汇总个人待办
|
||||
- 紧急度排序逻辑:@我且停留 >24h → 🔴紧急;待 review 的 PR → 🟡本周
|
||||
- 团队无对应 Skill,是真正的新增价值
|
||||
|
||||
---
|
||||
|
||||
## 五、验收串场词(5 分钟版)
|
||||
|
||||
```
|
||||
开场(30s):Skills 让 AI 能驱动 gitlink-cli。先看 snippet 实演(跑 snippet-live-demo.sh)。
|
||||
|
||||
转场:snippet 是本地功能。接下来演示需要平台 API 的 4 个 Skill,
|
||||
我用自然语言提问,看 AI 是否自主读 SKILL.md 编排命令。
|
||||
|
||||
① auth(30s):「检查登录状态」→ AI 调 auth status。
|
||||
② onboarding(1.5min):「找新手任务」→ AI 5 维度评估出推荐清单。(重点讲评估表)
|
||||
③ digest(1.5min):「给我项目简报」→ AI 跨源聚合出报告。(重点讲与团队分工)
|
||||
④ todo(1min):「我的待办」→ AI 汇总排序。(重点讲个人视角是缺口)
|
||||
|
||||
收尾(30s):5 个新增 Skill 都能被 AI 正确调用,snippet 7 命令实测通过。
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 六、安全清单(实演前确认)
|
||||
|
||||
- [ ] 用**测试仓库**演示,不用团队主仓库
|
||||
- [ ] 写操作(onboarding 引导评论、issue close)让 AI **先确认 / --dry-run**
|
||||
- [ ] 演示完 `auth logout` 的话,记得重新登录
|
||||
- [ ] 只读命令(list/view/search/info/messages)可放心反复跑
|
||||
|
|
@ -1,59 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
# ============================================================
|
||||
# 4 个 Skill 登录实演 · 辅助采集脚本
|
||||
# 作用:把每个 Skill 的「只读采集命令」串起来自动跑,展示真实数据
|
||||
# 分析(评估/聚合/排序)部分由 AI 在 Claude Code 里做——那才是亮点
|
||||
# 用法:bash demo/live-demo.sh <owner> <repo> [your-username]
|
||||
# 例:bash demo/live-demo.sh myorg myproject zhangsan
|
||||
# 前置:先 gitlink-cli auth login
|
||||
# ============================================================
|
||||
|
||||
_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
CLI="$_DIR/../gitlink-cli.exe"; [ -f "$CLI" ] || CLI="$_DIR/../gitlink-cli" # Win→.exe,Linux→无后缀
|
||||
OWNER="${1:-}"; REPO="${2:-}"; ME="${3:-$OWNER}"
|
||||
|
||||
G='\033[0;32m'; Y='\033[1;33m'; C='\033[0;36m'; R='\033[0;31m'; B='\033[1m'; N='\033[0m'
|
||||
banner() { echo -e "\n${B}══════════════════════════════════════════════════════${N}"; echo -e "${B} $1${N}"; echo -e "${B}══════════════════════════════════════════════════════${N}"; }
|
||||
section() { echo -e "\n${C}━━━ $1 ━━━${N}"; }
|
||||
run() { echo -e "${Y}❯ $1${N}"; eval "$1" 2>&1 | head -16; echo; }
|
||||
|
||||
# ---------- 前置检查 ----------
|
||||
banner "4 Skill 登录实演 · 辅助采集"
|
||||
[ -f "$CLI" ] || { echo -e "${R}✗ 找不到 gitlink-cli${N}"; exit 1; }
|
||||
if [ -z "$OWNER" ] || [ -z "$REPO" ]; then
|
||||
echo -e "${R}用法: bash $0 <owner> <repo> [your-username]${N}"
|
||||
echo -e "${R}例 : bash $0 myorg myproject zhangsan${N}"; exit 1
|
||||
fi
|
||||
echo -e "${G}✓${N} 目标仓库: ${B}$OWNER/$REPO${N},当前用户: ${B}$ME${N}"
|
||||
echo -e "${C}提示:本脚本只跑只读采集命令;分析(评估/聚合/排序)请在 Claude Code 里让 AI 做${N}"
|
||||
|
||||
# ---------- 0. auth:登录状态 ----------
|
||||
section "auth · 登录状态"
|
||||
run "\"$CLI\" auth status"
|
||||
|
||||
# ---------- 1. onboarding:找新手任务 ----------
|
||||
section "onboarding · 新手 Issue + 项目概览(供 AI 做 5 维度评估)"
|
||||
run "\"$CLI\" search +issues --owner $OWNER --repo $REPO --keyword 'good first issue' --category opened --format json"
|
||||
run "\"$CLI\" repo +info --owner $OWNER --repo $REPO --format json"
|
||||
|
||||
# ---------- 2. digest:多源数据(供 AI 聚合成简报)----------
|
||||
section "digest · Issue / PR / CI / 通知(供 AI 跨源聚合)"
|
||||
run "\"$CLI\" issue +list --owner $OWNER --repo $REPO --state open --format json"
|
||||
run "\"$CLI\" pr +list --owner $OWNER --repo $REPO --format json"
|
||||
run "\"$CLI\" ci +builds --owner $OWNER --repo $REPO --format json"
|
||||
run "\"$CLI\" api GET \"users/$ME/messages.json\""
|
||||
|
||||
# ---------- 3. todo:个人待办数据(供 AI 排序)----------
|
||||
section "todo · 分配给我的 Issue + @我消息(供 AI 排序成待办)"
|
||||
run "\"$CLI\" api GET \"users/me\" --format json"
|
||||
run "\"$CLI\" search +issues --assignee $ME --category opened --format json"
|
||||
run "\"$CLI\" api GET \"users/$ME/messages.json\""
|
||||
|
||||
# ---------- 总结 ----------
|
||||
banner "采集完成"
|
||||
echo -e "${B}接下来${N}:在 Claude Code 里用自然语言触发,让 AI 读对应 SKILL.md 分析以上数据:"
|
||||
echo -e " • ${C}「找适合新手的任务」${N} → onboarding 的 5 维度评估"
|
||||
echo -e " • ${C}「给我项目简报」${N} → digest 的跨源聚合"
|
||||
echo -e " • ${C}「我的待办有哪些」${N} → todo 的紧急度排序"
|
||||
echo -e "\n详见 ${Y}live-demo-guide.md${N}"
|
||||
read -p "按回车键继续..."
|
||||
|
|
@ -1,118 +0,0 @@
|
|||
# 代码质量看门人 · 工作流说明与架构(子任务三)
|
||||
|
||||
> 端到端自动化工作流:PR 提交后自动跑完「采集 → AI Review → CI → 评论 → 质量判定/合并」。
|
||||
> 对应 Skill:`skills/gitlink-pr-guard/SKILL.md`;可复现脚本:`demo/pr-guard-workflow.sh`。
|
||||
|
||||
---
|
||||
|
||||
## 一、工作流架构图
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────┐
|
||||
│ 触发:PR 提交 / 更新 │
|
||||
│ (或用户:帮我把关 PR #<id>) │
|
||||
└──────────────────────┬──────────────────────┘
|
||||
▼
|
||||
┌─────────────────────────────────────────────┐
|
||||
│ Step 1 采集 PR 变更 │
|
||||
│ pr +view → pr +files → pr +diff --stat │
|
||||
│ 产出:PR 详情 / 变更文件 / diff 统计 │
|
||||
└──────────────────────┬──────────────────────┘
|
||||
▼
|
||||
┌─────────────────────────────────────────────┐
|
||||
│ Step 2 AI Review(复用 code-review 逻辑) │
|
||||
│ 逐文件分析 diff → 分级找问题 │
|
||||
│ 🔴 Critical / 🟡 Warning / 🔵 Suggestion │
|
||||
└──────────────────────┬──────────────────────┘
|
||||
▼
|
||||
┌─────────────────────────────────────────────┐
|
||||
│ Step 3 CI 检查 │
|
||||
│ ci +builds → 匹配分支最新构建 → 状态 │
|
||||
│ success / failure / pending │
|
||||
└──────────────────────┬──────────────────────┘
|
||||
▼
|
||||
┌─────────────────────────────────────────────┐
|
||||
│ Step 4 发布质量看门人报告 │
|
||||
│ api POST .../pulls/:id/reviews │
|
||||
│ 报告:判定 + 问题清单 + CI + 处置建议 │
|
||||
└──────────────────────┬──────────────────────┘
|
||||
▼
|
||||
┌─────────────────────────────────────────────┐
|
||||
│ Step 5 质量判定(门禁规则) │
|
||||
│ ┌─────────────────────────────────────┐ │
|
||||
│ │ 0 Critical + CI success → ✅ 合并 │ │
|
||||
│ │ 有 Critical → 🔴 请求修改 │ │
|
||||
│ │ CI failure → 🔴 请求修改 │ │
|
||||
│ └─────────────────────────────────────┘ │
|
||||
│ 达标+确认 → pr +merge │
|
||||
└─────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 二、串联的 CLI 命令 / Skill(满足"≥3 步")
|
||||
|
||||
| Step | 命令域 | 具体调用 | 类型 |
|
||||
|:----:|:------:|---------|:----:|
|
||||
| 1 | pr | `pr +view` / `+files` / `+diff` | 采集 |
|
||||
| 2 | code-review | Review 分析逻辑(分级找问题) | AI 分析 |
|
||||
| 3 | ci | `ci +builds` / `+log` | 采集 |
|
||||
| 4 | api | `POST .../pulls/:id/reviews` | 写(评论) |
|
||||
| 5 | pr | `pr +merge`(达标确认后) | 写(合并) |
|
||||
|
||||
> **共串联 4 个命令域 + 5 个步骤 + 2 处写操作**,远超任务三"≥3 步"要求。
|
||||
|
||||
---
|
||||
|
||||
## 三、与子任务二的区别(关键)
|
||||
|
||||
| 维度 | 子任务二 Skill(如 code-review) | 子任务三 本工作流(pr-guard) |
|
||||
|------|--------------------------------|-----------------------------|
|
||||
| **交付单位** | 单个 Skill | 串联多步的**完整解决方案** |
|
||||
| **职责** | 只做 Review | Review + CI + 评论 + 合并决策 |
|
||||
| **触发** | 用户要 Review | PR 提交自动跑完整流水线 |
|
||||
| **决策** | 输出意见 | **质量门禁判定(通过/拒绝/合并)** |
|
||||
|
||||
> code-review 是"审查员",pr-guard 是"看门人"——后者在前者基础上加了 CI 维度和合并决策,形成完整门禁。
|
||||
|
||||
---
|
||||
|
||||
## 四、可复现性(对应交付要求)
|
||||
|
||||
| 要求 | 满足方式 |
|
||||
|------|---------|
|
||||
| 串联 ≥3 步 CLI/Skill | 5 步、4 域 ✅ |
|
||||
| 含自定义 Skill 兼容 Agent | `gitlink-pr-guard` SKILL.md(Claude Code 可读)✅ |
|
||||
| 可复现执行脚本 | `demo/pr-guard-workflow.sh`(参数化)✅ |
|
||||
| 真实 GitLink 项目演示 | 登录后对真实 PR 运行(见下) |
|
||||
| 工作流说明 + 架构图 | 本文档 ✅ |
|
||||
|
||||
---
|
||||
|
||||
## 五、真实演示步骤(登录后)
|
||||
|
||||
```bash
|
||||
# 1. 登录
|
||||
gitlink-cli auth login
|
||||
|
||||
# 2. 找一个真实 PR
|
||||
gitlink-cli pr +list --owner <owner> --repo <repo> --state open
|
||||
|
||||
# 3. 跑质量看门人流水线(脚本采集,AI 在 Claude Code 做 Step2 分析)
|
||||
bash demo/pr-guard-workflow.sh <owner> <repo> <pr_id>
|
||||
|
||||
# 或在 Claude Code 里自然语言触发:
|
||||
# "读 skills/gitlink-pr-guard/SKILL.md,帮我把关 <owner>/<repo> 的 PR #42"
|
||||
```
|
||||
|
||||
**预期 AI 行为**:读 pr-guard SKILL.md → 按工作流跑 5 步 → 输出质量看门人报告 + 判定(通过/拒绝)+ 合并建议。
|
||||
|
||||
---
|
||||
|
||||
## 六、交付清单
|
||||
|
||||
- [x] `skills/gitlink-pr-guard/SKILL.md` — 工作流定义 + 门禁规则 + 报告模板
|
||||
- [x] `demo/pr-guard-workflow.sh` — 可复现脚本(5 步串联)
|
||||
- [x] `demo/pr-guard-architecture.md` — 本文档(说明 + 架构图)
|
||||
- [ ] 真实项目演示(登录后运行 + 截图/录屏)
|
||||
- [ ] 报告(暂缓,后续按统一策略补《新需求构思》《变更影响测试》)
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
# ============================================================
|
||||
# 代码质量看门人 · 端到端工作流脚本(子任务三)
|
||||
# 串联 5 步:采集 PR → AI Review → CI 检查 → 汇总评论 → 质量判定
|
||||
# 用法:bash demo/pr-guard-workflow.sh <owner> <repo> <pr_id>
|
||||
# 例:bash demo/pr-guard-workflow.sh myorg myproject 42
|
||||
# 前置:gitlink-cli auth login(涉及平台 API)
|
||||
# 说明:采集命令真实执行;Review 分析由 AI Agent(读 pr-guard/SKILL.md)完成
|
||||
# ============================================================
|
||||
|
||||
_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
CLI="$_DIR/../gitlink-cli.exe"; [ -f "$CLI" ] || CLI="$_DIR/../gitlink-cli" # Win→.exe,Linux→无后缀
|
||||
OWNER="${1:-}"; REPO="${2:-}"; PR_ID="${3:-}"
|
||||
|
||||
G='\033[0;32m'; Y='\033[1;33m'; C='\033[0;36m'; R='\033[0;31m'; B='\033[1m'; N='\033[0m'
|
||||
banner() { echo -e "\n${B}══════════════════════════════════════════════════════${N}"; echo -e "${B} $1${N}"; echo -e "${B}══════════════════════════════════════════════════════${N}"; }
|
||||
step() { echo -e "\n${C}━━━ Step $1 ━━━ ${B}$2${N}"; }
|
||||
ai() { echo -e "🤖 ${G}AI(读 pr-guard/SKILL.md 后):${N} $1"; }
|
||||
run() { echo -e "${Y}❯ $1${N}"; eval "$1" 2>&1 | head -16; echo; }
|
||||
|
||||
# ---------- 前置检查 ----------
|
||||
banner "代码质量看门人 · PR #${PR_ID:-?} 质量流水线"
|
||||
[ -f "$CLI" ] || { echo -e "${R}✗ 找不到 gitlink-cli${N}"; exit 1; }
|
||||
if [ -z "$OWNER" ] || [ -z "$REPO" ] || [ -z "$PR_ID" ]; then
|
||||
echo -e "${R}用法: bash $0 <owner> <repo> <pr_id>${N}"
|
||||
echo -e "${R}例 : bash $0 myorg myproject 42${N}"; exit 1
|
||||
fi
|
||||
echo -e "${G}✓${N} 目标: ${B}$OWNER/$REPO${N} PR #${B}$PR_ID${N}"
|
||||
|
||||
# ---------- Step 1:采集 PR 变更 ----------
|
||||
step 1 "采集 PR 变更(pr +view / +files / +diff)"
|
||||
ai "先拉 PR 详情、变更文件、diff 统计,作为审查输入。"
|
||||
run "\"$CLI\" pr +view --id $PR_ID --format json"
|
||||
run "\"$CLI\" pr +files --id $PR_ID --format json"
|
||||
run "\"$CLI\" pr +diff --id $PR_ID --stat"
|
||||
|
||||
# ---------- Step 2:AI Review(复用 code-review 逻辑)----------
|
||||
step 2 "AI Review(按 code-review 分级找问题)"
|
||||
ai "逐文件分析 diff,按安全红线/错误处理/规范分级。这一步由 AI Agent 完成(读 code-review/SKILL.md)。"
|
||||
echo -e " ${C}分级框架${N}:"
|
||||
echo -e " 🔴 Critical:硬编码密钥 / SQL·命令注入 / 路径遍历(安全红线,阻断合并)"
|
||||
echo -e " 🟡 Warning :错误处理缺失 / 边界条件 / 明文敏感信息"
|
||||
echo -e " 🔵 Suggestion:命名 / 性能 / 可配置化"
|
||||
echo -e " ${C}Agent 在此输出分级清单(示例见 SKILL.md 输出模板)${N}"
|
||||
|
||||
# ---------- Step 3:CI 检查 ----------
|
||||
step 3 "CI 检查(ci +builds)"
|
||||
ai "查 PR 对应分支的最新构建状态,作为门禁第二维。"
|
||||
run "\"$CLI\" ci +builds --owner $OWNER --repo $REPO --format json"
|
||||
echo -e " ${C}判定:从返回按 source_branch 匹配最新构建 → success / failure / pending${N}"
|
||||
|
||||
# ---------- Step 4:发布汇总评论 ----------
|
||||
step 4 "发布质量看门人报告(api POST .../reviews)"
|
||||
ai "把 Review 意见 + CI 状态 + 质量判定组装成报告,评论到 PR。"
|
||||
echo -e "${Y}❯ gitlink-cli api POST /$OWNER/$REPO/pulls/$PR_ID/reviews --body '<报告>'${N}"
|
||||
echo -e " ${C}报告含${N}:质量判定 + Critical/Warning 清单 + CI 状态 + 处置建议"
|
||||
echo -e " ${C}[实演时此处真实发送;脚本演示仅展示结构]${N}"
|
||||
|
||||
# ---------- Step 5:质量判定 ----------
|
||||
step 5 "质量判定(门禁规则 → 合并 / 请求修改)"
|
||||
ai "按门禁规则决策。注意:合并是写操作,默认只建议,确认后才执行。"
|
||||
echo -e " ${C}门禁规则${N}:"
|
||||
echo -e " 0 Critical + CI success → ✅ 通过,建议合并"
|
||||
echo -e " 有 Critical 任一 → 🔴 拒绝,请求修改"
|
||||
echo -e " CI failure → 🔴 拒绝,附 CI 日志"
|
||||
echo -e " 仅 Warning/Suggestion → 🟡 通过(带建议)"
|
||||
echo ""
|
||||
echo -e " ${G}若判定通过 + 用户确认 →${N} ${Y}gitlink-cli pr +merge --id $PR_ID --method squash${N}"
|
||||
|
||||
# ---------- 总结 ----------
|
||||
banner "流水线完成"
|
||||
echo -e "${B}代码质量看门人${N} 串联了 ${B}5 步${N},覆盖 ${B}4 个 CLI 域${N}:"
|
||||
echo -e " pr(采集/合并)+ code-review(Review)+ ci(构建)+ api(评论)"
|
||||
echo -e "\n${C}真实演示${N}:登录后对本仓库一个真实 PR 跑此脚本,由 AI 完成 Step 2 分析。"
|
||||
echo -e "详见 ${Y}pr-guard-architecture.md${N}(工作流说明 + 架构图)"
|
||||
read -p "按回车键继续..."
|
||||
|
|
@ -1,104 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
# ============================================================
|
||||
# 科研仓库画像 · 端到端工作流脚本(子任务四)
|
||||
# 4 步:采集数据 → 四维评分 → 协作图谱 → 科研画像报告
|
||||
# 用法:bash demo/research-insight-workflow.sh <owner> <repo>
|
||||
# 例:bash demo/research-insight-workflow.sh someresearch awesome-paper-code
|
||||
# 前置:gitlink-cli auth login(只读分析,不改数据)
|
||||
# 说明:采集命令真实执行;四维评分 + 协作图谱由 AI(读 research-insight/SKILL.md)完成
|
||||
# ============================================================
|
||||
|
||||
_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
CLI="$_DIR/../gitlink-cli.exe"; [ -f "$CLI" ] || CLI="$_DIR/../gitlink-cli" # Win→.exe,Linux→无后缀
|
||||
OWNER="${1:-}"; REPO="${2:-}"
|
||||
|
||||
G='\033[0;32m'; Y='\033[1;33m'; C='\033[0;36m'; R='\033[0;31m'; B='\033[1m'; N='\033[0m'
|
||||
banner() { echo -e "\n${B}══════════════════════════════════════════════════════${N}"; echo -e "${B} $1${N}"; echo -e "${B}══════════════════════════════════════════════════════${N}"; }
|
||||
step() { echo -e "\n${C}━━━ Step $1 ━━━ ${B}$2${N}"; }
|
||||
ai() { echo -e "🤖 ${G}AI(读 research-insight/SKILL.md 后):${N} $1"; }
|
||||
run() { echo -e "${Y}❯ $1${N}"; eval "$1" 2>&1 | head -14; echo; }
|
||||
|
||||
# ---------- 前置检查 ----------
|
||||
banner "🔬 科研仓库画像 · $OWNER/${REPO:-?}"
|
||||
[ -f "$CLI" ] || { echo -e "${R}✗ 找不到 gitlink-cli${N}"; exit 1; }
|
||||
if [ -z "$OWNER" ] || [ -z "$REPO" ]; then
|
||||
echo -e "${R}用法: bash $0 <owner> <repo>${N}"
|
||||
echo -e "${R}例 : bash $0 someresearch awesome-paper-code${N}"; exit 1
|
||||
fi
|
||||
echo -e "${G}✓${N} 分析对象: ${B}$OWNER/$REPO${N}(只读,不改数据)"
|
||||
|
||||
# ---------- Step 0:fork 检测(避免给 fork 错评) ----------
|
||||
step 0 "fork 检测(引用价值要改评 upstream)"
|
||||
ai "先看 repo +info 的 fork_info。是 fork 则引用价值/活跃度改评 upstream。"
|
||||
INFO="$("$CLI" repo +info --owner "$OWNER" --repo "$REPO" --format json 2>/dev/null)"
|
||||
UPSTREAM="$(printf '%s' "$INFO" | grep -o '"fork_project_user_login": *"[^"]*"' | head -1 | sed 's/.*: *"//;s/"$//')"
|
||||
# fork_project_user_login 缺失或为 null → 非空才算 fork
|
||||
[ "$UPSTREAM" = "null" ] && UPSTREAM=""
|
||||
if [ -n "$UPSTREAM" ]; then
|
||||
echo -e " ${R}⚠️ $OWNER/$REPO 是 ${B}$UPSTREAM/$REPO${N}${R} 的 fork —— 引用价值应改评 upstream ${B}$UPSTREAM/$REPO${N}"
|
||||
else
|
||||
echo -e " ${G}✓${N} 独立仓库(非 fork),正常评估"
|
||||
fi
|
||||
|
||||
# ---------- Step 1:采集科研仓库数据 ----------
|
||||
step 1 "采集科研仓库数据(repo / file / issue / pr + 本地 git 兜底)"
|
||||
ai "拉基础画像、活跃度、合规复现性数据,作为科研评估输入。"
|
||||
echo -e "${Y}❯ 基础画像(repo +info / +languages / +contributors)${N}"
|
||||
"$CLI" repo +info --owner "$OWNER" --repo "$REPO" --format json 2>&1 | head -14
|
||||
"$CLI" repo +languages --owner "$OWNER" --repo "$REPO" --format json 2>&1 | head -8
|
||||
"$CLI" repo +contributors --owner "$OWNER" --repo "$REPO" --format json 2>&1 | head -12
|
||||
echo -e "\n${Y}❯ 复现性文件(file +get 读 LICENSE / CI —— 替代不存在的 repo +raw)${N}"
|
||||
"$CLI" file +get --owner "$OWNER" --repo "$REPO" --path LICENSE --format json 2>&1 | head -3
|
||||
"$CLI" repo +tree --owner "$OWNER" --repo "$REPO" --path .gitea/workflows --format json 2>&1 | head -6
|
||||
echo -e "\n${Y}❯ 版本归档(release +list —— 替代不存在的 repo +tags)${N}"
|
||||
"$CLI" release +list --owner "$OWNER" --repo "$REPO" --format json 2>&1 | head -6
|
||||
echo -e "\n${Y}❯ 活跃度(issue/pr + git 兜底 —— repo +commits 不存在)${N}"
|
||||
"$CLI" issue +list --owner "$OWNER" --repo "$REPO" --format json 2>&1 | head -8
|
||||
"$CLI" pr +list --owner "$OWNER" --repo "$REPO" --format json 2>&1 | head -8
|
||||
echo -e " ${C}repo +commits 不存在 → 用 git clone 兜底读提交时间线${N}"
|
||||
TMP="/tmp/${OWNER}-${REPO}-analyze"; rm -rf "$TMP"
|
||||
if git clone --quiet --depth 100 "https://gitlink.org.cn/$OWNER/$REPO.git" "$TMP" 2>/dev/null; then
|
||||
echo -e " 近 3 月提交: $(git -C "$TMP" log --oneline --since='3 months ago' 2>/dev/null | wc -l) 次"
|
||||
echo -e " 最近提交 : $(git -C "$TMP" log -1 --format='%ci %an' 2>/dev/null)"
|
||||
echo -e " tag 列表 : $(git -C "$TMP" tag 2>/dev/null | tr '\n' ' ')"
|
||||
echo -e " PR 合并数 : $(git -C "$TMP" log --merges --oneline 2>/dev/null | wc -l)"
|
||||
else
|
||||
echo -e " ${R}✗ git clone 失败(无 git 或无网络)→ 活跃度改用 repo +info 计数近似${N}"
|
||||
fi
|
||||
|
||||
# ---------- Step 2:四维科研评分 ----------
|
||||
step 2 "四维科研评分(AI 按指标体系打分)"
|
||||
ai "对采集数据按科研四维评分。这一步由 AI 完成(指标体系见 SKILL.md)。"
|
||||
echo -e " ${C}🔁 可复现性${N}(科研核心,满分10):CI(+2) / 依赖锁定(+2) / 数据说明(+2) / 运行文档(+2) / 版本归档(+2)"
|
||||
echo -e " ${C}📈 活跃度${N}:近3月提交频率 + Issue/PR 活跃 + 贡献者趋势"
|
||||
echo -e " ${C}📑 引用价值${N}:LICENSE + 版本归档 + 文档完整 + 星标"
|
||||
echo -e " ${C}🤝 协作健康${N}:Issue响应 + PR合并率 + 巴士因子(核心贡献者占比)"
|
||||
echo -e " ${C}Agent 在此输出各维度得分 + 判定依据${N}"
|
||||
|
||||
# ---------- Step 3:协作知识图谱 ----------
|
||||
step 3 "协作知识图谱(贡献者协作网络)"
|
||||
ai "从贡献者 + PR 协作数据生成 mermaid 协作网络,呼应『知识图谱』要求。"
|
||||
cat <<'MERMAID'
|
||||
graph LR
|
||||
A[核心贡献者1] -->|主提交| P((项目))
|
||||
B[核心贡献者2] -->|主提交| P
|
||||
C[偶发贡献者] -->|贡献| P
|
||||
A -.评审.-> C
|
||||
B -.评审.-> C
|
||||
MERMAID
|
||||
echo -e " ${C}巴士因子${N}:核心贡献者提交占比 → <健康 / 单点风险>"
|
||||
|
||||
# ---------- Step 4:科研画像报告 ----------
|
||||
step 4 "生成科研画像报告"
|
||||
ai "组装成《科研仓库画像报告》:一句话定性 + 综合评分 + 四维详情 + 协作图 + 引用/复现/合作建议。"
|
||||
echo -e " ${C}报告含${N}:🔬综合评分 / 📋基础信息 / 🔁可复现性详情 / 🤝协作网络图 / 💡给科研工作者建议"
|
||||
echo -e " ${C}模板见 SKILL.md「输出模板」+ research-insight-guide.md${N}"
|
||||
|
||||
# ---------- 总结 ----------
|
||||
banner "分析完成"
|
||||
echo -e "${B}科研仓库画像${N} 串联 ${B}5 步${N}(fork 检测 + 采集 + 评分 + 图谱 + 报告),覆盖 CLI 域(只读):"
|
||||
echo -e " repo / file / release / issue / pr + 本地 git(提交时间线兜底,repo +commits 不存在)"
|
||||
echo -e "\n${C}科研视角创新${N}:可复现性评分 + 引用价值 + 协作知识图谱(区别于普通 health 工程视角)"
|
||||
echo -e "${C}真实验证${N}:登录后对 GitLink 一个科研类仓库跑此脚本,由 AI 完成评分 → 产出报告 + 截图"
|
||||
echo -e "详见 ${Y}research-insight-guide.md${N}(完整中文使用文档 + 报告样例)"
|
||||
read -p "按回车键继续..."
|
||||
|
|
@ -1,94 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
# ============================================================
|
||||
# GitLink Skills 功能演示 —— snippet 完整闭环
|
||||
# 核心卖点:AI 读取 SKILL.md → 自动编排 gitlink-cli 命令 → 完成完整场景
|
||||
# 特点:snippet 是本地功能,无需登录,可安全现场实演
|
||||
# 用法:bash demo/snippet-live-demo.sh
|
||||
# ============================================================
|
||||
|
||||
# 不用 set -e:保证演示连续性,关键步骤手动检查
|
||||
_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
CLI="$_DIR/../gitlink-cli.exe"; [ -f "$CLI" ] || CLI="$_DIR/../gitlink-cli" # Win→.exe,Linux→无后缀
|
||||
|
||||
# ANSI 颜色
|
||||
G='\033[0;32m'; Y='\033[1;33m'; C='\033[0;36m'; R='\033[0;31m'; B='\033[1m'; N='\033[0m'
|
||||
|
||||
banner() { echo -e "\n${B}══════════════════════════════════════════════════════${N}"; echo -e "${B} $1${N}"; echo -e "${B}══════════════════════════════════════════════════════${N}"; }
|
||||
scene() { echo -e "\n${C}━━━ 场景 $1 ━━━ ${B}$2${N}"; }
|
||||
user() { echo -e "🧑 ${B}用户:${N} $1"; }
|
||||
ai() { echo -e "🤖 ${G}AI(读 snippet/SKILL.md 后):${N} $1"; }
|
||||
show() { echo -e "${Y}❯ $1${N}"; }
|
||||
|
||||
# ---------- 前置检查 ----------
|
||||
banner "GitLink Skills 演示 · snippet 闭环"
|
||||
[ -f "$CLI" ] || { echo -e "${R}✗ 找不到 gitlink-cli: $CLI${N}"; exit 1; }
|
||||
echo -e "${G}✓${N} gitlink-cli 就绪"
|
||||
echo -e "${G}✓${N} snippet 为本地功能(${B}无需登录${N}),可安全现场演示"
|
||||
echo -e "${G}✓${N} 演示数据用完即删,不污染环境"
|
||||
|
||||
# ---------- 场景 1:创建 ----------
|
||||
scene 1 "保存一段常用代码"
|
||||
user "帮我存一段快速排序代码,语言 python,标签 algorithm"
|
||||
ai "决策 → \`snippet +create\`(⚠️ Write)。SKILL.md 规则:--title 必填、--tags 逗号分隔、--language 标注。"
|
||||
show "gitlink-cli snippet +create --title '快速排序(演示)' --language python --tags algorithm,demo --content '...'"
|
||||
OUT=$("$CLI" snippet +create --title '快速排序(演示)' --language python --tags algorithm,demo \
|
||||
--content 'def qs(a): return a if len(a)<2 else qs([x for x in a[1:] if x<=a[0]])+[a[0]]+qs([x for x in a[1:] if x>a[0]])' \
|
||||
--format json 2>&1)
|
||||
echo "$OUT" | head -12
|
||||
DEMO_ID=$(echo "$OUT" | grep -oE '"id":[[:space:]]*"[0-9a-f]+"' | head -1 | grep -oE '[0-9a-f]{8}')
|
||||
echo -e "${G}✓${N} 已创建,id = ${B}$DEMO_ID${N}"
|
||||
|
||||
# ---------- 场景 2:列表 ----------
|
||||
scene 2 "浏览片段库"
|
||||
user "我存了哪些片段?"
|
||||
ai "决策 → \`snippet +list\`(Read)。可按 --tag / --language / --keyword 过滤。"
|
||||
show "gitlink-cli snippet +list --format json"
|
||||
"$CLI" snippet +list --format json 2>&1 | head -14
|
||||
|
||||
# ---------- 场景 3:搜索 ----------
|
||||
scene 3 "全文检索"
|
||||
user "帮我找包含 '排序' 的片段"
|
||||
ai "决策 → \`snippet +search\`(Read,全文匹配 title + content)。"
|
||||
show "gitlink-cli snippet +search --query '排序' --format json"
|
||||
"$CLI" snippet +search --query '排序' --format json 2>&1 | head -10
|
||||
|
||||
# ---------- 场景 4:查看详情 ----------
|
||||
scene 4 "查看指定片段"
|
||||
user "看看 id=$DEMO_ID 这个的详情"
|
||||
ai "决策 → \`snippet +view --id\`(Read)。"
|
||||
show "gitlink-cli snippet +view --id $DEMO_ID --format json"
|
||||
"$CLI" snippet +view --id "$DEMO_ID" --format json 2>&1 | head -12
|
||||
|
||||
# ---------- 场景 5:导出 ----------
|
||||
scene 5 "导出到文件复用"
|
||||
user "把它导出成文件,我要贴到项目里"
|
||||
ai "决策 → \`snippet +export --output\`(Read)。SKILL.md:默认输出到 stdout,-o 写文件。"
|
||||
TMP="$PWD/.demo_export_$$.py"
|
||||
show "gitlink-cli snippet +export --id $DEMO_ID --output $TMP"
|
||||
"$CLI" snippet +export --id "$DEMO_ID" --output "$TMP" >/dev/null 2>&1
|
||||
echo -e "${G}✓${N} 已导出,文件内容:"; cat "$TMP"; rm -f "$TMP"
|
||||
|
||||
# ---------- 场景 6:更新 ----------
|
||||
scene 6 "更新片段字段"
|
||||
user "给这个片段补个 tag 'sort'"
|
||||
ai "决策 → \`snippet +update\`(⚠️ Write)。--id 必填,至少一个字段。"
|
||||
show "gitlink-cli snippet +update --id $DEMO_ID --tags algorithm,demo,sort"
|
||||
"$CLI" snippet +update --id "$DEMO_ID" --tags algorithm,demo,sort --format json 2>&1 | head -8
|
||||
|
||||
# ---------- 场景 7:删除(清理)----------
|
||||
scene 7 "删除演示片段(清理)"
|
||||
user "演示结束,删掉刚才的测试片段"
|
||||
ai "决策 → \`snippet +delete\`(🔴 Destructive)。SKILL.md:删除不可逆,建议先 view 确认。"
|
||||
show "gitlink-cli snippet +delete --id $DEMO_ID"
|
||||
"$CLI" snippet +delete --id "$DEMO_ID" --format json 2>&1 | head -4
|
||||
echo -e "${G}✓${N} 演示数据已清理"
|
||||
|
||||
# ---------- 总结 ----------
|
||||
banner "演示完成"
|
||||
echo -e "${B}gitlink-snippet${N} Skill 的 7 个命令全部实测通过:"
|
||||
echo -e " create / list / search / view / export / update / delete"
|
||||
echo ""
|
||||
echo -e "${B}核心价值${N}:AI 读取 SKILL.md 后,能自动编排 gitlink-cli 命令完成完整场景,"
|
||||
echo -e "输出严格符合 SKILL.md 定义的 envelope 格式 {\"ok\":true,\"data\":{...}}。"
|
||||
echo -e "\n${C}其他 Skill(onboarding / digest / todo)涉及平台 API,登录后可按其 SKILL.md 的「工作流」演示。${N}"
|
||||
read -p "按回车键继续..."
|
||||
|
|
@ -1,56 +0,0 @@
|
|||
# GitLink CLI 智能化能力展示(演示网页)
|
||||
|
||||
一个**可交互的演示站**:点动词/敲命令 → 真跑 gitlink-cli → 显示真实输出,配合 25 域命令浏览器、48 Skill 卡片墙、pr-guard 流程、科研四维雷达,全面展示子任务一~四的成果。
|
||||
|
||||
> 位置:仓库内 `demo/web/`(`server.py` + `index.html`)。后端零依赖(仅 Python 标准库)。
|
||||
|
||||
## 架构(访客自带 token,零凭据上云)
|
||||
|
||||
```
|
||||
浏览器 index.html ──fetch──▶ server.py(Python 标准库)
|
||||
顶栏 token + owner/repo │ GET /api/skill 读 SKILL.md
|
||||
命令域 / 终端 / Skill 墙 │ POST /api/run 真跑 CLI(token 透传给子进程)
|
||||
pr-guard / 科研雷达 │ POST /api/analyze 四维评分 + 巴士因子
|
||||
▼
|
||||
gitlink-cli(仓库根 ../../gitlink-cli[.exe])
|
||||
```
|
||||
|
||||
- 访客 token 仅存在**访客自己的浏览器**(localStorage),按请求传后端 → 注入子进程 `GITLINK_TOKEN` → 用完即弃,**不落服务端、不写日志**。
|
||||
- 本地命令(`snippet`/`auth`)免 token 即可真跑;平台命令(`repo`/`issue`/`pr`…)需访客填自己的 token。
|
||||
|
||||
## 本地启动(3 步)
|
||||
|
||||
```bash
|
||||
# 1. 在仓库根编译 CLI(已有可跳过)
|
||||
cd gitlink-cli # 仓库根(含 go.mod)
|
||||
go build -o gitlink-cli . # Windows 会生成 gitlink-cli.exe
|
||||
|
||||
# 2. 启动后端(零依赖)
|
||||
cd demo/web
|
||||
python server.py # → http://0.0.0.0:8000
|
||||
|
||||
# 3. 浏览器打开 http://localhost:8000
|
||||
# 顶栏粘自己的 GitLink token(auth login --token 拿)→ 平台命令即可真跑
|
||||
```
|
||||
|
||||
> 服务端会自动探测二进制:`GITLINK_BIN` 环境变量 > 仓库根 `gitlink-cli`/`gitlink-cli.exe` > PATH。
|
||||
> 端口/主机可设:`PORT=9000 HOST=127.0.0.1 python server.py`。
|
||||
|
||||
## 展示区
|
||||
|
||||
| 区块 | 内容 |
|
||||
|------|------|
|
||||
| ① 命令全域浏览器 | 25 域 160+ 动词,按子任务分组 + 搜索;点动词填终端真跑 |
|
||||
| ② Skill 全集 | 48 个 Skill 卡片(按 全部/新增/科研/质量 筛选),点开读 SKILL.md 全文 |
|
||||
| ③ pr-guard | 5 步门禁动画 + 「用真实 PR 跑」(填 token) |
|
||||
| ④ 科研画像 | 「实拉分析」目标仓库 → 四维雷达 + 协作网络 + 巴士因子 |
|
||||
| ⑤ 验证 | 命令层 / 编排层 / 输出层 三层证据 |
|
||||
|
||||
## 安全
|
||||
|
||||
- 后端白名单(仅 30 个 gitlink-cli 顶层域)+ subprocess 列表参数(不经 shell)+ 30s 超时。
|
||||
- 访客 token 不落服务端。公网部署也**不烘焙任何团队 token**。
|
||||
|
||||
## 云端部署
|
||||
|
||||
见上级 [`demo/README.md`](../README.md)(Dockerfile + `.devops` 流水线 + 服务器部署说明)。
|
||||
|
|
@ -1,424 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="zh-CN">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>GitLink CLI · 智能化能力展示</title>
|
||||
<script src="https://cdn.tailwindcss.com"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/chart.js@4"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
|
||||
<style>
|
||||
:root { --bg:#0d1117; --panel:#161b22; --border:#30363d; --txt:#c9d1d9; --acc:#58a6ff; --green:#3fb950; --red:#f85149; --yellow:#d29922; }
|
||||
body { background:var(--bg); color:var(--txt); font-family: -apple-system, "Segoe UI", "Microsoft YaHei", sans-serif; }
|
||||
.panel { background:var(--panel); border:1px solid var(--border); }
|
||||
.mono { font-family: "Cascadia Code", Consolas, "Courier New", monospace; }
|
||||
#term-out { background:#010409; min-height:300px; max-height:440px; overflow-y:auto; padding:14px; }
|
||||
.l-cmd { color:var(--acc); } .l-out { color:var(--txt); white-space:pre-wrap; word-break:break-all; }
|
||||
.l-err { color:var(--red); } .l-muted { color:#6e7681; font-style:italic; }
|
||||
#term-input { background:#010409; border-top:1px solid var(--border); }
|
||||
.skill-card { transition:.2s; }
|
||||
.skill-card:hover { border-color:var(--acc); transform:translateY(-2px); }
|
||||
.step { transition:.3s; }
|
||||
.step.active { border-color:var(--green); background:#1c2820; }
|
||||
.verb { font-size:11px; padding:2px 7px; border-radius:4px; border:1px solid var(--border); background:#0d1117; cursor:pointer; transition:.15s; }
|
||||
.verb:hover { border-color:var(--acc); color:var(--acc); }
|
||||
.chip { background:#21262d; border:1px solid var(--border); }
|
||||
.fbtn { font-size:12px; padding:4px 12px; border-radius:9999px; border:1px solid var(--border); cursor:pointer; transition:.15s; }
|
||||
.fbtn.active { background:var(--acc); color:#000; border-color:var(--acc); }
|
||||
details > summary { list-style:none; }
|
||||
details > summary::-webkit-details-marker { display:none; }
|
||||
details[open] > summary .arr { transform:rotate(90deg); }
|
||||
.arr { display:inline-block; transition:.15s; }
|
||||
#skill-modal-body h1,#skill-modal-body h2,#skill-modal-body h3,#skill-modal-body h4 { color:#fff; margin:.7em 0 .35em; font-weight:600; }
|
||||
#skill-modal-body h1 { font-size:1.3em; border-bottom:1px solid var(--border); padding-bottom:.2em; }
|
||||
#skill-modal-body h2 { font-size:1.15em; } #skill-modal-body h3 { font-size:1.02em; }
|
||||
#skill-modal-body p { margin:.4em 0; line-height:1.6; }
|
||||
#skill-modal-body table { border-collapse:collapse; margin:.5em 0; display:block; overflow-x:auto; }
|
||||
#skill-modal-body th,#skill-modal-body td { border:1px solid var(--border); padding:4px 8px; text-align:left; font-size:.85em; }
|
||||
#skill-modal-body th { background:#21262d; }
|
||||
#skill-modal-body code { background:#010409; padding:1px 5px; border-radius:3px; color:var(--green); font-size:.85em; }
|
||||
#skill-modal-body pre { background:#010409; padding:10px; border-radius:6px; overflow-x:auto; margin:.5em 0; border:1px solid var(--border); }
|
||||
#skill-modal-body pre code { background:none; padding:0; color:var(--txt); }
|
||||
#skill-modal-body strong { color:#fff; }
|
||||
#skill-modal-body blockquote { border-left:3px solid var(--acc); padding-left:10px; color:#8b949e; margin:.5em 0; }
|
||||
#skill-modal-body ul,#skill-modal-body ol { padding-left:1.4em; margin:.4em 0; }
|
||||
#skill-modal-body hr { border-color:var(--border); margin:.8em 0; }
|
||||
#skill-modal-body a { color:var(--acc); }
|
||||
</style>
|
||||
</head>
|
||||
<body class="min-h-screen">
|
||||
|
||||
<!-- Header -->
|
||||
<header class="border-b border-[var(--border)] panel">
|
||||
<div class="max-w-7xl mx-auto px-6 py-5 flex items-center justify-between flex-wrap gap-4">
|
||||
<div>
|
||||
<h1 class="text-2xl font-bold text-white">🚀 GitLink CLI · 智能化能力展示</h1>
|
||||
<p class="text-sm text-[#8b949e] mt-1">从「开发者工具」升级为「AI 可驱动平台」—— 命令 · Skills · 工作流 · 科研辅助</p>
|
||||
</div>
|
||||
<div class="flex gap-2 flex-wrap text-xs">
|
||||
<span class="chip px-3 py-1.5 rounded-full">🛠 25 域 / 160+ 命令</span>
|
||||
<span class="chip px-3 py-1.5 rounded-full">🧠 53 Skills</span>
|
||||
<span class="chip px-3 py-1.5 rounded-full">🚪 pr-guard 工作流</span>
|
||||
<span class="chip px-3 py-1.5 rounded-full">🔬 科研四维画像</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="max-w-7xl mx-auto px-6 pb-4 flex items-center gap-3 flex-wrap text-sm">
|
||||
<span class="text-[#8b949e] whitespace-nowrap">🔑 GitLink Token</span>
|
||||
<input id="token-input" type="password" placeholder="粘贴你的 GitLink 个人访问令牌(仅存本机浏览器;公开仓库命令可免)" class="flex-1 min-w-[220px] bg-[#0d1117] border border-[var(--border)] rounded px-3 py-1.5 text-xs mono">
|
||||
<span class="text-[#8b949e] whitespace-nowrap">📦 默认目标</span>
|
||||
<input id="owner-input" value="Gitlink" class="w-28 bg-[#0d1117] border border-[var(--border)] rounded px-2 py-1.5 text-xs mono" placeholder="owner">
|
||||
<span class="text-[#6e7681]">/</span>
|
||||
<input id="repo-input" value="gitlink-cli" class="w-36 bg-[#0d1117] border border-[var(--border)] rounded px-2 py-1.5 text-xs mono" placeholder="repo">
|
||||
<span id="token-state" class="text-xs"></span>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<main class="max-w-7xl mx-auto px-6 py-8 space-y-10">
|
||||
|
||||
<!-- ① 命令浏览器 + 参数构建 + 终端 -->
|
||||
<section>
|
||||
<h2 class="text-xl font-bold text-white mb-1">▶ 命令浏览器 <span class="text-sm text-[#8b949e] font-normal">(先选大方向 → 展开域 → 点动词填参数 → 真跑)</span></h2>
|
||||
<p class="text-sm text-[#8b949e] mb-4">左侧点分类展开命令域;点动词在右侧「参数构建」里填参(搜索类命令的 keyword 等由你决定),回车或点▶运行。本地命令免 token。</p>
|
||||
<div class="grid grid-cols-1 lg:grid-cols-3 gap-4">
|
||||
<!-- 左:折叠分层浏览器 -->
|
||||
<div class="panel rounded-lg p-4">
|
||||
<div class="flex items-center gap-2 mb-3">
|
||||
<h3 class="font-semibold text-white">命令域</h3>
|
||||
<input id="cmd-search" placeholder="🔍 搜索" class="flex-1 bg-[#0d1117] border border-[var(--border)] rounded px-2 py-1 text-xs mono">
|
||||
</div>
|
||||
<div id="cmd-groups" class="text-sm max-h-[460px] overflow-y-auto pr-1"></div>
|
||||
</div>
|
||||
<!-- 右:参数构建 + 终端 -->
|
||||
<div class="panel rounded-lg lg:col-span-2 flex flex-col">
|
||||
<!-- 参数构建条 -->
|
||||
<div class="px-4 py-3 border-b border-[var(--border)] bg-[#0d1017]">
|
||||
<div class="flex items-center gap-2 mb-2">
|
||||
<span class="text-xs text-[var(--yellow)] font-semibold">🧩 参数构建</span>
|
||||
<span id="builder-hint" class="text-xs text-[#6e7681]">点左侧动词开始</span>
|
||||
</div>
|
||||
<div id="builder-params" class="grid grid-cols-2 gap-2 mb-2"></div>
|
||||
<div class="flex items-center gap-2">
|
||||
<span class="text-[var(--green)] mono text-sm">$</span>
|
||||
<input id="builder-cmd" class="flex-1 bg-[#010409] border border-[var(--border)] rounded px-2 py-1.5 text-xs mono text-[var(--green)]" placeholder="组装好的命令会显示在这里(可手改)" autocomplete="off">
|
||||
<button onclick="runBuilder()" class="bg-[var(--green)] text-black px-3 py-1.5 rounded text-xs font-semibold whitespace-nowrap">▶ 运行</button>
|
||||
</div>
|
||||
</div>
|
||||
<!-- 终端 -->
|
||||
<div class="flex items-center gap-2 px-4 py-2 border-b border-[var(--border)] text-xs text-[#8b949e]">
|
||||
<span class="w-3 h-3 rounded-full bg-[var(--red)]"></span><span class="w-3 h-3 rounded-full bg-[var(--yellow)]"></span><span class="w-3 h-3 rounded-full bg-[var(--green)]"></span>
|
||||
<span class="ml-2">终端</span><span id="term-target" class="ml-auto text-[var(--acc)]"></span>
|
||||
</div>
|
||||
<div id="term-out" class="mono text-sm flex-1"></div>
|
||||
<div class="flex items-center px-4 py-2 mono text-sm" id="term-input">
|
||||
<span class="text-[var(--green)] mr-2">$</span>
|
||||
<input id="cmd-input" class="flex-1 bg-transparent text-[var(--green)] mono" placeholder="或在此自由输入 gitlink-cli 命令回车" autocomplete="off">
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- ② Skill 卡片墙 -->
|
||||
<section>
|
||||
<div class="flex items-center justify-between flex-wrap gap-3 mb-4">
|
||||
<h2 class="text-xl font-bold text-white">🧠 Skill 全集 <span class="text-sm text-[#8b949e] font-normal">(53 个 · 点卡片读 SKILL.md 全文)</span></h2>
|
||||
<div class="flex gap-2 flex-wrap">
|
||||
<button class="fbtn active" onclick="filterSkill('all',this)">全部 53</button>
|
||||
<button class="fbtn" onclick="filterSkill('new',this)">✨ 本次新增 7</button>
|
||||
<button class="fbtn" onclick="filterSkill('research',this)">🔬 科研</button>
|
||||
<button class="fbtn" onclick="filterSkill('quality',this)">🚪 代码质量</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="grid grid-cols-2 md:grid-cols-3 lg:grid-cols-5 gap-3" id="skill-wall"></div>
|
||||
</section>
|
||||
|
||||
<!-- ③ 任务三 pr-guard -->
|
||||
<section class="panel rounded-lg p-6">
|
||||
<div class="flex items-center gap-2 mb-1"><h2 class="text-xl font-bold text-white">🚪 任务三:代码质量看门人</h2><span class="chip px-2 py-0.5 rounded text-xs">pr-guard</span></div>
|
||||
<div class="text-sm text-[#8b949e] mb-3 space-y-1">
|
||||
<p><b class="text-[var(--txt)]">是什么</b>:PR 提交后自动跑完 5 步质量门禁 —— 串接 <code class="text-[var(--green)]">pr → code-review → ci → api → pr</code> 四个命令域。</p>
|
||||
<p><b class="text-[var(--txt)]">门禁规则</b>:<span class="text-[var(--green)]">0 Critical + CI success → ✅ 合并</span>;否则 <span class="text-[var(--red)]">🔴 拒绝</span>。</p>
|
||||
<p><b class="text-[var(--txt)]">与 code-review 区别</b>:code-review 只做 Review;pr-guard 是<b>完整闭环</b>(采集→审查→CI→评论→判定/合并)。</p>
|
||||
<p><b class="text-[var(--txt)]">任务三全家桶</b>(不止 pr-guard):code-review×pr-summary 闭环、community-ops-sweep 七段式周报(wauxing)+ 自动化 Skill 族 <code class="text-[var(--green)]">gatekeeper / commit-quality / issue-triage / issueops / release-auto / wiki-builder / pipeline-guardian / webhook-sentinel</code>(点下方 Skill 墙查看)。</p>
|
||||
</div>
|
||||
<div class="flex items-center justify-between gap-2 mb-5 flex-wrap" id="pr-steps"></div>
|
||||
<div class="flex gap-2 flex-wrap">
|
||||
<button onclick="runPipeline()" class="bg-[var(--acc)] text-black px-4 py-2 rounded font-semibold text-sm hover:opacity-90">▶ 模拟流水线</button>
|
||||
<button onclick="livePR()" class="border border-[var(--border)] text-[var(--txt)] px-4 py-2 rounded text-sm hover:bg-[#21262d]">🔌 用真实 PR 跑(需 token)</button>
|
||||
</div>
|
||||
<div id="pr-verdict" class="mt-4 text-sm mono"></div>
|
||||
</section>
|
||||
|
||||
<!-- ④ 任务四 科研画像 -->
|
||||
<section class="panel rounded-lg p-6">
|
||||
<div class="flex items-center gap-2 mb-1"><h2 class="text-xl font-bold text-white">🔬 任务四:科研仓库画像</h2><span class="chip px-2 py-0.5 rounded text-xs">research-insight</span></div>
|
||||
<div class="text-sm text-[#8b949e] mb-3 space-y-1">
|
||||
<p><b class="text-[var(--txt)]">是什么</b>:四维科研评分(🔁可复现性 / 📈活跃度 / 📑引用价值 / 🤝协作健康)+ 贡献者协作网络 + 巴士因子。</p>
|
||||
<p><b class="text-[var(--txt)]">区别于 health</b>:health 看「工程维护好不好」,本工具看「<b class="text-[var(--txt)]">科研上值不值得引用/复现</b>」;含 <b class="text-[var(--txt)]">fork 检测</b>(fork 自动改评 upstream)。</p>
|
||||
<p><b class="text-[var(--txt)]">任务四全家桶</b>(whale 主导,<b class="text-[var(--txt)]">S1–S6 全生命周期</b>):<code class="text-[var(--green)]">research-insight(S1) / research-graph(S2) / compliance(S3) / collab-match(S4) / research-progress(S5) / research-visual(S6)</code> + research-fork-impact/scholar-profile;Python 算法层 ~5800 行 + Go Web demo。</p>
|
||||
<p><b class="text-[var(--txt)]">真实验证</b>:<code class="text-[var(--green)]">whale_hihihi/gitlink-cli</code> → 识别为 fork、巴士因子 38%、可复现性 8/10。</p>
|
||||
</div>
|
||||
<div class="flex items-center gap-2 mb-5 flex-wrap">
|
||||
<span class="text-sm text-[#8b949e]">分析对象 = 顶栏 owner/repo</span>
|
||||
<button onclick="analyze()" class="bg-[var(--green)] text-black px-4 py-2 rounded font-semibold text-sm hover:opacity-90">🔍 实拉分析</button>
|
||||
<span id="analyze-status" class="text-xs text-[#8b949e]">(公开仓库可免 token)</span>
|
||||
</div>
|
||||
<div class="grid grid-cols-1 md:grid-cols-2 gap-6">
|
||||
<div><canvas id="radar"></canvas><div id="repro-detail" class="text-xs text-[#8b949e] mt-3 mono"></div></div>
|
||||
<div>
|
||||
<h4 class="text-white font-semibold mb-2">协作网络图 <span id="bus-info" class="text-xs text-[#8b949e] font-normal">(点「实拉分析」用真实贡献者重绘)</span></h4>
|
||||
<svg id="collab-svg" viewBox="0 0 360 260" class="w-full panel rounded border border-[var(--border)]"></svg>
|
||||
<div id="repo-meta" class="text-xs text-[#8b949e] mt-2"></div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- ⑤ 验证 -->
|
||||
<section>
|
||||
<h2 class="text-xl font-bold text-white mb-4">✅ 验证:三层证据(对照模板法)</h2>
|
||||
<div class="grid grid-cols-1 md:grid-cols-3 gap-3">
|
||||
<div class="panel rounded-lg p-4"><div class="text-[var(--green)] text-2xl mb-1">①</div><h4 class="text-white font-semibold">命令层</h4><p class="text-sm text-[#8b949e] mt-1">命令真实执行,返回真实数据(非 unknown/401)</p></div>
|
||||
<div class="panel rounded-lg p-4"><div class="text-[var(--yellow)] text-2xl mb-1">②</div><h4 class="text-white font-semibold">编排层</h4><p class="text-sm text-[#8b949e] mt-1">AI 按 SKILL.md 的顺序调命令</p></div>
|
||||
<div class="panel rounded-lg p-4"><div class="text-[var(--acc)] text-2xl mb-1">③</div><h4 class="text-white font-semibold">输出层</h4><p class="text-sm text-[#8b949e] mt-1">输出符合 SKILL.md 模板(判定/评分/清单)</p></div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<footer class="text-center text-xs text-[#6e7681] py-6 border-t border-[var(--border)]">
|
||||
GitLink CLI 智能化能力展示 · 子任务一~四 + DevOps · 后端 demo/web/server.py(访客自带 token,零凭据上云)
|
||||
</footer>
|
||||
</main>
|
||||
|
||||
<script>
|
||||
// ===== token & owner/repo =====
|
||||
const tokenInput=document.getElementById('token-input'), ownerInput=document.getElementById('owner-input'), repoInput=document.getElementById('repo-input');
|
||||
tokenInput.value=localStorage.getItem('gl_token')||'';
|
||||
const tokenState=document.getElementById('token-state');
|
||||
function syncTokenState(){ tokenState.textContent=tokenInput.value?'✅ 已提供':'⚠️ 未提供(公开仓库命令仍可跑)'; tokenState.style.color=tokenInput.value?'var(--green)':'var(--yellow)'; }
|
||||
tokenInput.addEventListener('input',()=>{localStorage.setItem('gl_token',tokenInput.value);syncTokenState();}); syncTokenState();
|
||||
const getToken=()=>tokenInput.value.trim(), getOwner=()=>ownerInput.value.trim()||'Gitlink', getRepo=()=>repoInput.value.trim()||'gitlink-cli';
|
||||
function syncTarget(){ document.getElementById('term-target').textContent=getOwner()+'/'+getRepo(); } syncTarget();
|
||||
[ownerInput,repoInput].forEach(el=>el.addEventListener('input',()=>{syncTarget();updateCmd();}));
|
||||
|
||||
// ===== 命令域(25 域,按子任务分组)=====
|
||||
const DOMAIN_GROUPS=[
|
||||
{g:'资源管理(仓库/文件/版本)',open:true,domains:[
|
||||
{d:'repo',v:['info','languages','contributors','readme','tree','code-stats','list','create','delete','fork','stargazers','watchers']},
|
||||
{d:'file',v:['get','browse','create','update','delete']},
|
||||
{d:'branch',v:['list','create','delete','protect','unprotect']},
|
||||
{d:'release',v:['list','view','create','update','delete','download']},
|
||||
{d:'search',v:['issues','repos','users']},
|
||||
{d:'compare',v:['view','files']}]},
|
||||
{g:'Issue 跟踪',domains:[
|
||||
{d:'issue',v:['list','view','create','update','close','comment','batch-create','batch-update','batch-close','batch-assign','batch-label']},
|
||||
{d:'label',v:['list','create','update','delete']},
|
||||
{d:'milestone',v:['list','view','create','close','delete']}]},
|
||||
{g:'PR 与代码审查',domains:[
|
||||
{d:'pr',v:['list','view','diff','files','merge','reopen','comment','review','reviews','check-merge']}]},
|
||||
{g:'CI/CD · 流水线 · 工作流',domains:[
|
||||
{d:'ci',v:['builds','logs','restart','stop','enable','disable']},
|
||||
{d:'pipeline',v:['list','runs','run','view','logs','results','save-yaml']},
|
||||
{d:'workflow',v:['triage','health','pr-summary','repo-report']}]},
|
||||
{g:'项目管理 · 协作',domains:[
|
||||
{d:'pm',v:['boards','sprints','weekly','tags','pipelines','actions']},
|
||||
{d:'org',v:['list','info','members','create']},
|
||||
{d:'member',v:['list','add','remove']},
|
||||
{d:'webhook',v:['list','view','create','update','delete','history','test']},
|
||||
{d:'wiki',v:['list','view','create','update','delete']}]},
|
||||
{g:'用户与画像',domains:[
|
||||
{d:'user',v:['me','info','headmaps','stats-activity','stats-develop','trends']},
|
||||
{d:'profile',v:['activity','ability','contribution','role']}]},
|
||||
{g:'数据 · 合规 · 健康',domains:[
|
||||
{d:'dataset',v:['list','view','create','update']},
|
||||
{d:'license',v:['list']},
|
||||
{d:'health',v:['fetch']}]},
|
||||
{g:'本地工具(免登录)',open:true,domains:[
|
||||
{d:'snippet',v:['create','list','view','search','update','delete','export']},
|
||||
{d:'auth',v:['login','status','logout'],raw:true}]},
|
||||
];
|
||||
const LOCAL_DOMAINS=new Set(['snippet','auth','config','version','doctor']);
|
||||
|
||||
// 需要额外参数表单的动词(flag 已核对 CLI --help)
|
||||
const FORM={
|
||||
'search +issues':[{f:'-k',k:'keyword',req:true,ph:'如 good first issue'},{f:'-c',k:'category',sel:['opened','closed','all'],def:'opened'}],
|
||||
'search +repos':[{f:'-k',k:'keyword',req:true,ph:'如 gitlink'}],
|
||||
'search +users':[{f:'-k',k:'keyword',req:true,ph:'如用户名'}],
|
||||
'issue +list':[{f:'-s',k:'state',sel:['open','closed','all'],def:'open'},{f:'-k',k:'keyword',ph:'可选关键词'}],
|
||||
'issue +view':[{f:'-n',k:'number',req:true,ph:'Issue 编号(URL 里)'}],
|
||||
'pr +view':[{f:'-i',k:'id',req:true,ph:'PR 编号'}],
|
||||
'file +get':[{f:'--path',k:'path',req:true,ph:'如 LICENSE / README.md'}],
|
||||
'repo +tree':[{f:'--path',k:'path',ph:'目录路径,默认根'}],
|
||||
'snippet +create':[{f:'--title',k:'title',req:true},{f:'--language',k:'language',ph:'python/go'},{f:'--tags',k:'tags',ph:'逗号分隔'},{f:'--content',k:'content',req:true,area:true}],
|
||||
'snippet +view':[{f:'--id',k:'id',req:true,ph:'先 +list 取 id'}],
|
||||
'snippet +search':[{f:'--query',k:'query',req:true,ph:'搜索词'}],
|
||||
'snippet +delete':[{f:'--id',k:'id',req:true,ph:'先 +list 取 id'}],
|
||||
};
|
||||
|
||||
// ===== 渲染折叠浏览器 =====
|
||||
function renderDomains(q=''){
|
||||
const Q=q.trim().toLowerCase(); let html='';
|
||||
DOMAIN_GROUPS.forEach(grp=>{
|
||||
const doms=grp.domains.filter(dm=>!Q||dm.d.includes(Q)||dm.v.some(x=>x.includes(Q)));
|
||||
if(!doms.length) return;
|
||||
html+=`<details class="mb-1" ${grp.open&&!Q?'open':''}><summary class="cursor-pointer text-xs text-[var(--yellow)] py-1 select-none hover:text-[var(--acc)]"><span class="arr">▸</span> ${grp.g} <span class="text-[#6e7681]">(${doms.length})</span></summary><div class="pl-2 mt-1 space-y-1.5">`;
|
||||
doms.forEach(dm=>{
|
||||
const local=LOCAL_DOMAINS.has(dm.d);
|
||||
const tag=local?'<span class="text-[10px] text-[var(--green)]">本地</span>':'<span class="text-[10px] text-[#6e7681]">平台</span>';
|
||||
const verbs=dm.v.filter(x=>!Q||x.includes(Q)||dm.d.includes(Q)).map(v=>{
|
||||
const formTag=FORM[dm.d+' +'+v]?'<span class="text-[var(--acc)]">⚙</span>':'';
|
||||
return `<span class="verb" onclick="clickVerb('${dm.d}','+${v}')">${formTag}+${v}</span>`;
|
||||
}).join(' ');
|
||||
html+=`<div class="panel rounded p-2"><div class="mono text-xs text-[var(--acc)] mb-1">${dm.d} ${tag}</div><div class="flex flex-wrap gap-1">${verbs}</div></div>`;
|
||||
});
|
||||
html+=`</div></details>`;
|
||||
});
|
||||
document.getElementById('cmd-groups').innerHTML=html||'<p class="text-xs text-[#6e7681]">无匹配</p>';
|
||||
}
|
||||
renderDomains();
|
||||
document.getElementById('cmd-search').addEventListener('input',e=>renderDomains(e.target.value));
|
||||
|
||||
// ===== 参数构建 =====
|
||||
let currentVerb=null;
|
||||
function clickVerb(domain,verb){
|
||||
currentVerb={domain,verb,key:domain+' '+verb,local:LOCAL_DOMAINS.has(domain),form:FORM[domain+' '+verb]};
|
||||
renderBuilder();
|
||||
}
|
||||
function buildCmd(){
|
||||
const v=currentVerb; if(!v) return '';
|
||||
let parts=['gitlink-cli',v.domain,v.verb];
|
||||
if(v.form) v.form.forEach(p=>{
|
||||
const el=document.getElementById('pf-'+p.k); let val=el?el.value.trim():'';
|
||||
if(p.sel&&!val) val=p.def||'';
|
||||
if(val) parts.push(p.f,val);
|
||||
});
|
||||
if(!v.local) parts.push('--owner',getOwner(),'--repo',getRepo());
|
||||
return parts.join(' ');
|
||||
}
|
||||
function updateCmd(){ const c=buildCmd(); if(c) document.getElementById('builder-cmd').value=c; }
|
||||
function renderBuilder(){
|
||||
const v=currentVerb; const pe=document.getElementById('builder-params'); const hi=document.getElementById('builder-hint');
|
||||
if(!v){ pe.innerHTML=''; hi.textContent='点左侧动词开始'; document.getElementById('builder-cmd').value=''; return; }
|
||||
hi.innerHTML=`<code class="text-[var(--acc)]">${v.domain} ${v.verb}</code> · ${v.local?'本地命令':(v.form?'填参数后运行(自动带 owner/repo)':'平台命令,自动带 owner/repo')}`;
|
||||
if(v.form){
|
||||
pe.innerHTML=v.form.map(p=>{
|
||||
const req=p.req?'<span class="text-[var(--red)]">*</span>':'';
|
||||
const label=`<label class="text-xs text-[#8b949e]">${p.k}${req}${p.req?'<span class="text-[10px]"> 必填</span>':''}</label>`;
|
||||
if(p.sel) return `<div>${label}<select id="pf-${p.k}" class="w-full mt-0.5 bg-[#0d1117] border border-[var(--border)] rounded px-1 py-1 text-xs mono">${p.sel.map(s=>`<option ${s===p.def?'selected':''}>${s}</option>`).join('')}</select></div>`;
|
||||
if(p.area) return `<div class="col-span-2">${label}<textarea id="pf-${p.k}" rows="2" placeholder="${p.ph||''}" class="w-full mt-0.5 bg-[#0d1117] border border-[var(--border)] rounded px-2 py-1 text-xs mono"></textarea></div>`;
|
||||
return `<div>${label}<input id="pf-${p.k}" placeholder="${p.ph||''}" class="w-full mt-0.5 bg-[#0d1117] border border-[var(--border)] rounded px-2 py-1 text-xs mono"></div>`;
|
||||
}).join('');
|
||||
setTimeout(()=>v.form.forEach(p=>{const el=document.getElementById('pf-'+p.k);if(el){el.oninput=updateCmd;el.onchange=updateCmd;}}),0);
|
||||
} else { pe.innerHTML=''; }
|
||||
updateCmd();
|
||||
}
|
||||
function runBuilder(){ const c=document.getElementById('builder-cmd').value.trim(); if(c) runRaw(c); }
|
||||
|
||||
// ===== 终端 =====
|
||||
const out=document.getElementById('term-out');
|
||||
const input=document.getElementById('cmd-input');
|
||||
let history=[],hidx=0;
|
||||
function appendOut(text,cls='l-out'){const div=document.createElement('div');div.className='mono text-sm '+cls;div.textContent=text;out.appendChild(div);out.scrollTop=out.scrollHeight;}
|
||||
async function runRaw(cmd){
|
||||
if(!cmd||cmd.startsWith('#'))return;
|
||||
history.push(cmd);hidx=history.length;
|
||||
appendOut('$ '+cmd,'l-cmd');
|
||||
const m=document.createElement('div');m.className='mono text-sm l-muted';m.textContent='⏳ 运行中...';out.appendChild(m);out.scrollTop=out.scrollHeight;
|
||||
try{
|
||||
const r=await fetch('/api/run',{method:'POST',headers:{'Content-Type':'application/json'},body:JSON.stringify({cmd,token:getToken()})});
|
||||
const d=await r.json();m.remove();
|
||||
if(d.stdout) appendOut(d.stdout,'l-out');
|
||||
if(d.stderr) appendOut('[stderr] '+d.stderr,d.ok?'l-muted':'l-err');
|
||||
if(!d.ok){
|
||||
if(!d.stdout&&!d.stderr&&d.error) appendOut('❌ '+d.error,'l-err');
|
||||
if(d.code!=null) appendOut('[退出码 '+d.code+']','l-err');
|
||||
if(/缺少必需参数|required|missing/i.test(d.stderr||d.error||'')) appendOut('💡 该命令有必填参数,看上方「参数构建」填写','l-muted');
|
||||
if(d.needs_token&&!d.token_provided&&/401|登录|未授权|token/i.test(d.stderr||d.error||'')) appendOut('💡 此命令可能需要 token(顶栏填写)','l-muted');
|
||||
if(/timeout|handshake|refused|no such host|dial tcp/i.test(d.stderr||d.error||'')) appendOut('💡 网络连不上 GitLink(TLS/超时),稍后重试一次','l-muted');
|
||||
if(/接口数据异常|\[-1\]|数据异常/i.test(d.stderr||d.error||'')) appendOut('💡 GitLink 接口对该仓库返回异常(该仓库可能无此类数据 / CI 未启用)','l-muted');
|
||||
} else if(!d.stdout&&!d.stderr){ appendOut('(无输出)','l-muted'); }
|
||||
}catch(e){m.remove();appendOut('❌ 请求失败:'+e+'(后端 server.py 是否启动?)','l-err');}
|
||||
}
|
||||
input.addEventListener('keydown',e=>{
|
||||
if(e.key==='Enter'){const c=input.value.trim();input.value='';runRaw(c);}
|
||||
else if(e.key==='ArrowUp'){if(hidx>0){hidx--;input.value=history[hidx]||'';e.preventDefault();}}
|
||||
else if(e.key==='ArrowDown'){if(hidx<history.length){hidx++;input.value=history[hidx]||'';e.preventDefault();}}
|
||||
});
|
||||
|
||||
// ===== Skill 全集 =====
|
||||
const SKILLS=['auth','branch','ci','ci-health','code-review','collab-match','commit-quality','compare','competition-manager','compliance','contributor-insight','digest','file','gatekeeper','health','insight','issue','issue-tag','issue-triage','issueops','label','license-compliance','member','milestone','notification-digest','onboarding','org','pipeline','pipeline-guardian','pm','pr','pr-guard','release','release-auto','repo','research-fork-impact','research-graph','research-insight','research-progress','research-tracker','research-visual','scholar-profile','search','shared','snippet','stale-issue-manager','todo','user','webhook','webhook-sentinel','wiki','wiki-builder','workflow'];
|
||||
const NEW_SKILLS=new Set(['onboarding','auth','snippet','digest','todo','pr-guard','research-insight']);
|
||||
const SKILL_ICON={onboarding:'🚀',auth:'🔑',snippet:'📦',digest:'📰',todo:'📋','pr-guard':'🚪','research-insight':'🔬','code-review':'👁','commit-quality':'✨','health':'❤','release-auto':'🏷','workflow':'🔁','compliance':'✅','license-compliance':'📜','wiki-builder':'📚','pipeline-guardian':'🛡','webhook-sentinel':'📡'};
|
||||
function skillCat(n){if(NEW_SKILLS.has(n))return'new';if(/research|scholar|contributor-insight|insight|fork-impact|tracker/.test(n))return'research';if(/code-review|commit-quality|gatekeeper|pr-guard|compliance|license-compliance/.test(n))return'quality';return'other';}
|
||||
function skillEmoji(n){return SKILL_ICON[n]||(/research|scholar/.test(n)?'🔬':/wiki/.test(n)?'📚':/pipeline|ci|webhook/.test(n)?'🛠':'📁');}
|
||||
let SKILL_FILTER='all';
|
||||
function filterSkill(f,btn){SKILL_FILTER=f;document.querySelectorAll('.fbtn').forEach(b=>b.classList.remove('active'));btn.classList.add('active');renderSkills();}
|
||||
function renderSkills(){
|
||||
const list=SKILLS.filter(n=>SKILL_FILTER==='all'?true:(SKILL_FILTER==='new'?NEW_SKILLS.has(n):skillCat(n)===SKILL_FILTER));
|
||||
document.getElementById('skill-wall').innerHTML=list.map(n=>{
|
||||
const tag=NEW_SKILLS.has(n)?'<span class="text-[10px] text-[var(--green)]">✨新增</span>':(skillCat(n)==='research'?'<span class="text-[10px] text-[var(--acc)]">科研</span>':skillCat(n)==='quality'?'<span class="text-[10px] text-[var(--yellow)]">质量</span>':'');
|
||||
return `<div class="skill-card panel rounded-lg p-3 cursor-pointer" onclick="openSkill('${n}')"><div class="text-xl mb-1">${skillEmoji(n)}</div><div class="text-white text-sm font-semibold mono">gitlink-${n}</div><div class="mt-1">${tag}</div><div class="text-[10px] text-[var(--green)] mt-2">📖 SKILL.md →</div></div>`;
|
||||
}).join('');
|
||||
}
|
||||
renderSkills();
|
||||
|
||||
// ===== pr-guard =====
|
||||
const STEPS=[{n:'① 采集',d:'pr +diff/+files',c:'#8b949e'},{n:'② AI Review',d:'分级找问题',c:'#d29922'},{n:'③ CI 检查',d:'ci +builds',c:'#58a6ff'},{n:'④ 汇总评论',d:'api reviews',c:'#a371f7'},{n:'⑤ 质量判定',d:'门禁规则',c:'#3fb950'}];
|
||||
document.getElementById('pr-steps').innerHTML=STEPS.map((s,i)=>`<div class="step panel rounded p-3 text-center flex-1 min-w-[120px]" id="step-${i}"><div class="text-sm font-semibold text-white">${s.n}</div><div class="text-xs mono mt-1" style="color:${s.c}">${s.d}</div></div>${i<STEPS.length-1?'<span class="text-[#6e7681]">→</span>':''}`).join('');
|
||||
function runPipeline(){
|
||||
document.getElementById('pr-verdict').textContent='';STEPS.forEach((_,i)=>document.getElementById('step-'+i).classList.remove('active'));
|
||||
let i=0;const tick=setInterval(()=>{if(i>0)document.getElementById('step-'+(i-1)).classList.remove('active');if(i>=STEPS.length){clearInterval(tick);document.getElementById('pr-verdict').innerHTML='<span style="color:var(--green)">✅ 质量判定:通过</span> | 0 Critical + CI success → 建议合并';return;}document.getElementById('step-'+i).classList.add('active');i++;},600);
|
||||
}
|
||||
async function livePR(){
|
||||
runRaw(`pr +list --owner ${getOwner()} --repo ${getRepo()} --format json`);
|
||||
}
|
||||
|
||||
// ===== 雷达 + 协作图 =====
|
||||
let radarChart=new Chart(document.getElementById('radar'),{type:'radar',data:{labels:['🔁 可复现性','📈 活跃度','📑 引用价值','🤝 协作健康'],datasets:[{label:'示例(点「实拉分析」换真实数据)',data:[6,5,5,6],fill:true,backgroundColor:'rgba(88,166,255,0.18)',borderColor:'#58a6ff',pointBackgroundColor:'#58a6ff'}]},options:{plugins:{legend:{labels:{color:'#c9d1d9',font:{size:11}}}},scales:{r:{min:0,max:10,ticks:{color:'#6e7681',backdropColor:'transparent',stepSize:2},grid:{color:'#30363d'},pointLabels:{color:'#c9d1d9',font:{size:12}},angleLines:{color:'#30363d'}}}}});
|
||||
function drawCollab(contribs,repoName){
|
||||
const svg=document.getElementById('collab-svg');svg.innerHTML='';const cx=180,cy=130,R=95;
|
||||
svg.innerHTML+=`<circle cx="${cx}" cy="${cy}" r="24" fill="#1f6feb"/><text x="${cx}" y="${cy+3}" text-anchor="middle" fill="#fff" font-size="9">${(repoName||'repo').slice(0,8)}</text>`;
|
||||
const top=(contribs||[]).slice(0,6);if(!top.length){svg.innerHTML+='<text x="180" y="250" text-anchor="middle" fill="#6e7681" font-size="10">(点「实拉分析」用真实贡献者重绘)</text>';return;}
|
||||
const max=top[0].contributions||1;
|
||||
top.forEach((c,i)=>{const a=(-Math.PI/2)+i*(2*Math.PI/top.length),x=cx+Math.cos(a)*R,y=cy+Math.sin(a)*R,rad=Math.max(8,18*(c.contributions/max)),core=i<2;
|
||||
svg.innerHTML+=`<line x1="${cx}" y1="${cy}" x2="${x}" y2="${y}" stroke="${core?'#3fb950':'#30363d'}" stroke-width="${core?2:1}" stroke-dasharray="${core?'':'4'}"/>`;
|
||||
svg.innerHTML+=`<circle cx="${x}" cy="${y}" r="${rad}" fill="${core?'#238636':'#6e7681'}"/><text x="${x}" y="${y+3}" text-anchor="middle" fill="#fff" font-size="9">${(c.name||'?').slice(0,8)}</text><text x="${x}" y="${y+rad+12}" text-anchor="middle" fill="#8b949e" font-size="8">${c.perc||''}</text>`;});
|
||||
}
|
||||
drawCollab(null);
|
||||
async function analyze(){
|
||||
document.getElementById('analyze-status').textContent='⏳ 采集中...';
|
||||
try{
|
||||
const r=await fetch('/api/analyze',{method:'POST',headers:{'Content-Type':'application/json'},body:JSON.stringify({owner:getOwner(),repo:getRepo(),token:getToken()})});
|
||||
const d=await r.json();if(!d.ok){document.getElementById('analyze-status').textContent='❌ '+d.error;return;}
|
||||
const s=d.scores;radarChart.data.datasets[0].label=`${d.owner}/${d.repo}${d.is_fork?'(⚠️ fork of '+d.fork_from+')':''}`;
|
||||
radarChart.data.datasets[0].data=[s.repro,s.activity,s.citation,s.collab];radarChart.update();
|
||||
document.getElementById('analyze-status').innerHTML=`✅ ${d.contributor_count} 贡献者 · ${d.release_count} release · 协议 ${d.license}`;
|
||||
document.getElementById('repo-meta').innerHTML=`${d.is_fork?'⚠️ <b style="color:var(--yellow)">是 fork</b>(引用应指 upstream '+d.fork_from+')':'✅ 独立仓库'} · 巴士因子 <b style="color:${d.bus_risk==='低'?'var(--green)':d.bus_risk==='中'?'var(--yellow)':'var(--red)'}">${d.bus_factor}%(${d.bus_risk}风险)</b>`;
|
||||
document.getElementById('repro-detail').innerHTML='可复现性 '+s.repro+'/'+d.repro_max+':'+d.repro_detail.map(x=>x[1]?'✅'+x[0]:'❌'+x[0]).join(' · ');
|
||||
drawCollab(d.contributors,d.name);
|
||||
}catch(e){document.getElementById('analyze-status').textContent='❌ '+e;}
|
||||
}
|
||||
|
||||
// 初始提示
|
||||
appendOut('💡 左侧点分类展开 → 点动词(带 ⚙ 的有参数表单)→ 右侧填参 → ▶运行。','l-muted');
|
||||
appendOut(' 本地命令(snippet/auth)免 token;公开仓库的 repo/issue 等其实不填 token 也能跑。','l-muted');
|
||||
|
||||
// ===== Skill 详情模态框 =====
|
||||
async function openSkill(name){
|
||||
const modal=document.getElementById('skill-modal');
|
||||
document.getElementById('skill-modal-title').textContent='📖 gitlink-'+name;
|
||||
const body=document.getElementById('skill-modal-body');body.innerHTML='<p class="text-[#8b949e]">⏳ 加载 SKILL.md...</p>';modal.classList.remove('hidden');
|
||||
try{const r=await fetch('/api/skill?name='+encodeURIComponent(name));const d=await r.json();if(!d.ok){body.innerHTML='<p class="l-err">❌ '+d.error+'</p>';return;}body.innerHTML=marked.parse(d.content);}catch(e){body.innerHTML='<p class="l-err">❌ '+e+'</p>';}
|
||||
}
|
||||
function closeSkill(){document.getElementById('skill-modal').classList.add('hidden');}
|
||||
document.addEventListener('keydown',e=>{if(e.key==='Escape')closeSkill();});
|
||||
</script>
|
||||
|
||||
<div id="skill-modal" class="hidden fixed inset-0 z-50 flex items-center justify-center p-4" onclick="closeSkill()" style="background:rgba(0,0,0,.75)">
|
||||
<div class="panel rounded-lg max-w-4xl w-full max-h-[88vh] flex flex-col" onclick="event.stopPropagation()">
|
||||
<div class="flex items-center justify-between px-5 py-3 border-b border-[var(--border)]">
|
||||
<h3 id="skill-modal-title" class="text-white font-bold text-lg"></h3>
|
||||
<button onclick="closeSkill()" class="text-[#8b949e] hover:text-white text-3xl leading-none">×</button>
|
||||
</div>
|
||||
<div class="p-6 overflow-y-auto text-sm" id="skill-modal-body"></div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,319 +0,0 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
gitlink-cli 演示网页 · 后端(零依赖,仅 Python 标准库)
|
||||
作用:接收前端命令 + 访客 token,真跑 gitlink-cli,返回真实输出。
|
||||
启动:python server.py → http://0.0.0.0:$PORT (默认 8000)
|
||||
|
||||
位置:仓库内 demo/web/server.py。CLI 在仓库根 ../../gitlink-cli[.exe]。
|
||||
安全:本地/演示用。已做白名单(只允许 gitlink-cli 子命令)、subprocess 列表参数(不经 shell)、
|
||||
30s 超时。访客 token 仅在请求内存中传给子进程,不写日志、不落盘。
|
||||
"""
|
||||
import http.server
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import socketserver
|
||||
import subprocess
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from urllib.parse import urlparse, parse_qs
|
||||
|
||||
# Windows GBK 终端兼容
|
||||
try:
|
||||
sys.stdout.reconfigure(encoding="utf-8", errors="replace")
|
||||
sys.stderr.reconfigure(encoding="utf-8", errors="replace")
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
PORT = int(os.getenv("PORT", "8000"))
|
||||
HOST = os.getenv("HOST", "0.0.0.0") # 云端需 0.0.0.0;只听本机设 HOST=127.0.0.1
|
||||
ROOT = Path(__file__).resolve().parent # .../demo/web
|
||||
REPO_ROOT = ROOT.parent.parent # 仓库根 .../gitlink-cli
|
||||
|
||||
|
||||
def _find_cli():
|
||||
"""CLI 位置:GITLINK_BIN > 仓库内 > PATH。Linux=gitlink-cli,Windows=gitlink-cli.exe。"""
|
||||
env = os.getenv("GITLINK_BIN")
|
||||
if env and Path(env).exists():
|
||||
return Path(env)
|
||||
for name in ("gitlink-cli", "gitlink-cli.exe"):
|
||||
p = REPO_ROOT / name
|
||||
if p.exists():
|
||||
return p
|
||||
for d in os.getenv("PATH", "").split(os.pathsep):
|
||||
p = Path(d) / "gitlink-cli"
|
||||
if p.exists():
|
||||
return p
|
||||
return REPO_ROOT / "gitlink-cli" # 占位
|
||||
|
||||
|
||||
CLI = _find_cli()
|
||||
CWD = str(REPO_ROOT) # 让 --owner/--repo 可从 git remote 自动解析
|
||||
|
||||
ALLOWED_DOMAINS = { # 全部 30 个顶层域
|
||||
"api", "auth", "branch", "ci", "compare", "config", "dataset", "doctor",
|
||||
"file", "health", "ignore", "issue", "label", "license", "member",
|
||||
"milestone", "org", "pipeline", "pm", "pr", "profile", "release", "repo",
|
||||
"search", "snippet", "user", "version", "webhook", "wiki", "workflow",
|
||||
}
|
||||
NEEDS_TOKEN_DOMAINS = { # 平台域(访客需填 token)
|
||||
"repo", "issue", "pr", "branch", "release", "search", "label", "member",
|
||||
"milestone", "webhook", "wiki", "org", "user", "ci", "compare", "dataset",
|
||||
"health", "license", "pipeline", "pm", "profile", "workflow", "api",
|
||||
}
|
||||
LOCAL_DOMAINS = {"snippet", "auth", "config", "version", "doctor"}
|
||||
|
||||
|
||||
def _run_cli(args, token="", timeout=30):
|
||||
env = dict(os.environ)
|
||||
if token:
|
||||
env["GITLINK_TOKEN"] = token
|
||||
r = subprocess.run(
|
||||
[str(CLI)] + args, capture_output=True, text=True, timeout=timeout,
|
||||
cwd=CWD, encoding="utf-8", errors="replace", env=env,
|
||||
)
|
||||
return r.stdout, r.stderr, r.returncode
|
||||
|
||||
|
||||
def _parse_json(stdout):
|
||||
s = stdout.strip()
|
||||
i, j = s.find("{"), s.rfind("}")
|
||||
if i < 0 or j < 0:
|
||||
return None
|
||||
try:
|
||||
return json.loads(s[i:j + 1])
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
|
||||
def _license_name(text):
|
||||
t = (text or "").lower()
|
||||
if "mulan" in t: return "Mulan PSL v2"
|
||||
if t.startswith("mit") or "mit license" in t: return "MIT"
|
||||
if "apache" in t: return "Apache 2.0"
|
||||
if "gpl" in t: return "GPL"
|
||||
if "bsd" in t: return "BSD"
|
||||
return "有 LICENSE" if text else "无"
|
||||
|
||||
|
||||
def analyze_repo(owner, repo, token):
|
||||
"""采集 + 按 research-insight 评分表算四维 + 巴士因子。"""
|
||||
def cli(*a):
|
||||
return _run_cli(list(a), token=token, timeout=30)
|
||||
|
||||
info_o, _, _ = cli("repo", "+info", "--owner", owner, "--repo", repo, "--format", "json")
|
||||
info = (_parse_json(info_o) or {}).get("data") or {}
|
||||
|
||||
contrib_o, _, _ = cli("repo", "+contributors", "--owner", owner, "--repo", repo, "--format", "json")
|
||||
contribs = ((_parse_json(contrib_o) or {}).get("data") or {}).get("list") or []
|
||||
contribs_sorted = sorted(contribs, key=lambda c: -(c.get("contributions") or 0))
|
||||
|
||||
rel_o, _, _ = cli("release", "+list", "--owner", owner, "--repo", repo, "--format", "json")
|
||||
releases = ((_parse_json(rel_o) or {}).get("data") or {}).get("releases") or []
|
||||
|
||||
lic_o, _, _ = cli("file", "+get", "--owner", owner, "--repo", repo, "--path", "LICENSE", "--format", "json")
|
||||
lic_text = ""
|
||||
lic_parsed = _parse_json(lic_o)
|
||||
if lic_parsed:
|
||||
d = lic_parsed.get("data") or {}
|
||||
entries = d.get("entries") if isinstance(d, dict) else None
|
||||
if isinstance(entries, dict):
|
||||
lic_text = entries.get("content") or ""
|
||||
elif isinstance(d, str):
|
||||
lic_text = d
|
||||
|
||||
ci_o, _, _ = cli("repo", "+tree", "--owner", owner, "--repo", repo, "--path", ".gitea/workflows", "--format", "json")
|
||||
ci_entries = ((_parse_json(ci_o) or {}).get("data") or {}).get("entries") or []
|
||||
has_ci = bool(ci_entries)
|
||||
|
||||
tree_o, _, _ = cli("repo", "+tree", "--owner", owner, "--repo", repo, "--format", "json")
|
||||
root_files = [str(e.get("name", "")) for e in ((_parse_json(tree_o) or {}).get("data") or {}).get("entries") or []]
|
||||
lock_files = {"go.sum", "package-lock.json", "yarn.lock", "Cargo.lock", "requirements.txt", "poetry.lock", "pom.xml"}
|
||||
has_lock = any(f in lock_files for f in root_files)
|
||||
has_readme = any(f.lower().startswith("readme") for f in root_files)
|
||||
|
||||
# 可复现性(工程类,满分 8:数据项 N/A)
|
||||
repro, repro_detail = 0, []
|
||||
repro += 2 if has_ci else 0; repro_detail.append(("CI 配置", has_ci))
|
||||
repro += 2 if has_lock else 0; repro_detail.append(("依赖锁定", has_lock))
|
||||
repro += 2 if has_readme else 0; repro_detail.append(("运行文档", has_readme))
|
||||
ver = bool(releases or info.get("version_releases_count"))
|
||||
repro += 2 if ver else 0; repro_detail.append(("版本归档", ver))
|
||||
|
||||
n_contrib = len(contribs)
|
||||
activity = min(10, round(n_contrib / 3)) if n_contrib else 2 # 无 commits API,用贡献者规模近似
|
||||
|
||||
citation = 0
|
||||
citation += 3 if lic_text else 0
|
||||
citation += 3 if ver else 0
|
||||
citation += 2 if has_readme else 0
|
||||
citation += 2 if (info.get("fork_info") or {}).get("fork_project_user_login") else 0
|
||||
citation = min(10, citation)
|
||||
|
||||
top_perc = 0.0
|
||||
if contribs_sorted:
|
||||
try:
|
||||
top_perc = float(re.sub(r"[^\d.]", "", str(contribs_sorted[0].get("contribution_perc", "0"))))
|
||||
except Exception:
|
||||
top_perc = 0.0
|
||||
collab = 10 if top_perc < 33 else (6 if top_perc < 50 else 3)
|
||||
|
||||
fork_from = (info.get("fork_info") or {}).get("fork_project_user_login")
|
||||
return {
|
||||
"ok": True, "owner": owner, "repo": repo,
|
||||
"is_fork": bool(fork_from), "fork_from": fork_from,
|
||||
"name": info.get("name", repo),
|
||||
"license": _license_name(lic_text),
|
||||
"contributor_count": n_contrib,
|
||||
"release_count": len(releases),
|
||||
"version_releases_count": info.get("version_releases_count", 0),
|
||||
"contributors": [
|
||||
{"name": c.get("name") or c.get("login") or "?",
|
||||
"contributions": c.get("contributions", 0),
|
||||
"perc": c.get("contribution_perc", "")}
|
||||
for c in contribs_sorted[:8]
|
||||
],
|
||||
"scores": {"repro": repro, "activity": activity, "citation": citation, "collab": collab},
|
||||
"repro_max": 8, "repro_detail": repro_detail,
|
||||
"bus_factor": top_perc,
|
||||
"bus_risk": "低" if top_perc < 33 else ("中" if top_perc < 50 else "高"),
|
||||
}
|
||||
|
||||
|
||||
class Handler(http.server.BaseHTTPRequestHandler):
|
||||
def _cors(self):
|
||||
self.send_header("Access-Control-Allow-Origin", "*")
|
||||
self.send_header("Access-Control-Allow-Methods", "GET, POST, OPTIONS")
|
||||
self.send_header("Access-Control-Allow-Headers", "Content-Type")
|
||||
|
||||
def do_OPTIONS(self):
|
||||
self.send_response(204); self._cors(); self.end_headers()
|
||||
|
||||
def do_GET(self):
|
||||
path = urlparse(self.path).path
|
||||
if path in ("/", "/index.html"):
|
||||
self._serve_file("index.html", "text/html")
|
||||
elif path == "/api/cli":
|
||||
self._json({"ok": True, "cli": str(CLI), "exists": CLI.exists()})
|
||||
elif path == "/api/domains":
|
||||
self._json({"ok": True, "domains": sorted(ALLOWED_DOMAINS), "local": sorted(LOCAL_DOMAINS)})
|
||||
elif path == "/api/health":
|
||||
self._json({"ok": True, "cli_exists": CLI.exists()})
|
||||
elif path == "/api/skill":
|
||||
self._handle_skill()
|
||||
else:
|
||||
self.send_error(404)
|
||||
|
||||
def _handle_skill(self):
|
||||
q = parse_qs(urlparse(self.path).query)
|
||||
name = (q.get("name") or [""])[0].strip()
|
||||
if not name:
|
||||
self._json({"ok": False, "error": "缺少 ?name="}); return
|
||||
skill_md = REPO_ROOT / "skills" / f"gitlink-{name}" / "SKILL.md"
|
||||
if not skill_md.exists():
|
||||
self._json({"ok": False, "error": f"找不到 SKILL.md:gitlink-{name}"}); return
|
||||
self._json({"ok": True, "name": name, "content": skill_md.read_text(encoding="utf-8")})
|
||||
|
||||
def do_POST(self):
|
||||
path = urlparse(self.path).path
|
||||
body = self._read_body()
|
||||
if path == "/api/run":
|
||||
self._handle_run(body)
|
||||
elif path == "/api/analyze":
|
||||
owner = (body.get("owner") or "").strip()
|
||||
repo = (body.get("repo") or "").strip()
|
||||
token = (body.get("token") or "").strip()
|
||||
if not owner or not repo:
|
||||
self._json({"ok": False, "error": "缺少 owner/repo"}); return
|
||||
try:
|
||||
self._json(analyze_repo(owner, repo, token))
|
||||
except subprocess.TimeoutExpired:
|
||||
self._json({"ok": False, "error": "采集超时(>30s)"})
|
||||
except Exception as e:
|
||||
self._json({"ok": False, "error": str(e)})
|
||||
else:
|
||||
self.send_error(404)
|
||||
|
||||
def _handle_run(self, body):
|
||||
cmd = (body.get("cmd") or "").strip()
|
||||
token = (body.get("token") or "").strip()
|
||||
if not cmd:
|
||||
self._json({"ok": False, "error": "空命令"}); return
|
||||
args = cmd.split()
|
||||
while args and args[0] in ("gitlink-cli", "gitlink-cli.exe", "./gitlink-cli.exe"):
|
||||
args = args[1:]
|
||||
if not args:
|
||||
self._json({"ok": False, "error": "缺少子命令"}); return
|
||||
domain = args[0]
|
||||
if domain not in ALLOWED_DOMAINS:
|
||||
self._json({"ok": False, "error": f"不允许的命令:{domain}(仅限 gitlink-cli 子命令)"}); return
|
||||
needs_token = domain in NEEDS_TOKEN_DOMAINS
|
||||
try:
|
||||
out, err, code = _run_cli(args, token=token, timeout=30)
|
||||
# 失败时从 stderr 取首行作为 error,前端绝不再显示 undefined
|
||||
err_msg = None
|
||||
if code != 0:
|
||||
first = (err.strip() or out.strip()).splitlines()
|
||||
err_msg = first[0][:200] if first else f"命令失败(退出码 {code})"
|
||||
self._json({
|
||||
"ok": code == 0, "cmd": f"gitlink-cli {' '.join(args)}",
|
||||
"stdout": out, "stderr": err, "code": code, "error": err_msg,
|
||||
"needs_token": needs_token, "token_provided": bool(token),
|
||||
})
|
||||
except subprocess.TimeoutExpired:
|
||||
self._json({"ok": False, "error": "命令超时(>30s),可能涉及交互输入"})
|
||||
except Exception as e:
|
||||
self._json({"ok": False, "error": str(e)})
|
||||
|
||||
def _read_body(self):
|
||||
length = int(self.headers.get("Content-Length", 0) or 0)
|
||||
raw = self.rfile.read(length) if length else b"{}"
|
||||
try:
|
||||
return json.loads(raw)
|
||||
except Exception:
|
||||
return {}
|
||||
|
||||
def _json(self, obj):
|
||||
data = json.dumps(obj, ensure_ascii=False).encode("utf-8")
|
||||
self.send_response(200)
|
||||
self.send_header("Content-Type", "application/json; charset=utf-8")
|
||||
self._cors()
|
||||
self.send_header("Content-Length", str(len(data)))
|
||||
self.end_headers()
|
||||
self.wfile.write(data)
|
||||
|
||||
def _serve_file(self, name, mime):
|
||||
p = ROOT / name
|
||||
if not p.exists():
|
||||
self.send_error(404, f"{name} 不存在"); return
|
||||
data = p.read_bytes()
|
||||
self.send_response(200)
|
||||
self.send_header("Content-Type", f"{mime}; charset=utf-8")
|
||||
self._cors()
|
||||
self.send_header("Content-Length", str(len(data)))
|
||||
self.end_headers()
|
||||
self.wfile.write(data)
|
||||
|
||||
def log_message(self, *a):
|
||||
pass
|
||||
|
||||
|
||||
class ReuseTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer):
|
||||
allow_reuse_address = True
|
||||
daemon_threads = True # 每个请求独立线程,单个卡死不阻塞其他请求
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
if not CLI.exists():
|
||||
print(f"[!] 找不到 gitlink-cli 二进制:{CLI}")
|
||||
print(" 请先编译:cd <仓库根> && go build -o gitlink-cli . (Linux)")
|
||||
print(" 或设环境变量 GITLINK_BIN 指向已有二进制。")
|
||||
with ReuseTCPServer((HOST, PORT), Handler) as httpd:
|
||||
print(f"[OK] gitlink-cli 演示后端已启动:http://{HOST}:{PORT}")
|
||||
print(f" CLI:{CLI}(exists={CLI.exists()})")
|
||||
print(f" 访客在网页顶栏填自己的 GitLink token 即可跑平台命令。Ctrl+C 停止。")
|
||||
try:
|
||||
httpd.serve_forever()
|
||||
except KeyboardInterrupt:
|
||||
print("\n已停止")
|
||||
|
|
@ -0,0 +1,308 @@
|
|||
# Release Notes — gitlink-cli
|
||||
|
||||
> 官方 [GitLink](https://www.gitlink.org.cn) 命令行工具,面向人类用户和 AI Agent。
|
||||
> 支持 macOS、Linux 和 Windows,覆盖仓库管理、Issue 跟踪、Pull Request、Webhook、CI/CD 及 AI 驱动的工作流。
|
||||
|
||||
---
|
||||
|
||||
## v0.2.0 (2026-06-17) — 交互式 REPL 与输出大重构
|
||||
|
||||
### 里程碑亮点
|
||||
|
||||
- ✨ **交互式 REPL 模式**:新增基于 Bubble Tea TUI 框架的命令面板、参数表单与滚动视口
|
||||
- 📊 **输出系统重构**:统一表格渲染,终结 JSON 回退;支持嵌套对象层级展开、值截断、动态列合并
|
||||
- 🌏 **全命令中文覆盖**:全部 25+ 命令组的子命令描述、参数注释、帮助文本完成中文化
|
||||
- 🐛 **P1-P4 缺陷修复**:修复 16 项实测发现的问题,涉及 collaborator、branch、file、tag、interactive 等多个模块
|
||||
- 🧩 **3 个新 AI Agent Skill**:issue-triage、project-health、newcomer-guide
|
||||
- 🧪 **大规模测试**:新增交互模式冒烟测试、output 表格渲染单元测试、hook-runner 测试等
|
||||
|
||||
### 新增功能
|
||||
|
||||
#### 交互式 REPL (Bubble Tea TUI)
|
||||
|
||||
- **命令面板** (`/` 快捷键唤起):实时搜索 80+ 命令,支持模糊匹配
|
||||
- **参数表单**:选中命令后自动弹出表单填写 flags,支持必填/可选参数
|
||||
- **滚动视口**:长输出支持上下滚动浏览,不再截断
|
||||
- **默认 table 输出**:REPL 中统一使用表格格式,告别 JSON 裸输出
|
||||
- **Ctrl+C/Esc**:正确的退出与返回行为
|
||||
- **Smoke Test**:所有注册命令执行不 panic 的自动化验证
|
||||
|
||||
#### 输出系统重构
|
||||
|
||||
- **`printSliceTable` 增强**:表头取自所有行的字段并集,不再仅依赖第一行
|
||||
- **嵌套 Map 详情视图**:单对象详情(如 `tag +view`、`repo +info`)渲染为可读层级表格,`└` 缩进展开子字段,不再回退 JSON
|
||||
- **原生 Map Slice 表格化**:`[]map[string]string` 等本地构造数据也渲染为表格,不再显示 `[N items]`
|
||||
- **值截断与列限制**:超长值(URL、SHA、commit message)自动截断,核心列优先固定
|
||||
- **已废弃**:`hasOnlyNestedMaps` JSON 回退逻辑移除
|
||||
|
||||
#### Skill 与 Workflow
|
||||
|
||||
- 新增 3 个 AI Agent Skill:
|
||||
- `gitlink-issue-triage` — Issue 分类与优先级评估
|
||||
- `gitlink-project-health` — 项目健康度洞察
|
||||
- `gitlink-newcomer-guide` — 新贡献者引导
|
||||
- `gitlink-webhook` Skill:新增 `+failed`、`+task-view` 命令
|
||||
- 新增 `gitlink-wiki`、`gitlink-snippet` Skill
|
||||
- 新增 Workflow 自动化示例:issue-triage、project-health、newcomer-guide
|
||||
|
||||
#### 命令增强
|
||||
|
||||
- **Webhook**:`+failed` 查看失败投递、`+task-view` 支持 UUID/数字 ID 双查询、`--limit` 分页支持
|
||||
- **Shortcuts**:导出 `GetAllShortcuts` / `GetDescriptions` 供交互模式消费
|
||||
|
||||
### Bug 修复
|
||||
|
||||
| 模块 | 问题 | 修复 |
|
||||
|------|------|------|
|
||||
| **collaborator** | `change-role`/`batch-role` 请求体格式错误导致"未找到用户" | 改为 `{user_id: 整数, role: string}` 格式;自动解析用户名到数字 ID |
|
||||
| **branch** | protect/unprotect 接口路径误加 `/v1` 导致 404 | 走无 `/v1` 老接口 |
|
||||
| **branch** | `+list` 字段过多导致表格不稳定 | 投影到核心列:name/protected/last_commit/commit_time |
|
||||
| **file** | `+get` 端点调用了错误 API | 改为 `/entries` 提取单文件元信息 |
|
||||
| **file** | `+tree --recursive` 参数被 API 拒绝 | 移除无效 flag |
|
||||
| **file** | `+create`/`+update`/`+delete` 缺少必需参数 | 补 `--new-branch`、`--sha` 改为必填 |
|
||||
| **file** | `+replace` 端点已废弃 | 移除该命令 |
|
||||
| **tag** | `+view` 调用了不存在端点导致"标签不存在" | 改用列表过滤,新增 `findTagByName` |
|
||||
| **interactive** | 带可选参数的命令跳过表单直接执行 | 改为"有任何 flag 都弹表单" |
|
||||
| **interactive** | nil Client 导致 panic | `NewRuntimeContext` 初始化 |
|
||||
| **interactive** | `/` 键响应延迟 | 立即响应而非等待后续输入 |
|
||||
| **output** | 原生 `[]map[string]string` 不识别为表格 | reflect 统一处理 |
|
||||
| **output** | 单对象嵌套 Map 回退 JSON | 层级表格展开 |
|
||||
|
||||
### 文档与国际化
|
||||
|
||||
- **全部 25+ 命令组描述中文化**:repo / pr / issue / branch / tag / file / wiki / webhook / snippet / user / org / ci / search / label / milestone / release / commit / collaborator / attachment / dataset / template / util / sshkey / shortcut / interactive
|
||||
- **Shortcuts 模块详细中文注释**:参数映射(CLI→API)、批处理模式、设计决策
|
||||
- **P1-P4 缺陷中文标记**:issue +create --label 遗漏、hardcoded 'master' 等已知问题文档化
|
||||
- **交互模式设计文档**:实现计划 + 命令面板设计规格
|
||||
|
||||
### 基础设施
|
||||
|
||||
- **依赖**:引入 `bubbletea`、`bubbles`、`huh` TUI 框架
|
||||
- **CI**:DevOps 流水线(构建+验证)
|
||||
- **测试**:interactive smoke test、output 表格渲染回归测试、tag `+view` 单元测试、hook-runner 单元测试
|
||||
|
||||
### 贡献者
|
||||
|
||||
自 v0.1.18 以来的贡献者(按字母顺序):
|
||||
|
||||
2403_89190320, Leo77, Mengz, Tiger, s2_cc, wangyue789, wqer, yangsai01, 刘焱, 赵昌
|
||||
|
||||
---
|
||||
|
||||
## v0.1.18 (2026-05-19) — Webhook 集成与 Skills 扩展
|
||||
|
||||
> 这也是 v0.2.0 之前带交互式 REPL 内测功能的过渡版本。
|
||||
|
||||
### 核心变更
|
||||
|
||||
- **交互模式 MVP**:首次合入 Bubble Tea REPL 基础框架(命令执行器 + flag 解析 + TUI 入口),但随后回退(`Revert "Add TUI foundation"`),留待 v0.2.0 正式发布
|
||||
- **npm 安装**:修复 Windows 二进制缺失问题,改进安装后诊断
|
||||
|
||||
---
|
||||
|
||||
## v0.1.17 (2026-05-17) — Skills 生态与包管理器支持
|
||||
|
||||
### 新功能
|
||||
|
||||
- **3 个新 Skill**:`gitlink-code-review`(代码审查)、`gitlink-insight`(仓库洞察)、`gitlink-compliance`(合规检查)
|
||||
- **2 个自动化 Skill**:`gitlink-release-auto`(自动发版)、`gitlink-commit-quality`(提交信息规范检查)
|
||||
- **包管理器支持**:Homebrew(macOS/Linux)、Scoop(Windows)、Chocolatey(Windows)
|
||||
- **CI**:GitHub Release 工作流与 npm 自动发布
|
||||
- **npm 安装增强**:校验和验证、错误消息改进、版本检查
|
||||
|
||||
### 命令增强
|
||||
|
||||
- **PR**:新增 `+review` 审查快捷、`+patchset` 补丁集版本切换
|
||||
- **PR**:`+comment` 评论 CRUD
|
||||
- **Issue**:`+batch-close` 批量关闭(dry-run 支持)
|
||||
- **PR/Issue**:统一使用 project-level 编号替代数据库 ID
|
||||
|
||||
### Bug 修复
|
||||
|
||||
- **Issue**: `+list` 输出使用项目级 Issue 编号
|
||||
- **PR**: 统一使用 `pull_request_number` 替代 `pull_request_id`
|
||||
- **Issue**: `update` 时保留描述字段
|
||||
- **npm**: Windows 二进制缺失导致静默退出
|
||||
|
||||
### 文档
|
||||
|
||||
- Skills REFERENCE.md 参考文档
|
||||
- README 更新至 v0.1.17(12 Skills、npm 一键安装)
|
||||
- Fork-based PR 工作流指南
|
||||
- Skill 工具边界规则(防止在 GitLink 上误用 gh/hub)
|
||||
|
||||
---
|
||||
|
||||
## v0.1.14 (2026-05-17) — 全 API 覆盖里程碑
|
||||
|
||||
### 新功能
|
||||
|
||||
- **40+ 新命令 shortcut**:
|
||||
- **Repo**:22 个新 shortcut(settings/stats/social/transfer/invite/migrate/topics)
|
||||
- **User**:22 个新 shortcut(messages/stats/transfers/settings/feedback)
|
||||
- **PR**:comments CRUD、commits、reopen、update
|
||||
- **Issue**:comments CRUD、delete、batch-update、batch-destroy
|
||||
- **Branch**:all/default/restore;**Release**:edit/update
|
||||
- **协作**:org team-projects;**File**:batch/entries/replace
|
||||
- **CI 流水线**、**Wiki 导入/导出**、**Repo 加入/退出/迁移/话题**
|
||||
- **Util**、**Dataset**、**Template**、**Attachment** 快捷组
|
||||
- **代码片段管理**:`snippet +list/+view/+create/+delete`
|
||||
- **看板**:`board +view/+columns/+move`
|
||||
- **OAuth2 认证**、**颜色检测与 CJK 宽度支持**
|
||||
- **Wiki 命令改用 Git 操作**:`+list/+view/+create/+update/+delete` 重构为 Git-based
|
||||
|
||||
### 跨平台
|
||||
|
||||
- **Windows (x64/arm64)** 完整支持
|
||||
- 终端颜色自动检测与中文字符宽度适配
|
||||
|
||||
### Skills
|
||||
|
||||
- **6 个新 Skills**:`gitlink-repo`、`gitlink-issue`、`gitlink-pr`、`gitlink-ci`、`gitlink-search`、`gitlink-workflow`
|
||||
- **Skill 架构升级**:Anthropic Agent Skills 标准
|
||||
- **pm / org / user / release / branch** 等 Skill 持续完善
|
||||
|
||||
### 基础设施
|
||||
|
||||
- npm 包 `@gitlink-ai/cli` 分发上线
|
||||
- `GITLINK_TOKEN` 环境变量支持非交互式认证
|
||||
- `gitlink-cli-install-skills` 跨平台安装命令
|
||||
|
||||
### 项目健康
|
||||
|
||||
- 新增 CONTRIBUTORS 章节展示项目贡献者
|
||||
- 许可证切换至 MulanPSL-2.0(木兰宽松许可证)
|
||||
- README 中英双语
|
||||
|
||||
---
|
||||
|
||||
## v0.1.8 ~ v0.1.13 (2026-04-07 ~ 2026-04-15) — 功能夯实
|
||||
|
||||
### v0.1.13 (2026-04-15)
|
||||
|
||||
- **npm 安装方案**:修复 GitHub Release asset 匹配回退与相对 URL 拼接问题
|
||||
- 改进 release 创建时默认 `target_commitish=master`
|
||||
- Issue 创建默认 `priority_id=2`
|
||||
|
||||
### v0.1.12 (2026-04-15)
|
||||
|
||||
- Webhook 快捷命令组正式合入
|
||||
- `hook-runner` 集成为 `webhook` 子命令
|
||||
- 新增 `--limit` 标志与 UUID 显示改进
|
||||
|
||||
### v0.1.11 (2026-04-08)
|
||||
|
||||
- **PR 审查**:`+review` 审查提交
|
||||
- **PR 补丁集**:`+patchset-versions` 版本切换
|
||||
- 3 个新 Skills:`gitlink-code-review`、`gitlink-insight`、`gitlink-compliance`
|
||||
|
||||
### v0.1.10 (2026-04-08)
|
||||
|
||||
- 2 个自动化 Skill:`gitlink-release-auto`、`gitlink-commit-quality`
|
||||
- Webhook 端点测试修复
|
||||
|
||||
### v0.1.9 (2026-04-07)
|
||||
|
||||
- **Webhook shortcut 组**正式版
|
||||
- Skills 文档完善
|
||||
|
||||
### v0.1.8 (2026-04-07)
|
||||
|
||||
- **Branch Skill**:`gitlink-branch` 保护分支管理
|
||||
- PR `+comment` 快捷
|
||||
- Issue `+batch-close` 批量关闭
|
||||
- Issue v1 API 迁移,使用 `project_issues_index` 替代数据库 ID
|
||||
- 修复 Issue 描述 update 丢失问题
|
||||
|
||||
---
|
||||
|
||||
## v0.1.0-skill-test (2026-04-04) — Skill 概念验证
|
||||
|
||||
- Skill PR 全流程测试
|
||||
- 首个 Skill 原型验证
|
||||
- PR 创建、合入工作流测试
|
||||
|
||||
---
|
||||
|
||||
## v0.0.1-test-del / initial (2026-04-03) — 项目初始化
|
||||
|
||||
- `github.com/gitlink-org/gitlink-cli` 项目启动
|
||||
- 基础 CLI 框架(Cobra)
|
||||
- 初始命令:auth、repo、issue、pr
|
||||
- npm 分发基础 (`@gitlink-ai/cli`)
|
||||
- Cookie-based 登录与 token 认证
|
||||
|
||||
---
|
||||
|
||||
## 统计一览
|
||||
|
||||
| 版本 | 日期 | 新增文件 | 代码变更 | 贡献者 |
|
||||
|------|------|----------|----------|--------|
|
||||
| init → v0.1.8 | 2026-04 | ~30 | ~8k | 5 |
|
||||
| v0.1.8 → v0.1.14 | 2026-04~05 | ~60 | ~15k | 8 |
|
||||
| v0.1.14 → v0.1.18 | 2026-05 | ~22 | +514/-1015 | 4 |
|
||||
| v0.1.18 → v0.2.0 | 2026-05~06 | 114 | +24531/-324 | 10 |
|
||||
|
||||
## Skills 一览
|
||||
|
||||
| Skill | 用途 | 引入版本 |
|
||||
|-------|------|----------|
|
||||
| `gitlink-repo` | 仓库管理 | v0.1.14 |
|
||||
| `gitlink-issue` | Issue 跟踪 | v0.1.14 |
|
||||
| `gitlink-pr` | Pull Request 管理 | v0.1.14 |
|
||||
| `gitlink-ci` | CI/CD 流水线 | v0.1.14 |
|
||||
| `gitlink-search` | 全局搜索 | v0.1.14 |
|
||||
| `gitlink-workflow` | 工作流自动化 | v0.1.14 |
|
||||
| `gitlink-branch` | 保护分支管理 | v0.1.8 |
|
||||
| `gitlink-pm` | 项目管理 | v0.1.14 |
|
||||
| `gitlink-org` | 组织管理 | v0.1.14 |
|
||||
| `gitlink-user` | 用户管理 | v0.1.14 |
|
||||
| `gitlink-release` | 发布管理 | v0.1.14 |
|
||||
| `gitlink-code-review` | 代码审查 | v0.1.11 |
|
||||
| `gitlink-insight` | 仓库洞察 | v0.1.11 |
|
||||
| `gitlink-compliance` | 合规检查 | v0.1.11 |
|
||||
| `gitlink-release-auto` | 自动发版 | v0.1.10 |
|
||||
| `gitlink-commit-quality` | 提交信息规范 | v0.1.10 |
|
||||
| `gitlink-webhook` | Webhook 管理 | v0.1.9 |
|
||||
| `gitlink-wiki` | Wiki 管理 | v0.2.0 |
|
||||
| `gitlink-snippet` | 代码片段管理 | v0.2.0 |
|
||||
| `gitlink-issue-triage` | Issue 分类与优先级 | v0.2.0 |
|
||||
| `gitlink-project-health` | 项目健康度 | v0.2.0 |
|
||||
| `gitlink-newcomer-guide` | 新贡献者引导 | v0.2.0 |
|
||||
| `gitlink-shared` | 共享工具库 | v0.2.0 |
|
||||
| `gitlink-workflow` | 工作流定义 | v0.2.0 |
|
||||
|
||||
---
|
||||
|
||||
## 升级指南
|
||||
|
||||
### v0.1.x → v0.2.0
|
||||
|
||||
- **交互模式**:运行 `gitlink-cli interactive` 或 `gitlink-cli tui` 进入 REPL
|
||||
- **输出格式**:v0.2.0 默认输出格式为 table,如需 JSON 请使用 `--output json` 或 `--json`
|
||||
- **File 命令**:`+replace` 已移除,请改用 `+create`/`+update`
|
||||
- **Tag 命令**:`+view` 行为变更(从单端点改为列表过滤),功能一致
|
||||
|
||||
### 首次安装
|
||||
|
||||
```bash
|
||||
# npm (推荐)
|
||||
npm install -g @gitlink-ai/cli
|
||||
|
||||
# macOS (Homebrew)
|
||||
brew tap gitlink-ai/tap
|
||||
brew install gitlink-cli
|
||||
|
||||
# Windows (Scoop)
|
||||
scoop bucket add gitlink https://github.com/gitlink-ai/scoop-bucket
|
||||
scoop install gitlink-cli
|
||||
|
||||
# Windows (Chocolatey)
|
||||
choco install gitlink-cli
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
> 完整的提交历史请参阅 [CHANGELOG](./changes/) 目录。
|
||||
>
|
||||
> 如发现任何问题,欢迎在 [GitLink Issues](https://www.gitlink.org.cn/Gitlink/gitlink-cli/issues) 反馈。
|
||||
|
|
@ -0,0 +1,116 @@
|
|||
# 变更说明汇总
|
||||
|
||||
> 本文件汇总 GitLink CLI 智能化能力提升项目所有变更,按子任务分类。
|
||||
> 最后更新:2026-07-07
|
||||
|
||||
---
|
||||
|
||||
## 子任务一:CLI 能力扩展
|
||||
|
||||
### 新增 Shortcut 命令组
|
||||
|
||||
在原有 10 个命令组(branch/ci/common/issue/org/pr/release/repo/search/user)基础上,新增 13 个命令组:
|
||||
|
||||
| 命令组 | 子命令数 | 代码行数 | 单元测试 | 作者 | 说明 |
|
||||
|--------|---------|---------|---------|------|------|
|
||||
| webhook | 20 | 533 | ✅ | Mengz | Webhook 管理(增删改查+测试) |
|
||||
| wiki | 13 | 555 | ✅ | 赵昌 | 仓库 Wiki 页面管理 |
|
||||
| snippet | 9 | 271 | ✅ | 赵昌 | 代码片段管理 |
|
||||
| file | 18 | 490 | ❌ | 刘焱 | 文件管理(上传/下载/批量推送) |
|
||||
| collaborator | 13 | 69 | ✅ | 刘焱 | 协作者管理 |
|
||||
| milestone | 14 | 224 | ❌ | 刘焱 | 里程碑管理 |
|
||||
| commit | 13 | 172 | ❌ | 刘焱 | 提交记录查询 |
|
||||
| template | 10 | 150 | ❌ | 刘焱 | 模板管理(导入/导出) |
|
||||
| label | 11 | 218 | ❌ | 刘焱 | 标签管理 |
|
||||
| dataset | 9 | 123 | ❌ | 刘焱 | 数据集管理 |
|
||||
| tag | 7 | 138 | ✅ | 刘焱 | 标签(Release Tag)管理 |
|
||||
| sshkey | 8 | 96 | ❌ | 刘焱 | SSH 公钥管理 |
|
||||
| attachment | 4 | 53 | ❌ | 刘焱 | 附件管理 |
|
||||
| util | 3 | 46 | ❌ | 刘焱 | 通用工具函数 |
|
||||
|
||||
**合计**:新增 149 个子命令,约 3000 行 Go 代码,6 个命令组配有单元测试。
|
||||
|
||||
### 已有命令组扩展
|
||||
|
||||
对原有命令组也进行了功能增强:
|
||||
- `ci` — 新增 save-yaml、run-pipeline、delete-pipeline 等 DevOps 流水线管理命令
|
||||
- `pr` — 新增 batch-merge、batch-close、version-diff、versions 等批量操作命令
|
||||
- `issue` — 新增 batch-update 批量更新命令
|
||||
- `repo` — 新增 code-stats、contributors-stat 等统计分析命令
|
||||
|
||||
详细变更说明:[webhook-shortcut.md](./webhook-shortcut.md)
|
||||
|
||||
---
|
||||
|
||||
## 子任务二:AI Agent Skills
|
||||
|
||||
### 新增 Skills
|
||||
|
||||
在原有 Skills 基础上,团队新增 16 个自定义 Skill:
|
||||
|
||||
| Skill | 作者 | 说明 |
|
||||
|-------|------|------|
|
||||
| gitlink-community-ops | 赵昌 | 社区运营自动化(Issue 分拣→周报→Release Notes) |
|
||||
| gitlink-quality-gate | 赵昌 | 代码质量门禁(PR 审查→CI 检查→门禁决策) |
|
||||
| gitlink-project-health | 赵昌 | 项目健康度分析 |
|
||||
| gitlink-issue-triage | 赵昌 | Issue 自动分拣 |
|
||||
| gitlink-newcomer-guide | 赵昌 | 新人引导 |
|
||||
| gitlink-pr-deep-review | 赵昌 | PR 深度审查 |
|
||||
| gitlink-research-hotspot | 赵昌 | 科研热点追踪与知识图谱 |
|
||||
| gitlink-research-insight | 赵昌 | 科研项目洞悉 |
|
||||
| gitlink-snippet | 赵昌 | 代码片段 Skill |
|
||||
| gitlink-wiki | 赵昌 | Wiki 管理 Skill |
|
||||
| gitlink-contributor-growth | 刘焱 | 贡献者成长体系 |
|
||||
| gitlink-multi-repo-coordination | 刘焱 | 多仓库协同 |
|
||||
| gitlink-project-bootstrap | 刘焱 | 项目一键初始化 |
|
||||
| gitlink-research-compliance | 曾蔚然 | 科研合规与复现性 |
|
||||
| gitlink-research-matching | 曾蔚然 | 科研协作智能匹配 |
|
||||
| gitlink-research-progress | 曾蔚然 | 科研进度跟踪与预警 |
|
||||
|
||||
每个 Skill 包含:`SKILL.md`(命令参考)+ `examples/`(使用示例)+ `scripts/`(可复现脚本)。
|
||||
|
||||
---
|
||||
|
||||
## 子任务三:端到端自动化工作流
|
||||
|
||||
5 个端到端场景,统一采用"三阶段脚本 + JS 分析引擎"架构:
|
||||
|
||||
| 场景 | 串联脚本 | 分析引擎 | 作者 |
|
||||
|------|---------|---------|------|
|
||||
| 社区运营自动化 | community-ops-full.sh | health-analyze.js | 赵昌 |
|
||||
| 代码质量门禁 | quality-gate-full.sh | scoring-engine.js | 赵昌 |
|
||||
| 项目一键初始化 | project-bootstrap-full.sh | skeleton-gen.js | 刘焱 |
|
||||
| 多仓库协同 | multi-repo-full.sh | dashboard-gen.js | 刘焱 |
|
||||
| 贡献者成长体系 | contributor-growth-full.sh | growth-analyze.js | 刘焱 |
|
||||
|
||||
---
|
||||
|
||||
## 子任务四:科研辅助模块
|
||||
|
||||
5 大科研辅助模块,覆盖科研全生命周期:
|
||||
|
||||
| 模块 | Skill | 功能 |
|
||||
|------|-------|------|
|
||||
| 科研项目洞悉 | gitlink-research-insight | 8 维数据采集 + 4 维评分 |
|
||||
| 热点追踪与知识图谱 | gitlink-research-hotspot | 多关键词搜索 + 实体关系图谱 |
|
||||
| 科研合规与复现性 | gitlink-research-compliance | 三维复现性证据链 |
|
||||
| 科研协作智能匹配 | gitlink-research-matching | 角色匹配 + 缺口识别 |
|
||||
| 科研进度跟踪与预警 | gitlink-research-progress | 6 维动态风险信号 |
|
||||
|
||||
---
|
||||
|
||||
## DevOps 流水线
|
||||
|
||||
1 条已部署的建木流水线,push 代码时自动触发集成和部署:
|
||||
|
||||
| 流水线 | 触发方式 | 功能 | 文件 |
|
||||
|--------|---------|------|------|
|
||||
| 构建流水线 | push | 拉取代码 → 编译 → 部署到 /usr/local/bin → 验证 | `.devops/构建流水线.yml` |
|
||||
|
||||
另有 3 条流水线 YAML 配置已提交到仓库但未部署(项目初始化、多仓库协同、贡献者成长)。
|
||||
|
||||
---
|
||||
|
||||
## 操作中心
|
||||
|
||||
新增 `/gitlink` 斜杠命令作为统一入口,16 项操作上下选择执行。配置文件:`.claude/commands/gitlink.md`
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
# 新增命令别名(alias)
|
||||
|
||||
新增 `gitlink-cli alias` 根命令组,用于把常用命令行保存为用户自定义的快捷方式,行为对齐 `gh alias`。别名统一存放在配置文件(`config.yaml`)的 `aliases` 字段,通过 yaml.v3 与其他配置项一起读写,无需额外文件。
|
||||
|
||||
## 子命令
|
||||
|
||||
- `alias set <name> <expansion>...`:创建或更新别名。`name` 之后的所有参数会拼成展开内容,因此多词展开在 shell 上加不加引号都可以,例如 `alias set bugs issue +list --label bug`。
|
||||
- `alias list`:按名称排序列出全部别名;没有别名时给出提示。
|
||||
- `alias delete <name>`:删除别名,别名不存在时返回明确错误。
|
||||
- `alias import`:从 YAML 的 `name: expansion` 映射批量导入,来源可用 `--file` 指定文件,或从标准输入读取(便于管道注入);导入采用合并语义,同名覆盖。
|
||||
|
||||
## 别名展开
|
||||
|
||||
别名展开已接入根命令分发:在 `cmd.Execute()` 里,若 `os.Args` 的第一个位置参数命中已保存的别名,就把该 token 替换为别名展开(按 shell 风格拆分,识别单双引号)后再交给 cobra 分发。展开发生在翻译器解析之后,因此 `--lang` 等全局标志不受影响。
|
||||
|
||||
内置命令始终优先:展开前会先检查该 token 是否为已注册的根命令(或其 cobra 别名),命中则不展开。这样别名无法遮蔽真实命令——与内置命令同名的别名只是永远不会被触发,因此 `set` 不做额外的命名冲突校验。
|
||||
|
||||
## 本次变更
|
||||
|
||||
`internal/config` 的 `Config` 增加 `Aliases map[string]string` 字段并验证读写往返;新增 `cmd/alias` 命令组与 `cmd/expand.go` 展开逻辑,并在 `cmd/root.go` 注册与接线;中英文帮助与提示文案补齐到 `en-US.json` 与 `zh-CN.json`。测试覆盖配置往返、set/list/delete、文件与标准输入导入、非法 YAML,以及展开的别名命中、内置优先、首个为标志、未知 token 等分支和引号拆分。
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
# 新增 Raw API 批处理执行器
|
||||
|
||||
`gitlink-cli api` 现在支持通过 `--batch-file` 读取 JSON 批处理计划,把多个尚未封装为 shortcut 的 GitLink API 请求组织成一次可审计的自动化执行。计划文件支持 `vars` 模板变量,`--var key=value` 可以在执行时覆盖变量,便于同一批处理流程复用到不同仓库、Issue 或分支。
|
||||
|
||||
批处理模式提供 `--dry-run` 预览渲染后的 method、path、query 和 body,不会访问远端;实际执行时会输出每一步的成功/失败、响应数据和汇总计数。默认遇到失败立即停止,传入 `--continue-on-error` 后会继续执行后续请求,适合批量巡检、批量评论、批量元数据修复等场景。
|
||||
|
||||
本次变更包含计划文件解析、模板渲染、query/body 递归替换、失败控制、结构化汇总输出、中英文帮助文案、README 示例、Skill reference 和单元测试。测试覆盖 dry-run 不发请求、变量覆盖、模板缺失报错、失败默认中断以及失败继续执行等关键行为。
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
# Fix: Windows Git Bash 下 `gitlink-cli api` 路径被 MSYS2 污染导致 404
|
||||
|
||||
## 问题
|
||||
|
||||
在 Windows Git Bash(MSYS2)环境下执行:
|
||||
|
||||
```bash
|
||||
gitlink-cli api GET /v1/owner/repo
|
||||
```
|
||||
|
||||
路径参数 `/v1/owner/repo` 会被 MSYS2 自动改写为类似 `C:/Program Files/Git/v1/owner/repo` 的 Windows 路径——MSYS2 把以 `/` 开头的命令行参数当成 Unix 路径,转换为 Git 安装目录。结果 API 请求路径错误,返回 404。影响所有 Windows Git Bash 用户。
|
||||
|
||||
## 根因
|
||||
|
||||
MSYS2 的 POSIX→Windows 路径转换会对命令行参数中以 `/` 开头的字符串生效,且无法通过 shell 转义稳定规避(`MSYS_NO_PATHCONV` 等环境变量依赖用户配置,不可靠)。
|
||||
|
||||
## 修复
|
||||
|
||||
在 `cmd/api` 的 `runAPI` 中,对取到的 `path` 调用 `restoreAPIPath` 还原:
|
||||
|
||||
- 检测首部是否为盘符(正则 `^[A-Za-z]:/`);
|
||||
- 若是,按常见 API 前缀(`/v1/` `/v2/` `/api/` `/users/` `/projects/`)在污染后的路径里定位原始起点并截取;
|
||||
- 无盘符或无匹配前缀时原样返回,不影响其他平台与正常路径。
|
||||
|
||||
`restoreAPIPath` 为纯函数,便于单元测试。
|
||||
|
||||
## 影响
|
||||
|
||||
仅 Windows 受益,其他平台行为不变。改动集中在 `cmd/api/api.go`(约 +25 行,含函数与注释)。
|
||||
|
||||
## Tests
|
||||
|
||||
```bash
|
||||
go test ./cmd/api/... -run TestRestoreAPIPath -v
|
||||
```
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
# 新增 `api --paginate` 自动翻页
|
||||
|
||||
`gitlink-cli api GET <PATH> --paginate` 对齐 `gh api --paginate`:自动逐页抓取并把所有条目拼接成一个数组输出,免去手动传 `page`/`limit` 逐页拉取。仅支持 GET,其它方法会明确报错而不是静默退化。
|
||||
|
||||
配套修复了 `PaginateAll` 无法解包真实 GitLink 列表响应的问题。此前它只认顶层裸数组或 `data` 键下的数组,而 GitLink 列表接口把数组包在资源专属键下(`{"total_count":N,"pulls":[...]}`、`{"issues":[...]}`、`{"branches":[...]}` 等),这类响应会被当成单个对象直接返回、根本不翻页。现在解析顺序为:优先取 `data` 数组;否则取 map 中唯一的数组字段(覆盖 pulls/issues/branches/labels 等);无数组字段或存在多个数组字段(歧义)时,保留“单对象作为单元素返回”的旧行为。短页终止(本页条目数小于 limit 即停止)与既有的裸数组、`data` 包裹用例保持不变。
|
||||
|
||||
本次变更包含 `PaginateAll` 解包逻辑修复、`--paginate` 标志与 `runAPIPaginate` 路由、中英文帮助文案,以及单元测试:client 层验证 `{total_count, issues:[...]}` 两页拼接并正确解包 `issues`;cmd 层端到端验证 `--paginate` 合并多页输出与非 GET 报错。
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
# 修复 `api` 命令单次调用不替换 `:owner/:repo` 占位符
|
||||
|
||||
## 背景
|
||||
|
||||
`gitlink-cli api <METHOD> <PATH>` 单次调用此前直接把 `<PATH>` 原样发送给服务端,**不会替换 REST 风格的 `:owner` / `:repo` 占位符**。这导致:
|
||||
|
||||
- 该命令自身的帮助 `Example`(如 `api POST /:owner/:repo/issues`)跑不通;
|
||||
- 依赖 `:owner/:repo` 写法的 Skill / 文档(如 `api GET /:owner/:repo/commits`)报错;
|
||||
- 占位符替换能力此前只存在于 `--batch-file` 批处理模式的 `{{var}}` 模板中,单次调用无法复用。
|
||||
|
||||
对应 Issue:`bug: api 命令单次调用不替换 :owner/:repo 占位符(0.2.0)`。
|
||||
|
||||
## 变更
|
||||
|
||||
`api` 单次调用现在按以下顺序处理路径:
|
||||
|
||||
1. **`{{var}}` 模板渲染**:若提供了 `--var key=value`,复用与批处理模式相同的模板引擎渲染 `<PATH>` 中的 `{{key}}`,缺失变量时报错。
|
||||
2. **`:owner` / `:repo` 占位符替换**:当路径包含 `:owner` / `:repo` 时,使用与所有 shortcut 一致的解析逻辑 `context.ResolveOwnerRepo(--owner, --repo → git remote origin)` 解析仓库归属并替换;无法解析时给出明确错误提示。
|
||||
3. 保持原有的「缺失前导 `/` 自动补全」行为。
|
||||
|
||||
不含占位符、且未传 `--var` 的调用(如 `api GET /users/me`)行为完全不变。
|
||||
|
||||
## 示例
|
||||
|
||||
```bash
|
||||
# 自动从当前 git 仓库或 --owner/--repo 解析
|
||||
gitlink-cli api GET /:owner/:repo/commits --owner Gitlink --repo gitlink-cli
|
||||
|
||||
# 单次调用也支持 {{var}} 模板
|
||||
gitlink-cli api GET /v1/{{owner}}/gitlink-cli/issues --var owner=Gitlink
|
||||
```
|
||||
|
||||
## 实现与测试
|
||||
|
||||
- 改动集中在 `cmd/api/api.go`:新增 `resolveAPIPath` 辅助函数与 `:owner` / `:repo` 占位符正则(`\b` 边界避免误伤 `:owner_id` 等更长 token;`ReplaceAllLiteralString` 避免 `$` 被当作正则替换引用)。
|
||||
- 复用既有 `parseBatchVars` / `renderTemplate`(`cmd/api/batch.go`)与 `internal/context.ResolveOwnerRepo`,无新增依赖。
|
||||
- 更新命令 `Example` 帮助文案。
|
||||
- 新增单元测试:`:owner/:repo` 解析替换、单次调用 `{{var}}` 渲染、缺失模板变量报错;既有测试全部通过。
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
# api 单次调用模板变量与预演能力
|
||||
|
||||
这次改动把 `gitlink-cli api` 的单次调用模式和 batch 模式拉齐了。
|
||||
|
||||
- 单次调用现在支持 `--var key=value`,可以在路径、查询参数和 JSON 请求体里复用 `{{var}}` 模板变量。
|
||||
- 路径里的 `:owner` 和 `:repo` 会自动使用当前 `--owner` / `--repo` 或 git remote 上下文渲染,修复了单次调用不替换占位符的问题。
|
||||
- `--dry-run` 不再只属于 batch 模式,单次调用也可以先预览渲染后的 method、path、query、body 和 variables,再决定是否真正发请求。
|
||||
|
||||
这样做的目的不是单纯补一个 bug,而是让 Raw API 更适合脚本和 Agent 复用:同一份模板写法既能用在 `api --batch-file`,也能平滑退化成一次性的单条请求。
|
||||
|
||||
本地验证:
|
||||
|
||||
```bash
|
||||
go test ./cmd/api
|
||||
go test ./...
|
||||
go build ./...
|
||||
git diff --check
|
||||
go run . api --help
|
||||
```
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
# Attachment Shortcut
|
||||
|
||||
## Summary
|
||||
|
||||
This change adds a new `attachment` shortcut group to `gitlink-cli` so users can upload and delete standalone attachments without dropping down to raw API calls.
|
||||
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
gitlink-cli attachment +upload -f ./build.log -d "CI build log"
|
||||
gitlink-cli attachment +upload -f ./release-notes.md --container-id 42 --container-type VersionRelease
|
||||
gitlink-cli attachment +delete -i 791eccbf-2e35-4301-ad95-8c937a117f40
|
||||
```
|
||||
|
||||
## API Coverage
|
||||
|
||||
- `POST /api/attachments.json`
|
||||
- `DELETE /api/attachments/{uuid}.json`
|
||||
|
||||
## Notes
|
||||
|
||||
- Upload uses multipart form data and works with the same `GITLINK_TOKEN` access token flow already used by the CLI.
|
||||
- Delete accepts the attachment UUID returned by the upload API.
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
# 认证凭据 fallback 配置目录一致性修复
|
||||
|
||||
`gitlink-cli` 的主配置文件已经支持通过 `GITLINK_CONFIG_DIR` 指定配置目录,但认证模块在系统 Keychain 不可用时仍然把 fallback 凭据写到用户 home 下的 `~/.config/gitlink-cli/credentials`。这会让 CI、Windows 测试、Agent 沙箱和多账号隔离场景出现配置目录与凭据目录不一致的问题,也会导致测试中设置临时 HOME 后仍读写真实用户目录。
|
||||
|
||||
本次修复让文件凭据路径统一复用 `internal/config.ConfigDir()`:设置 `GITLINK_CONFIG_DIR` 时,fallback 凭据保存到 `$GITLINK_CONFIG_DIR/credentials`;未设置时仍保持原有默认路径。`auth logout` 在 fallback 文件不存在时也改为幂等成功,避免用户已经没有本地凭据时退出登录反而报错。
|
||||
|
||||
测试同步改为使用 `GITLINK_CONFIG_DIR` 隔离凭据目录,覆盖默认配置目录、文件创建、保存/读取/删除、Keychain 不可用 fallback、无凭据登出等场景。该修复提升了跨平台稳定性,也让本地全量测试不再因为 Windows `HOME`/`USERPROFILE` 解析差异污染真实用户凭据目录。
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
# Branch Lifecycle Shortcuts
|
||||
|
||||
This change expands branch management coverage so repository maintainers can complete more of the branch lifecycle from `gitlink-cli` without falling back to manual API calls.
|
||||
|
||||
## Commands
|
||||
|
||||
- `branch +all`
|
||||
- `branch +set-default`
|
||||
- `branch +restore`
|
||||
|
||||
## Improvements
|
||||
|
||||
- `branch +list` now supports `--state` so users can inspect visible branches, deleted branches, or all branch records.
|
||||
- `branch +list` now supports `--keyword` to filter branches by name on the server side.
|
||||
- The README examples document the deleted-branch recovery flow so users can retrieve `branch_id` and restore the branch in one CLI workflow.
|
||||
|
||||
## API Mapping
|
||||
|
||||
| Shortcut | Method | API path |
|
||||
|----------|--------|----------|
|
||||
| `branch +all` | GET | `/api/v1/{owner}/{repo}/branches/all.json` |
|
||||
| `branch +set-default` | PATCH | `/api/v1/{owner}/{repo}/branches/update_default_branch.json?name=...` |
|
||||
| `branch +restore` | POST | `/api/v1/{owner}/{repo}/branches/restore.json` |
|
||||
|
||||
## Verification
|
||||
|
||||
- Unit tests cover request methods, paths, query parameters, restore payloads, invalid `branch-id` validation, and HTTP error handling.
|
||||
- Documentation now includes branch filtering, default-branch switching, and deleted-branch restore examples.
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
# Branch OpenAPI Shortcuts
|
||||
|
||||
补齐 GitLink 分支 OpenAPI 的生命周期操作,并增强现有 branch shortcut 的安全性和参数能力。
|
||||
|
||||
## 新增 / 增强命令
|
||||
|
||||
- `branch +list`:新增 `--keyword` 和 `--state all|deleted`,对齐 OpenAPI 查询参数。
|
||||
- `branch +all`:调用无分页分支列表接口。
|
||||
- `branch +create`:新增 `--dry-run`,预览创建分支请求。
|
||||
- `branch +delete`:切换到 OpenAPI 文档中的 `DELETE /api/v1/{owner}/{repo}/branches/{branch}.json`,并新增 `--dry-run`。
|
||||
- `branch +set-default`:设置仓库默认分支,支持 `--dry-run`。
|
||||
- `branch +restore`:恢复已删除分支,支持 `--dry-run`。
|
||||
|
||||
## OpenAPI 对齐
|
||||
|
||||
- `GET /api/v1/{owner}/{repo}/branches.json`
|
||||
- `POST /api/v1/{owner}/{repo}/branches.json`
|
||||
- `GET /api/v1/{owner}/{repo}/branches/all.json`
|
||||
- `DELETE /api/v1/{owner}/{repo}/branches/{branch}.json`
|
||||
- `PATCH /api/v1/{owner}/{repo}/branches/update_default_branch.json`
|
||||
- `POST /api/v1/{owner}/{repo}/branches/restore.json`
|
||||
|
||||
## 安全设计
|
||||
|
||||
- `branch +create`、`branch +delete`、`branch +set-default`、`branch +restore` 都支持 `--dry-run`。
|
||||
- `branch +delete` 会对包含 `/` 的分支名进行路径转义,避免把 `feature/foo` 误解析为多级路径。
|
||||
- `branch +restore` 校验 `--branch-id` 必须为正整数。
|
||||
- `branch +list --state` 仅允许 `all` 或 `deleted`,避免无效状态参数。
|
||||
|
||||
## 测试
|
||||
|
||||
新增单元测试覆盖:
|
||||
|
||||
- list 查询参数。
|
||||
- all endpoint。
|
||||
- create payload 与 dry-run。
|
||||
- delete v1 endpoint 与路径转义。
|
||||
- set-default query 参数。
|
||||
- restore payload。
|
||||
- 无效 state / branch-id 不触发 API。
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
# Browse Shortcut
|
||||
|
||||
新增 `browse` Shortcut 组,在浏览器中打开仓库的各类页面,对标 `gh browse`:
|
||||
|
||||
- `browse +repo`
|
||||
- `browse +issue --number <n>`
|
||||
- `browse +pr --number <n>`
|
||||
- `browse +commit --sha <sha>`
|
||||
- `browse +branch [--name <branch>]`
|
||||
- `browse +file --path <path> [--ref <branch>]`
|
||||
- `browse +releases`
|
||||
- `browse +wiki`
|
||||
|
||||
说明:
|
||||
|
||||
- Web 地址由配置的 `base_url` 推导(去掉 `/api` 后缀),因此自建实例同样适用。
|
||||
- `-n/--no-browser` 只打印地址而不打开浏览器,便于脚本取用与 CI 环境。
|
||||
- 浏览器启动优先使用 `$BROWSER`,否则回退到平台默认(Windows/macOS/Linux)。
|
||||
|
||||
同时补充了 `internal/browser` 跨平台启动器与 URL 构造的单元测试。
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
# Capability shortcut
|
||||
|
||||
新增 `capability` 命令组 + `internal/capability` 包,提供 GitLink 后端 API 能力探测:
|
||||
|
||||
- `capability +check` — 向后端发送探测请求,检查各命令模块依赖的 API 是否就绪,结果缓存 24 小时
|
||||
- `capability +list` — 查看已缓存的能力探测结果
|
||||
|
||||
实现要点:
|
||||
|
||||
- 新增 `internal/capability` 包:`Registry` 记录各域(label/notification/pm/wiki/pipeline/webhook/member/milestone/export/search/workflow 等)的可用状态(Available/Unavailable/Error/Unknown),带 24 小时缓存(`~/.config/gitlink-cli/capabilities.json`)。
|
||||
- 探测复用 `internal/client`,对需要 owner/repo 上下文的域自动从 git remote 推断或 `--owner/--repo` 指定。
|
||||
- `+check` 输出表格(模块 / 状态 / 说明);`+list` 直接读缓存不发请求,过期会提示。
|
||||
|
||||
背景:不同 GitLink 实例后端能力不一致,命令调用前无法预知某模块是否可用。`capability` 组让用户/Agent 在调用前自检,提升跨实例兼容性与错误可诊断性。含完整单元测试(状态判定、探测 200/401/403/404、HTML 响应、repo 上下文等)。
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
# Catalog Shortcuts
|
||||
|
||||
Adds a `catalog` shortcut group for GitLink platform template lookups:
|
||||
|
||||
- `catalog +licenses` lists repository license templates.
|
||||
- `catalog +ignores` lists repository `.gitignore` templates.
|
||||
- Both commands support `--name` filtering and return the original API response in the configured output format.
|
||||
|
||||
This closes a small but useful OpenAPI coverage gap for repository bootstrap workflows. Agents and scripts can now discover valid license and ignore template names before creating repositories, without falling back to raw API paths.
|
||||
|
|
@ -1,63 +0,0 @@
|
|||
# CI control shortcuts
|
||||
|
||||
## Background
|
||||
|
||||
The CI shortcut group already supported build listing, log inspection, restart,
|
||||
and stop operations. Repository-level CI activation, deactivation, and
|
||||
authorization checks were still documented as Raw API calls in `gitlink-ci`.
|
||||
|
||||
This change adds first-class CI control shortcuts.
|
||||
|
||||
## New shortcuts
|
||||
|
||||
- `ci +activate` activates CI for a repository.
|
||||
- `ci +deactivate` deactivates CI for a repository.
|
||||
- `ci +authorize` shows CI authorization state for a repository.
|
||||
|
||||
## Safety model
|
||||
|
||||
`ci +authorize` is read-only and can run directly:
|
||||
|
||||
```bash
|
||||
gitlink-cli ci +authorize --owner Gitlink --repo forgeplus
|
||||
```
|
||||
|
||||
`ci +activate` and `ci +deactivate` change repository CI state, so they require
|
||||
an explicit confirmation flag and support dry-run previews:
|
||||
|
||||
```bash
|
||||
gitlink-cli ci +activate --owner Gitlink --repo forgeplus --dry-run
|
||||
gitlink-cli ci +activate --owner Gitlink --repo forgeplus --yes
|
||||
```
|
||||
|
||||
```bash
|
||||
gitlink-cli ci +deactivate --owner Gitlink --repo forgeplus --dry-run
|
||||
gitlink-cli ci +deactivate --owner Gitlink --repo forgeplus --yes
|
||||
```
|
||||
|
||||
## Documentation updates
|
||||
|
||||
- README and README.zh-CN include CI control examples.
|
||||
- `skills/gitlink-ci` now prefers `ci +activate`, `ci +deactivate`, and
|
||||
`ci +authorize` instead of Raw API calls.
|
||||
|
||||
## Tests
|
||||
|
||||
Unit tests cover:
|
||||
|
||||
- endpoint method/path mapping for activate, deactivate, and authorize;
|
||||
- dry-run behavior for state-changing commands;
|
||||
- `--yes` confirmation guards;
|
||||
- HTTP error propagation.
|
||||
|
||||
Suggested verification:
|
||||
|
||||
```bash
|
||||
go test ./shortcuts/ci ./shortcuts
|
||||
```
|
||||
|
||||
Full project verification:
|
||||
|
||||
```bash
|
||||
go test ./...
|
||||
```
|
||||
|
|
@ -1,86 +0,0 @@
|
|||
# Code history and batch file shortcuts
|
||||
|
||||
## Background
|
||||
|
||||
Agent workflows such as PR review, commit quality checks, repository health
|
||||
reports, and research reproducibility audits need commit timelines, changed
|
||||
files, commit diffs, and sometimes controlled multi-file updates. Before this
|
||||
change, several of these operations required Raw API calls.
|
||||
|
||||
This change adds a larger Subtask 1 feature set around repository code history
|
||||
and file operations.
|
||||
|
||||
## New shortcuts
|
||||
|
||||
Repository shortcuts:
|
||||
|
||||
- `repo +files` searches repository files with optional `--search` and `--ref`.
|
||||
- `repo +commits` lists commits for a branch, tag, or commit ref with pagination.
|
||||
- `repo +commit-files` lists files changed by a commit, with optional file-path filtering.
|
||||
- `repo +commit-diff` returns a commit diff.
|
||||
- `repo +tags` lists repository tags with pagination and optional name filtering.
|
||||
- `repo +tag` returns one tag's metadata and target commit.
|
||||
- `repo +delete-tag` deletes a repository tag after explicit confirmation.
|
||||
- `repo +batch-commit` creates, updates, or deletes multiple files in one commit.
|
||||
|
||||
Pull request shortcuts:
|
||||
|
||||
- `pr +commits` lists commits included in a pull request.
|
||||
|
||||
## Safety model
|
||||
|
||||
All history and file inspection commands are read-only.
|
||||
|
||||
`repo +delete-tag` and `repo +batch-commit` can modify repository content, so
|
||||
they require an explicit confirmation flag for remote writes:
|
||||
|
||||
```bash
|
||||
gitlink-cli repo +delete-tag --owner me --repo proj --name v0.1.0 --dry-run
|
||||
gitlink-cli repo +delete-tag --owner me --repo proj --name v0.1.0 --yes
|
||||
```
|
||||
|
||||
```bash
|
||||
gitlink-cli repo +batch-commit --owner me --repo proj \
|
||||
--branch master --message "docs: update" \
|
||||
--files 'update:README.md:# Updated' \
|
||||
--dry-run
|
||||
|
||||
gitlink-cli repo +batch-commit --owner me --repo proj \
|
||||
--branch master --message "docs: update" \
|
||||
--files 'update:README.md:# Updated' \
|
||||
--yes
|
||||
```
|
||||
|
||||
The `--files` format is:
|
||||
|
||||
```text
|
||||
action:path[:content][;action:path[:content]...]
|
||||
```
|
||||
|
||||
Supported actions are `create`, `update`, and `delete`. `create` and `update`
|
||||
require content; `delete` does not.
|
||||
|
||||
## Tests
|
||||
|
||||
Unit tests cover:
|
||||
|
||||
- repository file search query mapping;
|
||||
- commit list pagination and ref mapping;
|
||||
- commit changed-file and diff endpoints;
|
||||
- repository tag list/detail/delete endpoint mapping;
|
||||
- PR commit list endpoint;
|
||||
- `repo +batch-commit` dry-run behavior;
|
||||
- `repo +batch-commit` remote write protection without `--yes`;
|
||||
- batch file operation payload construction and validation.
|
||||
|
||||
Suggested verification:
|
||||
|
||||
```bash
|
||||
go test ./shortcuts/repo ./shortcuts/pr
|
||||
```
|
||||
|
||||
Full project verification:
|
||||
|
||||
```bash
|
||||
make test
|
||||
```
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
# Commit Inspect Shortcuts
|
||||
|
||||
Added `gitlink-cli commit` for read-only commit inspection.
|
||||
|
||||
| Command | Endpoint |
|
||||
| --- | --- |
|
||||
| `commit +list` | `GET /v1/{owner}/{repo}/commits` |
|
||||
| `commit +files` | `GET /v1/{owner}/{repo}/commits/{sha}/files` |
|
||||
| `commit +diff` | `GET /v1/{owner}/{repo}/commits/{sha}/diff` |
|
||||
| `commit +blame` | `GET /v1/{owner}/{repo}/blame` |
|
||||
|
||||
Validation:
|
||||
|
||||
```bash
|
||||
GOPROXY=https://goproxy.cn,direct go test ./shortcuts/commit ./shortcuts
|
||||
go vet ./shortcuts/commit ./shortcuts
|
||||
go run . commit --help
|
||||
```
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
# Commit shortcut
|
||||
|
||||
新增 `commit` Shortcut 组,封装 GitLink 仓库提交(Commit)相关 OpenAPI 的常用操作,支持查看提交列表、单条提交变更文件、提交 Diff 与文件 Blame:
|
||||
|
||||
- `commit +list`
|
||||
- `commit +view`
|
||||
- `commit +diff`
|
||||
- `commit +blame`
|
||||
|
||||
实现要点:
|
||||
|
||||
- `+list` 映射 `GET /v1/{owner}/{repo}/commits`,支持 `--sha`(分支 / 标签 / 提交 SHA 过滤)、`--page`(默认 `1`)、`--limit`(默认 `20`),通过查询参数传给 API。
|
||||
- `+view` 映射 `GET /v1/{owner}/{repo}/commits/{sha}/files`,返回某次提交涉及的文件清单;`--sha` 为必填,同时支持分页参数。
|
||||
- `+diff` 映射 `GET /v1/{owner}/{repo}/commits/{sha}/diff`,返回指定提交的 Diff 内容;`--sha` 为必填。
|
||||
- `+blame` 映射 `GET /v1/{owner}/{repo}/blame`,按文件展示逐行归属;`--path` 为必填,`--sha` 缺省为 `master`,二者以 `filepath` / `sha` 查询参数提交。
|
||||
- 四个命令均通过 `ResolveOwnerRepo()` 解析 `--owner` / `--repo`(支持 `-R owner/repo` 缩写与仓库默认推断),结果统一经 `ctx.Output(env)` 输出,兼容 `--format`(table / json)等全局参数。
|
||||
- 路径沿用 `/v1/` 前缀约定,与 webhook / milestone / label 等组保持一致;`.json` 后缀由底层 client 自动补全。
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# 列出 develop 分支最近 10 条提交
|
||||
gitlink-cli commit +list --owner Gitlink --repo forgeplus --sha develop --limit 10
|
||||
|
||||
# 查看某次提交涉及的文件
|
||||
gitlink-cli commit +view --owner Gitlink --repo forgeplus --sha abc123def
|
||||
|
||||
# 查看提交 Diff
|
||||
gitlink-cli commit +diff --owner Gitlink --repo forgeplus --sha abc123def
|
||||
|
||||
# 查看 README.md 在 master 分支的 Blame 信息
|
||||
gitlink-cli commit +blame --owner Gitlink --repo forgeplus --path README.md
|
||||
|
||||
# 使用 -R 缩写并以 JSON 输出
|
||||
gitlink-cli commit +list -R Gitlink/forgeplus --page 2 --format json
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
```bash
|
||||
GOPROXY=https://goproxy.cn,direct go test ./shortcuts/commit/...
|
||||
go test ./...
|
||||
go run . commit +list --help
|
||||
```
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
# Compare Summary Shortcuts
|
||||
|
||||
## Summary
|
||||
|
||||
Adds higher-level compare shortcuts so users and AI agents can inspect commit lists and summarize branch differences without manually stitching together raw compare responses.
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|---------|---------|
|
||||
| `gitlink-cli compare +commits` | List commits between two refs with optional author, keyword, limit, and reverse filters. |
|
||||
| `gitlink-cli compare +summary` | Summarize compare metadata, commit sample, changed file totals, file status counts, top files, path groups, and extension groups. |
|
||||
|
||||
## Behavior
|
||||
|
||||
- Reuse the existing compare endpoint so branch, tag, and commit refs keep the same URL-safe encoding behavior.
|
||||
- Normalize commit output into stable fields such as `subject`, `author_login`, and `committer_login`.
|
||||
- Aggregate compare file data into top changed files, directory groups, extension groups, and created / modified / deleted / renamed counts.
|
||||
- Mark truncated summaries when `--max-files` analyzes only part of a large compare result.
|
||||
- Validate `compare +files`, `compare +commits`, and `compare +summary` numeric flags before sending API requests.
|
||||
|
||||
## Tests
|
||||
|
||||
- `go test ./shortcuts/compare/...`
|
||||
- `go build ./...`
|
||||
- `go test ./...`
|
||||
- `go run . compare +summary --owner Gitlink --repo gitlink-cli --head Mengz:mengz/compare-summary-shortcuts --base master --format json`
|
||||
|
|
@ -1,70 +0,0 @@
|
|||
# Dataset Shortcuts
|
||||
|
||||
## Summary
|
||||
|
||||
Adds a new `dataset` shortcut group for managing and querying GitLink research
|
||||
datasets, which previously had no shortcut coverage. Datasets carry
|
||||
research-oriented metadata (title, description, `paper_content`, license, owning
|
||||
project) that is valuable for research/scientometric scenarios.
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose | Endpoint |
|
||||
|---------|---------|----------|
|
||||
| `gitlink-cli dataset +view` | View a repository's dataset and attachments | `GET /v1/{owner}/{repo}/dataset` |
|
||||
| `gitlink-cli dataset +list --ids <ids>` | List datasets for one or more projects | `GET /v1/project_datasets` |
|
||||
| `gitlink-cli dataset +create` | Create a repository's dataset | `POST /v1/{owner}/{repo}/dataset` |
|
||||
| `gitlink-cli dataset +update` | Update a repository's dataset | `PUT /v1/{owner}/{repo}/dataset` |
|
||||
| `gitlink-cli dataset +delete-attachment --uuid <uuid>` | Delete a dataset attachment | `DELETE /attachments/{uuid}` |
|
||||
|
||||
## Behaviour
|
||||
|
||||
- `+view` paginates attachments via `--page`/`--limit`.
|
||||
- `+list --ids 1,2,3` queries datasets by comma-separated numeric project IDs;
|
||||
IDs are validated client-side before the request.
|
||||
- `+create`/`+update` send `title`, `description`, optional `license-id`
|
||||
(validated as a positive integer) and `paper-content`. Both support
|
||||
`--dry-run` to preview the request body without writing.
|
||||
- `+delete-attachment` is destructive: it requires `--dry-run` preview or an
|
||||
explicit `--yes` confirmation before issuing the DELETE.
|
||||
|
||||
## Production status (verified)
|
||||
|
||||
Verified against production `gitlink.org.cn`:
|
||||
|
||||
- `GET /v1/project_datasets` (`+list`) — **available and verified** (e.g.
|
||||
`--ids 5988` returns the forgeplus dataset).
|
||||
- The per-repository routes `/v1/{owner}/{repo}/dataset`
|
||||
(`+view`/`+create`/`+update`) currently return `404` on production www
|
||||
(confirmed even for a repository's own owner; not reachable on the gateway
|
||||
host either). They follow the documented contract and are expected to work
|
||||
once the platform deploys these routes. `+delete-attachment` targets the
|
||||
generic attachments endpoint.
|
||||
|
||||
The commands and request shapes match the published OpenAPI spec, so they are
|
||||
ready the moment the routes go live; unit tests exercise every command against a
|
||||
mock server.
|
||||
|
||||
## Tests
|
||||
|
||||
Unit tests cover the view path with pagination, `--ids` normalization and
|
||||
validation, create/update request bodies and `license-id` validation, dry-run
|
||||
previews, and the destructive-delete confirmation guard (`--yes`).
|
||||
|
||||
## 中文说明
|
||||
|
||||
### 变更内容
|
||||
|
||||
- 新增 `dataset` 命令组:`+view`、`+list`、`+create`、`+update`、`+delete-attachment`。
|
||||
- `+view` 支持 `--page`/`--limit` 对附件分页;`+list --ids` 按项目 ID 查询。
|
||||
- `+create`/`+update` 发送 `title`/`description`/可选 `license-id`/`paper-content`,均支持 `--dry-run` 预览。
|
||||
- `+delete-attachment` 为破坏性操作,需 `--dry-run` 预览或显式 `--yes` 确认。
|
||||
|
||||
### 生产状态(已验证)
|
||||
|
||||
- `GET /v1/project_datasets`(`+list`)在生产**可用并已验证**(如 `--ids 5988` 返回 forgeplus 数据集)。
|
||||
- `/v1/{owner}/{repo}/dataset` 的 `+view`/`+create`/`+update` 当前在生产 www 返回 `404`(即使对仓库 owner 也如此,gateway 也未托管)。实现严格遵循已发布的 OpenAPI 契约,待平台部署后即可生效;单测以 mock 覆盖全部命令。
|
||||
|
||||
### 相对文档契约的增强
|
||||
|
||||
双语 i18n 帮助文案、写操作 `--dry-run` 预览、破坏性删除 `--yes` 二次确认、`license-id` 正整数校验。
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
# CLI 自诊断命令
|
||||
|
||||
新增 `gitlink-cli doctor`,用于在用户遇到“无法认证、仓库识别失败、配置异常、API 请求失败”等问题时快速定位原因。命令会一次性检查配置文件是否存在且可解析、`base_url` 和 `default_format` 是否合理、本地 Token 或 `GITLINK_TOKEN` 是否可用、当前目录能否解析出 GitLink 仓库上下文,以及认证 API 是否能正常返回当前用户。
|
||||
|
||||
输出沿用项目已有的 `ok/data/error/meta` 结构,诊断结果包含每个检查项的状态、说明、细节和可执行修复建议,便于人类阅读,也便于 Agent 或 CI 解析。默认会验证认证 API 连通性,`--skip-network` 可在离线环境或 CI 中只做本地检查。
|
||||
|
||||
本次变更同时补充了中英文帮助文案、README 使用示例和单元测试。测试覆盖了正常本地检查、损坏配置文件、非法 `base_url`、仓库上下文缺失、认证 API mock 成功,以及命令 JSON envelope 输出,确保诊断命令在常见失败场景下返回结构化结果而不是直接崩溃。
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue