github-overview 0.1.2 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -10
- package/bin/cli.mjs +57 -24
- package/docs/screenshot-dark.png +0 -0
- package/docs/screenshot-light.png +0 -0
- package/package.json +1 -1
- package/public/index.html +1261 -120
- package/src/auth.mjs +279 -0
- package/src/config.mjs +37 -2
- package/src/github.mjs +122 -34
- package/src/loop.mjs +67 -0
- package/src/npm.mjs +14 -12
- package/src/server.mjs +988 -74
- package/src/store.mjs +74 -19
- package/src/summary.mjs +270 -20
package/README.md
CHANGED
|
@@ -9,17 +9,24 @@
|
|
|
9
9
|
## 用法
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
+
npx github-overview init --user 你的GitHub用户名 # 绑定账号下全部仓库
|
|
12
13
|
npx github-overview init --repo owner/repo --npm 包名
|
|
13
14
|
npx github-overview start # http://127.0.0.1:4317
|
|
14
15
|
```
|
|
15
16
|
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
-
|
|
17
|
+
- `--user` 会把账号下自己拥有的仓库都绑上;页面顶部可以切到「全部仓库」看合计,也可以切单个仓库。只要一部分就写 `--repo a/b,c/d`。
|
|
18
|
+
- `--npm` 按同一个顺序对应仓库,只在包名和仓库名不一样时才写。默认拿仓库名去找包,找到了还要核对 registry 上的维护者是不是你,不是就不算下载。
|
|
19
|
+
- 首次同步把 14 天内的流量存到本地,之后每 6 小时自动刷新(`--refresh` 可改),页面上的「刷新」随时手动同步;issue / PR 不跟这个慢循环,默认每 15 分钟单独刷新(`--contrib` 可改,0 关闭),贡献区块标出这部分的快照时间。
|
|
20
|
+
- AI 摘要:`npx github-overview config --apikey KEY --baseurl URL --model MODEL`,或点页面右下角「配置」直接填,只存本机 `~/.config/github-overview/config.json`。模型不写用 `deepseek-chat`。
|
|
21
|
+
- 切到「全部仓库」会多出一块「项目」:按访客或窗口内下载把仓库排成一列,点一行就切到那个仓。
|
|
22
|
+
- 再往下是「发版效果」:各仓最近一次发版前后的浏览日均并排,按涨幅排,点一行切过去。
|
|
23
|
+
- 「漏斗」把浏览、落到仓库主页、npm 下载三个数放在一起。下载是 npm 注册表口径,和浏览不是同一批人,所以只报倍数、不折算百分比。
|
|
24
|
+
- 外部贡献按窗口计数,子标点出没关又没人回的那几条,点名字直接跳到那条;安全告警标出条数最多的仓库,点进去看具体条目。
|
|
25
|
+
- 没配 AI 也能用,摘要走内置模板;配好后还能在摘要框下面问一句,按当前范围的数据回答。
|
|
19
26
|
|
|
20
27
|
## 为什么需要它
|
|
21
28
|
|
|
22
|
-
GitHub 自带的 traffic 只给 14 天,而且只有浏览和克隆,看不到 npm
|
|
29
|
+
GitHub 自带的 traffic 只给 14 天,而且只有浏览和克隆,看不到 npm 下载。页面下半有一块「发版效果」:挑最近一个前后都有数据的版本,把发版前后各 7 天的浏览与下载日均并排放在一起(覆盖不满时标出实际天数),涨没涨一眼能看出。发行版一多、渠道一散,判断「这次发版有没有人真用上」就得自己拼数据。这个项目把 GitHub traffic、npm 下载、发版记录放在同一条时间轴上,再用一句话说清发生了什么。
|
|
23
30
|
|
|
24
31
|
## 口径
|
|
25
32
|
|
|
@@ -29,19 +36,22 @@ GitHub 自带的 traffic 只给 14 天,而且只有浏览和克隆,看不到
|
|
|
29
36
|
| 访客 | 去重后的人数,一个人来三次算一个 |
|
|
30
37
|
| 克隆 | `git clone` 的总次数 |
|
|
31
38
|
| 克隆人数 | 去重后的人数 |
|
|
32
|
-
| 发版 | 窗口内发布的版本,含 npm
|
|
33
|
-
|
|
|
39
|
+
| 发版 | 窗口内发布的版本,含 npm 发布时间;每仓最多取最近 100 条,覆盖不满整窗时界面会标出实际区间和下限 |
|
|
40
|
+
| 星数增长 | 窗口内新增的 star,按每个 star 的日期算 |
|
|
41
|
+
| 外部贡献 | 别人提的 issue 和 PR,作者自己和 CI、机器人账号的不计 |
|
|
34
42
|
|
|
35
43
|
- 浏览和克隆是两个指标,不相加。
|
|
36
|
-
-
|
|
37
|
-
-
|
|
44
|
+
- 页面构成是浏览落在哪些页面,来源是从哪个站进来,两者分开;这两块都用最近 14 天,不随上面选的窗口变。
|
|
45
|
+
- 问「有多少用户」时按访客和 npm 下载两路折算后给约数和区间,不是只报访客数;克隆数不参与人数估算。
|
|
46
|
+
- 多仓合计时浏览、克隆、下载、star 相加;访客不去重跨仓相加,沿用的是各仓 API 给的人数。
|
|
38
47
|
|
|
39
48
|
## 数据源
|
|
40
49
|
|
|
41
50
|
| 来源 | 指标 | 粒度 |
|
|
42
51
|
| --- | --- | --- |
|
|
43
52
|
| GitHub traffic | 浏览、克隆、页面、来源 | 每日 + 快照 |
|
|
44
|
-
| GitHub
|
|
53
|
+
| GitHub API | 外部 issue、PR | 按更新时间拉取,按创建或合并、关闭时间入窗 |
|
|
54
|
+
| GitHub stargazers | 星数增长 | 每个 star 的时间(分页取最近 1000) |
|
|
45
55
|
| GitHub alerts | 安全告警 | 快照 |
|
|
46
56
|
| npm | 每日下载、版本时间 | 每日(约 2–3 天延迟) |
|
|
47
57
|
|
|
@@ -49,7 +59,11 @@ GitHub 自带的 traffic 只给 14 天,而且只有浏览和克隆,看不到
|
|
|
49
59
|
|
|
50
60
|
## 14 天窗口
|
|
51
61
|
|
|
52
|
-
GitHub 的 traffic 只保留最近 14 天,所以第一次运行就要开始存快照。30 天、90
|
|
62
|
+
GitHub 的 traffic 只保留最近 14 天,所以第一次运行就要开始存快照。30 天、90 天视图读本地存储,只画有记录的那段,不会把空缺画成 0。
|
|
63
|
+
|
|
64
|
+
访客是 14 天窗口内去重的人数,GitHub 不提供更长范围的人数,所以 30 天、90 天视图显示同一个值,并在访客下面标出去重窗口,不会因为切了范围就变少。
|
|
65
|
+
|
|
66
|
+
星数增长只算有记录的日期:窗口比储存的记录长时,按记录的首尾日期算,不会把没采集的日子当成 0。
|
|
53
67
|
|
|
54
68
|
## 路线
|
|
55
69
|
|
|
@@ -58,6 +72,10 @@ GitHub 的 traffic 只保留最近 14 天,所以第一次运行就要开始存
|
|
|
58
72
|
- [x] 定时刷新与手动刷新
|
|
59
73
|
- [x] 面板内配置(AI 的 base URL 与 key)
|
|
60
74
|
- [x] AI 摘要,未配置时用模板
|
|
75
|
+
- [x] 摘要框里直接提问
|
|
76
|
+
- [x] npm 包归属核对,机器人 PR 不计入外部
|
|
77
|
+
- [x] 绑定 GitHub 账号,多仓切换与合计
|
|
78
|
+
- [x] 提问会自己查数据:跨仓比较、拉最新、给估算
|
|
61
79
|
|
|
62
80
|
## License
|
|
63
81
|
|
package/bin/cli.mjs
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import { readConfig, writeConfig, parseRepo, CONFIG_PATH } from "./../src/config.mjs";
|
|
2
|
+
import { readConfig, writeConfig, parseRepo, normalizeConfig, resolveToken, CONFIG_PATH } from "./../src/config.mjs";
|
|
3
3
|
import { createApp } from "./../src/server.mjs";
|
|
4
|
+
import { startLoop } from "./../src/loop.mjs";
|
|
4
5
|
|
|
5
6
|
const argv = process.argv.slice(2);
|
|
6
7
|
const cmd = argv[0] && !argv[0].startsWith("-") ? argv[0] : "start";
|
|
@@ -13,28 +14,62 @@ const flag = (...names) => {
|
|
|
13
14
|
};
|
|
14
15
|
|
|
15
16
|
const repoArg = flag("--repo", "-r");
|
|
17
|
+
const userArg = flag("--user", "-u");
|
|
16
18
|
const port = Number(flag("--port", "-p") || process.env.PORT || 4317);
|
|
17
19
|
const npmArg = flag("--npm");
|
|
18
20
|
const days = Number(flag("--days") || 7);
|
|
19
21
|
const intervalHours = Number(flag("--refresh") || 6);
|
|
22
|
+
const contribMinutes = Number(flag("--contrib") || 15);
|
|
20
23
|
|
|
21
24
|
function usage() {
|
|
22
25
|
console.log(`github-overview
|
|
23
26
|
|
|
24
|
-
github-overview init --
|
|
25
|
-
github-overview
|
|
27
|
+
github-overview init --user 用户名 [--npm 包名,...]
|
|
28
|
+
github-overview init --repo owner/repo[,owner/repo2] [--npm 包名,...]
|
|
29
|
+
github-overview start [--port 4317] [--days 7] [--refresh 6] [--contrib 15]
|
|
26
30
|
github-overview sync
|
|
27
|
-
github-overview config --apikey KEY --baseurl URL
|
|
31
|
+
github-overview config --apikey KEY --baseurl URL [--model deepseek-chat]
|
|
28
32
|
`);
|
|
29
33
|
}
|
|
30
34
|
|
|
35
|
+
// 账号绑定:列出该账号名下仓库;有 token 时能拿到私有仓库的 traffic
|
|
36
|
+
async function listUserRepos(user) {
|
|
37
|
+
const token = resolveToken(readConfig());
|
|
38
|
+
const headers = { accept: "application/vnd.github+json", "user-agent": "github-overview" };
|
|
39
|
+
if (token) headers.authorization = `Bearer ${token}`;
|
|
40
|
+
const who = await fetch("https://api.github.com/user", { headers }).then((r) => (r.ok ? r.json() : null)).catch(() => null);
|
|
41
|
+
const base = who?.login === user ? "/user/repos?affiliation=owner&per_page=100&sort=pushed" : `/users/${encodeURIComponent(user)}/repos?per_page=100&sort=pushed`;
|
|
42
|
+
const all = [];
|
|
43
|
+
for (let page = 1; page <= 10; page++) {
|
|
44
|
+
const res = await fetch(`https://api.github.com${base}&page=${page}`, { headers });
|
|
45
|
+
if (!res.ok) throw new Error(`拉取 ${user} 的仓库失败:${res.status}`);
|
|
46
|
+
const rows = await res.json();
|
|
47
|
+
all.push(...rows);
|
|
48
|
+
if (rows.length < 100) break;
|
|
49
|
+
}
|
|
50
|
+
return all.filter((r) => !r.fork && (r.permissions ? r.permissions.push : true)).map((r) => ({ repo: r.full_name }));
|
|
51
|
+
}
|
|
52
|
+
|
|
31
53
|
try {
|
|
32
54
|
if (cmd === "init") {
|
|
33
|
-
|
|
34
|
-
|
|
55
|
+
let repos = [];
|
|
56
|
+
let user = userArg;
|
|
57
|
+
if (user) repos = await listUserRepos(user);
|
|
58
|
+
else if (repoArg) repos = repoArg.split(",").map((s) => s.trim()).filter(Boolean).map((s) => parseRepo(s)).map((r) => ({ repo: `${r.owner}/${r.name}` }));
|
|
59
|
+
else {
|
|
60
|
+
usage();
|
|
61
|
+
throw new Error("给个账号或仓库:--user 用户名 或 --repo owner/repo");
|
|
62
|
+
}
|
|
63
|
+
if (!repos.length) throw new Error(`${user || repoArg} 下没有可绑定的仓库`);
|
|
64
|
+
const npmList = npmArg ? npmArg.split(",").map((s) => s.trim()) : [];
|
|
65
|
+
repos = repos.map((r, i) => (npmList[i] ? { ...r, npm: npmList[i] } : r));
|
|
66
|
+
const next = { ...readConfig(), user: user || repos[0].repo.split("/")[0], repos };
|
|
67
|
+
delete next.repo;
|
|
68
|
+
delete next.npm;
|
|
35
69
|
writeConfig(next);
|
|
36
70
|
console.log(`已写入 ${CONFIG_PATH}`);
|
|
37
|
-
console.log(
|
|
71
|
+
console.log(`绑定 ${next.user},${repos.length} 个仓库`);
|
|
72
|
+
console.log(repos.slice(0, 8).map((r) => ` ${r.repo}${r.npm && r.npm !== r.repo.split("/")[1] ? " → npm " + r.npm : ""}`).join("\n") + (repos.length > 8 ? `\n …共 ${repos.length} 个` : ""));
|
|
38
73
|
console.log("下一步:github-overview start");
|
|
39
74
|
process.exit(0);
|
|
40
75
|
}
|
|
@@ -43,42 +78,40 @@ try {
|
|
|
43
78
|
const next = { ...readConfig() };
|
|
44
79
|
const apikey = flag("--apikey");
|
|
45
80
|
const baseurl = flag("--baseurl");
|
|
81
|
+
const model = flag("--model");
|
|
46
82
|
if (apikey) next.apikey = apikey;
|
|
47
83
|
if (baseurl) next.baseurl = baseurl.replace(/\/$/, "");
|
|
84
|
+
if (model) next.model = model;
|
|
48
85
|
writeConfig(next);
|
|
49
86
|
console.log(`AI 配置已保存到 ${CONFIG_PATH}`);
|
|
50
87
|
process.exit(0);
|
|
51
88
|
}
|
|
52
89
|
|
|
53
|
-
const cfg = readConfig();
|
|
54
|
-
const
|
|
55
|
-
|
|
90
|
+
const cfg = normalizeConfig(readConfig());
|
|
91
|
+
const repos = cfg.repos;
|
|
92
|
+
// init/sync 需要仓库;start 不需要——空配置先起绑定页,绑完就能用
|
|
93
|
+
if (!repos.length && cmd !== "start") {
|
|
56
94
|
usage();
|
|
57
|
-
console.log("
|
|
95
|
+
console.log("还没有绑定账号,先跑:github-overview init --user 用户名");
|
|
58
96
|
process.exit(1);
|
|
59
97
|
}
|
|
60
98
|
|
|
61
99
|
if (cmd === "sync") {
|
|
62
|
-
const app = createApp({
|
|
100
|
+
const app = createApp({ repos, days, intervalHours, contribMinutes, cfg });
|
|
63
101
|
const out = await app.sync();
|
|
102
|
+
for (const r of out.results) console.log(`${r.ok ? "同步" : "失败"} ${r.repo}${r.error ? ":" + r.error : ""}`);
|
|
64
103
|
console.log(`同步完成 ${out.syncedAt}`);
|
|
65
|
-
process.exit(0);
|
|
104
|
+
process.exit(out.ok ? 0 : 1);
|
|
66
105
|
}
|
|
67
106
|
|
|
68
107
|
if (cmd === "start") {
|
|
69
|
-
const app = createApp({
|
|
108
|
+
const app = createApp({ repos, days, intervalHours, contribMinutes, cfg });
|
|
70
109
|
const addr = await app.listen(port);
|
|
71
110
|
console.log(`github-overview 在 http://127.0.0.1:${addr.port}`);
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
} catch (e) {
|
|
77
|
-
console.log(`同步失败:${e.message}`);
|
|
78
|
-
}
|
|
79
|
-
};
|
|
80
|
-
tick();
|
|
81
|
-
setInterval(tick, Math.max(1, intervalHours) * 3600e3);
|
|
111
|
+
if (repos.length) console.log(`已绑定 ${cfg.user},${repos.length} 个仓库`);
|
|
112
|
+
else console.log(`还没绑定账号,打开 http://127.0.0.1:${addr.port} 用浏览器登录一次`);
|
|
113
|
+
// 同步节奏放在 src/loop.mjs,桌面端跑的也是这一份
|
|
114
|
+
startLoop(app, { intervalHours, contribMinutes, onLog: (line) => console.log(line) });
|
|
82
115
|
await new Promise(() => {});
|
|
83
116
|
}
|
|
84
117
|
|
package/docs/screenshot-dark.png
CHANGED
|
Binary file
|
|
Binary file
|