create-clis 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.
- package/LICENSE +21 -0
- package/README.md +113 -0
- package/README.zh-CN.md +113 -0
- package/assets/manifest.json +99 -0
- package/assets/template/.editorconfig +12 -0
- package/assets/template/.gitattributes +18 -0
- package/assets/template/.github/ISSUE_TEMPLATE/bug_report.yml +86 -0
- package/assets/template/.github/ISSUE_TEMPLATE/feature_request.yml +45 -0
- package/assets/template/.github/PULL_REQUEST_TEMPLATE.md +26 -0
- package/assets/template/.github/workflows/ci.yml +42 -0
- package/assets/template/.github/workflows/release.yml +65 -0
- package/assets/template/.gitignorerc.json +21 -0
- package/assets/template/.nvmrc +1 -0
- package/assets/template/.oxlintrc.json +52 -0
- package/assets/template/.prettierignore +11 -0
- package/assets/template/.prettierrc +11 -0
- package/assets/template/.releaserc.json +17 -0
- package/assets/template/.vscode/extensions.json +8 -0
- package/assets/template/.vscode/launch.json +13 -0
- package/assets/template/.vscode/settings.json +14 -0
- package/assets/template/AGENTS.md +25 -0
- package/assets/template/CODE_OF_CONDUCT.md +91 -0
- package/assets/template/CONTRIBUTING.md +85 -0
- package/assets/template/CONTRIBUTING.zh-CN.md +85 -0
- package/assets/template/LICENSE +21 -0
- package/assets/template/README.md +22 -0
- package/assets/template/README.zh-CN.md +22 -0
- package/assets/template/SECURITY.md +21 -0
- package/assets/template/_gitignore +409 -0
- package/assets/template/_npmrc +6 -0
- package/assets/template/bunfig.toml +16 -0
- package/assets/template/docs/README.md +30 -0
- package/assets/template/docs/adrs/README.md +7 -0
- package/assets/template/docs/designs/README.md +11 -0
- package/assets/template/docs/designs/tech-debt.md +22 -0
- package/assets/template/docs/development.md +59 -0
- package/assets/template/lefthook.yml +55 -0
- package/assets/template/package.json +38 -0
- package/assets/template/packages/{{NAME}}/CHANGELOG.md +3 -0
- package/assets/template/packages/{{NAME}}/LICENSE +21 -0
- package/assets/template/packages/{{NAME}}/README.md +33 -0
- package/assets/template/packages/{{NAME}}/README.zh-CN.md +33 -0
- package/assets/template/packages/{{NAME}}/docs/README.md +21 -0
- package/assets/template/packages/{{NAME}}/package.json +40 -0
- package/assets/template/packages/{{NAME}}/scripts/build.ts +82 -0
- package/assets/template/packages/{{NAME}}/scripts/verify-release.test.ts +214 -0
- package/assets/template/packages/{{NAME}}/scripts/verify-release.ts +152 -0
- package/assets/template/packages/{{NAME}}/src/index.ts +15 -0
- package/assets/template/packages/{{NAME}}/tsconfig.build.json +12 -0
- package/assets/template/packages/{{NAME}}/tsconfig.json +5 -0
- package/assets/template/packages/{{NAME}}-cli/CHANGELOG.md +3 -0
- package/assets/template/packages/{{NAME}}-cli/LICENSE +21 -0
- package/assets/template/packages/{{NAME}}-cli/README.md +35 -0
- package/assets/template/packages/{{NAME}}-cli/README.zh-CN.md +35 -0
- package/assets/template/packages/{{NAME}}-cli/bin/{{BIN_NAME}} +30 -0
- package/assets/template/packages/{{NAME}}-cli/bin/{{BIN_NAME}}.cmd +30 -0
- package/assets/template/packages/{{NAME}}-cli/bin/{{BIN_NAME}}.d.mts +23 -0
- package/assets/template/packages/{{NAME}}-cli/bin/{{BIN_NAME}}.mjs +212 -0
- package/assets/template/packages/{{NAME}}-cli/docs/README.md +21 -0
- package/assets/template/packages/{{NAME}}-cli/package.json +48 -0
- package/assets/template/packages/{{NAME}}-cli/scripts/release-artifact.ts +141 -0
- package/assets/template/packages/{{NAME}}-cli/scripts/release.fixtures.ts +70 -0
- package/assets/template/packages/{{NAME}}-cli/scripts/verify-release.test.ts +444 -0
- package/assets/template/packages/{{NAME}}-cli/scripts/verify-release.ts +72 -0
- package/assets/template/packages/{{NAME}}-cli/scripts/write-dist-manifest.test.ts +126 -0
- package/assets/template/packages/{{NAME}}-cli/scripts/write-dist-manifest.ts +81 -0
- package/assets/template/packages/{{NAME}}-cli/src/cli.ts +36 -0
- package/assets/template/packages/{{NAME}}-cli/tsconfig.json +4 -0
- package/assets/template/scripts/ci.ts +163 -0
- package/assets/template/scripts/install-git-hooks.mjs +122 -0
- package/assets/template/scripts/install-git-hooks.test.ts +418 -0
- package/assets/template/scripts/lib/git-env.ts +21 -0
- package/assets/template/scripts/lib/release-verify.ts +431 -0
- package/assets/template/scripts/lib/tmp-root.ts +17 -0
- package/assets/template/scripts/lib/workspace.test.ts +92 -0
- package/assets/template/scripts/lib/workspace.ts +100 -0
- package/assets/template/scripts/lint-doc-examples.test.ts +129 -0
- package/assets/template/scripts/lint-doc-examples.ts +249 -0
- package/assets/template/scripts/lint-doc-references.test.ts +158 -0
- package/assets/template/scripts/lint-doc-references.ts +308 -0
- package/assets/template/scripts/lint-doc-shared.ts +59 -0
- package/assets/template/scripts/lint-stray-backups.test.ts +53 -0
- package/assets/template/scripts/lint-stray-backups.ts +39 -0
- package/assets/template/scripts/npm-trust-guard.test.ts +253 -0
- package/assets/template/scripts/npm-trust-guard.ts +533 -0
- package/assets/template/scripts/safe-install.ts +39 -0
- package/assets/template/scripts/transcription/api-harness.ts +219 -0
- package/assets/template/scripts/transcription/compare.ts +421 -0
- package/assets/template/scripts/transcription/corpus.ts +208 -0
- package/assets/template/scripts/transcription/fixture.ts +290 -0
- package/assets/template/scripts/transcription/make-mutants.ts +425 -0
- package/assets/template/scripts/transcription/report.ts +86 -0
- package/assets/template/scripts/transcription/run-conformance.ts +344 -0
- package/assets/template/scripts/transcription/validate-coverage.test.ts +119 -0
- package/assets/template/scripts/transcription/validate-coverage.ts +144 -0
- package/assets/template/scripts/transcription/validate.ts +366 -0
- package/assets/template/tsconfig.json +46 -0
- package/assets/template/turbo.jsonc +60 -0
- package/bin/create-clis +35 -0
- package/bin/create-clis.cmd +32 -0
- package/bin/create-clis.mjs +219 -0
- package/dist/create-clis.js +87682 -0
- package/dist/manifest.json +7 -0
- package/package.json +57 -0
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* npm 安装场景的启动器: 挑选运行时 (Bun 优先, 其次 Node) 后启动真实入口。
|
|
4
|
+
* 与 bin/create-clis (sh) / bin/create-clis.cmd (cmd) 职责同逻辑 (挑选运行时: Bun 优先, Node
|
|
5
|
+
* 回退), 差异在本文件是 npm 的 bin 目标: 本文件同时承担 Unix 与 Windows 的 npm shim 目标
|
|
6
|
+
* (shebang 必须是 node, 否则 npm 的 cmd-shim 会按 shebang 解释器生成 Windows 上不存在的调用)。
|
|
7
|
+
*
|
|
8
|
+
* 只认产物 (与既有 CLI 包启动器的一处刻意差异): 生成器无源码回退: 入口恒为
|
|
9
|
+
* dist/create-clis.js, 产物缺失即报错退出。生成器随包发售的是产物 + 模板资产 (assets/),
|
|
10
|
+
* 二者缺一不可; 「开发态回退直跑 src/cli.ts」会把发行面缺陷藏起来 (源码在包内并不存在),
|
|
11
|
+
* 仓库开发态请先跑构建 (bun run build)。
|
|
12
|
+
*
|
|
13
|
+
* 运行时解析防劫持 (与 @iyowei/sweep-node-modules-cli 启动器同款处理): Windows 上裸名执行会
|
|
14
|
+
* 先搜当前工作目录 (CreateProcessW 的搜索序里「parent 的当前目录」居第 2 位; 本文件走的 Node
|
|
15
|
+
* spawn 亦然: libuv 的 search_path 以 NeedCurrentDirectoryForExePathW 门控先试 cwd 再扫
|
|
16
|
+
* PATH), 而生成器的调用现场恰是「在用户自己的目录里跑」, 目录内放一个同名 bun.exe / bun.com
|
|
17
|
+
* 即可顶替真实运行时进入执行链。故 win32 下先按 PATH 解析出绝对路径 (空条目与相对条目都会把
|
|
18
|
+
* 解析引回当前目录, 一并跳过) 再探测与执行, 解析面与执行面都不再触发任何搜索序; POSIX 侧同法
|
|
19
|
+
* 收紧 (空与相对条目在 POSIX 下同样意为当前目录), 并保持 execvp「首候选不可执行时继续搜索」的
|
|
20
|
+
* 语义 (逐候选探测)。该逻辑与 sweep-nm 启动器逐行同源, 三个函数带可注入接缝导出 (platform /
|
|
21
|
+
* pathEnv / fileProbe / probe), 由 scripts/launcher.runtime-resolution.test.mjs 注入复现;
|
|
22
|
+
* 测试写成 .mjs 而非 .ts: 被测对象是纯 JS 分发入口 (node 直跑, 不进 tsc 编译面), 用 .ts 就得给
|
|
23
|
+
* bin/ 配类型投影 (bin/create-clis.d.mts), 而 files 白名单整目录收 bin/, 投影会多出一份发行面
|
|
24
|
+
* 文件 (白名单契约是 bin 三件)。
|
|
25
|
+
*
|
|
26
|
+
* 产物自证 (发行面 dist/create-clis.js 与源码和提交无身份绑定的运行时防线): 决定跑
|
|
27
|
+
* dist/create-clis.js 之前必须与随附的 dist/manifest.json 对账 (形状版本受支持, 且清单记的
|
|
28
|
+
* cliSha256 必须等于实测摘要), 清单缺失 / 损坏 / 版本不支持 / 摘要不符一律拒收产物并给出指引,
|
|
29
|
+
* 不静默执行 (静默执行会把产物漂移藏起来)。工作树脏净不进本判定 (开发态常脏), 那是发布闸门
|
|
30
|
+
* scripts/verify-release.ts 的职责; 清单字段契约见 scripts/release-artifact.ts (包内无法
|
|
31
|
+
* 跨语言复用该模块, 两边口径由 scripts/write-dist-manifest.test.ts 的钉住用例与两侧注释对齐)。
|
|
32
|
+
*
|
|
33
|
+
* 退出码原样透传; 两个运行时都缺席时给出可操作提示并非零退出。
|
|
34
|
+
*/
|
|
35
|
+
import { spawnSync } from 'node:child_process';
|
|
36
|
+
import { createHash } from 'node:crypto';
|
|
37
|
+
import { existsSync, readFileSync, realpathSync, statSync } from 'node:fs';
|
|
38
|
+
import { dirname, join, posix, win32 } from 'node:path';
|
|
39
|
+
import { fileURLToPath } from 'node:url';
|
|
40
|
+
|
|
41
|
+
/** 产物与清单的文件名 (与 scripts/release-artifact.ts 的 CLI_FILE / MANIFEST_FILE 同值) */
|
|
42
|
+
const CLI_FILE = 'create-clis.js';
|
|
43
|
+
const MANIFEST_FILE = 'manifest.json';
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* win32 的候选可执行扩展名, 顺序与 Node 实际走的 libuv 搜索一致 (.com 先于 .exe)。
|
|
47
|
+
* 不展开 PATHEXT: .bat / .cmd 无法被 Node 无 shell 直接执行, 展开只会把不可执行的命中当成功;
|
|
48
|
+
* 保持该面与 libuv 等价也意味着本次收紧不改动 win32 上「哪些安装形态能命中」的既有行为。
|
|
49
|
+
*/
|
|
50
|
+
const WIN32_EXEC_EXTS = ['.com', '.exe'];
|
|
51
|
+
|
|
52
|
+
/** 探测命令是否可执行 (以 --version 的实际退出码为准, 不依赖 shell 内建) */
|
|
53
|
+
const available = (command) =>
|
|
54
|
+
spawnSync(command, ['--version'], { stdio: 'ignore' }).status === 0;
|
|
55
|
+
|
|
56
|
+
/** 路径处是否为普通文件 (探针读不到即 false, 不抛; 目录名撞上候选名时不得当选) */
|
|
57
|
+
const isFileAt = (path) => {
|
|
58
|
+
try {
|
|
59
|
+
return statSync(path).isFile();
|
|
60
|
+
} catch {
|
|
61
|
+
return false;
|
|
62
|
+
}
|
|
63
|
+
};
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* 在 PATH 中解析命令的绝对路径 (win32 语义), 找不到返回 null。
|
|
67
|
+
* 只供 win32 分支调用: CreateProcessW 与 libuv 的裸名搜索序都会先搜当前目录, 本函数把
|
|
68
|
+
* 「当前目录」从解析面整个摘掉: 空条目 (Windows 上表示当前目录) 与相对条目 (同样按当前
|
|
69
|
+
* 目录解析) 一律跳过, 只认绝对目录; 条目两侧的引号按 libuv 同款剥掉 (Windows PATH 允许
|
|
70
|
+
* 引号包裹含空格的目录)。注入 pathEnv / fileProbe 供测试在非 win32 宿主上覆盖本函数。
|
|
71
|
+
*/
|
|
72
|
+
export const resolveWin32Executable = (name, pathEnv, fileProbe) => {
|
|
73
|
+
for (const raw of pathEnv.split(';')) {
|
|
74
|
+
const dir =
|
|
75
|
+
raw.length > 1 && raw.startsWith('"') && raw.endsWith('"')
|
|
76
|
+
? raw.slice(1, -1)
|
|
77
|
+
: raw;
|
|
78
|
+
if (dir === '' || !win32.isAbsolute(dir)) continue;
|
|
79
|
+
for (const ext of WIN32_EXEC_EXTS) {
|
|
80
|
+
const candidate = win32.join(dir, name + ext);
|
|
81
|
+
if (fileProbe(candidate)) return candidate;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
return null;
|
|
85
|
+
};
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* 在 PATH 中解析命令的全部候选绝对路径 (POSIX 语义, 保持 PATH 顺序), 跳过空条目与相对
|
|
89
|
+
* 条目 (两者在 POSIX 下都按当前目录解析, 属本工具要摘掉的解析面; 与 win32 分支同一理由)。
|
|
90
|
+
* 返回数组而非首命中: 同名文件可能不可执行, execvp 在该情形会继续搜索, 候选交由调用方逐个
|
|
91
|
+
* 探测以保持同一语义。注入 pathEnv / fileProbe 供测试覆盖本函数。
|
|
92
|
+
*/
|
|
93
|
+
export const resolvePosixExecutables = (name, pathEnv, fileProbe) => {
|
|
94
|
+
const found = [];
|
|
95
|
+
for (const dir of pathEnv.split(':')) {
|
|
96
|
+
if (dir === '' || !dir.startsWith('/')) continue;
|
|
97
|
+
const candidate = posix.join(dir, name);
|
|
98
|
+
if (fileProbe(candidate)) found.push(candidate);
|
|
99
|
+
}
|
|
100
|
+
return found;
|
|
101
|
+
};
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* 挑选运行时: Bun 优先, 其次 Node; 皆无则 null (由调用处报错退出)。
|
|
105
|
+
* 两个平台都先按 PATH 解析绝对路径再探测 (理由见文件头「运行时解析防劫持」): win32 取
|
|
106
|
+
* 首个解析命中, POSIX 按 PATH 顺序逐个候选探测 (保持 execvp 的继续搜索语义)。
|
|
107
|
+
* 各参数显式传入供测试注入, 生产调用不传。
|
|
108
|
+
*/
|
|
109
|
+
export const pickRuntime = ({
|
|
110
|
+
platform = process.platform,
|
|
111
|
+
pathEnv = process.env.PATH ?? '',
|
|
112
|
+
fileProbe = isFileAt,
|
|
113
|
+
probe = available,
|
|
114
|
+
} = {}) => {
|
|
115
|
+
for (const name of ['bun', 'node']) {
|
|
116
|
+
if (platform === 'win32') {
|
|
117
|
+
const resolved = resolveWin32Executable(name, pathEnv, fileProbe);
|
|
118
|
+
if (resolved !== null && probe(resolved)) return resolved;
|
|
119
|
+
continue;
|
|
120
|
+
}
|
|
121
|
+
for (const candidate of resolvePosixExecutables(name, pathEnv, fileProbe)) {
|
|
122
|
+
if (probe(candidate)) return candidate;
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
return null;
|
|
126
|
+
};
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* 产物自证: 核对 dist/create-clis.js 与 dist/manifest.json 的摘要是否同源。
|
|
130
|
+
* 通过返回 null, 否则返回人话原因; 原因串全是本文件固定措辞, 不回显清单内容 (清单是外部
|
|
131
|
+
* 文件, 其文本不受控, 不落进输出面)。
|
|
132
|
+
*/
|
|
133
|
+
const artifactProblem = (distDir) => {
|
|
134
|
+
const manifestPath = join(distDir, MANIFEST_FILE);
|
|
135
|
+
if (!existsSync(manifestPath)) return `缺少产物清单 (dist/${MANIFEST_FILE})`;
|
|
136
|
+
let manifest;
|
|
137
|
+
try {
|
|
138
|
+
manifest = JSON.parse(readFileSync(manifestPath, 'utf8'));
|
|
139
|
+
} catch {
|
|
140
|
+
return `产物清单 (dist/${MANIFEST_FILE}) 损坏, 不是合法 JSON`;
|
|
141
|
+
}
|
|
142
|
+
// 形状版本先对: 异版本的字段语义无保证, 宁可拒收 (字面量 1 与 scripts/release-artifact.ts 的
|
|
143
|
+
// MANIFEST_SCHEMA_VERSION 同值, 改动须两处同步; 启动器随包分发, 包内无法 import 该模块)
|
|
144
|
+
if (manifest?.schemaVersion !== 1) {
|
|
145
|
+
return `产物清单 (dist/${MANIFEST_FILE}) 的 schemaVersion 不是受支持的版本 (期望 1)`;
|
|
146
|
+
}
|
|
147
|
+
const recorded = manifest?.cliSha256;
|
|
148
|
+
if (typeof recorded !== 'string') {
|
|
149
|
+
return `产物清单 (dist/${MANIFEST_FILE}) 缺少 cliSha256 字段`;
|
|
150
|
+
}
|
|
151
|
+
let actual;
|
|
152
|
+
try {
|
|
153
|
+
actual = createHash('sha256')
|
|
154
|
+
.update(readFileSync(join(distDir, CLI_FILE)))
|
|
155
|
+
.digest('hex');
|
|
156
|
+
} catch {
|
|
157
|
+
return `产物 (dist/${CLI_FILE}) 读不出来, 摘要算不出`;
|
|
158
|
+
}
|
|
159
|
+
if (recorded !== actual)
|
|
160
|
+
return `产物 (dist/${CLI_FILE}) 的摘要与清单记录不符`;
|
|
161
|
+
return null;
|
|
162
|
+
};
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* 本文件是否作为入口被直接执行。
|
|
166
|
+
* 经 realpath 比对而非字面路径: npm 在 Unix 上以符号链接 (或经 shim) 落 bin, 此时 argv[1] 是
|
|
167
|
+
* 链接路径而 import.meta.url 是解析后的真实路径。main 守卫只为让「被 import 时不跑主流程」,
|
|
168
|
+
* 判定失配的后果是入口静默不跑, 故除字面相等外只在 realpath 成功时采信。
|
|
169
|
+
*/
|
|
170
|
+
const isEntry = () => {
|
|
171
|
+
const entry = process.argv[1];
|
|
172
|
+
if (typeof entry !== 'string' || entry === '') return false;
|
|
173
|
+
const self = fileURLToPath(import.meta.url);
|
|
174
|
+
if (entry === self) return true;
|
|
175
|
+
try {
|
|
176
|
+
return realpathSync(entry) === self;
|
|
177
|
+
} catch {
|
|
178
|
+
return false;
|
|
179
|
+
}
|
|
180
|
+
};
|
|
181
|
+
|
|
182
|
+
const main = () => {
|
|
183
|
+
const root = dirname(dirname(fileURLToPath(import.meta.url)));
|
|
184
|
+
const distDir = join(root, 'dist');
|
|
185
|
+
const entry = join(distDir, CLI_FILE);
|
|
186
|
+
// 生成器只认产物 (无源码回退): 产物缺失即拒, 退出码与「无运行时」同一档: 1
|
|
187
|
+
if (!existsSync(entry)) {
|
|
188
|
+
process.stderr.write(
|
|
189
|
+
`create-clis: 缺少产物 (dist/${CLI_FILE} 不存在), 本入口只认构建产物, 无源码回退。\n` +
|
|
190
|
+
' 处置: 重装本包换一份完好分发 (npm install -g create-clis);' +
|
|
191
|
+
' 本仓开发态请先跑构建 (bun run build)。\n',
|
|
192
|
+
);
|
|
193
|
+
process.exit(1);
|
|
194
|
+
}
|
|
195
|
+
// 有产物就得先自证 (与随附清单对账); 不通过即拒收
|
|
196
|
+
const problem = artifactProblem(distDir);
|
|
197
|
+
if (problem !== null) {
|
|
198
|
+
process.stderr.write(
|
|
199
|
+
`create-clis: ${problem}, 已拒绝执行该产物 (无法证明它与构建清单同源)。\n` +
|
|
200
|
+
' 处置: 重装本包换一份完好分发 (npm install -g create-clis);' +
|
|
201
|
+
' 重装无效则说明该版本包有缺陷, 需发布者重新构建后再发。\n',
|
|
202
|
+
);
|
|
203
|
+
process.exit(1);
|
|
204
|
+
}
|
|
205
|
+
const runtime = pickRuntime();
|
|
206
|
+
|
|
207
|
+
if (runtime === null) {
|
|
208
|
+
process.stderr.write('create-clis: 未找到 bun 或 node, 请至少安装其一\n');
|
|
209
|
+
process.exit(1);
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
const { status } = spawnSync(runtime, [entry, ...process.argv.slice(2)], {
|
|
213
|
+
stdio: 'inherit',
|
|
214
|
+
});
|
|
215
|
+
|
|
216
|
+
process.exit(status ?? 1);
|
|
217
|
+
};
|
|
218
|
+
|
|
219
|
+
if (isEntry()) main();
|