@868618/fup-cli 0.0.0-stage → 0.1.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.
Files changed (3) hide show
  1. package/README.md +70 -2
  2. package/dist/cli.js +257 -0
  3. package/package.json +31 -4
package/README.md CHANGED
@@ -1,3 +1,71 @@
1
- # Temporary Holding Version
1
+ # fup
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ `fup` 是一个 Node.js 全局命令:从当前 Git 项目收集变更文件,经确认后,上传到项目根目录 `automanage.php` 配置的 FTP。项目使用 TypeScript 编写,由 Vite 库模式构建。npm 包名为 `@868618/fup-cli`,终端命令名为 `fup`。
4
+
5
+ ## 功能
6
+
7
+ - 不指定 commit:收集暂存区、工作区和未跟踪文件。
8
+ - 指定 commit:额外收集该提交(含)至 `HEAD` 的变更。
9
+ - 默认忽略**项目根目录**的 `.php` 文件,扩展名不区分大小写;子目录中的 PHP 文件仍可上传。
10
+ - 支持重复使用 `--ignore` 排除指定文件或目录,目录路径以 `/` 结尾。
11
+ - 上传前展示文件清单,只有输入 `y` 或 `yes` 才会读取 FTP 配置并开始上传。已删除文件不会上传。
12
+ - 使用 curl 创建远端目录并上传,最多同时处理 4 个文件;部分文件失败时返回非零退出码。
13
+
14
+ ## 环境要求
15
+
16
+ - Node.js 22.12 或更新版本
17
+ - Git 和支持 FTP 的 curl,均可在终端中直接运行
18
+ - 目标 Git 项目根目录存在 `automanage.php`,FTP 设置采用脚本支持的直接字符串赋值形式
19
+
20
+ ## 本地开发与安装
21
+
22
+ 在本项目目录运行:
23
+
24
+ ```powershell
25
+ npm ci
26
+ npm run build
27
+ npm install -g .
28
+ ```
29
+
30
+ 构建后可在任意 Git 项目目录运行 `fup`。修改源码后执行 `npm run build`;全局本地安装指向当前项目,构建产物更新后即可使用。`npm run dev` 会监听源码并重建。
31
+
32
+ 发布到 npmjs.org 后,也可以使用 `npm install -g @868618/fup-cli` 安装;发布前请使用上面的本地安装方法。
33
+
34
+ ## 使用示例
35
+
36
+ ```powershell
37
+ fup
38
+ fup <commit>
39
+ fup --ignore cache/ --ignore config/local.php
40
+ fup <commit> --ignore cache/
41
+ fup --help
42
+ ```
43
+
44
+ `--ignore` 路径相对于 Git 项目根目录。命令在当前目录向上查找 Git 根目录;运行前请确认当前所在项目。取消上传只需在提示处输入 `n` 或直接回车。
45
+
46
+ ## 项目文件
47
+
48
+ | 文件 | 用途 |
49
+ | --- | --- |
50
+ | `package.json` | 包名、`fup` 命令入口、依赖和构建脚本 |
51
+ | `package-lock.json` | npm 依赖版本锁定 |
52
+ | `vite.config.ts` | Vite 库模式配置,构建 Node.js 命令并保留 shebang |
53
+ | `tsconfig.json` | TypeScript 类型检查配置 |
54
+ | `src/cli.ts` | 命令行参数、帮助信息及错误出口 |
55
+ | `src/commands/upload.ts` | 文件筛选、展示、确认及并发上传流程 |
56
+ | `src/git/changes.ts` | 调用 Git 并收集变更路径 |
57
+ | `src/ftp/config.ts` | 读取并校验目标项目的 FTP 配置 |
58
+ | `.gitignore` | 排除依赖、构建产物、本地配置和打包文件 |
59
+
60
+ `dist/` 由 `npm run build` 生成,不提交到仓库;`npm pack` 生成的 `.tgz` 也不提交。发布包只包含构建后的命令、`package.json` 和 README。原始参考脚本不在本仓库中。
61
+
62
+ ## 开发检查
63
+
64
+ ```powershell
65
+ npm run typecheck
66
+ npm run build
67
+ node dist/cli.js --help
68
+ npm pack --dry-run
69
+ ```
70
+
71
+ 卸载本地全局安装:`npm uninstall -g @868618/fup-cli`。
package/dist/cli.js ADDED
@@ -0,0 +1,257 @@
1
+ #!/usr/bin/env node
2
+ import { Command as e } from "commander";
3
+ import * as t from "node:fs";
4
+ import * as n from "node:path";
5
+ import { spawn as r, spawnSync as i } from "node:child_process";
6
+ import * as a from "node:readline/promises";
7
+ import { stdin as o, stdout as s } from "node:process";
8
+ // src/git/changes.ts
9
+ function c(e, t) {
10
+ let n = i("git", e, {
11
+ cwd: t,
12
+ encoding: null,
13
+ windowsHide: !0
14
+ });
15
+ if (n.error) throw n.error;
16
+ if (n.status !== 0) {
17
+ let t = (n.stderr || Buffer.alloc(0)).toString("utf8").trim();
18
+ throw Error(t || `git ${e[0]} 执行失败`);
19
+ }
20
+ return n.stdout;
21
+ }
22
+ function l(e, t) {
23
+ for (let n of t.toString("utf8").split("\0").filter(Boolean)) e.add(n.replace(/\\/g, "/"));
24
+ }
25
+ function u(e, t) {
26
+ let n = /* @__PURE__ */ new Set();
27
+ if (t) {
28
+ c([
29
+ "cat-file",
30
+ "-e",
31
+ `${t}^{commit}`
32
+ ], e);
33
+ let r = c([
34
+ "rev-list",
35
+ "--parents",
36
+ "-n",
37
+ "1",
38
+ t
39
+ ], e).toString("utf8").trim().split(/\s+/)[1];
40
+ r ? (l(n, c([
41
+ "diff",
42
+ "--name-only",
43
+ "-z",
44
+ r,
45
+ "HEAD"
46
+ ], e)), l(n, c([
47
+ "log",
48
+ "--name-only",
49
+ "--pretty=format:",
50
+ "-z",
51
+ `${t}..HEAD`
52
+ ], e))) : (l(n, c([
53
+ "diff-tree",
54
+ "--root",
55
+ "--no-commit-id",
56
+ "--name-only",
57
+ "-r",
58
+ "-z",
59
+ t
60
+ ], e)), l(n, c([
61
+ "log",
62
+ "--name-only",
63
+ "--pretty=format:",
64
+ "-z",
65
+ `${t}..HEAD`
66
+ ], e)));
67
+ }
68
+ return l(n, c([
69
+ "diff",
70
+ "--name-only",
71
+ "-z",
72
+ "--cached"
73
+ ], e)), l(n, c([
74
+ "diff",
75
+ "--name-only",
76
+ "-z"
77
+ ], e)), l(n, c([
78
+ "ls-files",
79
+ "--others",
80
+ "--exclude-standard",
81
+ "-z"
82
+ ], e)), Array.from(n).sort((e, t) => e.localeCompare(t));
83
+ }
84
+ // src/ftp/config.ts
85
+ function d(e, t) {
86
+ for (let n of t) {
87
+ let t = n.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"), r = RegExp("\\$" + t + "\\s*=\\s*(['\"])([\\s\\S]*?)\\1\\s*;", "i"), i = e.match(r);
88
+ if (i) return i[2].replace(/\\([\\"'])/g, "$1");
89
+ }
90
+ }
91
+ function f(e) {
92
+ let r = n.join(e, "automanage.php");
93
+ if (!t.existsSync(r)) throw Error(`项目根目录找不到配置文件:${r}`);
94
+ let i = t.readFileSync(r, "utf8"), a = {
95
+ host: d(i, [
96
+ "ftphost",
97
+ "ftp_host",
98
+ "ftpserver",
99
+ "ftp_server"
100
+ ]),
101
+ port: d(i, ["ftpport", "ftp_port"]),
102
+ username: d(i, [
103
+ "ftpusername",
104
+ "ftp_user",
105
+ "ftpuser",
106
+ "ftp_username"
107
+ ]),
108
+ password: d(i, [
109
+ "ftppassword",
110
+ "ftp_pass",
111
+ "ftppwd",
112
+ "ftp_password"
113
+ ]),
114
+ root: d(i, [
115
+ "ftpwww",
116
+ "ftp_www",
117
+ "ftppath",
118
+ "ftp_path",
119
+ "ftpdir"
120
+ ])
121
+ }, o = Object.keys(a).filter((e) => !a[e]);
122
+ if (o.length) throw Error(`automanage.php 中 FTP 配置缺失或不是直接字符串赋值:${o.join(", ")}`);
123
+ let s = Number(a.port);
124
+ if (!Number.isInteger(s) || s < 1 || s > 65535) throw Error("automanage.php 中 ftpport 不是有效端口");
125
+ return {
126
+ host: a.host,
127
+ port: s,
128
+ username: a.username,
129
+ password: a.password,
130
+ root: a.root.replace(/^\/+|\/+$/g, "")
131
+ };
132
+ }
133
+ // src/commands/upload.ts
134
+ var p = {
135
+ reset: "\x1B[0m",
136
+ cyan: "\x1B[36m",
137
+ green: "\x1B[32m",
138
+ yellow: "\x1B[33m",
139
+ red: "\x1B[31m",
140
+ bold: "\x1B[1m"
141
+ };
142
+ function m(e) {
143
+ return e.map((e) => {
144
+ let t = e.replace(/\\/g, "/"), r = t.endsWith("/"), i = n.posix.normalize(t.replace(/^\.\//, "")).replace(/^\/+|\/+$/g, "");
145
+ if (!i || i === "." || n.posix.isAbsolute(t) || /^[a-zA-Z]:/.test(t) || i.split("/").includes("..")) throw Error(`无效的 --ignore 路径:${t}`);
146
+ return {
147
+ path: i,
148
+ isDirectory: r
149
+ };
150
+ });
151
+ }
152
+ function h(e) {
153
+ return /^[^/]+\.php$/i.test(e);
154
+ }
155
+ function g(e, t) {
156
+ return h(e) || t.some((t) => t.isDirectory ? e === t.path || e.startsWith(t.path + "/") : e === t.path);
157
+ }
158
+ function _(e) {
159
+ return e.split("/").filter(Boolean).map((e) => encodeURIComponent(e)).join("/");
160
+ }
161
+ function v(e) {
162
+ return String(e).replace(/\\/g, "\\\\").replace(/"/g, "\\\"").replace(/\r?\n/g, "");
163
+ }
164
+ function y(e, t, n, i) {
165
+ return new Promise((a, o) => {
166
+ let s = [i.root, t].filter(Boolean).join("/"), c = `ftp://${i.host}:${i.port}/${_(s)}`, l = `user = "${v(i.username)}:${v(i.password)}"\n`, u = r("curl", [
167
+ "--silent",
168
+ "--show-error",
169
+ "--fail",
170
+ "--ftp-create-dirs",
171
+ "--upload-file",
172
+ e,
173
+ "--config",
174
+ "-",
175
+ c
176
+ ], {
177
+ cwd: n,
178
+ windowsHide: !0,
179
+ stdio: [
180
+ "pipe",
181
+ "ignore",
182
+ "pipe"
183
+ ]
184
+ }), d = "";
185
+ u.stderr.setEncoding("utf8"), u.stderr.on("data", (e) => {
186
+ d += e;
187
+ }), u.on("error", o), u.on("close", (e) => {
188
+ e === 0 ? a() : o(Error(d.trim() || `curl 退出码 ${e}`));
189
+ }), u.stdin.end(l);
190
+ });
191
+ }
192
+ async function b(e, t, n) {
193
+ let r = 0, i = Array.from({ length: Math.min(t, e.length) }, async () => {
194
+ for (; r < e.length;) await n(e[r++]);
195
+ });
196
+ await Promise.all(i);
197
+ }
198
+ async function x(e, r = []) {
199
+ let i = n.resolve(c(["rev-parse", "--show-toplevel"], process.cwd()).toString("utf8").trim()), l = m(r), d = u(i, e), _ = d.filter(h).length, v = d.filter((e) => g(e, l)).length, x = d.filter((e) => !g(e, l));
200
+ if (console.log(`${p.bold}${p.cyan}项目:${i}${p.reset}`), console.log(e ? `${p.cyan}变更范围:提交 ${e}(含)至 HEAD,并包含暂存区和工作区改动${p.reset}` : `${p.cyan}变更范围:暂存区、工作区及未跟踪文件${p.reset}`), console.log(`${p.cyan}默认忽略:项目根目录的 *.php(命中 ${_} 个路径)${p.reset}`), l.length && console.log(`${p.cyan}附加忽略规则:${l.map((e) => e.path + (e.isDirectory ? "/" : "")).join(", ")}${p.reset}`), console.log(""), !d.length) {
201
+ console.log(`${p.green}没有发现文件变更。${p.reset}`);
202
+ return;
203
+ }
204
+ if (!x.length) {
205
+ console.log(`${p.green}变更文件均已忽略,没有可展示或上传的文件。${p.reset}`);
206
+ return;
207
+ }
208
+ let S = [];
209
+ for (let e of x) {
210
+ let r = n.resolve(i, ...e.split("/")), a = n.relative(i, r);
211
+ a !== "" && (a === ".." || a.startsWith(".." + n.sep) || n.isAbsolute(a)) ? console.log(`${p.red}[跳过路径越界] ${e}${p.reset}`) : !t.existsSync(r) || !t.statSync(r).isFile() ? console.log(`${p.red}[删除或非普通文件,不上传] ${e}${p.reset}`) : (console.log(`${p.yellow}● ${e}${p.reset}`), S.push({
212
+ absolutePath: r,
213
+ relativePath: e
214
+ }));
215
+ }
216
+ if (console.log(`\n共 ${x.length} 个未忽略变更路径,其中 ${S.length} 个可上传文件;忽略 ${v} 个路径。`), !S.length) {
217
+ console.log("没有可上传的普通文件。");
218
+ return;
219
+ }
220
+ let C = a.createInterface({
221
+ input: o,
222
+ output: s
223
+ }), w;
224
+ try {
225
+ w = (await C.question("确认并行上传到 automanage.php 配置的 FTP?(y/N) ")).trim().toLowerCase();
226
+ } finally {
227
+ C.close();
228
+ }
229
+ if (w !== "y" && w !== "yes") {
230
+ console.log("已取消上传。");
231
+ return;
232
+ }
233
+ let T = f(i);
234
+ console.log(`开始上传到 ${T.host}:${T.port}/${T.root}(并发 4)。`);
235
+ let E = [];
236
+ await b(S, 4, async (e) => {
237
+ try {
238
+ await y(e.absolutePath, e.relativePath, i, T), console.log(`${p.green}[上传成功] ${e.relativePath}${p.reset}`);
239
+ } catch (t) {
240
+ E.push(e.relativePath);
241
+ let n = t instanceof Error ? t.message : String(t);
242
+ console.error(`${p.red}[上传失败] ${e.relativePath}: ${n}${p.reset}`);
243
+ }
244
+ }), console.log(E.length ? `${p.red}上传结束:成功 ${S.length - E.length},失败 ${E.length}。${p.reset}` : `${p.green}上传完成:${S.length} 个文件全部成功。${p.reset}`), E.length && (process.exitCode = 1);
245
+ }
246
+ // src/cli.ts
247
+ function S(e, t) {
248
+ return t.push(e), t;
249
+ }
250
+ await new e().name("fup").description("上传当前 Git 项目的变更文件到 automanage.php 配置的 FTP").version("0.1.0").argument("[commit]", "从指定提交(含)开始统计至 HEAD 的变更").option("--ignore <path>", "忽略相对项目根目录的文件或目录;目录路径以 / 结尾,可重复使用", S, []).action(async (e, t) => {
251
+ try {
252
+ await x(e, t.ignore);
253
+ } catch (e) {
254
+ let t = e instanceof Error ? e.message : String(e);
255
+ console.error(`\u001b[31m错误:${t}\u001b[0m`), process.exitCode = 1;
256
+ }
257
+ }).parseAsync(process.argv);
package/package.json CHANGED
@@ -1,6 +1,33 @@
1
1
  {
2
2
  "name": "@868618/fup-cli",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.1.0",
4
+ "description": "Upload changed Git files to the FTP server configured in automanage.php",
5
+ "keywords": ["ftp", "git", "upload", "cli"],
6
+ "type": "module",
7
+ "preferGlobal": true,
8
+ "bin": {
9
+ "fup": "dist/cli.js"
10
+ },
11
+ "files": ["dist"],
12
+ "publishConfig": {
13
+ "registry": "https://registry.npmjs.org/",
14
+ "access": "public"
15
+ },
16
+ "scripts": {
17
+ "dev": "vite build --watch",
18
+ "typecheck": "tsc --noEmit",
19
+ "build": "npm run typecheck && vite build",
20
+ "prepack": "npm run build"
21
+ },
22
+ "engines": {
23
+ "node": ">=22.12.0"
24
+ },
25
+ "devDependencies": {
26
+ "@types/node": "^26.6.6",
27
+ "typescript": "~7.0.2",
28
+ "vite": "^8.3.6"
29
+ },
30
+ "dependencies": {
31
+ "commander": "^15.1.0"
32
+ }
33
+ }