@follenfang/wowdoc 0.0.8 → 0.0.10
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/README.md +13 -2
- package/README.zh-CN.md +13 -2
- package/package.json +6 -6
- package/skill/SKILL.md +2 -1
- package/skill/references/commands.md +4 -1
- package/skill/references/source-catalog.md +3 -0
package/README.md
CHANGED
|
@@ -71,7 +71,7 @@ branch / Tag / version / Commit
|
|
|
71
71
|
|
|
72
72
|
| Source | Products / channels |
|
|
73
73
|
| --- | --- |
|
|
74
|
-
| Blizzard UI source | Retail, PTR, PTR2, Beta, Classic, Classic PTR/Beta, Classic Era/PTR, Anniversary, Titan |
|
|
74
|
+
| Blizzard UI source | Retail, PTR, PTR2, Beta, Classic, Classic PTR/Beta, Classic Era/PTR, Anniversary, Titan, Forever |
|
|
75
75
|
| [ElvUI](https://github.com/tukui-org/ElvUI) | main, PTR |
|
|
76
76
|
| [WeakAuras](https://github.com/WeakAuras/WeakAuras2) | main |
|
|
77
77
|
| [NDui](https://github.com/siweia/NDui) | main, Classic, Era, Anniversary, Titan |
|
|
@@ -117,17 +117,28 @@ wowdoc diff `
|
|
|
117
117
|
```powershell
|
|
118
118
|
wowdoc validate `
|
|
119
119
|
--path D:\AddOns\MyAddon `
|
|
120
|
+
--toc MyAddon_Mainline.toc `
|
|
120
121
|
--source wow-ui-source `
|
|
121
122
|
--product retail `
|
|
122
123
|
--ref latest
|
|
123
124
|
```
|
|
124
125
|
|
|
126
|
+
With `--toc`, wowdoc validates only the ordered Lua/XML closure actually loaded by that TOC, including recursive XML `Script` and `Include` references. The JSON result includes every file's load order and sources, exact Tag and immutable Commit evidence, diagnostics, unresolved dynamic references, and static coverage counts. Omit `--toc` to retain the original recursive Lua scan.
|
|
127
|
+
|
|
128
|
+
Validate several client TOCs together with a matrix file:
|
|
129
|
+
|
|
130
|
+
```powershell
|
|
131
|
+
wowdoc validate-matrix --config wowdoc.matrix.json
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
The matrix preserves each target result and merges API/event signatures, XML templates, Mixins, Frame types, TOC Interface evidence, target-only files, diagnostics, and unresolved items. A valid static result means no error was found by the covered checks; it is not a guarantee of perfect in-game behavior.
|
|
135
|
+
|
|
125
136
|
Every successful reference identifies the source, product, requested ref, matching Tag when available, resolved Commit, repository path, line, excerpt, and content hash.
|
|
126
137
|
|
|
127
138
|
## Command map
|
|
128
139
|
|
|
129
140
|
```text
|
|
130
|
-
Search wowdoc query | explore | inspect | diff | validate
|
|
141
|
+
Search wowdoc query | explore | inspect | diff | validate | validate-matrix
|
|
131
142
|
Sources wowdoc source list | check | sync
|
|
132
143
|
Indexes wowdoc index build | refresh | status
|
|
133
144
|
Health wowdoc doctor
|
package/README.zh-CN.md
CHANGED
|
@@ -71,7 +71,7 @@ npm install -g @follenfang/wowdoc --foreground-scripts --verbose
|
|
|
71
71
|
|
|
72
72
|
| 源码 | 产品 / 通道 |
|
|
73
73
|
| --- | --- |
|
|
74
|
-
| 暴雪 UI 源码 | Retail、PTR、PTR2、Beta、Classic、Classic PTR/Beta、Classic Era/PTR、Anniversary、Titan |
|
|
74
|
+
| 暴雪 UI 源码 | Retail、PTR、PTR2、Beta、Classic、Classic PTR/Beta、Classic Era/PTR、Anniversary、Titan、Forever |
|
|
75
75
|
| [ElvUI](https://github.com/tukui-org/ElvUI) | main、PTR |
|
|
76
76
|
| [WeakAuras](https://github.com/WeakAuras/WeakAuras2) | main |
|
|
77
77
|
| [NDui](https://github.com/siweia/NDui) | main、Classic、Era、Anniversary、Titan |
|
|
@@ -117,17 +117,28 @@ wowdoc diff `
|
|
|
117
117
|
```powershell
|
|
118
118
|
wowdoc validate `
|
|
119
119
|
--path D:\AddOns\MyAddon `
|
|
120
|
+
--toc MyAddon_Mainline.toc `
|
|
120
121
|
--source wow-ui-source `
|
|
121
122
|
--product retail `
|
|
122
123
|
--ref latest
|
|
123
124
|
```
|
|
124
125
|
|
|
126
|
+
传入 `--toc` 后,wowdoc 只验证该 TOC 实际加载的有序 Lua/XML 闭包,并递归处理 XML `Script` 与 `Include`。JSON 会返回文件加载顺序和来源、精确 Tag、不可变 Commit、诊断、动态未决项和静态覆盖计数。不传 `--toc` 时继续使用原有递归 Lua 扫描。
|
|
127
|
+
|
|
128
|
+
多客户端可以通过矩阵配置一次验证:
|
|
129
|
+
|
|
130
|
+
```powershell
|
|
131
|
+
wowdoc validate-matrix --config wowdoc.matrix.json
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
矩阵保留每个目标的完整结果,并归并 API/事件签名、XML 模板、Mixin、Frame 类型、TOC Interface、各端独有文件、诊断和动态未决项。静态结果有效只表示已覆盖检查中未发现 error,不保证插件在游戏内完美运行。
|
|
135
|
+
|
|
125
136
|
查询成功后会返回 source、product、用户请求的 ref、匹配到的 Tag、实际 Commit、仓库路径、行号、代码片段和内容哈希。
|
|
126
137
|
|
|
127
138
|
## 命令一览
|
|
128
139
|
|
|
129
140
|
```text
|
|
130
|
-
检索 wowdoc query | explore | inspect | diff | validate
|
|
141
|
+
检索 wowdoc query | explore | inspect | diff | validate | validate-matrix
|
|
131
142
|
源码 wowdoc source list | check | sync
|
|
132
143
|
索引 wowdoc index build | refresh | status
|
|
133
144
|
检查 wowdoc doctor
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@follenfang/wowdoc",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.10",
|
|
4
4
|
"description": "Auditable WoW UI source intelligence CLI for coding agents",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -21,11 +21,11 @@
|
|
|
21
21
|
"LICENSE"
|
|
22
22
|
],
|
|
23
23
|
"optionalDependencies": {
|
|
24
|
-
"@follenfang/wowdoc-darwin-arm64": "0.0.
|
|
25
|
-
"@follenfang/wowdoc-darwin-x64": "0.0.
|
|
26
|
-
"@follenfang/wowdoc-linux-arm64": "0.0.
|
|
27
|
-
"@follenfang/wowdoc-linux-x64": "0.0.
|
|
28
|
-
"@follenfang/wowdoc-win32-x64": "0.0.
|
|
24
|
+
"@follenfang/wowdoc-darwin-arm64": "0.0.10",
|
|
25
|
+
"@follenfang/wowdoc-darwin-x64": "0.0.10",
|
|
26
|
+
"@follenfang/wowdoc-linux-arm64": "0.0.10",
|
|
27
|
+
"@follenfang/wowdoc-linux-x64": "0.0.10",
|
|
28
|
+
"@follenfang/wowdoc-win32-x64": "0.0.10"
|
|
29
29
|
},
|
|
30
30
|
"scripts": {
|
|
31
31
|
"postinstall": "node scripts/install.mjs",
|
package/skill/SKILL.md
CHANGED
|
@@ -9,11 +9,12 @@ Translate the user's wording into explicit `source`, `product`, `ref`, `topic`,
|
|
|
9
9
|
|
|
10
10
|
1. Run `wowdoc source list --source SOURCE --product PRODUCT` when source, product, or available versions are uncertain.
|
|
11
11
|
2. Prefer an exact displayed plugin version. The CLI maps it only to an exact Tag and immutable Commit.
|
|
12
|
-
3. Use one read command: `query` for a focused question, `explore` for a subsystem, `inspect` for a known symbol/path, `diff` for two versions, or `validate` for
|
|
12
|
+
3. Use one read command: `query` for a focused question, `explore` for a subsystem, `inspect` for a known symbol/path, `diff` for two versions, `validate --toc` for one client AddOn load closure, or `validate-matrix` for multiple client TOCs. Omit `--toc` only for the legacy recursive Lua scan.
|
|
13
13
|
4. If the CLI returns `snapshot_not_ready`, run only the listed `source sync` and `index build|refresh` steps, then retry the original read command.
|
|
14
14
|
5. If an exact plugin version returns `version_not_found`, keep the same source and product, run `source check`, synchronize and refresh if needed, then query `latest`. Mark the answer with `requestedVersion`, `matchedTag=null`, `resolutionMode=latest_fallback`, product branch, resolved Commit, and state that the evidence is from latest rather than the requested version.
|
|
15
15
|
6. Do not apply latest fallback to `ambiguous_version`, `unsupported_build`, `ref_not_found`, or update failures.
|
|
16
16
|
7. Cite `sourceId`, product, Tag when present, resolved Commit, path, line, and the returned excerpt. Treat `dynamic-unresolved` edges as unresolved, not exact.
|
|
17
|
+
8. A successful static validation means the reported checks found no error. Never describe it as a guarantee that the AddOn runs perfectly in game.
|
|
17
18
|
|
|
18
19
|
The data directory defaults to `~/.wowdoc`. `WOWDOC_HOME` may override it with another writable path for an isolated workspace, another drive, or a server deployment. This changes only wowdoc's source, index, object, lock, and log storage; it does not change the npm installation directory or the Skill directory. Run `wowdoc doctor` to see the resolved data directory.
|
|
19
20
|
|
|
@@ -6,7 +6,8 @@ wowdoc explore --source SOURCE --product PRODUCT --ref REF --topic TOPIC --text
|
|
|
6
6
|
wowdoc inspect --source SOURCE --product PRODUCT --ref REF --symbol QUALIFIED_NAME
|
|
7
7
|
wowdoc inspect --source SOURCE --product PRODUCT --ref REF --path REPOSITORY_PATH
|
|
8
8
|
wowdoc diff --source SOURCE --product PRODUCT --from REF --to REF
|
|
9
|
-
wowdoc validate --path ADDON_DIR --source SOURCE --product PRODUCT --ref REF
|
|
9
|
+
wowdoc validate --path ADDON_DIR --toc TOC_FILE --source SOURCE --product PRODUCT --ref REF
|
|
10
|
+
wowdoc validate-matrix --config MATRIX_JSON
|
|
10
11
|
wowdoc source list --source SOURCE --product PRODUCT
|
|
11
12
|
wowdoc source check --source SOURCE --product PRODUCT
|
|
12
13
|
wowdoc source sync --source SOURCE --product PRODUCT
|
|
@@ -24,6 +25,8 @@ wowdoc uninstall --yes
|
|
|
24
25
|
|
|
25
26
|
Use exact qualified identifiers when known. For natural-language questions, select a topic and use the narrowest stable identifier, event, template, TOC field, asset path, or API name present in the question. Prefer results marked `exact_symbol`; verify relationship confidence and retain the returned excerpt as evidence.
|
|
26
27
|
|
|
28
|
+
Use `validate --toc` when a client TOC is known. It limits checks to that TOC's ordered Lua/XML load closure. Use `validate-matrix` when the AddOn declares multiple client TOCs. Keep `unresolved` items unresolved, and describe `valid: true` as no error found by the reported static checks rather than proof of perfect in-game behavior. Omit `--toc` only when the caller intentionally wants the legacy recursive Lua scan.
|
|
29
|
+
|
|
27
30
|
## Data directory
|
|
28
31
|
|
|
29
32
|
Without configuration, all source mirrors, objects, indexes, manifests, locks, logs, and temporary worktrees live under `~/.wowdoc`.
|
|
@@ -6,9 +6,12 @@
|
|
|
6
6
|
| `wow-ui-source` | `ptr`, `ptr2`, `beta` | matching channel | Channel is separate from build |
|
|
7
7
|
| `wow-ui-source` | `classic`, `classic-ptr`, `classic-beta` | matching classic channel | Do not infer compatibility from branch name |
|
|
8
8
|
| `wow-ui-source` | `classic-era`, `classic-era-ptr`, `anniversary`, `titan` | matching channel | Titan is its own product |
|
|
9
|
+
| `wow-ui-source` | `forever` | `forever` | 1.60 line (e.g. `1.60.1`); do not infer compatibility from branch name |
|
|
9
10
|
| `elvui` | `main`, `ptr` | matching branch | Version input such as `15.18` maps exactly to Tag `v15.18` |
|
|
10
11
|
| `weakauras` | `main` | `main` | Current source supports its declared TOCs; check the selected snapshot |
|
|
11
12
|
| `ndui` | `main`, `classic`, `era`, `anniversary`, `titan` | `master`, `Classic`, `Era`, `Anniversary`, `Titan` | Tags are filtered by product branch reachability and product-line rule |
|
|
12
13
|
| `ellesmereui` | `main` | `main` | Retail-oriented suite; version input maps to `v` Tag |
|
|
13
14
|
|
|
14
15
|
The version truth is `Tag -> Commit -> source snapshot`. Release attachments and packaged externals can differ from Tag source; describe evidence as Tag source, not an installed package reconstruction.
|
|
16
|
+
|
|
17
|
+
Interface evidence for `validate` comes from the snapshot's build `version.txt` (e.g. `1.60.1` → `16001`) plus indexed TOC entries. A `toc_interface_mismatch` against a rebuilt snapshot means the declared Interface is genuinely absent from that build.
|