Jacob
9 天以前 74bd629e27bb16b8e07ceecc8960083d2d0748c7
scripts/publish.js
....@@ -2,38 +2,201 @@
22 * 命令行发行(不上传)+ 自动用微信开发者工具打开产物
33 *
44 * 用法:
5
- * node scripts/publish.js sit # 发行 SIT 版本并打开微信开发者工具
6
- * node scripts/publish.js prod # 发行 PROD 版本并打开微信开发者工具
7
- * node scripts/publish.js sit --sync # 同时把 appid 同步进 manifest.json(默认不动 manifest)
8
- * node scripts/publish.js sit --no-open # 只编译,不打开微信开发者工具
9
- * node scripts/publish.js sit --dry-run # 只打印将要执行的命令
5
+ * node scripts/publish.js sit # 发行 SIT 版本并打开微信开发者工具
6
+ * node scripts/publish.js prod # 发行 PROD 版本并打开微信开发者工具
7
+ * node scripts/publish.js sit --no-gen # 不改 manifest.json(要求它已存在)
8
+ * node scripts/publish.js sit --no-open # 只编译,不打开微信开发者工具
9
+ * node scripts/publish.js sit --dry-run # 只打印将要执行的命令
1010 *
11
- * 环境值统一取自 config/env/<env>.js(唯一数据源),接口地址等运行时参数由包内自动识别,
12
- * 本脚本只负责让“编译期 appid”与目标环境一致 —— 微信开发者工具打开的产物 appid,
13
- * 就是 unpackage/dist/build/mp-weixin/project.config.json 里的 appid(构建时由 manifest 生成)。
11
+ * 流程:从 manifest.json.demo 生成 manifest.json(按目标环境注入 appid)→ 发行编译 →
12
+ * 校正产物 appid → 用微信开发者工具打开产物
1413 *
15
- * 默认策略:不动 manifest.json(仓库保持 prod 基线,git 无噪音),只回写未跟踪的产物文件。
14
+ * 环境值统一取自 config/env/<env>.js(唯一数据源),接口地址等运行时参数由包内按 appid 自动识别;
15
+ * manifest.json 是生成物(已 .gitignore),因此 git 永远没有环境噪音。
16
+ * 微信开发者工具打开的产物 appid = unpackage/dist/build/mp-weixin/project.config.json 的 appid
17
+ * (构建时由 manifest 生成,这里再兜底校正一次)。
18
+ *
19
+ * 外部工具(HBuilderX cli.exe、微信开发者工具 cli.bat)不写死绝对路径,按顺序自动查找:
20
+ * 1) 环境变量 HBUILDERX_CLI / WX_DEVTOOLS_CLI
21
+ * 2) 系统 PATH
22
+ * 3) 常见安装目录(Program Files、用户目录、各磁盘常见软件目录)
23
+ * 4) 磁盘根目录浅层扫描(≤2 层)
24
+ * 找到后会把其所在目录加入本次进程 PATH(便于按名字直接调用),找不到则报错并给出解决办法。
1625 */
1726 const { spawnSync } = require('child_process');
1827 const fs = require('fs');
1928 const path = require('path');
29
+const manifest = require('./manifest');
2030
2131 const ROOT = path.resolve(__dirname, '..');
2232 const ENV_DIR = path.join(ROOT, 'config', 'env');
2333 const DIST_DIR = path.join(ROOT, 'unpackage', 'dist', 'build', 'mp-weixin');
2434 const DIST_CONFIG = path.join(DIST_DIR, 'project.config.json');
2535
26
-// 外部工具路径:可用环境变量覆盖,便于换机器
27
-const HX_CLI = process.env.HBUILDERX_CLI || 'C:\\Users\\Administrator\\Desktop\\HBuilderX\\cli.exe';
28
-const WX_CLI = process.env.WX_DEVTOOLS_CLI || 'D:\\Program Files (x86)\\Tencent\\微信web开发者工具\\cli.bat';
36
+/* ------------------------- 外部工具定位 ------------------------- */
37
+
38
+// 扫描时要跳过的系统/无关目录
39
+const SKIP_DIRS = /^(\$recycle\.bin|system volume information|windows|winsxs|node_modules|\.git|\.cache|programdata)$/i;
40
+
41
+const HX_TOOL = {
42
+ envKey: 'HBUILDERX_CLI',
43
+ label: 'HBuilderX 命令行 cli.exe',
44
+ names: ['cli.exe'],
45
+ subDirs: ['HBuilderX', 'HBuilderX\\HBuilderX'],
46
+ dirPattern: /^hbuilderx/i,
47
+ ok: function(file) { return /hbuilderx/i.test(file); },
48
+ hint: 'HBuilderX 安装/解压目录下的 cli.exe(如 X:\\HBuilderX\\cli.exe)',
49
+ extra: ''
50
+};
51
+
52
+const WX_TOOL = {
53
+ envKey: 'WX_DEVTOOLS_CLI',
54
+ label: '微信开发者工具命令行 cli.bat',
55
+ names: ['cli.bat'],
56
+ subDirs: ['微信web开发者工具', '微信开发者工具', 'Tencent\\微信web开发者工具', 'Tencent\\微信开发者工具'],
57
+ dirPattern: /微信(web)?开发者工具/,
58
+ hint: '微信开发者工具安装目录下的 cli.bat(如 X:\\Program Files (x86)\\Tencent\\微信web开发者工具\\cli.bat)',
59
+ extra: ' 3) 或加 --no-open,只编译不自动打开产物\n'
60
+};
61
+
62
+function fail(msg) {
63
+ console.error('[release] ' + msg);
64
+ process.exit(1);
65
+}
66
+
67
+function uniq(list) {
68
+ return list.filter(function(v, i) { return v && list.indexOf(v) === i; });
69
+}
70
+
71
+function isFile(p) {
72
+ try { return fs.statSync(p).isFile(); } catch (e) { return false; }
73
+}
74
+
75
+function isDir(p) {
76
+ try { return fs.statSync(p).isDirectory(); } catch (e) { return false; }
77
+}
78
+
79
+/** 本地固定磁盘(C:、D: …);拿不到时退回环境变量里的盘符(结果缓存,只探测一次) */
80
+let DRIVES = null;
81
+function fixedDrives() {
82
+ if (DRIVES) return DRIVES;
83
+ const ps = spawnSync('powershell', ['-NoProfile', '-NonInteractive', '-Command',
84
+ "[System.IO.DriveInfo]::GetDrives() | Where-Object { $_.DriveType -eq 'Fixed' } | ForEach-Object { $_.Name }"
85
+ ], { encoding: 'utf8', windowsHide: true });
86
+ const fromPs = (ps.stdout || '').split(/\r?\n/)
87
+ .map(function(s) { return s.trim().replace(/\\$/, ''); })
88
+ .filter(function(s) { return /^[A-Za-z]:$/.test(s); });
89
+ const fromEnv = [process.env.SystemDrive, process.env.HOMEDRIVE];
90
+ DRIVES = uniq(fromPs.concat(fromEnv).map(function(d) { return (d || '').replace(/\\$/, ''); }));
91
+ return DRIVES;
92
+}
93
+
94
+/** 在系统 PATH 中按文件名查找,ok() 用于排除同名无关程序 */
95
+function findOnPath(names, ok) {
96
+ const dirs = (process.env.PATH || '').split(path.delimiter);
97
+ for (let i = 0; i < dirs.length; i++) {
98
+ const dir = dirs[i].replace(/^"|"$/g, '');
99
+ if (!dir) continue;
100
+ for (let j = 0; j < names.length; j++) {
101
+ const file = path.join(dir, names[j]);
102
+ if (isFile(file) && (!ok || ok(file))) return file;
103
+ }
104
+ }
105
+ return '';
106
+}
107
+
108
+/** 常见安装根目录:Program Files、用户目录、各磁盘根与常见软件目录 */
109
+function baseDirs() {
110
+ const bases = [
111
+ process.env.ProgramFiles,
112
+ process.env['ProgramFiles(x86)'],
113
+ process.env.LOCALAPPDATA,
114
+ process.env.APPDATA,
115
+ process.env.USERPROFILE,
116
+ process.env.LOCALAPPDATA && path.join(process.env.LOCALAPPDATA, 'Programs'),
117
+ process.env.USERPROFILE && path.join(process.env.USERPROFILE, 'Desktop'),
118
+ process.env.USERPROFILE && path.join(process.env.USERPROFILE, 'Downloads')
119
+ ];
120
+ fixedDrives().forEach(function(d) {
121
+ bases.push(d + '\\', d + '\\Program Files', d + '\\Program Files (x86)',
122
+ d + '\\soft', d + '\\software', d + '\\Programs', d + '\\develop');
123
+ });
124
+ return uniq(bases).filter(isDir);
125
+}
126
+
127
+/** 磁盘浅层扫描:找名字符合特征的目录(兜底手段) */
128
+function scanPlausibleDirs(pattern) {
129
+ const found = [];
130
+ fixedDrives().forEach(function(root) {
131
+ let level1 = [];
132
+ try { level1 = fs.readdirSync(root + '\\', { withFileTypes: true }); } catch (e) { return; }
133
+ level1.forEach(function(e1) {
134
+ if (!e1.isDirectory() || SKIP_DIRS.test(e1.name)) return;
135
+ const p1 = path.join(root + '\\', e1.name);
136
+ if (pattern.test(e1.name)) { found.push(p1); return; }
137
+ let level2 = [];
138
+ try { level2 = fs.readdirSync(p1, { withFileTypes: true }); } catch (e) { return; }
139
+ level2.forEach(function(e2) {
140
+ if (e2.isDirectory() && pattern.test(e2.name)) found.push(path.join(p1, e2.name));
141
+ });
142
+ });
143
+ });
144
+ return found;
145
+}
146
+
147
+/** 定位工具:返回 { file, source },找不到返回 null */
148
+function resolveTool(cfg) {
149
+ // 1) 环境变量显式指定
150
+ const fromEnv = (process.env[cfg.envKey] || '').trim();
151
+ if (fromEnv) {
152
+ if (isFile(fromEnv)) return { file: fromEnv, source: '环境变量 ' + cfg.envKey };
153
+ fail('环境变量 ' + cfg.envKey + ' 指向的文件不存在:' + fromEnv);
154
+ }
155
+
156
+ // 2) 系统 PATH
157
+ const onPath = findOnPath(cfg.names, cfg.ok);
158
+ if (onPath) return { file: onPath, source: '系统 PATH' };
159
+
160
+ // 3) 常见安装目录 + 磁盘浅层扫描
161
+ const dirs = baseDirs().concat(scanPlausibleDirs(cfg.dirPattern));
162
+ for (let i = 0; i < dirs.length; i++) {
163
+ for (let j = 0; j < cfg.subDirs.length; j++) {
164
+ for (let k = 0; k < cfg.names.length; k++) {
165
+ const file = path.join(dirs[i], cfg.subDirs[j], cfg.names[k]);
166
+ if (isFile(file)) return { file: file, source: '常见安装目录' };
167
+ }
168
+ }
169
+ }
170
+ return null;
171
+}
172
+
173
+/** 找不到工具时的报错提示 */
174
+function toolFail(cfg) {
175
+ fail('未找到 ' + cfg.label + '\n' +
176
+ ' 已查找:环境变量 ' + cfg.envKey + ' → 系统 PATH → 常见安装目录 → 磁盘浅层扫描\n' +
177
+ ' 典型位置:' + cfg.hint + '\n' +
178
+ ' 解决办法(任选其一):\n' +
179
+ ' 1) 把安装目录加入 PATH:set PATH=%PATH%;<安装目录>\n' +
180
+ ' 2) 用环境变量指定:set ' + cfg.envKey + '=<cli 完整路径>\n' +
181
+ cfg.extra);
182
+}
183
+
184
+/** 把工具所在目录加入本次进程 PATH,便于按名字直接调用 */
185
+function putOnPath(file) {
186
+ const dir = path.dirname(file);
187
+ const cur = process.env.PATH || '';
188
+ if (cur.split(path.delimiter).indexOf(dir) < 0) process.env.PATH = dir + path.delimiter + cur;
189
+}
190
+
191
+/* ------------------------- 参数解析 ------------------------- */
29192
30193 const argv = process.argv.slice(2);
31194 const envName = (argv.find(function(a) { return a.charAt(0) !== '-'; }) || '').trim();
32
-const syncManifest = argv.indexOf('--sync') > -1;
195
+const noGen = argv.indexOf('--no-gen') > -1;
33196 const noOpen = argv.indexOf('--no-open') > -1;
34197 const dryRun = argv.indexOf('--dry-run') > -1;
35198
36
-const OWN_ARGS = ['--sync', '--no-open', '--dry-run'];
199
+const OWN_ARGS = ['--no-gen', '--no-open', '--dry-run'];
37200 // 透传给 HBuilderX cli 的额外参数(保留 "参数 值" 成对关系)
38201 const passthrough = [];
39202 let envNameSkipped = false;
....@@ -45,11 +208,6 @@
45208 }
46209 passthrough.push(a);
47210 });
48
-
49
-function fail(msg) {
50
- console.error('[release] ' + msg);
51
- process.exit(1);
52
-}
53211
54212 function readAppId(file) {
55213 try {
....@@ -79,47 +237,57 @@
79237
80238 const env = require(path.join(ENV_DIR, envName + '.js'));
81239
82
- if (!fs.existsSync(HX_CLI)) {
83
- fail('未找到 HBuilderX cli.exe:' + HX_CLI +
84
- '\n 请确认安装路径,或设置环境变量 HBUILDERX_CLI 指向 cli.exe');
85
- }
86
- if (!noOpen && !fs.existsSync(WX_CLI)) {
87
- fail('未找到微信开发者工具 cli.bat:' + WX_CLI +
88
- '\n 请设置环境变量 WX_DEVTOOLS_CLI,或加 --no-open 自行打开产物目录');
240
+ // 定位外部工具(不写死路径)
241
+ console.log('[release] 查找 HBuilderX / 微信开发者工具…');
242
+ const hx = resolveTool(HX_TOOL);
243
+ if (!hx) toolFail(HX_TOOL);
244
+ const wx = noOpen ? null : resolveTool(WX_TOOL);
245
+ if (!noOpen && !wx) toolFail(WX_TOOL);
246
+ putOnPath(hx.file);
247
+ if (wx) putOnPath(wx.file);
248
+
249
+ // 目标编译产物由 manifest.json 决定,而 manifest.json 是生成物
250
+ if (noGen && !fs.existsSync(manifest.TARGET)) {
251
+ fail('--no-gen 需要 manifest.json 已存在,请先运行:node scripts/set-env.js ' + envName);
89252 }
90253
91254 console.log('[release] 环境 : ' + envName + '(' + env.ENV_NAME + ')');
92255 console.log('[release] 小程序appid : ' + env.APPID);
93256 console.log('[release] 接口地址 : ' + env.HTTP_REQUEST_URL);
94257 console.log('[release] 产物目录 : ' + DIST_DIR);
95
- console.log('[release] manifest.json: ' + (syncManifest ? '同步为 ' + envName + ' 的 appid(会产生 git 改动)' : '保持不动(仓库维持基线,无 git 改动)'));
258
+ console.log('[release] HBuilderX : ' + hx.file + '(' + hx.source + ')');
259
+ if (wx) console.log('[release] 开发者工具 : ' + wx.file + '(' + wx.source + ')');
260
+ console.log('[release] manifest.json: ' + (noGen
261
+ ? '不改动(--no-gen)'
262
+ : '由 manifest.json.demo 生成(appid ' + env.APPID + ',生成物不入库)'));
96263
97264 const cliArgs = ['publish', '--platform', 'mp-weixin', '--project', ROOT].concat(passthrough);
98
- // 路径含空格/中文,交给 cmd 解析更稳
99
- const openCmd = '"' + WX_CLI + '" open --project "' + DIST_DIR + '"';
265
+ // 路径含空格/中文,交给 cmd 解析更稳(--no-open 时没有微信开发者工具,不拼这条命令)
266
+ const openCmd = wx ? '"' + wx.file + '" open --project "' + DIST_DIR + '"' : '';
100267
101268 if (dryRun) {
102
- console.log('[release] 1) 编译: "' + HX_CLI + '" ' + cliArgs.join(' '));
269
+ console.log('[release] 0) 生成: manifest.json ← manifest.json.demo' + (noGen ? '(已指定 --no-gen,跳过)' : ''));
270
+ console.log('[release] 1) 编译: "' + hx.file + '" ' + cliArgs.join(' '));
103271 console.log('[release] 2) 产物 appid 回写为 ' + env.APPID + ' → ' + DIST_CONFIG);
104272 if (!noOpen) console.log('[release] 3) 打开: ' + openCmd);
105273 console.log('[release] --dry-run,未执行');
106274 return;
107275 }
108276
109
- // 1) 可选:同步 manifest.json(会让被跟踪文件产生改动,默认不做)
110
- if (syncManifest) {
111
- console.log('[release] 同步 manifest.json 的 appid…');
112
- const sync = spawnSync(process.execPath, [path.join(__dirname, 'set-env.js'), envName], { cwd: ROOT, stdio: 'inherit' });
113
- if (sync.status !== 0) fail('同步 manifest.json 失败');
277
+ // 1) 生成 manifest.json(HBuilderX 的编译输入,模板:manifest.json.demo)
278
+ if (noGen) {
279
+ console.log('[release] 跳过 manifest.json 生成(--no-gen)');
280
+ } else {
281
+ manifest.generate(env);
114282 }
115283
116284 // 2) 发行编译(产物:unpackage/dist/build/mp-weixin)
117285 console.log('[release] 开始发行编译,日志见 HBuilderX 控制台…');
118
- const build = spawnSync(HX_CLI, cliArgs, { cwd: ROOT, stdio: 'inherit' });
286
+ const build = spawnSync(hx.file, cliArgs, { cwd: ROOT, stdio: 'inherit' });
119287 if (build.error) fail('调用 cli.exe 失败:' + build.error.message);
120288 if (build.status !== 0) fail('cli.exe 退出码 ' + build.status + ',请查看 HBuilderX 控制台输出');
121289
122
- // 3) 校正产物 appid(--sync 时通常已一致,这里兜底保证)
290
+ // 3) 校正产物 appid(正常应与 manifest 一致,这里兜底保证)
123291 if (!fs.existsSync(DIST_CONFIG)) {
124292 fail('发行产物缺少 project.config.json:' + DIST_CONFIG + '\n 请确认 HBuilderX 编译是否成功');
125293 }