clarify-kit-facts 0.1.0-alpha.1 → 0.2.0-alpha.1

package/dist/clarify-kit/index.json

@@ -5,7 +5,7 @@
   "entry": "clarify-kit",
   "component": "clarify-kit-facts.npm",
   "describes": {
-    "clarify-kit": "0.1.0-alpha.1"
+    "clarify-kit": "0.2.0-alpha.1"
   },
   "publish": {
     "target": "npm",
@@ -447,6 +447,29 @@
               "exit": "有任何問題時結束碼為 1"
             }
           }
+        },
+        {
+          "since": "0.2.0-alpha.1",
+          "content": {
+            "value": {
+              "codes": {
+                "missing-required-section": "文件缺範本的必要段落",
+                "unknown-fact-reference": "區塊引用不存在的 fact",
+                "supersedes-unknown": "`supersedes` 指向不存在的 decision",
+                "scenario-without-fact": "requirement 的驗收情境沒有引用 fact",
+                "outside-entry": "`*.doc.ts` 不在任何 entry 底下",
+                "load-error": "`index.ts` 或 `*.doc.ts` 載入失敗，或預設匯出不是文件",
+                "duplicate-document-id": "同一個 entry 內有兩份文件的 `id` 相同"
+              },
+              "scope": {
+                "supersedes-unknown": "`supersedes` 只在同一個 entry 的 decision 之間解析",
+                "unknown-fact-reference": "到設定檔 `factSources` 列的 facts 套件找，找法見 `clarify-kit.check.fact-lookup`，pending 列也算存在"
+              },
+              "stable": "`code` 穩定，訊息給人看",
+              "output": "每筆問題含 `code`、`message` 與 `location`",
+              "exit": "有任何問題時結束碼為 1"
+            }
+          }
         }
       ],
       "source": {
@@ -457,7 +480,6 @@
           "codes": {
             "missing-required-section": "文件缺範本的必要段落",
             "unknown-fact-reference": "區塊引用不存在的 fact",
-            "adopted-content-changed": "已採納的 decision 或寫完的 record 內文與雜湊不同",
             "supersedes-unknown": "`supersedes` 指向不存在的 decision",
             "scenario-without-fact": "requirement 的驗收情境沒有引用 fact",
             "outside-entry": "`*.doc.ts` 不在任何 entry 底下",
@@ -466,8 +488,7 @@
           },
           "scope": {
             "supersedes-unknown": "`supersedes` 只在同一個 entry 的 decision 之間解析",
-            "unknown-fact-reference": "到設定檔 `factSources` 列的 facts 套件找，找法見 `clarify-kit.check.fact-lookup`，pending 列也算存在",
-            "adopted-content-changed": "文件帶 `contentHash` 就比對，不看狀態"
+            "unknown-fact-reference": "到設定檔 `factSources` 列的 facts 套件找，找法見 `clarify-kit.check.fact-lookup`，pending 列也算存在"
           },
           "stable": "`code` 穩定，訊息給人看",
           "output": "每筆問題含 `code`、`message` 與 `location`",
@@ -511,7 +532,7 @@
         "cli"
       ],
       "title": "CLI 指令清單",
-      "description": "`clarify-kit` 提供 build、check、pin、render 與 adopt 五個指令。",
+      "description": "`clarify-kit` 的 CLI 指令清單。",
       "variants": [
         {
           "since": "0.1.0-alpha.1",
@@ -527,6 +548,20 @@
               ]
             }
           }
+        },
+        {
+          "since": "0.2.0-alpha.1",
+          "content": {
+            "value": {
+              "binary": "clarify-kit",
+              "commands": [
+                "build",
+                "check",
+                "pin",
+                "render"
+              ]
+            }
+          }
         }
       ],
       "source": {
@@ -539,8 +574,7 @@
             "build",
             "check",
             "pin",
-            "render",
-            "adopt"
+            "render"
           ]
         }
       }
@@ -665,6 +699,10 @@
           }
         }
       ],
+      "when": {
+        "deprecatedIn": "0.2.0-alpha.1",
+        "removeIn": "0.2.0-alpha.1"
+      },
       "source": {
         "kind": "published"
       },
@@ -711,6 +749,25 @@
               "keeps": "帶 `pending` 的文件、段落與區塊不動，其餘的 `since` 也不動；功能落地時作者先拿掉 `pending`，下一次 pin 才會釘版號。雜湊排除 `since` 與 `pending`，所以 pin 與拿掉標籤都不影響採納後內文的雜湊"
             }
           }
+        },
+        {
+          "since": "0.2.0-alpha.1",
+          "content": {
+            "value": {
+              "usage": "clarify-kit pin --version <v> [--config <file>]",
+              "does": "把 `docsDir` 底下 `*.doc.ts` 裡文件、段落與區塊的 `since: next` 換成版號 `<v>`，用法同 `fact-kit pin`",
+              "flags": {
+                "--version": "必填，要釘上的版號",
+                "--config": "設定檔路徑"
+              },
+              "exitCodes": {
+                "0": "成功",
+                "1": "找到問題或操作被拒絕",
+                "2": "沒給 `--version` 或版號不是 semver"
+              },
+              "keeps": "帶 `pending` 的文件、段落與區塊不動，其餘的 `since` 也不動；功能落地時作者先拿掉 `pending`，下一次 pin 才會釘版號。"
+            }
+          }
         }
       ],
       "source": {
@@ -729,7 +786,7 @@
             "1": "找到問題或操作被拒絕",
             "2": "沒給 `--version` 或版號不是 semver"
           },
-          "keeps": "帶 `pending` 的文件、段落與區塊不動，其餘的 `since` 也不動；功能落地時作者先拿掉 `pending`，下一次 pin 才會釘版號。雜湊排除 `since` 與 `pending`，所以 pin 與拿掉標籤都不影響採納後內文的雜湊"
+          "keeps": "帶 `pending` 的文件、段落與區塊不動，其餘的 `since` 也不動；功能落地時作者先拿掉 `pending`，下一次 pin 才會釘版號。"
         }
       }
     },
@@ -1028,6 +1085,33 @@
               ]
             }
           }
+        },
+        {
+          "since": "0.2.0-alpha.1",
+          "content": {
+            "value": {
+              "kind": "decision",
+              "lifecycle": "record",
+              "states": {
+                "proposed": "提案中",
+                "accepted": "已採納",
+                "rejected": "已否決",
+                "superseded": "已取代"
+              },
+              "versionField": "appliesFrom",
+              "versionRule": "開始適用的版本",
+              "specificRules": [
+                "supersedes: 用 `supersedes` 指向被取代的 decision，被取代的那份狀態改為已取代",
+                "accepted-content-frozen: 採納後內文不改，由 PR 審查把關"
+              ],
+              "covers": [
+                "ADR",
+                "PDR",
+                "組織決策",
+                "RFC"
+              ]
+            }
+          }
         }
       ],
       "source": {
@@ -1047,7 +1131,7 @@
           "versionRule": "開始適用的版本",
           "specificRules": [
             "supersedes: 用 `supersedes` 指向被取代的 decision，被取代的那份狀態改為已取代",
-            "adopted-content-frozen: 採納後內文不改，採納時寫入內文雜湊，check 重算比對"
+            "accepted-content-frozen: 採納後內文不改，由 PR 審查把關"
           ],
           "covers": [
             "ADR",
@@ -1081,6 +1165,21 @@
               ]
             }
           }
+        },
+        {
+          "since": "0.2.0-alpha.1",
+          "content": {
+            "value": {
+              "kind": "record",
+              "lifecycle": "record",
+              "states": {},
+              "versionField": "date",
+              "versionRule": "日期（`YYYY-MM-DD`）",
+              "specificRules": [
+                "written-once: 寫完不改，由 PR 審查把關"
+              ]
+            }
+          }
         }
       ],
       "source": {
@@ -1094,7 +1193,7 @@
           "versionField": "date",
           "versionRule": "日期（`YYYY-MM-DD`）",
           "specificRules": [
-            "written-once: 寫完不改，寫入雜湊的那一刻就是寫完"
+            "written-once: 寫完不改，由 PR 審查把關"
           ]
         }
       }
@@ -1133,6 +1232,10 @@
           }
         }
       ],
+      "when": {
+        "deprecatedIn": "0.2.0-alpha.1",
+        "removeIn": "0.2.0-alpha.1"
+      },
       "source": {
         "kind": "published"
       },
@@ -1374,6 +1477,67 @@
               "noOtherFields": true
             }
           }
+        },
+        {
+          "since": "0.2.0-alpha.1",
+          "content": {
+            "value": {
+              "required": [
+                "id",
+                "type",
+                "title",
+                "topics",
+                "sections",
+                "factRefs"
+              ],
+              "optional": [
+                "template",
+                "pending"
+              ],
+              "meaning": {
+                "id": "文件 id，同一個 entry 內不重複，`supersedes` 指向它",
+                "type": "`doc`、`requirement`、`decision` 或 `record`",
+                "title": "標題",
+                "topics": "主題，格式同 fact 的 `topics`，可為空陣列",
+                "sections": "內文，每段含 `id`、`title` 與 `blocks`",
+                "factRefs": "內文引用的 fact id，依第一次出現的順序排列，各一次",
+                "template": "寫成這份文件所用的範本名稱，沒用範本時不寫",
+                "pending": "只有帶這個標籤的讀取端看得到這份文件，沒標時不寫"
+              },
+              "byType": {
+                "doc": {
+                  "required": [
+                    "status"
+                  ],
+                  "optional": [
+                    "since"
+                  ]
+                },
+                "requirement": {
+                  "required": [
+                    "status",
+                    "release"
+                  ],
+                  "optional": []
+                },
+                "decision": {
+                  "required": [
+                    "status",
+                    "appliesFrom",
+                    "supersedes"
+                  ],
+                  "optional": []
+                },
+                "record": {
+                  "required": [
+                    "date"
+                  ],
+                  "optional": []
+                }
+              },
+              "noOtherFields": true
+            }
+          }
         }
       ],
       "source": {
@@ -1425,17 +1589,13 @@
                 "appliesFrom",
                 "supersedes"
               ],
-              "optional": [
-                "contentHash"
-              ]
+              "optional": []
             },
             "record": {
               "required": [
                 "date"
               ],
-              "optional": [
-                "contentHash"
-              ]
+              "optional": []
             }
           },
           "noOtherFields": true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clarify-kit-facts",
-  "version": "0.1.0-alpha.1",
+  "version": "0.2.0-alpha.1",
   "description": "Facts for clarify-kit: the document types, blocks, templates, CLI, index format and read API",
   "license": "MIT",
   "type": "module",
@@ -17,7 +17,7 @@
   ],
   "devDependencies": {
     "clarify-kit-facts.npm": "0.0.0",
-    "fact-kit": "^0.12.0",
+    "fact-kit": "^0.12.1",
     "oxc-parser": "^0.155.0"
   },
   "exports": {