/** * README 的安裝段。 * * 這一段是使用者照著打的東西,打錯一個字就裝不起來,所以指令要能逐字複製執行, * 而且不能留下已經不成立的說法——並列一條「照著做不會出現任何指令」的流程等於在說謊。 */ import test from 'node:test'; import assert from 'node:assert/strict'; import { readFileSync } from 'node:fs'; import { join } from 'node:path'; import { repoRoot } from './helpers/run-script.js'; const readme = () => readFileSync(join(repoRoot, 'README.md'), 'utf8'); const agents = () => readFileSync(join(repoRoot, 'AGENTS.md'), 'utf8'); /** 取出所有 bash 圍欄裡的指令行 */ function commands(text) { return [...text.matchAll(/```bash\n([\s\S]*?)```/g)] .flatMap((block) => block[1].split('\n')) .map((line) => line.trim()) .filter((line) => line !== '' && !line.startsWith('#')); } test('安裝以 npm 為唯一建議路徑,指令含完整可複製的 git URL', () => { const install = commands(readme()).filter((line) => line.startsWith('npm i -g')); assert.equal(install.length > 0, true, 'README 沒有 npm 安裝指令'); assert.ok( install.some((line) => line.includes('https://gitea.jsc.idv.tw/plugins/tea-sdlc.git')), `安裝指令少了完整 git URL:${install.join(' / ')}`, ); }); test('更新與移除各有完整指令表,順序講清楚先 uninstall 再 npm rm', () => { const text = readme(); assert.match(text, /npm i -g https:\/\/gitea\.jsc\.idv\.tw\/plugins\/tea-sdlc\.git/); assert.match(text, /tea-sdlc uninstall/); assert.match(text, /npm rm -g tea-sdlc/); // 先砍套件就再也刪不掉那些孤兒轉接檔,順序本身就是內容 assert.ok( text.indexOf('tea-sdlc uninstall') < text.indexOf('npm rm -g tea-sdlc'), 'uninstall 必須寫在 npm rm -g 之前', ); }); test('明寫不要用 npm update -g,並說出為什麼', () => { const text = readme(); assert.match(text, /npm update -g/); const at = text.indexOf('npm update -g'); assert.match(text.slice(at - 200, at + 200), /不要|別/); }); test('四個子指令在 README 上都有用途說明', () => { const text = readme(); for (const name of ['install', 'uninstall', 'prompt', 'status']) { assert.match(text, new RegExp(`tea-sdlc ${name}`), `README 沒有交代 ${name}`); } }); test('七套 marketplace 流程移進附錄保留,內容沒有被刪掉', () => { const text = readme(); const appendix = text.slice(text.indexOf('## 附錄')); assert.ok(text.includes('## 附錄'), 'README 沒有附錄'); for (const line of ['claude plugin marketplace add', 'codex plugin marketplace add', 'agy plugin install']) { assert.ok(appendix.includes(line), `附錄少了 ${line}`); } }); test('模組邊界表指得到實際存在的檔案', () => { const text = agents(); assert.match(text, /`bin\/tea-sdlc\.js`/); assert.match(text, /`scripts\/install\.js`/); assert.equal(/\| `install\.js` \|/.test(text), false, '表上還留著已經不存在的根目錄 install.js'); });