plugins/cli
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(wiki): 體檢目錄頁改條列式版面，鍵改用體檢頁頁名

Browse Source 
What：`templates/check-contents.md` 從 markdown 表格改成一台執行環境一個 H2 區塊，H2 標題就是那一台的體檢頁頁名 `CHECK_{HASH}`，原本的七個欄位改成標題底下一層 `- {欄位名}：{值}` 的條列，頁上不留任何表格。`skills/doctor/SKILL.md` 與 `skills/setup/SKILL.md` 對目錄頁的呼叫從 `wiki-contents.sh upsert CHECK 4 "{HASH}"` 改成 `upsert CHECK 1 "CHECK_{HASH}"`，`references/behaviors.md` 的關鍵步驟、完成條件與可驗證跡象，以及 `README.md` 的兩段技能敘述都跟著對齊。

Why：一列七格的表格，欄位一多就要橫向捲動，讀的人得先數欄位再對照表頭才知道哪一格是什麼；一筆一個 H2 區塊、每一條自己帶欄位名，掃過去就讀得懂。版面換成區塊之後鍵也得跟著換：表格時代的鍵是第 4 欄的裸 `HASH`，區塊沒有欄位可指，唯一能當鍵的是 H2 標題。key-col 與 key 沿用舊值會讓腳本比對不中，同一台機器每體檢一次就在頁尾多附一個區塊，舊區塊從此再也更新不到，而頁面看起來完全正常，錯得無聲無息。頁名只由 `{短主機名}/{登入帳號}` 決定，`GITEA_HOST` 換掉、`JSC_WIKI_REPO_CHECK` 搬到別的存取庫、Gitea 對頁名的編碼有差都動不到它，拿它當鍵比拿任何含網址的值都穩。

How：範本頁首的寫入語意從「一列」改寫成「一個區塊」，並補上四個參數的說明。第三個參數 `<key>` 收 H2 標題文字，也就是 `CHECK_{HASH}`；第四個參數收的是區塊檔而不是列檔，內容為 `## CHECK_{HASH}` 那一行、一個空行，再照範本的欄位順序每欄一條條列，`HASH` 那一欄照樣要寫，標題是鍵不代表欄位可以省，否則下一個讀的人讀不到。第二個參數 `1` 定位成 `<key-col>`，只在頁面還留著舊表格、需要自動轉檔時才用得到，指舊表格裡持有 `[CHECK_{HASH}](網址)` 的第 1 欄，轉檔時取那一格的文字當 H2 標題，頁面已經是條列格式就忽略它。「體檢頁」那一條維持 `[{文字}]({絕對網址})` 的人用連結寫法，H2 標題本身不放連結也不放網址。兩支技能的結束碼分流一併校正：`wiki-contents.sh` 的結束碼 1 從「寫入失敗」改寫成「組不出頁面內容或寫入失敗」，頁上找不到本機那一個區塊不算這一碼，腳本會改成附加。實際的轉檔與 upsert 邏輯都在 `jsc-gitea/tools/wiki-contents.sh`，這個存取庫只改敘述與範本。

Who：屬於「wiki 目錄頁改條列式呈現」這個需求落在 jsc-cli 的部分，也就是 `CHECK_CONTENTS` 這一型目錄頁的去表格化。內容頁維持圖表優先，不在這一輪範圍。
This commit is contained in:
jiantw83
2026-09-02 17:25:37 +08:00
parent 8444307534
commit d5bc40be13
5 changed files with 56 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
templates/check-contents.md
+17 -9
View File
@@ -1,19 +1,27 @@
# 體檢目錄
> 由 `jsc-cli:doctor` 維護。每台執行環境一列；`HASH` 取 `{短主機名}/{登入帳號}`，算法與其他頁面共用。主機名取不含網域的短名，FQDN 要先切掉第一個點之後的部分，否則同一台機器會多出第二頁。
> 由 `jsc-cli:doctor` 維護。每台執行環境一個區塊；`HASH` 取 `{短主機名}/{登入帳號}`，算法與其他頁面共用。主機名取不含網域的短名，FQDN 要先切掉第一個點之後的部分，否則同一台機器會多出第二頁。
>
> 本頁落在 `JSC_WIKI_REPO_CONTENTS` 解出的專用存取庫，與體檢頁 `CHECK_{HASH}` 不同庫。目錄頁全部住這裡，不退回 `JSC_WIKI_REPO_CHECK`。
>
> 寫入語意：一列代表一台執行環境，也就是一組主機加帳號。一律用 `jsc-gitea/tools/wiki-contents.sh upsert CHECK 4 {HASH} {列檔} {本範本}` 寫，它先讀回整頁，該執行環境已經有列就更新那一列，沒有才在表尾附加一列。禁止整頁覆蓋，也不得改動別人的列。體檢頁 `CHECK_{HASH}` 只留最新一次結果、可以整頁改寫，這份目錄頁不行。
> 寫入語意：一個區塊代表一台執行環境，也就是一組主機加帳號。一律用 `jsc-gitea/tools/wiki-contents.sh upsert CHECK 1 CHECK_{HASH} {區塊檔} {本範本}` 寫，它先讀回整頁，該執行環境已經有區塊就整塊換掉，沒有才在頁尾附加一個區塊。禁止整頁覆蓋，也不得改動別人的區塊。體檢頁 `CHECK_{HASH}` 只留最新一次結果、可以整頁改寫，這份目錄頁不行。
>
> 鍵是第 4 欄的 `HASH`：`jsc-gitea/tools/hash-id` 印出什麼就填什麼，完整 40 碼大寫十六進位，不截短、不加前綴、不包成連結。腳本比對的是整格文字，鍵一定要跟這一格一字不差。
> 參數說明：第二個參數 `1` 是 `<key-col>`，只在這一頁還留著舊的 markdown 表格時用得到，指舊表格裡持有身分那一欄的序號，也就是持有 `[CHECK_{HASH}](網址)` 的第 1 欄，自動轉檔時取那一格的文字當 H2 標題；頁面已經是條列格式就完全忽略它。第三個參數 `<key>` 是 H2 標題文字，也就是體檢頁頁名 `CHECK_{HASH}`。第四個參數是區塊檔，不是列檔：內容為 `## CHECK_{HASH}` 那一行、一個空行，再接各條欄位。
>
> 鍵用裸 `HASH` 才穩。`GITEA_HOST` 換掉、`JSC_WIKI_REPO_CHECK` 換過存取庫、Gitea 對頁名的網址編碼有差，網址就跟著變；拿含網址的儲存格當鍵，比對就永遠比不中，同一台機器每體檢一次就多附一列，畫面上還看不出來。
> 鍵是 H2 標題 `CHECK_{HASH}`：`jsc-gitea/tools/hash-id` 印出什麼就接在 `CHECK_` 後面，完整 40 碼大寫十六進位，不截短、不加別的前後綴、不包成連結、不加日期。腳本比對的是去掉頭尾空白後的整段標題文字，鍵一定要跟標題一字不差。
>
> 連結寫法：第 1 欄的連結只給人點，不當鍵用。一律寫成 `[{文字}]({連結})`，也就是 `[CHECK_{HASH}]({wiki-url 印出的絕對網址})`，網址取 `jsc-gitea/tools/gitea.sh wiki-url` 印出的那一串，不自己組路徑。同 wiki 的雙括號寫法一概不用：兩頁分屬不同存取庫，連不過去，畫面上還看不出壞掉。
> 鍵用頁名才穩。頁名只由 `{短主機名}/{登入帳號}` 決定；`GITEA_HOST` 換掉、`JSC_WIKI_REPO_CHECK` 換過存取庫、Gitea 對頁名的網址編碼有差，網址就跟著變，頁名一個字都不動。拿含網址的值當鍵，比對就永遠比不中，同一台機器每體檢一次就多附一個區塊，畫面上還看不出來。
>
> 連結驗證：這一列要寫進去的每一個連結，先交給 `jsc-gitea/tools/link-check.sh`，結束碼 0 才寫。有任何一筆 DEAD 就整列不寫，把連不到的清單回報給呼叫端。結束碼 3 代表 `GITEA_HOST` 沒設定，先設好再寫，不得跳過驗證；結束碼 7 代表金鑰失效，停下來回報金鑰問題，不要當成死連結。驗證一律走 API，不看網頁狀態碼：私有存取庫的網頁網址對未登入請求一律回 404，拿狀態碼判會把好連結判成壞的，整批砍掉還在的頁。
> 連結寫法：「體檢頁」那一條的連結只給人點，不當鍵用；H2 標題本身不放連結、不放網址。連結一律寫成 `[{文字}]({連結})`，也就是 `[CHECK_{HASH}]({wiki-url 印出的絕對網址})`，網址取 `jsc-gitea/tools/gitea.sh wiki-url` 印出的那一串，不自己組路徑。同 wiki 的雙括號寫法一概不用：兩頁分屬不同存取庫，連不過去，畫面上還看不出壞掉。
>
> 連結驗證：這個區塊要寫進去的每一個連結，先交給 `jsc-gitea/tools/link-check.sh`，結束碼 0 才寫。有任何一筆 DEAD 就整個區塊都不寫，把連不到的清單回報給呼叫端。結束碼 3 代表 `GITEA_HOST` 沒設定，先設好再寫，不得跳過驗證；結束碼 7 代表金鑰失效，停下來回報金鑰問題，不要當成死連結。驗證一律走 API，不看網頁狀態碼：私有存取庫的網頁網址對未登入請求一律回 404，拿狀態碼判會把好連結判成壞的，整批砍掉還在的頁。
| 體檢頁 | 主機 | 帳號 | HASH | 必要項缺漏 | 設定錯誤 | 最後體檢 |
| --- | --- | --- | --- | --- | --- | --- |
| [CHECK_{HASH}]({wiki-url 印出的絕對網址}) | {短主機名} | {使用者帳號} | {HASH} | {n} | {n} | {yyyy-MM-dd HH:mm} |
## CHECK_{HASH}
- 體檢頁：[CHECK_{HASH}]({wiki-url 印出的絕對網址})
- 主機：{短主機名}
- 帳號：{使用者帳號}
- HASH：{HASH}
- 必要項缺漏：{n}
- 設定錯誤：{n}
- 最後體檢：{yyyy-MM-dd HH:mm}