16 Commits
Author SHA1 Message Date
lanyi 4f422a748e find asset 2026-09-10 23:16:36 +02:00
lanyi a25adacaee finalize 2026-09-10 21:39:32 +02:00
lanyi 5993da4ce6 ai agent 2026-09-10 19:18:15 +02:00
lanyi 3a3d70efeb ai agent 2026-09-10 17:03:10 +02:00
lanyi 90dc18a167 0.1.25 2026-08-11 23:33:21 +02:00
lanyi 19dbfe0f34 0.1.24 fix inheritFrom="type:id" 2026-08-11 20:01:33 +02:00
lanyi 84a44bedfd fix inherit from 2026-08-11 19:42:23 +02:00
lanyi b5e055216c 0.1.22 2026-08-11 16:23:58 +02:00
lanyi 21c2275c00 fixed manifest references with same id 2026-08-11 15:17:30 +02:00
lanyi 2fd40d9d51 准备发布! 2026-08-11 12:27:37 +02:00
lanyi 2a049c7e92 0.1.21 2026-08-11 12:01:25 +02:00
lanyi dbc2c99d8d 0.1.20 2026-08-11 02:20:06 +02:00
lanyi 36eaaafa01 improve codelens 2026-08-07 13:16:50 +02:00
lanyi 47807f9fed 0.1.15 继续优化补全 2026-08-04 19:14:12 +02:00
lanyi f8187da611 0.1.13 improve completion 2026-08-04 17:53:11 +02:00
lanyi 6794896ac7 0.1.9 2026-08-04 14:28:26 +02:00
119 changed files with 24412 additions and 777 deletions
+2
View File
@@ -11,6 +11,8 @@ debug.log
docs/**
OpenSAGE/**
test/**
images/**
!images/icon.png
**/*.map
tsconfig.json
esbuild.mjs
+121
View File
@@ -0,0 +1,121 @@
# Changelog
## 0.1.26 — 2026-09-10
### Added
- **AI Agent access (MCP).** `RA3 Mod XML: Enable AI Agent access…` exposes the
semantic index to AI agent clients through a local, read-only MCP (Model
Context Protocol) server. It exports a stable snapshot, writes a launcher
under `~/.ra3modxml/`, starts a loopback query server while VS Code is
running, and offers to install the Agent Skill and/or write the MCP client
configuration (Claude Desktop, Cursor global/project, or a copied generic
block). `Disable AI Agent access` stops the live server for the workspace;
`Uninstall AI Agent integration…` removes MCP config entries, the launcher,
and Skill copies after a confirmation prompt.
- **Agent Skill (`ra3-mod-xml`).** `RA3 Mod XML: Install Agent Skill…` installs
`SKILL.md` plus a query-tool reference to `~/.agents/skills/`, and optionally
to Claude Code or project-local skill directories. It explains when the index
applies and how to reach it with or without MCP. `Uninstall Agent Skill…`
removes only directories that still carry the extension's marker.
- **`RA3 Mod XML: Export AI Agent index snapshot`** writes the gzipped,
versioned snapshot that the MCP server and CLI fall back to when VS Code is
closed.
- **Agent CLI** (`dist/agent/cli.js`): live-index first, exported-snapshot
fallback. `outgoing` and `projects` need element context and report that
explicitly instead of returning an empty result.
- **First-run / upgrade introduction.** After the first index, the extension
offers AI Agent access once (per machine). Upgrades from a build that already
had the feature stay silent, and "Don't show again" is remembered.
- **Live discovery and multi-window safety.** Per-project endpoint files, one
`instances/` entry per VS Code window, and a merged `~/.ra3modxml/index.json`.
Queries are pinned to a project and a mismatched answer is refused. A crashed
window's instance file is pruned by the next activation.
- **No Node installation required.** The MCP launcher for AI Agent Access runs
the bundled server on VS Code's own Electron binary (`ELECTRON_RUN_AS_NODE=1`)
and falls back to `node` on `PATH` only when that binary is missing.
Launchers are refreshed on activation, so moving or updating VS Code does not
break an existing MCP configuration.
## 0.1.25 — 2026-08-11
### Changed
- Repository and homepage links now point to the GitHub mirror; README links to both GitHub and Gitea.
- Extension now activates in untrusted (Restricted Mode) workspaces; workspace-defined `ra3modxml.sdkPath` and `ra3modxml.additionalDataSearchPaths` are ignored until the workspace is trusted.
- **Find asset.** `RA3 Mod XML: Find asset (id or Type:Id)…` opens a search
picker over the whole index: type `Type:Id`, an exact id or a partial id and
the result list updates as you type (`Type:` alone lists every asset of that
type). Rows show the asset type, origin (project / SDK / manifest), reference
count and defining file; accepting one jumps to the definition. When a
`type:id` is defined in several places (mod override + vanilla source +
compiled manifest) a second picker chooses which definition to open. The
query can also be prefilled from the current selection through the editor
context menu entry.
### Fixed
- The editor context-menu entries were declared under a top-level `menus` key
instead of `contributes.menus`, so VS Code never showed them. Adding the new
search entry moved the block where it belongs; `Find unreferenced assets of
this type` now appears in the editor context menu as documented.
## 0.1.24 — 2026-08-11
### Fixed
- Manifest-style qualified reference values (`Type:Id`, e.g.
`inheritFrom="AudioEvent:BaseSoundEffect"`,
`Sound="AudioEvent:JAP_Refinery_Select"`, `Side="PlayerTemplate:Allies"`)
now resolve to the plain-id definitions indexed from XML (mod or
`SageXml`). Previously the plugin only applied the “last colon segment”
rule to manifest asset names, so qualified XML references were reported as
unresolved even when the definition existed (the reported
`AudioEvent:BaseSoundEffect` case).
- The same normalization now applies to simple-content references, the
semantic reverse index (Find All References / CodeLens counts), and the
reference peek path, so hover, Ctrl+click, diagnostics, reference counts
and unreferenced reports all agree.
- Value completion keeps a `Type:` prefix the user already typed:
`inheritFrom="AudioEvent:Base…` completes to
`AudioEvent:BaseSoundEffect` instead of dropping the prefix. Plain ids
without a prefix keep the previous bare-id behavior.
- `inheritFrom` is now accepted on all `BaseAssetType`-derived assets (e.g. `FXList`, `AIMicroManagerData`, `ObjectCreationList`, `OnDemandTextureImage`, `AITargetingHeuristic`). The XSD only declares it on `BaseInheritableAsset`, but vanilla and Corona data use it more broadly. Attribute legality is now separate from the CodeLens / Find All References “reference target by design” filter, so the universal attribute does not widen the code-lens type list.
- `simpleContent` complex types (`AudioFileRefWithWeight`, `MultisoundSubsoundRef`) keep their XSD attributes (`Weight`, `Volume`, `PitchShiftLow/High`, ...) and their text content (`<Sound>AudioFile</Sound>`, `<Subsound>VoiceEvent</Subsound>`) is now handled as a typed asset reference by completion, hover, navigation, diagnostics, the semantic reference index, and Find All References.
- Fragment roots whose name also appears as a nested child type (e.g. `<EvaEvent>`, `<UpgradeTemplate>`) now resolve to the top-level `AssetDeclaration` type instead of the colliding child type.
- Element-name completion for simple-content children now re-triggers value suggestions after inserting the `<Name>$1</Name>` snippet.
### Added
- 128×128 PNG extension icon (converted from `images/icon.webp`). The `.vsix` no longer bundles the `images` folder, so the large GIF demos stay out of the package.
## 0.1.22 — 2026-08-11
### Fixed
- Manifest assets that share the same id under different types are now all kept in the by-id index. Previously the first same-id entry (e.g. `W3DHierarchy:AUMCV_HOVER`) could shadow later definitions (e.g. `W3DContainer:AUMCV_HOVER`), causing `Model@Name` and other `BaseRenderAssetType` references to be reported as unresolved even though the asset existed in `Static.manifest`.
- `xi:include` without an `xpointer` now splices the target document's root element itself (XInclude semantics), so fragments like `GenericCelestialBuildingSuicide.xml` keep their module wrapper (`CreateObjectDie`) instead of only inserting its children.
- Fragment files (documents whose root is not `AssetDeclaration`) no longer trigger standalone-document diagnostics: top-level `missing-id`, duplicate-id, unresolved-reference and undefined-define checks are skipped, unknown wrapper roots are not reported as unknown elements, and a known fragment root still validates its subtree's elements/attributes.
### Added
- Missing `xi:include` targets now surface in the Problems panel as `include-not-found` warnings for the edited document (previously only tracked in indexer diagnostics).
## 0.1.21 — 2026-08-11
### Added
- English/Chinese localization for the extension manifest, commands, settings, status bar, notifications, hover, completions, CodeLens, and diagnostics.
- `package.nls.*` and `l10n/` bundles so future languages can be added without touching source code.
- AI-generated project disclosure in both `README.md` and `README.zh-CN.md`.
### Changed
- Packaged extension now includes localization resources.
- `npm run package` no longer fails on missing repository-link rewriting.
### Fixed
- Parser errors carry stable codes and parameters so the UI layer can localize them while the parsing core stays VS Code-independent.
+60
View File
@@ -0,0 +1,60 @@
# RA3 Mod XML License
## Original code — MIT
Copyright (c) 2026 The RA3 Mod XML contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
## EA Mod SDK-derived data
The following file is generated from materials distributed with the
Command & Conquer: Red Alert 3 Mod SDK, which is owned by Electronic Arts Inc.
and its licensors:
- `src/model/schema-model.json` — generated by `tools/xsd-to-model.mjs` from
the SDK's XSD schemas.
This file is not covered by the MIT license above. It is included only for
modding interoperability and remains subject to the EA Tools & Materials
End User License. "Command & Conquer" and "Red Alert 3" are trademarks of
their respective owners.
This extension does not bundle the RA3 Mod SDK; the SDK must be installed
separately by the user.
## OpenSAGE-derived files — LGPL-3.0
The following files are derived from OpenSAGE
(<https://github.com/OpenSAGE/OpenSAGE>), which is licensed under the GNU
Lesser General Public License version 3:
- `src/indexer/manifestParser.ts` — ported from
`src/OpenSage.Game/Data/StreamFS/ManifestFile.cs`.
- `src/model/asset-types.json` — extracted from
`src/OpenSage.Game/Data/StreamFS/AssetType.cs`.
These files are licensed under LGPL-3.0. The full license text is available at
<https://www.gnu.org/licenses/lgpl-3.0.html> and in the vendored OpenSAGE copy
at `OpenSAGE/LICENSE.md`.
## Other files
Unless stated otherwise above, all other files in this repository are
licensed under the MIT license above.
+310 -76
View File
@@ -1,100 +1,334 @@
# RA3 Mod XML(VS Code 扩展)
> This site is not endorsed by or affiliated with Electronic Arts, or its licensors. Trademarks are the property of their respective owners. Game content and materials copyright Electronic Arts Inc. and its licensors. All Rights Reserved.
>
> RA3 Mod XML is an unofficial player-made tool. It requires a separately installed RA3 Mod SDK.
面向《命令与征服:红色警戒 3》Mod XML(SAGE / BinaryAssetBuilder 格式)的 VS Code 工具扩展。
[**English**](README.md) | [中文](README.zh-CN.md)
## 功能
# RA3 Mod XML
- **语法高亮**:在普通 XML 高亮之上叠加领域标记(`$DEFINE` 常量、`inheritFrom`、`xai:joinAction`、结构标签);XML 语法异常(如未闭合引号)期间由语义 token 兜底,标签/属性/值着色不中断。
- **自动补全**:
- 元素名:按当前父元素的 XSD 模型补全子元素;顶层资产(`AssetDeclaration` 内)补全 `GameObject`、`WeaponTemplate` 等 295 种类型。
- 属性名:必填属性优先,附带类型/文档/默认值;自动提示 `xai:joinAction` 与 `xmlns:xai`。
- 属性值:
- 引用型属性(如 `CommandSet`、`Weapon`)按 `xas:refType` 补全对应类型的资产 ID(**同名 ID 只补全匹配类型**);
- `inheritFrom` 补全可继承的资产 ID;
- 枚举与位标志列表(如 `Include type`、`LocomotorTemplate@Surfaces`、`KindOf`;列表值支持空格后继续补全下一项);
- 布尔值、`$DEFINE` 常量;
- `<Include source>` 补全可解析的 `DATA:` / `ART:` / `AUDIO:` 与项目相对路径。
- **悬停提示**:元素/属性显示 XSD 文档、类型、必填/默认值;引用值显示定义位置;`$DEFINE` 显示值与定义位置;`Include source` / `xi:include href` 显示解析后的目标文件;`xi:include` 元素与属性给出 XInclude 说明。
- **引用导航**:从引用值(`CommandSet="..."`、`Weapon="..."`、`inheritFrom`)跳转到定义(严格按引用类型过滤,候选由 `ra3modxml.definitionMode` 控制:`all` 列出 mod + 原版、`project-only` 优先项目内定义);`Ctrl+点击` Include / `xi:include href` 打开目标文件;Find All References 搜索整个工作区;文档大纲列出顶层资产与 `$DEFINE`。
- **错误检查**:XML 格式错误、未知元素/属性(`xi:` 等外来命名空间不误报)、顶层资产缺 `id`、重复 ID、未解析引用(含类型不匹配)、Include / 嵌套 `xi:include` 目标找不到、`$DEFINE` 未定义。
- **manifest 支持**:`<Include type="reference">` 指向的 `static/global/audio.manifest`(SDK `builtmods`)会被解析,manifest 中的原版资产 ID 可用于补全/悬停/导航/诊断。
- **美术资产(`.w3x`)**:`W3X.xml` / `ART:` include 链中的 `.w3x` 模型文件会被
索引(`W3DContainer` / `W3DMesh` / `W3DHierarchy` 等顶层资产),因此
`Model@Name`、`Hierarchy`、`Mesh` 等引用可以解析、悬停与跳转。超大模型
(几十 MB 的顶点/三角形数据)采用浅扫描——只提取顶层资产记录、不建 DOM 树,
结果在 workspace 级缓存并跨重建复用,保存文件触发的重建不会重读未变化的模型文件。
- **大项目性能**:索引记录(资产 / Define / Include / 行号)与 include 解析结果
跨重建缓存,保存触发的重建零 stat、零重读(Corona 实测约 2 秒);DOM 树只按需
保留并设元素预算,避免内存膨胀。
> **AI-generated project**
>
> This extension was generated almost entirely by AI. As a result, there may be unexpected bugs or edge cases. Bug reports, corrections, and feedback are very welcome.
## 使用
A VS Code extension that brings **IntelliSense, navigation, reference tracking, and diagnostics** to XML-based mods for **Command & Conquer: Red Alert 3**.
1. 用 VS Code 打开 RA3 Mod 项目文件夹(含 `Data/Mod.xml` 或 `mod.babproj`)。
2. 插件自动激活并开始后台索引(状态栏显示资产数量)。
3. 编辑任意 `*.xml` 即可获得补全、跳转与诊断。
It understands the RA3 Mod SDK's XML schema, asset types, references, includes, and vanilla game data — so editing a large mod feels much more like working with a real programming language.
### 设置(`settings.json`)
Source code: [GitHub mirror](https://github.com/RA3CoronaDevelopers/Ra3ModXmlExt.git) · [Gitea](https://git.ra3battle.cn/RA3CoronaDevelopers/Ra3ModXmlExt)
| 设置 | 默认值 | 说明 |
|---|---|---|
| `ra3modxml.sdkPath` | `C:\Apps\RA3-MODSDK-X` | Mod SDK 根目录 |
| `ra3modxml.indexSageXml` | `true` | 是否索引 SDK 的 `SageXml` 原版源码 |
| `ra3modxml.reportUnresolvedReferences` | `warning` | 未解析引用诊断级别(`warning`/`information`/`none`) |
| `ra3modxml.diagnoseUnknownElements` | `true` | 是否报告未知元素/属性(自定义 XSD 项目可关闭) |
| `ra3modxml.definitionMode` | `all` | 跳转候选:`all` 列出 mod 定义与原版定义(mod 优先);`project-only` 仅在项目内已有定义时直接跳转 mod 定义 |
| `ra3modxml.additionalDataSearchPaths` | `[]` | 追加的 `DATA:` 搜索目录 |
<table>
<tr>
<td align="center">
<strong>Intelligent Completion</strong><br>
<a href="https://ra3modxml-images.ratotal.workers.dev/enum_completion.gif">
<img src="https://ra3modxml-images.ratotal.workers.dev/enum_completion.gif" alt="RA3 XML intelligent completion" width="100%">
</a>
</td>
<td align="center">
<strong>Go to Definition</strong><br>
<a href="https://ra3modxml-images.ratotal.workers.dev/navigation.gif">
<img src="https://ra3modxml-images.ratotal.workers.dev/navigation.gif" alt="RA3 XML navigation" width="100%">
</a>
</td>
</tr>
</table>
### 命令
<p align="center">
<strong>Reference-aware completion</strong><br>
<a href="https://ra3modxml-images.ratotal.workers.dev/ref_completion.gif">
<img src="https://ra3modxml-images.ratotal.workers.dev/ref_completion.gif" alt="RA3 XML reference completion" width="80%">
</a>
</p>
- `RA3 Mod XML: Re-index workspace`:手动重建索引。
- `RA3 Mod XML: Show index report`:查看索引统计。
## Features
## 开发
### Intelligent Completion
Get context-aware completion based on the RA3 XML schema and project data.
* Elements and attributes based on the RA3 XSD
* Required attributes, types, documentation, and default values
* Asset references such as `Weapon`, `CommandSet`, and `inheritFrom`
* Enum values and flag lists such as `KindOf` and `Surfaces`
* Asset IDs in text-content elements such as `<CreateObject>` and `<RequiredUpgrade>`
* `DATA:`, `ART:`, and `AUDIO:` paths
* Automatic continuation when editing flag lists
Reference completion is type-aware, so an asset ID is only suggested where its asset type is valid.
### Syntax Highlighting
RA3-specific constructs are highlighted on top of the built-in XML grammar.
### Navigation & References
Navigate through a mod's asset graph directly from the editor.
* **Go to Definition** (Ctrl+Click) for asset references
* **Find All References** using semantic reference information
* **Reference CodeLens** showing how many times an asset is referenced
* Hover information for elements, attributes, references, and `$DEFINE`s
* Ctrl+Click navigation for `Include` and `xi:include`
* Document outline for top-level assets and `$DEFINE`s
### Diagnostics
Catch common modding mistakes while you edit.
* XML syntax errors
* Unknown elements and attributes
* Missing or duplicate asset IDs
* Unresolved asset references
* References to the wrong asset type
* Undefined `$DEFINE`s
### Project Analysis
The extension can analyze the entire workspace rather than only the file currently open.
**Find asset** searches the index for an asset by `Type:Id`, by exact id, or by a partial id — typed directly into the picker, with results updating as you type. The result list shows each asset's type, origin (project / SDK / manifest), reference count and defining file; accepting a result jumps to its definition. When the same `type:id` exists in several places (for example a mod override of a vanilla asset), a second picker asks which definition to open.
Run:
`RA3 Mod XML: Find asset (id or Type:Id)…`
You can also select an id in the editor and use the context menu entry to search for it.
**Find unreferenced assets** lists project assets that are not referenced anywhere in the workspace, helping identify obsolete or accidentally unused definitions.
Run:
`RA3 Mod XML: Find unreferenced assets…`
You can also use the editor context menu to find unreferenced assets of the current asset type.
### Vanilla SDK Integration
The extension can use asset definitions from the **RA3 Mod SDK**, allowing vanilla game assets to participate in completion, hover information, navigation, and diagnostics.
`<Include type="reference">` manifests such as `static.manifest`, `global.manifest`, and `audio.manifest` (from the SDK's `builtmods` directory) are supported when the corresponding SDK data is available.
### Large Mod Support
Workspace indexing runs in the background and uses persistent caches to avoid rebuilding everything on every VS Code launch.
The extension has been tested on Corona Mod, a large size RA3 mod:
- 32000+ assets
- 8000+ XML files
- 3000+ W3X files
- **Full index:** ~3 minutes
- **Cached startup:** ~40 seconds to validate cached data and rebuild the in-memory index
Measurements were taken on a mechanical hard drive. Actual performance depends on hardware and project structure.
## Getting Started
1. Install the extension from the VS Code Marketplace.
2. Open your RA3 Mod project folder in VS Code.
3. Make sure the workspace contains `Data/Mod.xml`, `Data/additionalmaps/mapmetadata_*.xml`, or a `*.babproj` file.
4. Set the RA3 Mod SDK path if necessary — the extension can auto-detect an
installed SDK from the Windows registry, or you can pick the folder
manually. Leaving it empty runs the extension in project-only mode.
5. Open any `*.xml` file and start editing.
The extension automatically detects RA3 Mod workspaces and starts indexing in
the background. When the SDK is missing it shows a status-bar hint and offers
to configure the path (once per session).
## Configuration
| Setting | Default | Description |
| -------------------------------------- | ---------------------- | ------------------------------------------------------------------------------- |
| `ra3modxml.sdkPath` | *(empty)* | Path to the RA3 Mod SDK; empty disables vanilla SDK features (project-only mode) |
| `ra3modxml.indexSageXml` | `true` | Index vanilla XML definitions from the SDK's `SageXml` directory |
| `ra3modxml.reportUnresolvedReferences` | `warning` | Diagnostic level for unresolved references: `warning`, `information`, or `none` |
| `ra3modxml.diagnoseUnknownElements` | `true` | Report unknown XML elements and attributes |
| `ra3modxml.definitionMode` | `all` | Choose between project and vanilla definitions when navigating to references |
| `ra3modxml.additionalDataSearchPaths` | `[]` | Additional directories searched for `DATA:` paths |
If the SDK is installed, the extension detects it from the registry and offers
it with one click; otherwise you can set `ra3modxml.sdkPath` manually or use
the `RA3 Mod XML: Configure SDK path…` command.
An empty `ra3modxml.sdkPath` is also the default value. Leaving the setting
untouched does **not** suppress the SDK setup hint; only explicitly setting it
to an empty string opts out of SDK features permanently.
## Commands
* `RA3 Mod XML: Re-index workspace`
* `RA3 Mod XML: Show index report`
* `RA3 Mod XML: Clear caches and rebuild`
* `RA3 Mod XML: Configure SDK path…`
* `RA3 Mod XML: Show cache report`
* `RA3 Mod XML: Find asset (id or Type:Id)…`
* `RA3 Mod XML: Find unreferenced assets…`
* `RA3 Mod XML: Find unreferenced assets of this type`
* `RA3 Mod XML: Enable AI Agent access…`
* `RA3 Mod XML: Disable AI Agent access`
* `RA3 Mod XML: Install Agent Skill…`
* `RA3 Mod XML: Uninstall Agent Skill…`
* `RA3 Mod XML: Uninstall AI Agent integration…`
* `RA3 Mod XML: Export AI Agent index snapshot`
## AI Agent Access
The extension can expose its semantic asset index to AI Agent clients through
a local, read-only MCP (Model Context Protocol) server. This is optional and
does not modify `PATH` or install global commands.
Run:
`RA3 Mod XML: Enable AI Agent access…`
The command:
1. Exports a stable index snapshot for the active project.
2. Creates a stable launcher under `~/.ra3modxml/`.
3. Starts a local read-only query server while VS Code is running.
4. Offers to:
* install the `ra3-mod-xml` Agent Skill to `~/.agents/skills/` (and
optionally to Claude Code or project-local skill directories),
* write the MCP client configuration for Claude Desktop or Cursor,
* copy a generic MCP configuration block.
The MCP server prefers the live in-memory index while the extension is
running and falls back to the last exported snapshot when VS Code is closed.
The exposed tools include asset lookup, incoming semantic references,
**outgoing reference edges** (`get_asset_references`: which assets an asset
uses, through which element/attribute, and where in the XML), active-file
checks, `$DEFINE` lookup, and Include source resolution.
`get_asset_references` follows `inheritFrom` ancestors and marks the
ancestor's entries with `definedIn`, so "this unit has no `WeaponSetUpdate`,
but the base unit it inherits from does" is answerable in a single call. It is
bounded by `depth` (default 1, max 3), `targetTypes` and `maxEdges`, and
reports truncation instead of silently dropping results.
Discovery is per project (`~/.ra3modxml/endpoints/<project>.json`), so several
VS Code windows can enable agent access at the same time without shadowing each
other, and a client can never be silently answered from a different project.
Each window also registers itself under `~/.ra3modxml/instances/`, and a small
merged `~/.ra3modxml/index.json` lists the live instances and their project
roots. A window that crashes is cleaned up by whichever instance starts next —
no workspace has to be reopened first.
**No Node installation is required.** The launcher runs the bundled server on
VS Code's own Electron binary (`ELECTRON_RUN_AS_NODE=1`) and only falls back to
`node` from `PATH` if that binary is missing. The launcher is rewritten on every
activation, so updating or moving VS Code does not break an existing MCP config.
The MCP server is plain JSON-RPC over stdio, so an agent can also query the
index without any MCP setup at all by piping a request into the launcher. A
matching CLI (`cli.js`, next to `mcpServer.js` in `dist/agent/`) answers from
the live index when VS Code is running and from the exported snapshot
otherwise; commands that need element context say so explicitly rather than
returning an empty result.
### Installing and removing the integration
* `RA3 Mod XML: Install Agent Skill…` works with or without an indexed project.
The default target is the cross-agent `~/.agents/skills/ra3-mod-xml/`
convention; Claude Code (`~/.claude/skills/`), project-local `.agents/skills/`
and `.claude/skills/`, and any custom folder can be selected too.
* `RA3 Mod XML: Uninstall Agent Skill…` lists the recorded copies and removes
only directories that still carry the extension's marker. A folder the user
replaced or created by hand is never deleted.
* `RA3 Mod XML: Disable AI Agent access` stops the live query server for the
current workspace (project discovery files for this window are cleaned up).
Installed skills and MCP client configurations are kept.
* `RA3 Mod XML: Uninstall AI Agent integration…` is the cleanup wizard. It can
stop live access, remove installed Agent Skills, delete the MCP entries this
extension wrote (from the recorded files and the conventional Claude
Desktop / Cursor paths, leaving other servers untouched), and delete the
stable launcher. Nothing is removed before a confirmation prompt.
After an extension upgrade, recorded Skill copies are rewritten automatically
to the new version; directories without the extension's marker are left alone.
The first time an AI Agent feature becomes available (fresh install, or an
upgrade from an older version), the extension offers to enable it after the
first index. It never asks twice: choosing "Don't show again" — or simply
ignoring the message — is remembered, and later upgrades stay silent.
See `docs/ai-agent-integration-plan.md` for the full design and progress.
## Requirements
* Visual Studio Code
* A Red Alert 3 Mod SDK installation for full schema and vanilla asset support
* A RA3 Mod project containing `Data/Mod.xml`, `Data/additionalmaps/mapmetadata_*.xml`, or a `*.babproj` file
## Development
```powershell
npm install
npm run generate-model # 从 SDK XSD 重新生成 src/model/schema-model.json
npm test # 单元测试(tsc + node --test)
npm run build # esbuild 打包到 dist/
npm run package # 生成可安装的 .vsix
npm run generate-model # Generate the runtime schema model from the SDK XSD
npm test # Run unit tests
npm run build # Build the extension
npm run package # Create a .vsix package
```
测试夹具:`test/fixtures/minimod`(含 include、重复 ID、同名不同类型 ID、manifest 回退等场景)。
Test fixtures are located in `test/fixtures/minimod` and cover scenarios including includes, duplicate IDs, same-name/different-type IDs, and manifest fallback.
## 架构
## Architecture
```
The extension is organized around a VS Code-independent parsing and indexing core:
```text
src/
extension.ts 激活入口与 provider 注册
workspace.ts 项目检测、索引生命周期、状态栏
settings.ts 配置读取(sdkPath、definitionMode 等)
extension.ts
projectRoot.ts
workspace.ts
settings.ts
language/
xmlParser.ts 带源码偏移的轻量 XML 解析器(容错、行尾恢复)
context.ts 补全上下文分析
typeContext.ts 上下文感知元素类型解析
semanticTokens.ts 语义 token 兜底高亮(纯 TS)
xmlParser.ts
context.ts
typeContext.ts
semanticTokens.ts
model/
schemaModel.ts XSD 模型运行时(schema-model.json / asset-types.json 由 tools 生成)
schemaModel.ts
schema-model.json # Generated XSD model, bundled with the extension
asset-types.json # Generated AssetType hash table, bundled with the extension
indexer/
includeResolver.ts Include 路径解析(纯 TS,移植 check_duplicate_ids.py)
manifestParser.ts .manifest 二进制解析(移植 OpenSAGE ManifestFile.cs)
fileScanner.ts 目录扫描与 Include source 候选
refs.ts 引用目标解析(按引用类型过滤)
shallowScan.ts .w3x 等大体积美术资产顶层浅扫描(纯 TS,不建 DOM)
records.ts 每文件紧凑索引记录(资产/Define/Include/xi + 行号)
caches.ts 跨重建持久缓存(DocumentCache / IndexRecordsCache /
IncludeResolveCache)
indexer.ts 工作区索引器(后台、缓存、记录驱动重建)
features/ completion / hover / navigation / diagnostics / semanticTokens
syntaxes/ TextMate 注入语法
tools/ XSD → 模型、AssetType 枚举提取
includeResolver.ts
existence.ts
manifestParser.ts
fileScanner.ts
refs.ts
referenceIndex.ts
xpointer.ts
logicalTree.ts
localScope.ts
shallowScan.ts
records.ts
caches.ts
diskCache.ts
indexer.ts
types.ts
features/
completion.ts
hover.ts
navigation.ts
references.ts
codeLens.ts
unreferenced.ts
diagnostics.ts
semanticTokens.ts
syntaxes/
ra3modxml.tmLanguage.json # Injected domain grammar (keeps the built-in XML grammar)
tools/
xsd-to-model.mjs # Generates schema-model.json from the SDK XSD
extract-asset-types.mjs # Extracts AssetType hashes from OpenSAGE
```
解析/索引核心不依赖 VS Code API,可被其他工具复用(见 `docs/plan.md` 的远期目标:搜索与索引复用)。
## References
## 参考
- 领域说明与需求:`docs/requirements.md`
- 调研与设计决策:`docs/plan.md`
- 问题分析与修复记录:`docs/analysis-issues.md`
- Manifest 格式参考:OpenSAGE `src/OpenSage.Game/Data/StreamFS/ManifestFile.cs`(本仓库 `OpenSAGE/` 子目录,commit `d45d361`)
* OpenSAGE `ManifestFile.cs` — manifest format reference
+290
View File
@@ -0,0 +1,290 @@
> This site is not endorsed by or affiliated with Electronic Arts, or its licensors. Trademarks are the property of their respective owners. Game content and materials copyright Electronic Arts Inc. and its licensors. All Rights Reserved.
>
> RA3 Mod XML is an unofficial player-made tool. It requires a separately installed RA3 Mod SDK.
[English](README.md) | [**中文**](README.zh-CN.md)
# RA3 Mod XML
> **AI 生成项目**
>
> 本扩展几乎完全由 AI 生成,因此可能存在意外 bug 或边界情况。欢迎提交 bug 报告、修正与反馈。
一款面向 **《命令与征服:红色警戒 3》** XML 模组的 VS Code 扩展,提供 **IntelliSense、导航、引用追踪与诊断** 能力。
它理解 RA3 Mod SDK 的 XML schema、资产类型、引用、include 以及原版游戏数据——编辑大型模组的体验会更接近真正的编程语言。
源码:[GitHub 镜像](https://github.com/RA3CoronaDevelopers/Ra3ModXmlExt.git) · [Gitea](https://git.ra3battle.cn/RA3CoronaDevelopers/Ra3ModXmlExt)
<table>
<tr>
<td align="center">
<strong>智能补全</strong><br>
<a href="https://ra3modxml-images.ratotal.workers.dev/enum_completion.gif">
<img src="https://ra3modxml-images.ratotal.workers.dev/enum_completion.gif" alt="RA3 XML 智能补全" width="100%">
</a>
</td>
<td align="center">
<strong>转到定义</strong><br>
<a href="https://ra3modxml-images.ratotal.workers.dev/navigation.gif">
<img src="https://ra3modxml-images.ratotal.workers.dev/navigation.gif" alt="RA3 XML 导航" width="100%">
</a>
</td>
</tr>
</table>
<p align="center">
<strong>引用感知补全</strong><br>
<a href="https://ra3modxml-images.ratotal.workers.dev/ref_completion.gif">
<img src="https://ra3modxml-images.ratotal.workers.dev/ref_completion.gif" alt="RA3 XML 引用补全" width="80%">
</a>
</p>
## 功能特性
### 智能补全
基于 RA3 XML schema 与项目数据,提供上下文感知的补全。
* 基于 RA3 XSD 的元素与属性
* 必填属性、类型、文档与默认值
* 资产引用,如 `Weapon`、`CommandSet` 与 `inheritFrom`
* 枚举值与标志位列表,如 `KindOf` 与 `Surfaces`
* 文本内容元素中的资产 ID,如 `<CreateObject>` 与 `<RequiredUpgrade>`
* `DATA:`、`ART:` 与 `AUDIO:` 路径
* 编辑标志位列表时的自动续写
引用补全是类型感知的,因此资产 ID 只会在其类型有效的位置被提示。
### 语法高亮
在保留内置 XML 语法的基础上,额外高亮 RA3 特有的结构。
### 导航与引用
直接在编辑器中浏览模组的资产关系图。
* 资产引用的**转到定义**(Ctrl+Click)
* 基于语义引用信息的**查找所有引用**
* **引用 CodeLens**:显示资产被引用了多少次
* 元素、属性、引用与 `$DEFINE` 的悬停信息
* `Include` 与 `xi:include` 的 Ctrl+Click 导航
* 顶层资产与 `$DEFINE` 的文档大纲
### 诊断
在编辑时发现常见的模组编写错误。
* XML 语法错误
* 未知元素与属性
* 缺失或重复的资产 ID
* 无法解析的资产引用
* 引用了错误的资产类型
* 未定义的 `$DEFINE`
### 项目分析
扩展可以分析整个工作区,而不仅仅是当前打开的文件。
**查找资产** 可以在索引中按 `类型:ID`、精确 ID 或部分 ID 搜索资产——直接在输入框中输入,结果随输入实时更新。结果列表显示资产的类型、来源(项目 / SDK / manifest)、引用次数与所在文件;选中后会跳转到其定义。当同一个 `类型:ID` 存在多处定义时(例如 mod 覆盖了原版资产),会再弹出一次选择框让你选择打开哪一处定义。
运行:
`RA3 Mod XML: Find asset (id or Type:Id)…`
你也可以在编辑器中选中一个 ID,然后用右键菜单直接搜索它。
**查找未引用的资产** 会列出工作区中任何地方都未被引用的项目资产,帮助识别过时或意外未使用的定义。
运行:
`RA3 Mod XML: Find unreferenced assets…`
你也可以使用编辑器右键菜单查找当前资产类型的未引用资产。
### 原版 SDK 集成
扩展可以使用 **RA3 Mod SDK** 中的资产定义,让原版游戏资产参与补全、悬停、导航与诊断。
当对应的 SDK 数据可用时,支持 `<Include type="reference">` 引用的 manifest,例如 SDK `builtmods` 目录下的 `static.manifest`、`global.manifest` 与 `audio.manifest`。
### 大型模组支持
工作区索引在后台运行,并使用持久化缓存,避免每次启动 VS Code 时都重建全部数据。
扩展已在大型 RA3 模组日冕 Mod 上测试:
- 32000+ 资产
- 8000+ XML 文件
- 3000+ W3X 文件
- **完整索引:** 约 3 分钟
- **缓存启动:** 约 40 秒校验缓存数据并重建内存索引
以上数据在机械硬盘上测得。实际性能取决于硬件与项目结构。
## 开始使用
1. 从 VS Code Marketplace 安装扩展。
2. 在 VS Code 中打开 RA3 Mod 项目文件夹。
3. 确保工作区包含 `Data/Mod.xml`、`Data/additionalmaps/mapmetadata_*.xml` 或 `*.babproj` 文件。
4. 如有必要,配置 RA3 Mod SDK 路径——扩展可以从 Windows 注册表自动检测已安装的
SDK,也可以手动选择文件夹;留空则进入仅项目模式。
5. 打开任意 `*.xml` 文件开始编辑。
扩展会自动检测 RA3 Mod 工作区并在后台开始索引。当缺少 SDK 时,状态栏会给出提示,
并在每个会话中提供一次一键设置入口。
## 配置
| 设置 | 默认值 | 说明 |
| ----------------------------------- | ----------------------- | -------------------------------------------------------------------------------- |
| `ra3modxml.sdkPath` | *(空)* | RA3 Mod SDK 的路径;留空则禁用原版 SDK 功能(仅项目模式) |
| `ra3modxml.indexSageXml` | `true` | 索引 SDK `SageXml` 目录中的原版 XML 定义 |
| `ra3modxml.reportUnresolvedReferences` | `warning` | 无法解析引用的诊断级别:`warning`、`information` 或 `none` |
| `ra3modxml.diagnoseUnknownElements` | `true` | 报告未知的 XML 元素与属性 |
| `ra3modxml.definitionMode` | `all` | 导航引用时选择项目定义或原版定义 |
| `ra3modxml.additionalDataSearchPaths` | `[]` | 额外的 `DATA:` 路径搜索目录 |
如果已安装 SDK,扩展会从注册表检测到它并提供一键设置;也可以手动设置
`ra3modxml.sdkPath`,或使用 `RA3 Mod XML: Configure SDK path…` 命令。
`ra3modxml.sdkPath` 的默认值本身就是空字符串。**不修改该设置**不会抑制 SDK
设置提示;只有显式把它设为空字符串,才表示永久禁用 SDK 功能。
## 命令
* `RA3 Mod XML: Re-index workspace`(重新索引工作区)
* `RA3 Mod XML: Show index report`(显示索引报告)
* `RA3 Mod XML: Clear caches and rebuild`(清除缓存并重建)
* `RA3 Mod XML: Configure SDK path…`(配置 SDK 路径)
* `RA3 Mod XML: Show cache report`(显示缓存报告)
* `RA3 Mod XML: Find asset (id or Type:Id)…`(查找资产(ID 或 类型:ID)…)
* `RA3 Mod XML: Find unreferenced assets…`(查找未引用的资产…)
* `RA3 Mod XML: Find unreferenced assets of this type`(查找此类型的未引用资产)
* `RA3 Mod XML: Enable AI Agent access…`(启用 AI Agent 访问…)
* `RA3 Mod XML: Disable AI Agent access`(禁用 AI Agent 访问)
* `RA3 Mod XML: Install Agent Skill…`(安装 Agent Skill…)
* `RA3 Mod XML: Uninstall Agent Skill…`(卸载 Agent Skill…)
* `RA3 Mod XML: Uninstall AI Agent integration…`(卸载 AI Agent 集成…)
* `RA3 Mod XML: Export AI Agent index snapshot`(导出 AI Agent 索引快照)
## AI Agent 访问
扩展可以通过本地只读 MCP(Model Context Protocol)Server,把语义索引提供给 AI Agent 使用。该功能可选,不会修改 `PATH`,也不会注册全局命令。
运行:
`RA3 Mod XML: Enable AI Agent access…`
该命令会:
1. 为当前项目导出稳定的索引快照;
2. 在 `~/.ra3modxml/` 下创建稳定 launcher;
3. 在 VS Code 运行期间启动本地只读查询服务;
4. 让用户选择:
* 安装 `ra3-mod-xml` Agent Skill 到 `~/.agents/skills/`(也可选择 Claude Code 或项目级目录);
* 写入 Claude Desktop / Cursor 的 MCP 配置;
* 复制通用 MCP 配置。
MCP Server 在扩展运行时优先查询内存中的实时索引;扩展关闭后回退到最近一次导出的快照。暴露的工具包括资产定义查询、语义引用查询、**正向引用边**(`get_asset_references`:该资产用了哪些资产、通过哪个元素/属性、写在 XML 的哪一行)、文件是否有效 include、`$DEFINE` 查询以及 Include source 解析。
`get_asset_references` 会沿 `inheritFrom` 祖先链遍历,并用 `definedIn` 标出条目实际写在哪个祖先的文件里,因此"这个单位自己没有 `WeaponSetUpdate`,但它继承的基础单位有"可以在一次调用里回答。它受 `depth`(默认 1,上限 3)、`targetTypes` 与 `maxEdges` 三重限制,并在截断时显式报告,而不是静默丢弃结果。
Endpoint 按项目存放(`~/.ra3modxml/endpoints/<project>.json`),因此多个 VS Code 窗口可以同时启用 AI Agent 访问而不互相覆盖,客户端也不会被静默地用另一个项目的数据回答。每个窗口还会在 `~/.ra3modxml/instances/` 下登记自己,并由一份合并的只读 `~/.ra3modxml/index.json` 列出当前实例与项目根。崩溃残留的实例会被下一个启动的实例顺手清理,不需要先重新打开同一个工作区。
**不需要安装 Node。** launcher 使用 VS Code 自带的 Electron 二进制(`ELECTRON_RUN_AS_NODE=1`)运行内置的 MCP Server,只有在该二进制缺失时才回退到 `PATH` 上的 `node`。launcher 在每次激活时重写,所以升级或移动 VS Code 都不会让已有的 MCP 配置失效。
MCP Server 本质上就是 stdio 上的 JSON-RPC,因此 agent 也可以完全不做 MCP 配置,直接把请求管道给 launcher。另有一个配套 CLI(`cli.js`,与 `mcpServer.js` 同在 `dist/agent/`):VS Code 运行时走实时索引,否则读导出的快照;需要元素上下文的命令会明确说明,而不是返回空结果。
### 安装与移除
* `RA3 Mod XML: Install Agent Skill…` 不要求项目已建立索引。默认安装到跨 agent 的 `~/.agents/skills/ra3-mod-xml/`,也可选择 Claude Code(`~/.claude/skills/`)、项目级 `.agents/skills/` 与 `.claude/skills/`,或任意自定义文件夹。
* `RA3 Mod XML: Uninstall Agent Skill…` 列出已记录的安装位置,只删除仍带有本扩展标记的目录;被用户替换或手工创建的目录不会被删除。
* `RA3 Mod XML: Disable AI Agent access` 停止当前工作区的实时查询服务并清理本窗口的发现文件;已安装的 Skill 与 MCP 客户端配置会保留。
* `RA3 Mod XML: Uninstall AI Agent integration…` 是清理向导:可停止实时访问、移除已安装的 Agent Skill、删除本扩展写入的 MCP 配置项(来自记录文件与常规的 Claude Desktop / Cursor 路径,不会动其他 server),以及删除稳定 launcher。确认之前不会删除任何内容。
扩展升级后,记录中的 Skill 副本会自动重写到新版本;不带本扩展标记的目录不会被改写。
当 AI Agent 功能首次可用时(全新安装,或从旧版本升级),扩展会在第一次索引完成后询问是否启用。它不会反复打扰:选择"不再提示"——或者干脆忽略——都会被记住,之后的升级保持静默。
完整设计与进度见 `docs/ai-agent-integration-plan.md`。
## 环境要求
* Visual Studio Code
* 安装 Red Alert 3 Mod SDK,以获得完整的 schema 与原版资产支持
* 包含 `Data/Mod.xml`、`Data/additionalmaps/mapmetadata_*.xml` 或 `*.babproj` 文件的 RA3 Mod 项目
## 开发
```powershell
npm install
npm run generate-model # 从 SDK XSD 生成运行时 schema 模型
npm test # 运行单元测试
npm run build # 构建扩展
npm run package # 打包 .vsix
```
测试夹具位于 `test/fixtures/minimod`,覆盖 include、重复 ID、同名不同类型 ID 以及 manifest 回退等场景。
## 架构
扩展围绕一个与 VS Code 无关的解析与索引核心组织:
```text
src/
extension.ts
projectRoot.ts
workspace.ts
settings.ts
language/
xmlParser.ts
context.ts
typeContext.ts
semanticTokens.ts
model/
schemaModel.ts
schema-model.json # 生成的 XSD 模型,随扩展打包
asset-types.json # 生成的 AssetType 哈希表,随扩展打包
indexer/
includeResolver.ts
existence.ts
manifestParser.ts
fileScanner.ts
refs.ts
referenceIndex.ts
xpointer.ts
logicalTree.ts
localScope.ts
shallowScan.ts
records.ts
caches.ts
diskCache.ts
indexer.ts
types.ts
features/
completion.ts
hover.ts
navigation.ts
references.ts
codeLens.ts
unreferenced.ts
diagnostics.ts
semanticTokens.ts
syntaxes/
ra3modxml.tmLanguage.json # 注入式领域语法(保留内置 XML 语法)
tools/
xsd-to-model.mjs # 从 SDK XSD 生成 schema-model.json
extract-asset-types.mjs # 从 OpenSAGE 提取 AssetType 哈希
```
## 参考
* OpenSAGE `ManifestFile.cs` — manifest 格式参考
File diff suppressed because it is too large Load Diff
+1519 -66
View File
File diff suppressed because it is too large Load Diff
+134
View File
@@ -0,0 +1,134 @@
# 功能设计:引用计数、语义 Find All References 与未引用资产
> 状态:已实现(v0.1.16 起)。本文档记录需求分析结论、语义定义、数据流与
> 已知边界;问题排查记录仍放在 `docs/analysis-issues.md`,功能设计单独成文。
## 一、需求与结论
原始需求:
1. 在每个顶部 asset 上显示它被引用了多少次,点击后直接打开“查找所有引用”,
而不是必须通过右键菜单;
2. 能查找“某一种类型中所有没被引用的顶部 asset”。
调研结论(2026-08-05):
- XSD 模型层面,292 个有模型类型的顶层资产中:73 个有类型化引用指向它们,
28 个只能被 `inheritFrom` 指向,**191 个在模型里根本没有任何引用指向**
(设置类、地图元数据、w3x 子结构等)。对这些类型,“0 引用”是唯一正常状态。
- AttachTest 实测:625 个项目定义中 29% 是 0 引用、48% 是 1 引用。
因此“所有资产一律显示计数”会制造大量噪音,也会让用户误以为资产是孤儿。
- 结论:**计数按类型过滤**——只在“设计上应该被引用”的类型上显示
(0 也显示,因为对 GameObject 这类类型 0 是有效信号);自动注册/结构类
类型不显示。
- 旧版 Find All References 是全文搜索(正则匹配 `"id"` / `>id<`),会把
`id="X"` 定义本身、`EditorName="X"` 等非引用属性也算进去。计数如果和它
同源,必然误导;如果不同源,点击后的结果又对不上。因此本轮把 FAR 一起
升级为语义引用索引,计数与点击结果共用同一数据源。
## 二、语义定义:什么算一次“引用”
与补全 / hover / 跳转 / 诊断完全一致(`refs.ts` 是唯一判定来源):
- 带 `xas:refType` 的属性值(如 `CommandSet` → `LogicCommandSet`);
- 带 `xas:refType` 的 simple-content 文本(如 `<CreateObject>ID</CreateObject>`,
含 simpleContent 复杂类型 `<Sound>AudioFile</Sound>`、`<Subsound>VoiceEvent</Subsound>`);
- `inheritFrom`(按元素自身类型过滤);
- 无 `refType` 的 `isRef` 属性(按同名 ID 匹配任意声明类型)。
引用值本身支持原版/Mod 常用的 manifest 风格全名 `类型:ID`
(`inheritFrom="AudioEvent:BaseSoundEffect"`、`Sound="AudioEvent:..."`、
`Side="PlayerTemplate:Allies"`):解析与反向索引先按 `normalizeReferenceId`
取最后冒号段,再执行上述类型过滤;记录里的原始值与偏移保持不变。
`inheritFrom` 对 `BaseAssetType` 系资产是通用合法属性(XSD 只在
`BaseInheritableAsset` 声明,但原版数据在 `FXList` 等类型上也使用)。这里的
“合法属性”判定与“设计上应显示引用计数”的 `referenceTargetTypes()` 是分开的:
通用 `inheritFrom` 不会把每个资产类型都变成 CodeLens / 未引用报告的目标。
不算引用:
- 元素自己的 `id` 定义点(除非是 `RoadObject@id→Road` 这类跨类型 id 引用);
- Poid 管线局部引用(`ModuleId`、`AttachModuleId`、`SoundRef` 等);
- `$DEFINE` / `=` 常量值;
- 枚举、文件路径、`Include@source` / `xi:include href`;
- w3x 内部父子结构关系(`W3DMesh` 等靠结构归属,不走全局引用)。
引用索引按“类型 + id + 定义位置”精确归属,同名 ID 的不同类型定义互不串扰
(`WeaponTemplate:X` 的引用不会计到 `GameObject:X` 头上)。
## 三、数据流
```
parse DOM
│ records.ts extractIndexRecords(parse, lineMap, text)
▼
IndexRecords.references[] 每文件紧凑记录(refType / selfType / value /
│ 行号 / 起止偏移),随 records 缓存跨重建复用,
│ 并持久化到磁盘缓存(缓存版本 v3,full XML
│ 附带内容哈希;快照另发布每文件 records 哈希)
▼
indexer.ts buildReferences() 只解算本次 build 触及的文件,防止陈旧缓存泄漏
│ referenceIndex.ts buildReferenceIndex()
▼
ModIndex.references Map<定义 key, ReferenceSite[]>
├── CodeLens 计数(O(1) 查表)
├── 语义 Find All References(返回精确位置)
└── 未引用资产报告(0 引用 = 不在反向索引中)
```
引用记录在解析期就把 `refType` / `selfType` 固化下来,反向索引构建时不需要
再解析 DOM、也不需要上下文类型解析;只需对 `assetsById` 做一次查找并按类型
过滤。快照发布时(XML 阶段 + art 阶段)各构建一次反向索引,Corona 规模下
开销远小于 include 遍历。
反向索引只从**本次构建的 walk 实际消费的 records**(`ModIndexer.buildRecords`)
构建,不读共享 recordsCache:中途 watcher 失效、或 feature 通过 `readDom`
重读文件,都不会让“资产在但引用缺失”的快照出现。打开文档时 CodeLens / FAR
还会比较当前文本的 records 哈希与快照,不一致就定向 invalidate 并触发
`records-desync` 重建自愈(仅对已保存文档,未保存编辑不触发)。
## 四、CodeLens 规则
- 只对根级(`AssetDeclaration` 直接子元素)带 `id` 的资产显示;
- 只对 `isReferenceTargetType()` 为真的类型显示(类型化引用目标 +
`inheritFrom` 可继承类型;见 `refs.ts` 的 `referenceTargetTypes()`);
- 0 也显示:`0 references` / `1 reference` / `N references`;
- 点击执行 `ra3modxml.showReferences` → `editor.action.showReferences`
打开 references peek,结果与计数完全一致(不含定义本身);
- 计数除了当前定义自己的反向索引桶,还并入“manifestSource 可解析到当前
文件”的 manifest 定义桶:`manifestSource` 按 vanilla-only 搜索路径
(SDK 根 + `SageXml`)解析,mod 同名 DATA 路径不会被视为源码;manifest
资产有对应 SageXml 源码时,引用直接视作 SageXml 源码对该 asset 的引用
(Go to Definition 同样把 manifest 定义映射到 SageXml 源码);
- 索引重建完成后自动 `editor.action.codeLens.refresh`,计数不会停留在旧值。
## 五、未引用资产
- 主入口:命令面板 `RA3 Mod XML: Find unreferenced assets…`
第一步 QuickPick 选类型(只列“设计上应被引用”的类型,显示每种未引用数量),
第二步列出资产(`id — 相对路径:行号`),点击跳转到定义;
- 加速入口:编辑器右键菜单
`RA3 Mod XML: Find unreferenced assets of this type`
(仅 `editorLangId == xml && ra3modxml.active` 时显示),光标在顶部资产上
时直接预选该类型,否则回退到类型选择;
- 语义:只统计 `origin === "project"` 且非 `viaInstance` 的定义;
manifest / SDK 定义永远不参与;如果某个 id 覆盖了原版资产,来自原版/其他
流的引用同样计入(否则会把覆盖件误报成未使用)。
## 六、已知边界与后续
- 当前文档局部作用域(不在任何全局流里的文件)的引用不在全局反向索引中:
这类文件打开后 CodeLens / FAR 只反映全局流;局部链内的引用暂不计数。
- Find All References 不返回定义行本身(即使 VS Code 传入
`includeDeclaration`),因此结果数量与 CodeLens 计数严格一致。
- `AssetIdList` 等“任意资产 ID 列表”的引用语义仍未建模:整个属性值按一条
引用记录处理,与现有补全/诊断保持一致(已知缺口,后续可在 records 层扩展)。
- w3x 文件本身不提取引用记录(浅扫描无 DOM);对 w3x 资产的引用从引用它的
XML 文件捕获。
- manifest 二进制里包含 BAB 编译后的完整引用图(`AssetReferenceOffset/Count` +
8 字节 `TypeId+InstanceId` 条目),目前仍跳过。将来可解析它给原版/manifest
资产提供“编译器权威”计数;mod 源码资产在编译前没有 manifest,仍需源码级
引用索引。
- 未引用资产目前是命令 + QuickPick 的“查询”形态;如果之后想要常驻浏览,
可以再加 Tree View(更重,暂不计划)。
+301 -32
View File
@@ -1,6 +1,6 @@
# 调研结论与实施计划(已按最新代码同步更新)
> 说明:本文档随实现演进持续同步。最近一次同步(2026-08-01)对齐了实现过程中新增的模块与设计变更:BAB 精确搜索路径、manifest 类型/ID 推导、上下文感知元素类型、属性级 refType / Poid 局部引用(`id` 定义点)、精确跳转范围、嵌套 `xi:include`、注入式语法高亮等。
> 说明:本文档随实现演进持续同步。最近一次同步(2026-08-11)对齐了实现过程中新增的模块与设计变更:BAB 精确搜索路径、manifest 类型/ID 推导、上下文感知元素类型、属性级 refType / Poid 局部引用(`id` 定义点)、精确跳转范围、嵌套 `xi:include`、注入式语法高亮、bit-flag 列表补全(空格触发 / 排除已用 / 追加模式)、simple-content 元素文本引用(补全 / hover / 跳转 / 诊断 / Find All References)、语义引用索引 / CodeLens 引用计数 / 未引用资产命令、属性补全换行判定与按 id 去重、manifest 源地址按 vanilla-only 解析(避免 mod 同名 DATA 路径遮蔽)、`assetsById` 保留同 id 的不同类型 manifest 定义等。
## 一、调研结论(带证据)
@@ -24,7 +24,7 @@
- 共 **821 个 XSD / 1.5 MB**,入口 `CnC3Types.xsd`。
- 根元素 `AssetDeclaration`:`Tags` / `Includes` / `Defines` + **295 个顶层资产元素**(含内联声明)。
- 每个元素名对应一个 `complexType`,子元素用 `xs:sequence` / `xs:choice` 定义,属性用 `xs:attribute` 定义;复杂类型通过 `xs:extension` 继承(如 `BaseInheritableAsset` 提供 `inheritFrom`)。
- 每个元素名对应一个 `complexType`,子元素用 `xs:sequence` / `xs:choice` 定义,属性用 `xs:attribute` 定义;复杂类型通过 `xs:extension` 继承(XSD 中 `BaseInheritableAsset` 提供 `inheritFrom`)。实测 BAB / 原版数据也接受 `FXList`、`AIMicroManagerData`、`AITargetingHeuristic`、`ObjectCreationList` 等 `BaseAssetType` 系资产使用 `inheritFrom`,因此插件把 `inheritFrom` 作为所有资产类型的通用属性处理;“设计上应显示引用计数”的判定仍按 XSD 显式声明的可继承类型,两者分开。
- `Includes/Ref.xsd` 定义了大量带 `xas:refType="<资产类型>"` 的引用类型(如 `CommandSet` 引用 `LogicCommandSet`)→ 补全/导航按引用类型过滤的依据。
- `XmlEdit:Default` 提供默认值;`xs:enumeration` 提供枚举值。`xas:refType` 可声明在 simple type 上,也可声明在 `<xs:attribute>` 节点上(模型生成器两者都读、属性级优先)。
- `Poid`("Pipeline Object Id",`xas:isWeakRef="true"`)表示**管线局部标识**:`id` 属性定义元素自身(如 `ModuleData@id` → refType `ModuleData`);`ModuleId`、`AutoResolveBody`、`SoundRef` 等 Poid 属性引用同一资产/子树内的模块、子对象、材质——它们都不对全局资产索引做 resolved 判定。
@@ -69,7 +69,10 @@
```
src/
extension.ts 激活入口(provider 注册、索引调度、诊断调度)
workspace.ts 项目检测(Data/Mod.xml / mod.babproj)、索引生命周期、状态栏、重建防抖
projectRoot.ts 项目根发现(向上 / 容器向下 / 单文件,Data/Mod.xml、
mapmetadata_*.xml、*.babproj 标记,纯 TS 可单测)
workspace.ts 多项目状态(按文档就近选项目、惰性索引、全局串行构建队列、
共享缓存、按项目磁盘缓存、watchers、状态栏、重建防抖)
settings.ts 配置读取(sdkPath、indexSageXml、definitionMode 等)
language/
xmlParser.ts 带源码偏移的轻量 XML 解析器(格式错误定位、容错)
@@ -81,20 +84,29 @@ src/
schema-model.json 由 tools/xsd-to-model.mjs 生成
asset-types.json 由 tools/extract-asset-types.mjs 生成(TypeId 哈希→类型名)
indexer/
includeResolver.ts Include 路径解析(纯 TS,BAB /data /art /audio 顺序)
includeResolver.ts Include 路径解析(纯 TS,BAB /data /art /audio 顺序)+
manifest 源 vanilla-only 解析(SDK 根 + SageXml)
existence.ts 文件集存在性快照(目录枚举 Set,替代逐路径 statSync)
manifestParser.ts .manifest 二进制解析 + 类型/ID 推导(纯 TS)
fileScanner.ts 目录遍历缓存 + Include source 候选收集
refs.ts 引用目标解析(按 refType / isRef / inheritFrom 过滤,纯 TS)
refs.ts 引用目标解析(属性 + 元素文本内容,按 refType / isRef /
inheritFrom 过滤,纯 TS)+ “设计上可被引用类型”判定
referenceIndex.ts 引用记录 → 反向引用索引(定义 → 引用位置)+ 未引用报告
shallowScan.ts 大体积美术资产(.w3x 等)顶层浅扫描(纯 TS,不建 DOM)
records.ts 每文件紧凑索引记录(资产/Define/Include/xi + 行号)
records.ts 每文件紧凑索引记录(资产/Define/Include/xi/引用 + 行号偏移)
caches.ts 跨重建持久缓存(DocumentCache / IndexRecordsCache /
IncludeResolveCache)
indexer.ts 工作区索引器(资产/Define/流/manifest/w3x 合并)
IncludeResolveCache)+ 失效纪元 InvalidationsEpoch
diskCache.ts 跨会话磁盘缓存(gzip JSON、原子写、多信号 stat 校验)
indexer.ts 工作区索引器(资产/Define/流/manifest/w3x 合并,
分阶段:XML → art,中间快照可发布)
types.ts 共享类型
features/
completion.ts 补全 provider(元素/属性/值,上下文感知;xs:list 多值按当前段过滤)
hover.ts hover provider
navigation.ts 定义/引用/文档链接/大纲
references.ts 语义 FAR / 引用上下文 / CodeLens 命令共享逻辑
codeLens.ts CodeLens 引用计数(类型过滤,0 也显示,点击开 references peek)
unreferenced.ts 未引用资产 QuickPick 命令 + 右键菜单入口
diagnostics.ts 实时诊断
semanticTokens.ts 语义 token provider(文档有解析错误时接管着色)
syntaxes/
@@ -104,23 +116,33 @@ tools/
extract-asset-types.mjs OpenSAGE AssetType.cs → asset-types.json
test/
fixtures/minimod 样例 Mod(include 各种情形、同名 ID、嵌套 xi:include、manifest 回退)
*.test.mjs 11 个测试文件(xmlParser / context / completion / semanticTokens /
*.test.mjs 16 个测试文件(xmlParser / context / completion / semanticTokens /
includeResolver / manifestParser / indexer / schemaModel / refs /
typeContext / manifestTypes)
typeContext / manifestTypes / referenceIndex / codeLens /
referenceProvider / projectRoot / workspaceMulti)
```
### 关键设计决策
1. **语言激活范围**:不劫持 `*.xml`。通过 `workspaceContains:**/Data/Mod.xml`、`**/*.babproj` 激活;语法高亮为**纯注入** grammar(不声明 `language`,避免覆盖内置 XML 语法)。
1. **语言激活范围与项目检测**:不劫持 `*.xml`。激活条件含 `onLanguage:xml`、
`workspaceContains:Mod.xml`、`additionalmaps/mapmetadata_*.xml`、
`**/Data/Mod.xml`、`**/Data/additionalmaps/mapmetadata_*.xml`、`**/*.babproj`;
语法高亮为**纯注入** grammar(不声明 `language`,避免覆盖内置 XML 语法)。
项目根通过 `src/projectRoot.ts` 发现:工作区文件夹向上最多 12 层、容器文件夹
向下浅扫最多 3 层(跳过 Data/Art/builtmods/.git 等)、打开的 XML 文件向上,
任一 `Data/Mod.xml`、`Data/additionalmaps/mapmetadata_*.xml`、`*.babproj`
标记命中即算项目根(大小写不敏感、最近命中者优先)。多项目按文档就近选择:
单个项目打开时立即建索引;容器/多项目时惰性建索引(活动文档所属项目先建,
其他在文档打开/首次请求时建),构建经全局串行队列避免并发写共享缓存。
2. **索引范围与默认值**:索引“项目 Data + additionalmaps + 沿 include 可达的 SageXml 原版源码”;SDK 路径默认 `C:\Apps\RA3-MODSDK-X`(可配置)。`reference` include 解析为 `builtmods` 下对应 manifest(惰性解析、按文件缓存),manifest 缺失/无效时回退到占位 XML。
**美术资产(.w3x)**:`<Include type="all">` / `ART:` 指向的 `.w3x`(及内容嗅探为
XML 的未知扩展名文件)按其顶层资产入库(`W3DContainer` / `W3DMesh` /
`W3DHierarchy` / `W3DCollisionBox` 等),使 `Model@Name`、`Hierarchy`、`Mesh`
等引用可解析;大模型文件**浅扫描**(不建 DOM),结果缓存在 workspace 级、
跨重建复用(详见设计决策 14)。
3. **manifest 资产建模**:类型优先用哈希表,未知时从名称前缀推导;可引用 ID 取最后冒号段;类型名统一走大小写规范化(`W3dContainer` ↔ `W3DContainer`),类型匹配严格遵循 XSD 继承链。
3. **manifest 资产建模**:类型优先用哈希表,未知时从名称前缀推导;可引用 ID 取最后冒号段;类型名统一走大小写规范化(`W3dContainer` ↔ `W3DContainer`),类型匹配严格遵循 XSD 继承链。`assetsById` 按 id 汇总**全部类型**的定义,去重身份为 `(type, file, line)`,同一 manifest 中同名但不同类型的美术资产(如 `W3DHierarchy:AUMCV_HOVER` 与 `W3DContainer:AUMCV_HOVER`)必须全部保留,避免 `Model@Name` 这类 `BaseRenderAssetType` 引用因先到的非渲染类型而被误判为未解析。
4. **上下文感知元素类型**:同名元素按父元素类型解析(`resolveElementType` 沿解析树逐层 `childTypeOf`,失败回退全局映射),保证 `<Weapon>` 等元素的属性/引用判定正确。
5. **引用判定与解析**:`refType` 或 `isRef` 均视为引用;带 `refType` 时严格按类型过滤(同名 ID 不串类型);`inheritFrom` 按可继承类型过滤。**局部作用域例外**(`isLocalReferenceAttribute`):`id` 是元素自身的定义点——无 refType 或 refType 与自身类型兼容时不检查、不解析(`RoadObject@id→Road` 这类跨类型 id 引用保留检查);Poid 类型属性是管线局部引用,全局索引无法判定,不检查、不解析。
5. **引用判定与解析**:`refType` 或 `isRef` 均视为引用;带 `refType` 时严格按类型过滤(同名 ID 不串类型);`inheritFrom` 按可继承类型过滤。**局部作用域例外**(`isLocalReferenceAttribute`):`id` 是元素自身的定义点——无 refType 或 refType 与自身类型兼容时不检查、不解析(`RoadObject@id→Road` 这类跨类型 id 引用保留检查);Poid 类型属性是管线局部引用,全局索引无法判定,不检查、不解析。**限定引用值**:原版/Mod 数据常用 manifest 风格全名 `类型:ID`(如 `AudioEvent:BaseSoundEffect`、`PlayerTemplate:Allies`);XML 定义侧 id 从不含冒号,所以查询统一走 `normalizeReferenceId`(取最后冒号段,与 manifest 的 `deriveAssetId` 同一规则)后再按 refType/selfType 过滤,records 仍保留原始值与偏移供导航/悬停使用。
6. **重复 ID 诊断**:与 `check_duplicate_ids.py` 一致——SageXml 不参与冲突判定,mod 覆盖原版视为正常。
7. **未解析引用诊断**:按设置严重级别报告(默认 warning);类型不匹配时给出明确文案("有同名 ID 但类型不匹配")。`definitionMode` 设置控制跳转候选:`all`(mod + 原版全部列出,mod 优先)或 `project-only`。
8. **跳转精度**:XML 定义跳转到 `id` 属性值的精确 Range;manifest 定义映射到源码文件(如 SageXml)时也在文件内精确定位;找不到再回退到记录行。
@@ -129,10 +151,16 @@ test/
11. **`xs:list` 建模与多值补全**:list 简单类型继承 itemType 的枚举 / refType / isRef /
allowsDefine 并标记 `isList`(`LocomotorSurfaceBitFlags`、`KindOfBitFlags` 等 79 个
类型、317 处属性声明受益);补全只对“最后一个空格段”过滤,替换范围只覆盖当前段,
支持 `Surfaces="GROUND ` 之后继续输入 `W` 提示 `WATER`。
支持 `Surfaces="GROUND ` 之后继续输入 `W` 提示 `WATER`。第十三轮(2026-08-04)
补全触发与编辑体验:空格注册为触发字符;列表过滤排除已出现的 flag;当前段已是
完整枚举值且没有更长变体时进入“追加模式”(零宽 range + `insertText=" FLAG"`,
可直接在闭合值末尾/中间追加);替换范围止于光标,中间插入不会删除尾部 flag。
12. **未闭合引号的行尾恢复**:起始标签扫描到 EOF 且引号未闭合时,在第一个换行处截断
标签并继续解析,未闭合只影响当前行(仍上报 `Unterminated start tag`),后续元素
的补全 / hover / 诊断不中断。
的补全 / hover / 诊断不中断。第十三轮补充:恢复出的元素带 `recoveredStartTag`
标记并补挂父链;补全上下文对“光标在恢复元素内但越过 `startTagEnd`”的情况按
`text.slice(tagStart, cursor)` 重新解析部分标签,使多行书写的未闭合属性
(如 `Disposition="`)仍可获得 attribute-value 补全,且不影响全局解析。
13. **语义 token 兜底高亮**:TextMate 对未闭合引号会把后续内容当字符串吞掉(任何
XML 编辑器皆然);扩展注册 `DocumentSemanticTokensProvider`,仅当解析报错时用
语义 token 覆盖标签名 / 属性名 / 属性值(标准 token 类型 `type` / `property` /
@@ -144,8 +172,9 @@ test/
- 全量解析内存放大约 17 倍(6.3 MB 文本 → +109 MB DOM),不可接受;`scanXmlShallow`
单次线性扫描只提取顶层 `name+id`、`<Includes>`、`<xi:include>`、`<Defines>`,
22 MB 文件 ~600 ms、保留内存≈0。
- 索引按扩展名三分:`.xml`/`.manifestxml` 全量解析(4 MB 上限不变);`.w3x` 浅扫描;
未知扩展名嗅探文件头(`<` 开头、无 NUL)决定按 XML 浅扫描或二进制登记。
- 索引按扩展名三分:`.xml` 全量解析(4 MB 上限不变);`.w3x` 浅扫描;
未知扩展名嗅探文件头(`<` 开头、无 NUL)决定按 XML 浅扫描或二进制登记
(manifest 是 `*.manifest` 二进制,不存在 `.manifestxml` 源码格式)。
- `DocumentCache` / `ShallowScanCache` 由 `ModWorkspace` 持有,每次重建传入新的
`ModIndexer`;按 `mtimeMs + size` 校验,未变化不重读。Corona 第二次构建
w3x 重扫数为 0(4,829 次缓存命中)。
@@ -164,6 +193,106 @@ test/
堆保留确认为构建期可回收垃圾,常驻 ~100MB;强制 reindex ~5-25s。
- 候选目录扫描并行化;`stats` 新增 `candidatesMs` / `walkMs` / `resolveCalls` /
`resolveCacheHits` 供索引报告定位耗时。
16. **分阶段索引与部分可用性**(第十轮,2026-08-03):索引分两阶段发布——
阶段 A(xml)只走 XML + manifest include 链,w3x 只登记进待扫队列;
阶段 B(art)浅扫描队列并继续走 w3x 内的 include。阶段 A 结束即发布
不可变快照(`snapshotIndex` 深拷贝嵌套 Map/数组),XML/枚举/语法类功能
在首建早期即可用;引用类诊断在 `!complete || stale` 时“显示但标注”
(code 为 `*-indexing`,消息注明 index incomplete)。快照携带
`complete` / `phase` / `stale`,状态栏显示阶段。
17. **构建中失效与 stale 标记**(第十轮):watcher 的 change / create /
delete 均触发防抖重建;`InvalidationsEpoch` 记录失效次数,快照发布时若
期间有失效则标记 stale,由 dirty 机制随后重建收敛;构建失败保留上一个
快照而非清空索引。
18. **多信号文件 stamp**(第十轮):`IndexedFile.stat` 扩展为
`{ size, mtimeMs, birthtimeMs, ctimeMs }`,任一不匹配即重读,为磁盘
持久化缓存铺路(FAT32 mtime 2s 粒度、工具保留 mtime 等场景)。
19. **文件集快照替代 statSync**(第十一轮,2026-08-03):`ExistenceSnapshot`
用**惰性按目录 readdir**(只读查询到的父目录,按目录缓存)回答 include
存在性,覆盖根之外才 statSync 回退;盘符根不枚举。首版全量递归枚举使
XML 阶段从 27s 涨到 45s,已改为惰性模式(复测 24.0s)。
`stats.snapshotHits / snapshotFallbacks` 入报告;Corona 首建 75,926 次
查询全部由快照回答、0 回退。
20. **磁盘持久化缓存**(第十一轮):`DiskRecordsCache` 持久化 records 缓存
(gzip JSON、原子写、identity key);启动时并发 stat 多信号校验,不匹配
丢弃重读;构建后异步回写。Corona 缓存仅 651 KB,冷启动约 11s(原
~2.5 分钟)。
21. **缓存命令**(第十一轮):`ra3modxml.clearCache`(清内存 + 磁盘 +
强制重建)、`ra3modxml.showCacheReport`(路径/大小/校验统计/命中数)。
22. **重建插桩**(第十一轮补充):`buildCount` / `lastBuildTrigger`
(initial、save、watcher-*、config、reindex、clear-cache、
dirty-followup)进入索引/缓存报告;“RA3 Mod XML” 输出通道记录每次构建
的触发原因、phase A 发布时间与完成耗时,用于定位“首建后又重建一次”
之类的现象。
23. **watcher 噪声过滤与 URI 日志**(第十一轮补充):watcher 事件把触发
URI 写入输出通道;路径含 `.git` 段的事件直接忽略(后台 fetch /
maintenance 会周期性触碰 `.git`,不应触发重建或 stale 标记)。
24. **watcher 内容白名单**(第十一轮补充):临时文件命名模式
(`.git`/`.tmp`/`.lock`/`~`/`.swp`/`.bak`/`.orig` 后缀、`.#`/`.~`
前缀)全部忽略;`onDidChange` 只响应扩展名白名单(`.xml` / `.w3x`,
RA3 合理文本格式为 xml/w3x/lua,lua 暂未索引、manifest 为二进制)或已在
索引中的文件;创建/删除仍响应所有真实文件(影响 include 存在性)。
25. **当前文档局部链 + 逻辑树展开(第十二轮,T1)**:新增 `xpointer.ts` /
`logicalTree.ts` / `localScope.ts`。打开文件时按当前文本建立局部 overlay
(自身资产 / `$DEFINE` / include 链),并生成展开 `xi:include` 的逻辑树;
features 经 `ws.getScope(document)` 拿到 overlay-aware 索引。Poid 引用
(`AttachModuleId` / `ModuleId` / `AutoResolveBody` 等)在最近 GameObject
子树内解析;未命中不新增诊断(保守策略,避免跨文件误报)。
顶层 `<Include type="all">` 暂不并入逻辑树(保留为后续扩展)。
26. **属性补全的插入布局与类型化默认值(第十四轮,2026-08-04)**:
`attributeInsertLayout` 按临近属性的排版决定插入方式——贴引号时补空格、
一行一个属性时补换行 + 缩进、已在新行时用临近缩进替换当前行空白、
inline 风格的手动换行保留用户缩进;`attributeValuePlaceholder` 对引用/
枚举/list/布尔等建议类属性保留 `$1` + 自动触发,对标量属性填 XSD 默认值
或类型示例(`0d` / `0s` / `100%` / `0.0` / `0`),具体默认值不再弹空
suggest。
第十五轮(2026-08-04)最终结论:VS Code 插入含换行的补全文本时会把当前
行基础缩进与文本内嵌缩进相加(3+3=6、6+3=9…),因此换行前缀只插入 `\n`、
缩进交给编辑器;同时半截属性名(`hasValue=false`)不再作为缩进锚点,改用
第一个独占一行的完整属性作为规范缩进,插入换行时顺带吞掉触发补全留下的
尾随空格;属性名补全改用 `SnippetString`(`$1` 成为真正占位符),并新增
输出通道调试日志。
27. **simple-content 元素文本引用(第十六轮,2026-08-04;第三十一轮扩展)**:
simple type 子元素(如 `ObjectCreationList` 内嵌套 `<CreateObject>`,类型
`GameObjectWeakRef`)以及 simpleContent 复杂类型(如 `<Sound>` →
`AudioFileRefWithWeight`、`<Subsound>` → `MultisoundSubsoundRef`)的
**标签间文本**就是资产引用。内容区补全现在区分“复杂元素 → 子元素名”与
“内容元素 → 值补全”;用户已输入 `<` 时替换范围从 `<` 开始,杜绝 `<<`;
内容元素片段固定为 `<Name>$1</Name>`(可填值)并自动触发值补全。hover /
Ctrl 跳转 / 诊断 / Find All References 均增加内容 token 分支。只有**带
`xas:refType`** 的内容按全局引用处理(291 处 simple type 子元素声明 +
`Sound` / `Attack` / `Decay` / `Subsound` 等 simpleContent 复杂类型);
无类型 `AssetReference`(`FXShaderConstantTexture@Value`、
`RenderSubObjectReference@Mesh` 等真实数据是贴图/子对象名)与 `Poid`
不参与全局解析,避免误报。
补充:真实文件中 `<` 后还有 `</…>` 时,`findTagEnd` 曾把闭合标签的 `>` 误
当成残缺开始标签的结束,生成空名/半截名伪元素,补全走 element-name 分支
导致 `<<`。修复为引号外遇到 `<` 即视为未闭合(行尾恢复),且
`elementNameItems` 的替换范围包含 `<`。实机再回归:范围含 `<` 会让 VS Code
用 `<` 做过滤前缀导致菜单为空——改为保留已输入的 `<`、range 从 `<` 之后
开始、插入文本不带开括号;`textContentTokenAt` 对未闭合元素用 `el.end`
作内容边界。
28. **语义引用索引 + CodeLens 计数 + 未引用资产(第十八轮,2026-08-05)**:
- 动机与结论:292 个有模型类型的顶层资产中 191 个在 XSD 中没有任何
类型化引用指向(设置/地图元数据/w3x 子结构等自动注册类型),
AttachTest 实测 29% 项目定义 0 引用、48% 恰好 1 引用。因此 CodeLens
计数只显示在 `isReferenceTargetType()` 为真的类型上(类型化引用目标 +
`inheritFrom` 可继承类型),0 也显示;未引用报告默认也只列这些类型。
- 数据:`IndexRecords` 增加 `references[]`
(`kind / refType / selfType / value / line / start / end`),解析期固化
引用上下文,反向索引构建零 DOM、零上下文重解析;`ModIndex.references`
为“定义 key → 引用位置”的反向表,快照发布时构建;磁盘缓存版本
v1 → v2(`index-records-v2.json.gz`),v3 起附加内容/records 哈希。
- FAR 从全文搜索改为语义索引:不再把 `id="X"` 定义行、`EditorName="X"`
等非引用属性计为引用;CodeLens 显示的计数与点击打开的 references peek
严格一致;`includeDeclaration` 时才附加定义位置。
- 未引用资产:命令面板 `Find unreferenced assets…` + 编辑器右键菜单
`Find unreferenced assets of this type`;只统计 `origin === "project"`
且非 `viaInstance` 的定义;覆盖原版 id 时来自原版/其他流的引用计入。
- 边界:局部 scope(不在全局流里的文件)的引用不入全局反向索引;
`AssetIdList` 等列表引用按整值记录;w3x 不提取引用记录(对 w3x 资产的
引用从引用它的 XML 捕获);manifest 编译期引用图(AssetReference 缓冲)
留作后续。设计文档:`docs/features-reference-counts.md`。
## 三、实施步骤
@@ -182,6 +311,127 @@ test/
9. [x] Corona 性能与内存优化(第九轮,v0.1.1):`records.ts` 记录驱动索引、
`IncludeResolveCache` 零 stat 重建、DOM 元素预算淘汰、w3x LineMap 移除、
候选并行扫描、阶段计时;Corona 信任重建 2.0s;确认首建 2.5GB 为可回收垃圾。
10. [x] 部分可用性 + 分阶段索引(第十轮,2026-08-03):T0 解耦(语法/模型
诊断、枚举/子元素补全、Include 链接无索引可用)、A/B 分阶段发布、watcher
触发重建 + 失效纪元 stale 标记、stat 多信号扩展;测试 73 → 79。
11. [x] 冷启动提速(第十一轮,2026-08-03):文件集快照替代 statSync、
磁盘持久化缓存(多信号校验、原子写)、clearCache/showCacheReport 命令;
测试 79 → 90;Corona 冷启动 ~11s。
12. [x] 惰性存在性快照 + 重建插桩(第十一轮补充,2026-08-03):全量目录枚举
改为惰性按目录 readdir(phase A 45s → 24.0s);新增 buildCount /
lastBuildTrigger 与输出通道日志;索引/缓存报告显示构建序号与触发原因。
13. [x] watcher 噪声过滤 + URI 日志(第十一轮补充,2026-08-03):输出通道
记录 `[watcher-*] <path>`;`.git` 段路径忽略;测试 90 → 91。
14. [x] watcher 内容白名单(第十一轮补充,2026-08-03):临时文件命名模式
过滤 + 内容变更扩展名白名单 + `isIndexedFile` 兜底;测试 91 → 92。
15. [x] T1 当前文档局部链 + include 展开(第十二轮,2026-08-03):局部
overlay(不在任何流里的文件也能解析自身引用)+ `xi:include` 逻辑树展开
+ Poid 局部作用域补全/悬停/跳转;测试 92 → 98。2026-08-04 补充构建期
闸门:`getScope` 在重建进行中只返回 parse-only scope,避免与 indexer
抢盘(版本 0.1.9)。
16. [x] bit-flag 列表补全修复(第十三轮,2026-08-04):空格触发字符、多行
未闭合标签的部分标签重解析(`recoveredStartTag` 标记 + 恢复元素父链)、
闭合值内追加模式与中间插入范围修复;测试 98 → 107(版本 0.1.10)。
17. [x] 属性补全插入体验(第十四轮,2026-08-04):闭合引号后自动补空格、
临近属性缩进对齐、标量属性类型化默认值;测试 107 → 111(版本 0.1.11)。
18. [x] 属性补全缩进叠加修复(第十五轮,2026-08-04):换行前缀只插入 `\n`
(编辑器自动补基础缩进,避免 3+3=6 式叠加)、完整属性锚点 + 首个独占一行
属性为规范缩进、`$1` 改为 SnippetString 占位符、输出通道调试日志、尾随
空格吞除;测试 111 → 113(版本 0.1.12–0.1.13)。
19. [x] simple-content 文本引用修复(第十六轮,2026-08-04):`<` 后补全范围
覆盖 `<`、simple type 元素片段 `<Name>$1</Name>`、简单元素内容值补全、
`refs.ts` 新增 `isReferenceContentType` / `resolveContentReferenceTargets`、
hover / 定义跳转 / 诊断 / Find All References 内容分支;
测试 113 → 121(版本 0.1.14)。实机回归补充:`findTagEnd` 引号外遇 `<`
视为未闭合 + 插入文本不带开括号(range 从 `<` 之后开始);测试 121 → 125,
再回归 125 → 128(未闭合元素内容 token)。
20. [x] simple-content 零宽边界与大列表补全(第十七轮,2026-08-04):
`>` 后光标归入内容区、已闭合元素 `end` 改为开区间;超过 400 条的
id/define/local/include 候选返回 `isIncomplete` 让 VS Code 随输入重请求;
当前文档 local 资产优先、候选 top-N 用堆避免全量排序、Include source
先排序再截断;测试 128 → 136。
21. [x] 语义引用索引 + CodeLens + 未引用资产(第十八轮,2026-08-05):
records 引用记录提取、`referenceIndex.ts` 反向索引、语义 FAR(替换全文
搜索)、CodeLens 引用计数(类型过滤、0 也显示、点击开 references peek)、
`findUnreferencedAssets` 命令 + 右键菜单、磁盘缓存 v2;
测试 136 → 146;设计文档 `docs/features-reference-counts.md`。
22. [x] FAR 定义行排除 + manifest 源引用归并(2026-08-05 修复轮):
FAR 不再因 `includeDeclaration` 附加定义行(消除“自引用”观感);
`referenceSitesForDefinition` 把 manifestSource 可解析到当前文件的
manifest 定义站点并入 CodeLens 计数(AttachTest 326 个 manifest 定义
受益);测试 146 → 147;版本 0.1.17;分析见
`docs/analysis-issues.md` 二十三。
23. [x] 引用索引与缓存同步加固(2026-08-06):反向索引改为从**构建期本地
records**(`buildRecords`)构建,不再读共享 recordsCache——中途失效、
feature `readDom` 重读都不再造成“资产在但引用缺失”;构建中 `readDom`
不再被定义跳转调用(避免污染进行中的构建);force 重建(Re-index)
对 stat 匹配的 full XML 做内容哈希校验;打开文档时比较 records 哈希,
不一致则定向 invalidate + `records-desync` 重建自愈;磁盘缓存 v2 → v3;
测试 147 → 151;分析见 `docs/analysis-issues.md` 二十四。
24. [x] 多项目支持(2026-08-07):新增纯模块 `src/projectRoot.ts`(向上 12 层 /
容器向下 3 层 / 单文件向上,`Data/Mod.xml`、`mapmetadata_*.xml`、`*.babproj`
标记,大小写不敏感、最近优先、跳过 Data/Art/builtmods/.git 等目录);
`ModWorkspace` 改为多项目状态——按文档就近选项目、单项目立即索引 /
多项目惰性索引(活动文档所属项目先建)、全局串行构建队列保护共享缓存、
磁盘缓存按项目分文件、watcher 事件按路径归属调度、workspace 文件夹变化
重检、激活事件补 mapmetadata 与打开 Data 文件夹场景;测试 151 → 168。
25. [x] 属性补全换行判定与值补全去重(2026-08-07):`attributeInsertLayout`
只按光标之前的完整属性判断“是否已在新行”,one-per-line 标签中间插入或
首属性新行补全不再多插换行,同一行第二个属性仍按原规则换行;
`assetIdItems` 按 id 去重(局部 overlay / 全局索引 / manifest 同一 ID
只给一项,其余定义列入文档说明),`defineItems` 同步按名去重;
测试 168 → 173;版本 0.1.20;分析见 `docs/analysis-issues.md` 二十五。
26. [x] 磁盘缓存可观测性、分阶段校验与进度显示(2026-08-08):
`DiskRecordsCache` 拆为 `load()`(读 + gunzip + JSON)与 `validate()`(逐文件
stat,带进度回调);冷启动**先校验 XML/full 记录再构建**,美术/shallow
记录先以 `validated:false` 预播种(phase A 只登记不消费,避免 stat 2.6GB
模型),在 phase A 发布后的回调里校验并进入 phase B——phase A 可用时间
从 ~34s 提前到 ~16s,且不牺牲“未校验缓存不可信”的正确性(曾尝试构建后
后台校验,既有 I/O 争用又无法事后发现 stat 不可见变化,已放弃);
校验进度写入状态栏(`validating cache N/M…`)并每 1000 条输出一行日志;
`DiskCacheLoadStats` 增加 `loadMs` / `validateMs`,输出通道新增
`[disk-cache] loaded / validated / saved` 计时与 `[build] wall time`
(含缓存加载的总耗时),cacheReport 与状态栏 tooltip 展示校验耗时;
输出通道所有日志行自动加本地 `HH:mm:ss.mmm` 时间戳(`ModWorkspace.log`);
修复构建完成后状态栏仍显示 indexing(`building` 置 false 后补一次
`updateStatusBar()`);测试 173 → 175;分析见
`docs/analysis-issues.md` 二十六。
27. [x] CodeLens 与 FAR 使用同一套定义合并路径(2026-08-10):CodeLens
改为通过 `getScope(document)` 取 merged index,并用
`definitionsForReference`(文档 local overlay + 全局同名定义)+
`collectReferenceSites` 计算计数,与 Find All References 严格一致;
点击 lens 打开的 references peek(`showReferencesForDef`)同步改为
同一逻辑,修复“FAR 有引用但 WeaponTemplate 等 CodeLens 不显示/为 0”
的 standalone / 未进全局流文件场景;`scheduleRebuildIfRecordsDesync`
在 CodeLens 中也改用 `recordsSyncSurfaceFor(document)`(按文档所属
项目自愈)。补充:CodeLens 改用轻量 `getCodeLensScope`(只解析当前
文档 + 挂全局索引,不展开 include 链),快照发布后计数即时刷新;
仅在尚无全局快照(`stats.indexedFiles === 0`)时不渲染 CodeLens,
快照存在后“0 references”仍按设计显示;新增 `onDidChangeCodeLenses`
事件在每次快照发布时主动通知 VS Code 重新查询(不再只依赖 refresh
命令);输出通道增加 `[codelens] refresh`(快照发布时低频记录)、
`[codelens] suppressed`(首个快照前每个文档只记一次)、scope 异常与
超过 250ms 的慢调用记录;另加**全局重试定时器**:构建期间每 2s 重新
fire 一次 CodeLens 刷新(`onBuildStart` 启动、`!isBuilding` 停止),
避免 VS Code 合并/漏掉单次 refresh 事件导致 phase A 计数迟迟不出现;
定时器只在构建期存在,构建结束即清除;测试 175 → 178;分析见
`docs/analysis-issues.md` 二十七。
28. [x] manifest 源地址按 vanilla-only 解析(2026-08-10):新增
`buildVanillaSearchPaths(sdkDir)`,`manifestSource` 只按
`[SDK根, SDK\SageXml]`(ART/AUDIO 同理)解析,不再使用当前项目 BAB
顺序;修复 mod 同名 `DATA:globaldata/weapon.xml` 遮蔽导致 manifest
定义跳不到 SageXml 的问题;`referenceIndex` 的 manifest 源归并同步
修正;SageXml 源缺失时保持 manifest-only,文件存在但 id 被删时降级
到文件顶部;测试 178 → 184;分析见 `docs/analysis-issues.md`
二十八。
29. [x] 限定引用值 `类型:ID` 归一化(2026-08-11,v0.1.24):新增
`refs.normalizeReferenceId`(取最后冒号段,与 manifest `deriveAssetId`
同一规则),应用到属性引用、simple-content 引用、语义反向索引与
FAR/CodeLens 的 `definitionsForReference`;records 仍保存原始值与
偏移;补全在已输入 `类型:` 前缀时按冒号后片段过滤并保留前缀;
实测 SageXml 5483 / Corona 3219 处 `inheritFrom="AudioEvent:..."`
等受限引用全部修复;测试 219 → 226;分析见
`docs/analysis-issues.md` 三十二。
## 四、验证结果(实测)
@@ -191,7 +441,28 @@ test/
| GenEvoTest | 66 文件 | 首次 ~2.6s / 二次 ~0.4s | 35,502(manifest 35,322,w3x 浅扫 38) | 2 个流、73 个 Define;二次构建 0 重扫 / 38 缓存命中 |
| Corona | 8,976 文件 | 首次 ~250s / 信任二次 ~2s / 强制 ~5-25s | 64,868(manifest 35,322,w3x 浅扫 4,829) | 3 个流、183 个 Define、0 诊断;二次构建 statSync 0、resolveHits 15,333 |
单元测试覆盖:XML 解析(自闭合/容错/偏移/未闭合引号行尾恢复)、补全上下文(未闭合引号仍为 attribute-value、list 多值分段)、补全集成(vscode stub 下 `LocomotorTemplate@Surfaces` 未闭合引号枚举补全、空格后第二段过滤与替换范围)、语义 token(标签/属性/值范围、合法文档返回空、malformed 返回兜底 token)、include 解析(BAB 顺序、SDK 根优先于 SageXml)、manifest 二进制解析(合成 v5 样本、类型/ID 推导)、索引器(资产/Define/流/缺失 include/嵌套 xi:include)、XSD 模型(上下文类型、`childTypeOf`、大小写规范化、属性级 refType、外来命名空间判定、`xs:list` 枚举继承与 `isList` 标记)、引用过滤(`Weapon="X"` 只跳 `WeaponTemplate`、模块 `id` 定义点、Poid 局部引用、`xi:include` 不校验、`Side="Allies"` 命中 manifest 的 `PlayerTemplate`)。
单元测试覆盖:XML 解析(自闭合/容错/偏移/未闭合引号行尾恢复 + recovered
标记)、补全上下文(未闭合引号仍为 attribute-value、多行未闭合引号、list 多值
分段、闭合引号后为 attribute-name)、补全集成(vscode stub 下
`LocomotorTemplate@Surfaces` 未闭合引号枚举补全、空格后第二段过滤与替换范围、
空格后排除已用 flag、中间插入范围止于光标、闭合值末尾追加模式、`CAN_ATTACK`
前缀保护、多行未闭合 `Disposition` 完整链路、闭合引号后补空格、一行一个属性
换行缩进、新行缩进对齐、标量类型化默认值)、语义 token(标签/属性/值范围、
合法文档返回空、malformed 返回兜底 token)、include 解析(BAB 顺序、SDK 根
优先于 SageXml;manifest 源 vanilla-only:mod 同名遮蔽仍命中 SageXml、
源缺失保持 manifest-only、id 被删降级文件顶部)、manifest 二进制解析
(合成 v5 样本、类型/ID 推导)、索引器
(资产/Define/流/缺失 include/嵌套 xi:include)、XSD 模型(上下文类型、
`childTypeOf`、大小写规范化、属性级 refType、外来命名空间判定、`xs:list`
枚举继承与 `isList` 标记)、引用过滤(`Weapon="X"` 只跳 `WeaponTemplate`、
模块 `id` 定义点、Poid 局部引用、`xi:include` 不校验、`Side="Allies"` 命中
manifest 的 `PlayerTemplate`)、simple-content 文本引用(`<` 后补全不产生
`<<`、`<CreateObject>$1</CreateObject>` 片段、内容值按 refType 过滤、
内容 hover / Ctrl 跳转 / 诊断)、引用索引(records 引用提取:attr/content/
inheritFrom、排除 id/Poid/`$DEFINE`/枚举;`buildReferenceIndex` 严格类型过滤
不串同名 ID;minimod 集成:`CommandSet` / `inheritFrom` 反向命中;未引用过滤
只含 project 非 viaInstance;CodeLens 类型过滤与 0 显示;语义 FAR 排除定义
行与非引用属性)。
> 注:D: 盘移动硬盘已恢复连接;Corona 已在第八 / 九轮按上述新数据回归。
@@ -200,16 +471,11 @@ test/
- 假设 SDK 路径默认 `C:\Apps\RA3-MODSDK-X`(与 prompts 一致),可在设置中修改。
- 假设补全/导航以“文本语义分析”为主,不做完整 XSD 校验(BAB 才是权威校验器)。
- 开放:是否发布到 VS Code Marketplace(需要 publisher)——本期先保证本地 `vsce package` 可安装。
- 开放:**“宏展开”式虚拟合并**(用户提议,方向已确认):解析前先把 `xi:include`
(以及顶层 `<Include type="all">`、`inheritFrom` 继承合并)展开成不含 include 的
文档树,再对展开后的树做 XSD 校验、补全与诊断——与 BAB 编译时把整个 Mod 合并成
一份大 XML 的行为一致。展开树需携带**来源追溯**(错误/跳转仍定位到原始文件),
并处理 xpointer 子集解析与 include 循环。当前仅做到:目标文件可索引、可导航、
缺失可诊断;`xi:include` 本身不参与 XSD 校验(第五轮)。
该功能也是“GameObject 内模块 id 局部作用域解析”(第四轮遗留)的地基。
详细设计备忘见下一节。
- 开放:**“宏展开”式虚拟合并**(用户提议,方向已确认):`xi:include` 已按逻辑树
展开(第十二轮,见第六节);顶层 `<Include type="all">` 与 `inheritFrom` +
`xai:joinAction` 的深合并仍未实现,后续如需要“当前文档视角的全量合并诊断”再继续。
## 六、include 展开设计备忘(2026-08-01,待实施)
## 六、include 展开设计备忘(2026-08-01;xi:include 部分已实施于第十二轮,无 xpointer 语义与片段诊断见第二十八轮)
> 目的:集中记录 include 处理相关的现状、结论与设计,下次遇到 include 问题时从这里继续,
> 并在实施后把结果回写本节。
@@ -222,7 +488,8 @@ test/
| `reference` → builtmods manifest 解析 / 缺失回退占位 XML | 已实现 |
| 嵌套 `xi:include`(任意层级):目标可索引、缺失报 `include-not-found`、Ctrl+点击跳转、`href` hover 解析目标 | 已实现(第二轮 + 第五轮) |
| `xi:include` 及其属性不参与 XSD 校验(外来命名空间守卫 `isXsdElementName` / `isXsdAttributeName`) | 已实现(第五轮) |
| include 目标内容“虚拟合并”进父文档的逻辑树 | **未实现**(本文档主题) |
| include 目标内容“虚拟合并”进父文档的逻辑树 | 已实现 `xi:include`(第十二轮);**无 `xpointer` 时整体包含目标根元素**(第二十八轮修正);顶层 `<Include type="all">` 仍不展开 |
| 片段文件(根非 `AssetDeclaration`)的诊断 | 已实现 P0(第二十八轮):跳过顶层 id/重复/引用/define 检查;根为已知 XSD 元素时仍校验子树;根未知时只报语法与 include 缺失 |
### 2. 已确认的方向
@@ -233,9 +500,11 @@ BAB(`defaultscript.cs`)编译时正是这样把整个 Mod 合并成一份大
- **不要**把 include 目标展开成文本再整体重新解析:源码偏移会断裂,诊断 / 跳转 / hover /
补全全部无法映射回原始文件。
- **要做**的是:解析器逐文件解析(现状不变);展开器把目标文件选中节点按 `xpointer`
子集挂进父元素,节点保留各自的源文件与原始偏移(来源追溯)。后续分析跑在逻辑树上,
范围映射按节点 `sourceFile` 回到对应文件的 lineMap。
- **要做**的是:解析器逐文件解析(现状不变);展开器把目标文件选中节点挂进父元素——
有 `xpointer` 时取 `/n:Name/child::*` 选中 children,无 `xpointer` 时按 XInclude 语义
整体包含目标根元素(RA3 片段如 `CreateObjectDie` 依赖这一行为);节点保留各自的源文件
与原始偏移(来源追溯)。后续分析跑在逻辑树上,范围映射按节点 `sourceFile` 回到对应
文件的 lineMap。
- 现有 `parseXml` 已记录标签 / 属性 / 值的起止偏移,`XmlElement` 结构可直接复用;拼接时
用浅拷贝节点壳并重建 parent 链,避免破坏目标文件缓存树自身的 parent 指针。
@@ -243,7 +512,7 @@ BAB(`defaultscript.cs`)编译时正是这样把整个 Mod 合并成一份大
| 构造 | 拼入逻辑树 | 理由 |
|---|---|---|
| `xi:include` | ✅ | 内容并入父元素(HeadlightDraw2 场景) |
| `xi:include` | ✅ | 有 `xpointer`:选中容器 children;无 `xpointer`:整体包含目标根元素(CreateObjectDie / TechUpgradeReceiver 等片段场景) |
| EA `<Include type="all">` | ✅ | BAB“内容合并”,等价于复制进来 |
| `type="instance"` | ❌ | 只影响编译可见性;拼树会把 BaseVehicle 的顶层资产错误塞进当前文档 |
| `type="reference"` | ❌ | manifest 编译产物,无文本内容 |
+44 -2
View File
@@ -23,7 +23,9 @@ XML 之间的组织靠 `<Include>` 标签,共有三种语义:
- 无前缀的路径相对于当前文件所在目录;
- `ART:` 路径支持“文件名前两个小写字母作为子目录”的匹配(如 `JUAntiShip` → `ju/JUAntiShip`)。
继承机制:`inheritFrom` 让一个元素默认获得目标元素的所有内容;具体合并行为由 `xai:joinAction`(`uri:ea.com:eala:asset:instance` 命名空间)控制,实际项目中出现的取值为 `Replace`、`Remove`。
继承机制:`inheritFrom` 让一个元素默认获得目标元素的所有内容;具体合并行为由 `xai:joinAction`(`uri:ea.com:eala:asset:instance` 命名空间)控制,实际项目中出现的取值为 `Replace`、`Remove`。XSD 只在 `BaseInheritableAsset` 上显式声明 `inheritFrom`,但原版与 Corona 数据也在 `FXList`、`AIMicroManagerData` 等 `BaseAssetType` 系资产上使用它,插件按“所有资产类型的通用属性”处理。
引用值写法:原版与 Corona 数据中的引用既可以是裸 ID,也可以是 manifest 风格的全名 `类型:ID`(如 `inheritFrom="AudioEvent:BaseSoundEffect"`、`Sound="AudioEvent:JAP_Refinery_Select"`、`Side="PlayerTemplate:Allies"`、`ParticleTexture="Texture:FXLenzFlare01"`)。XML 定义侧的 `id` 从不含冒号,因此插件统一按“最后冒号段”归一化后再匹配定义,类型过滤仍按 refType / 元素自身类型执行。
全部 XML 语法由 XSD 定义:SDK 自带 `Schemas/xsd/CnC3Types.xsd`(及其 800+ 个子 XSD)。大型 Mod 项目(如 Corona)还会携带自己修改过的 XSD 副本。
@@ -38,12 +40,20 @@ XML 之间的组织靠 `<Include>` 标签,共有三种语义:
- 属性值:
- 引用型属性(XSD 中带 `xas:refType`)补全已定义的资产 ID;
- `inheritFrom` 补全可继承的资产 ID;
- 引用值支持 `类型:ID` 前缀写法:已输入 `AudioEvent:` 时按冒号后的 ID 过滤,插入时保留已输入的前缀;未输入前缀时保持裸 ID 补全;
- 枚举值(XSD `xs:enumeration`);
- `$DEFINE` 常量(如 `$CIV_HEALTH_SMALL`);
- `<Include source>` 补全可解析的文件路径(`DATA:` / `ART:` / `AUDIO:`)。
- **元素文本内容(simple content)**:带 `xas:refType` 的内容元素
(simple type 如 `<CreateObject>ID</CreateObject>`,simpleContent 复杂类型
如 `<Sound>AudioFile</Sound>`、`<Subsound>VoiceEvent</Subsound>`)在标签间
补全对应类型的资产 ID、枚举或 `$DEFINE`;补全出的 simple-content 元素必须
是可填值的成对标签(`<Name></Name>`),且内容区已输入 `<` 时不得产生 `<<`。
3. **引用提示(Hover)**:元素/属性悬停显示 XSD 文档、类型、默认值;资产 ID 悬停显示定义位置;`$DEFINE` 悬停显示值与定义位置。
- 元素文本内容(simple content 引用)悬停同样显示定义位置。
4. **引用导航**:
- 从引用型属性值跳转到对应资产定义(Go to Definition);
- 从 simple-content 引用元素(`<CreateObject>ID</CreateObject>`)的文本跳转到对应资产定义;
- 查找某资产 ID 的所有引用(Find All References);
- `<Include source>` / `xi:include href` 直接打开目标文件;
- `inheritFrom` 跳转到被继承元素;
@@ -54,9 +64,19 @@ XML 之间的组织靠 `<Include>` 标签,共有三种语义:
- 缺失必填 `id`(顶层资产);
- 重复 ID(同类型 + 同 id,mod 文件之间;覆盖原版 SageXml 不算冲突);
- 引用未解析(引用了不存在的资产 ID,可配置是否忽略原版 manifest 中的 ID);
- 引用值带 `类型:` 前缀时先归一化为裸 ID 再判定(如 `AudioEvent:BaseSoundEffect` → `BaseSoundEffect`),前缀不影响类型过滤;
- simple-content 引用元素的文本未解析(同属性引用规则,仅带 refType 的类型)。
- `<Include>` 目标文件找不到、Include 循环;
- `$DEFINE` 未定义。
**补充(工作区/项目检测,2026-08-07)**:
- 项目根不要求工作区精确匹配 `Data/Mod.xml`:从工作区文件夹向上最多 12 层、
从打开的 XML 文件向上、以及从“包含多个 mod 的容器文件夹”向下浅扫最多 3 层
均可发现项目根(`Data/Mod.xml`、`Data/additionalmaps/mapmetadata_*.xml`、
`*.babproj` 任一标记命中即可,大小写不敏感、最近命中优先)。
- 多项目同时打开时按文档就近选择项目;单项目打开立即建索引,容器/多项目采用
惰性索引(活动文档所属项目先建,其他在文档打开或首次请求时建),构建串行执行。
**补充(manifest 解析,支持 include reference 后的补全/导航/诊断)**:
- 当 `Mod.xml`(或其他文件)用 `<Include type="reference" source="DATA:static.xml" />` 引用占位文件时,实际内容来自 SDK `builtmods` 下对应的已编译二进制 manifest(`static.manifest` / `global.manifest` / `audio.manifest`)。
@@ -64,6 +84,11 @@ XML 之间的组织靠 `<Include>` 标签,共有三种语义:
- **代码补全**:例如 reference 了 `audio.xml` 后,所有音频资产 ID 都能出现在引用型属性(如 `AudioEventRef`)的补全里;
- **引用导航/悬停**:能定位资产来自哪个 manifest、哪个源文件;
- **诊断**:能把“引用了 manifest 中的 ID”识别为已解析,而不是误报未解析引用。
- manifest 的 `sourceFileName`(如 `DATA:globaldata/weapon.xml`)是**原版编译
时的源地址**,按 vanilla-only 搜索路径(SDK 根 + `SageXml`)解析,不能用当前
mod 的 BAB 顺序解析——否则 mod 同名 DATA 路径会遮蔽 SageXml 源码。ART/AUDIO
源码默认不映射(SDK 基本不提供);SageXml 源缺失时保持 manifest-only,
文件存在但 id 被删时降级到文件顶部。
- manifest 为二进制格式,解析逻辑参考 OpenSAGE `ManifestFile.cs`(用户已在本工作区 `OpenSAGE/` 克隆并切到指定 commit)。关键格式要点:
- 头部含版本(5/6/7)、端序标志、各缓冲区大小、资产数量;
- 每个资产条目含 `TypeId`(哈希)、`NameOffset`、`SourceFileNameOffset` 等;
@@ -79,9 +104,21 @@ XML 之间的组织靠 `<Include>` 标签,共有三种语义:
美术资产目录(Corona 约 2.6 GB);索引记录与 include 解析结果同样跨重建缓存,
保存触发的重建零 stat、零重读(Corona 实测约 2 秒)。
**补充(引用计数、语义 Find All References 与未引用资产,2026-08-05)**:
- 每个顶部 asset 显示被引用次数(CodeLens,0 也显示),点击直接打开
references peek;只在“设计上应被引用”的类型上显示,避免设置类/地图元数据/
w3x 子结构等自动注册类型制造满屏 0;
- Find All References 改为基于语义引用索引(属性引用 + simple-content 文本 +
`inheritFrom`,排除 id 定义点 / Poid / `$DEFINE`),不再全文搜索;
- 命令 `Find unreferenced assets…`:按类型列出所有零引用的项目定义并跳转;
编辑器右键菜单 `Find unreferenced assets of this type` 预选光标所在类型;
- 设计文档见 `docs/features-reference-counts.md`。
### P1:非近期目标(本期不做,但预留扩展点)
6. **高效搜索**:Mod 项目巨大(Corona 约 7500 个 XML、38MB)时直接全文搜索很慢,需要一个高效的 XML 内容索引机制。
(2026-08-05:语义引用索引已落地,FAR / 引用计数 / 未引用报告不再全文搜索;
通用内容搜索与索引复用仍属远期。)
7. **索引机制的复用性**:希望索引不仅能服务 VS Code 插件,也能被其他工具(如搜索、静态分析)复用,因此索引/解析核心应设计成与编辑器无关的纯模块。
## 三、环境与参考资源
@@ -90,11 +127,16 @@ XML 之间的组织靠 `<Include>` 标签,共有三种语义:
- 中小项目:`C:\Apps\RA3-MODSDK-X\Mods\AttachTest`、`D:\Mods\CoronaMod\mods\mods\GenEvoTest`。
- 大型项目:`D:\Mods\CoronaMod\mods\mods\corona`(自带 `xsd/`)。
- 现有工具:工作区 `check_duplicate_ids.py`(include 解析与重复 ID 检测的参考实现)。
- manifest 格式参考:OpenSAGE `src/OpenSage.Game/Data/StreamFS/ManifestFile.cs`(commit `d45d361`,最新分支已移除该文件)。本机网络受限未能拉取,且 manifest 为压缩/哈希的二进制,本期不实现其解析。
- manifest 格式参考:OpenSAGE `src/OpenSage.Game/Data/StreamFS/ManifestFile.cs`
(commit `d45d361`,本仓库 `OpenSAGE/` 子目录)。插件已实现 v5/v6/v7 二进制
解析(`src/indexer/manifestParser.ts`),未知 TypeId 哈希时按资产名前缀推导类型。
## 四、验收标准
- 在 AttachTest / GenEvoTest 上开箱即用(高亮、补全、跳转、诊断)。
- 打开 mod 的 `Data` 文件夹、`Data` 子文件夹、仅含 mapmetadata 的项目、
单个 XML 文件、以及“内部包含多个 mod”的容器文件夹时均能正确发现项目根;
多项目打开时各自索引与功能互不串扰。
- 在 Corona 规模的目录上不卡 UI:索引在后台执行、保存文件后增量更新。
- 纯解析/索引核心不依赖 VS Code API,可被其他工具复用。
- 可用 `vsce package` 打出可安装的 `.vsix`。
+14 -2
View File
@@ -1,11 +1,23 @@
import * as esbuild from "esbuild";
import { rm } from "node:fs/promises";
const watch = process.argv.includes("--watch");
// Remove previous outputs first. esbuild only overwrites the files its current
// entry points produce, so without this a packaged VSIX can ship stale
// artifacts from an older layout (e.g. the pre-`outbase` dist/mcpServer.js
// next to the current dist/agent/mcpServer.js).
await rm("dist", { recursive: true, force: true });
const ctx = await esbuild.context({
entryPoints: ["./src/extension.ts"],
entryPoints: [
"./src/extension.ts",
"./src/agent/mcpServer.ts",
"./src/agent/cli.ts",
],
bundle: true,
outfile: "dist/extension.js",
outdir: "dist",
outbase: "src",
external: ["vscode"],
format: "cjs",
platform: "node",
Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 MiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

+228
View File
@@ -0,0 +1,228 @@
{
"RA3 Mod XML: caches cleared; rebuilding from scratch…": "RA3 Mod XML: caches cleared; rebuilding from scratch…",
"RA3 Mod XML: index is still building — check the status bar. Most features become available after the XML phase.": "RA3 Mod XML: index is still building — check the status bar. Most features become available after the XML phase.",
"RA3 Mod XML: no index for the active project yet — open a mod XML document to start indexing.": "RA3 Mod XML: no index for the active project yet — open a mod XML document to start indexing.",
"RA3 Mod XML: no index available. Open a workspace that contains Data/Mod.xml, Data/additionalmaps/mapmetadata_*.xml or a mod folder.": "RA3 Mod XML: no index available. Open a workspace that contains Data/Mod.xml, Data/additionalmaps/mapmetadata_*.xml or a mod folder.",
"(stale)": "(stale)",
"RA3 Mod XML index": "RA3 Mod XML index",
"Project: {0}": "Project: {0}",
"Files: {0} ({1} parsed, {2} shallow-scanned, {3} cache hits)": "Files: {0} ({1} parsed, {2} shallow-scanned, {3} cache hits)",
"Assets: {0} ({1} from {2} manifests)": "Assets: {0} ({1} from {2} manifests)",
"References: {0}": "References: {0}",
"Defines: {0} · Streams: {1} · Candidates: {2}": "Defines: {0} · Streams: {1} · Candidates: {2}",
"Phase: {0} · Complete: {1}{2}": "Phase: {0} · Complete: {1}{2}",
"Build #{0} (trigger: {1})": "Build #{0} (trigger: {1})",
"Indexed in {0}s": "Indexed in {0}s",
"XML walk: {0}s · Candidates: {1}s · Art scan: {2}s": "XML walk: {0}s · Candidates: {1}s · Art scan: {2}s",
"0 references": "0 references",
"1 reference": "1 reference",
"{0} references": "{0} references",
"Type: {0}": "Type: {0}",
"RA3 XML · {0}": "RA3 XML · {0}",
"RA3 XML": "RA3 XML",
"Root element of every RA3 asset file": "Root element of every RA3 asset file",
"**Required**": "**Required**",
"References: `{0}`": "References: `{0}`",
"Values: {0}": "Values: {0}",
"Default: `{0}`": "Default: `{0}`",
"Type: `{0}`": "Type: `{0}`",
"Suggest attribute values": "Suggest attribute values",
"Instance join action": "Instance join action",
"Controls how this element merges with the inherited definition: `Replace` or `Remove`.": "Controls how this element merges with the inherited definition: `Replace` or `Remove`.",
"xai namespace": "xai namespace",
"Include type": "Include type",
"xai:joinAction": "xai:joinAction",
"enum": "enum",
"boolean": "boolean",
"Include source": "Include source",
"`{0}` · {1}": "`{0}` · {1}",
"relative": "relative",
"manifest ({0})": "manifest ({0})",
"manifest": "manifest",
"**Type**: {0}": "**Type**: {0}",
"**Source**: {0}": "**Source**: {0}",
"**Origin**: {0}": "**Origin**: {0}",
"Also defined as **{0}** · {1}": "Also defined as **{0}** · {1}",
"{0} · {1}": "{0} · {1}",
"Define": "Define",
"local module": "local module",
"Pipeline-local id in the enclosing GameObject (includes xi:include targets).": "Pipeline-local id in the enclosing GameObject (includes xi:include targets).",
"Suggest content value": "Suggest content value",
"project": "project",
"SDK": "SDK",
"Content is not allowed before the root element": "Content is not allowed before the root element",
"Unterminated comment": "Unterminated comment",
"Unterminated CDATA section": "Unterminated CDATA section",
"Unterminated DOCTYPE": "Unterminated DOCTYPE",
"Unterminated processing instruction": "Unterminated processing instruction",
"Unterminated closing tag": "Unterminated closing tag",
"Unterminated start tag": "Unterminated start tag",
"Malformed markup": "Malformed markup",
"Unexpected closing tag </{0}>": "Unexpected closing tag </{0}>",
"Mismatched closing tag: expected </{0}>, found </{1}>": "Mismatched closing tag: expected </{0}>, found </{1}>",
"Element <{0}> is never closed": "Element <{0}> is never closed",
"Top-level asset <{0}> requires an id attribute": "Top-level asset <{0}> requires an id attribute",
"Unknown element <{0}> (not in the RA3 XSD model)": "Unknown element <{0}> (not in the RA3 XSD model)",
" (based on a partial index)": " (based on a partial index)",
" (index incomplete — may be a false positive)": " (index incomplete — may be a false positive)",
"Include target not found: {0}": "Include target not found: {0}",
"xi:include target not found: {0}": "xi:include target not found: {0}",
"XInclude element (W3C XInclude namespace) — not part of the RA3 XSD model.": "XInclude element (W3C XInclude namespace) — not part of the RA3 XSD model.",
"**Top-level asset element**": "**Top-level asset element**",
"Attributes: {0} · Children: {1}": "Attributes: {0} · Children: {1}",
"Extends: `{0}`": "Extends: `{0}`",
"Simple type: `{0}`": "Simple type: `{0}`",
"Not found in the bundled XSD model.": "Not found in the bundled XSD model.",
"Namespace/instance attribute.": "Namespace/instance attribute.",
"XInclude attribute (W3C XInclude namespace) — not part of the RA3 XSD model.": "XInclude attribute (W3C XInclude namespace) — not part of the RA3 XSD model.",
"Unknown attribute for this element.": "Unknown attribute for this element.",
"References assets of type `{0}`": "References assets of type `{0}`",
"Values: `{0}`": "Values: `{0}`",
"May use `$DEFINE` constants": "May use `$DEFINE` constants",
"**Include source**": "**Include source**",
"Include source: `{0}` (not in candidate index)": "Include source: `{0}` (not in candidate index)",
"Index is still building — references cannot be resolved yet.": "Index is still building — references cannot be resolved yet.",
"**Define** `{0}`": "**Define** `{0}`",
"Defined in `{0}:{1}`": "Defined in `{0}:{1}`",
"**1 definition**": "**1 definition**",
"**{0} definitions**": "**{0} definitions**",
"manifest `{0}`": "manifest `{0}`",
"`{0}:{1}`": "`{0}:{1}`",
"- `{0}` · {1}": "- `{0}` · {1}",
"No matching definition of type `{0}` in the current index (may exist in a compiled manifest or vanilla data).": "No matching definition of type `{0}` in the current index (may exist in a compiled manifest or vanilla data).",
"No matching definition of the expected declared type in the current index (may exist in a compiled manifest or vanilla data).": "No matching definition of the expected declared type in the current index (may exist in a compiled manifest or vanilla data).",
"No matching definition in the current index (may exist in a compiled manifest or vanilla data).": "No matching definition in the current index (may exist in a compiled manifest or vanilla data).",
"**Local pipeline id** `{0}`": "**Local pipeline id** `{0}`",
"RA3 Mod XML: no index available yet.": "RA3 Mod XML: no index available yet.",
"RA3 Mod XML: no unreferenced assets found.": "RA3 Mod XML: no unreferenced assets found.",
"{0} unreferenced": "{0} unreferenced",
"Select an asset type": "Select an asset type",
"RA3 Mod XML: no unreferenced {0} assets found.": "RA3 Mod XML: no unreferenced {0} assets found.",
"{0}: {1} unreferenced": "{0}: {1} unreferenced",
"RA3 Mod XML: open an RA3 mod project first to configure the SDK path.": "RA3 Mod XML: open an RA3 mod project first to configure the SDK path.",
"Use detected path": "Use detected path",
"Choose manually…": "Choose manually…",
"Not now": "Not now",
"RA3 Mod XML could not find a valid SDK path. Detected installed SDK: {0}": "RA3 Mod XML could not find a valid SDK path. Detected installed SDK: {0}",
"Choose SDK folder…": "Choose SDK folder…",
"RA3 Mod XML needs the RA3 Mod SDK path to enable vanilla data, manifests and cross-file completion/navigation. Without it, the extension runs in project-only mode.": "RA3 Mod XML needs the RA3 Mod SDK path to enable vanilla data, manifests and cross-file completion/navigation. Without it, the extension runs in project-only mode.",
"Choose SDK root": "Choose SDK root",
"Choose the RA3 Mod SDK root (should contain Schemas/xsd/CnC3Types.xsd)": "Choose the RA3 Mod SDK root (should contain Schemas/xsd/CnC3Types.xsd)",
"The selected directory is not a usable RA3 Mod SDK (missing {0}). Please choose again.": "The selected directory is not a usable RA3 Mod SDK (missing {0}). Please choose again.",
"that directory": "that directory",
"$(warning) RA3 XML: SDK path does not exist": "$(warning) RA3 XML: SDK path does not exist",
"$(warning) RA3 XML: SDK not configured": "$(warning) RA3 XML: SDK not configured",
"$(warning) RA3 XML: SDK path is invalid": "$(warning) RA3 XML: SDK path is invalid",
"$(warning) RA3 XML: SDK is incomplete": "$(warning) RA3 XML: SDK is incomplete",
"The directory configured in ra3modxml.sdkPath does not exist: {0}. Click to reconfigure, or clear ra3modxml.sdkPath to disable vanilla data features.": "The directory configured in ra3modxml.sdkPath does not exist: {0}. Click to reconfigure, or clear ra3modxml.sdkPath to disable vanilla data features.",
"RA3 Mod SDK path is not configured. Click to set it, or clear ra3modxml.sdkPath to disable vanilla data features.": "RA3 Mod SDK path is not configured. Click to set it, or clear ra3modxml.sdkPath to disable vanilla data features.",
"The directory configured in ra3modxml.sdkPath is not an RA3 Mod SDK root (missing Schemas/xsd/CnC3Types.xsd). Click to reconfigure.": "The directory configured in ra3modxml.sdkPath is not an RA3 Mod SDK root (missing Schemas/xsd/CnC3Types.xsd). Click to reconfigure.",
"RA3 Mod SDK is missing: {0}. Manifest / vanilla source / SDK search path features are unavailable.": "RA3 Mod SDK is missing: {0}. Manifest / vanilla source / SDK search path features are unavailable.",
"RA3 Mod XML: SDK path set to {0}; rebuilding the index…": "RA3 Mod XML: SDK path set to {0}; rebuilding the index…",
"$(sync~spin) RA3 XML: indexing…": "$(sync~spin) RA3 XML: indexing…",
"art cache": "art cache",
"$(error) RA3 XML: indexing failed (stale index kept)": "$(error) RA3 XML: indexing failed (stale index kept)",
"$(error) RA3 XML: indexing failed": "$(error) RA3 XML: indexing failed",
"$(sync~spin) RA3 XML: validating {0} {1}/{2}…": "$(sync~spin) RA3 XML: validating {0} {1}/{2}…",
"RA3 Mod XML cache report": "RA3 Mod XML cache report",
"Projects: {0}": "Projects: {0}",
" builds: #{0} (last trigger: {1})": " builds: #{0} (last trigger: {1})",
" disk cache: {0}": " disk cache: {0}",
"not loaded": "not loaded",
" file: {0}": " file: {0}",
"{0} KB": "{0} KB",
"missing": "missing",
" last load: file={0} keyMatched={1} loaded={2} validated={3} dropped={4} (load {5}ms, validate {6}ms)": " last load: file={0} keyMatched={1} loaded={2} validated={3} dropped={4} (load {5}ms, validate {6}ms)",
" saved after last build: {0}": " saved after last build: {0}",
"yes": "yes",
"no": "no",
" last build: phase={0} assets={1} snapshotHits={2} snapshotFallbacks={3} recordsCacheHits={4} shallowCacheHits={5}": " last build: phase={0} assets={1} snapshotHits={2} snapshotFallbacks={3} recordsCacheHits={4} shallowCacheHits={5}",
"Shared in-memory: {0} record entries · {1} documents ({2} elements) · {3} include resolutions": "Shared in-memory: {0} record entries · {1} documents ({2} elements) · {3} include resolutions",
"$(symbol-misc) RA3 XML: {0} project(s) — open a mod XML to index": "$(symbol-misc) RA3 XML: {0} project(s) — open a mod XML to index",
"$(symbol-misc) RA3 XML: {0} · {1} assets{2}": "$(symbol-misc) RA3 XML: {0} · {1} assets{2}",
"{0} files indexed ({1} parsed, {2} art assets shallow-scanned, {3}s)": "{0} files indexed ({1} parsed, {2} art assets shallow-scanned, {3}s)",
"{0} assets ({1} from {2} manifests)": "{0} assets ({1} from {2} manifests)",
"{0} reference sites": "{0} reference sites",
"{0} defines, {1} streams, {2} include candidates": "{0} defines, {1} streams, {2} include candidates",
"Disk cache: load {0}s, validate {1}s ({2}/{3} ok)": "Disk cache: load {0}s, validate {1}s ({2}/{3} ok)",
"Duplicate id \"{0}\" for <{1}> (also defined on line {2})": "Duplicate id \"{0}\" for <{1}> (also defined on line {2})",
"Duplicate id \"{0}\" for <{1}> (also defined in {2})": "Duplicate id \"{0}\" for <{1}> (also defined in {2})",
"Unknown attribute \"{0}\" for <{1}>": "Unknown attribute \"{0}\" for <{1}>",
"Undefined define \"${0}\"": "Undefined define \"${0}\"",
"Invalid Include type \"{0}\" (expected reference, instance or all)": "Invalid Include type \"{0}\" (expected reference, instance or all)",
"Reference \"{0}\" has no definition of type `{1}` (ids with the same name exist for other types)": "Reference \"{0}\" has no definition of type `{1}` (ids with the same name exist for other types)",
"Reference \"{0}\" has no definition of the expected declared type (ids with the same name exist for other types)": "Reference \"{0}\" has no definition of the expected declared type (ids with the same name exist for other types)",
"Reference \"{0}\" has no matching definition (ids with the same name exist for other types)": "Reference \"{0}\" has no matching definition (ids with the same name exist for other types)",
"Unresolved reference \"{0}\" (not found in the current index)": "Unresolved reference \"{0}\" (not found in the current index)",
"RA3 Mod XML: no index available yet. Wait for indexing to finish before exporting an AI Agent snapshot.": "RA3 Mod XML: no index available yet. Wait for indexing to finish before exporting an AI Agent snapshot.",
"RA3 Mod XML: exported AI Agent index snapshot to {0}": "RA3 Mod XML: exported AI Agent index snapshot to {0}",
"Reveal in Explorer": "Reveal in Explorer",
"RA3 Mod XML: failed to export AI Agent index snapshot: {0}": "RA3 Mod XML: failed to export AI Agent index snapshot: {0}",
"RA3 Mod XML: no index available yet. Wait for indexing to finish before enabling AI Agent access.": "RA3 Mod XML: no index available yet. Wait for indexing to finish before enabling AI Agent access.",
"RA3 Mod XML: the AI Agent launcher will use Node from PATH. Install Node, or run VS Code from a normal installation so the bundled runtime can be used.": "RA3 Mod XML: the AI Agent launcher will use Node from PATH. Install Node, or run VS Code from a normal installation so the bundled runtime can be used.",
"Install Agent Skill (recommended)": "Install Agent Skill (recommended)",
"Write MCP config to Claude Desktop": "Write MCP config to Claude Desktop",
"Write MCP config to Cursor (global)": "Write MCP config to Cursor (global)",
"Write MCP config to Cursor (project)": "Write MCP config to Cursor (project)",
"Copy MCP config": "Copy MCP config",
"RA3 Mod XML AI Agent access enabled. Choose an optional next step.": "RA3 Mod XML AI Agent access enabled. Choose an optional next step.",
"RA3 Mod XML Agent Skill installed to {0}": "RA3 Mod XML Agent Skill installed to {0}",
"RA3 Mod XML: could not write the Agent Skill to {0}": "RA3 Mod XML: could not write the Agent Skill to {0}",
"RA3 Mod XML MCP config written to {0}": "RA3 Mod XML MCP config written to {0}",
"RA3 Mod XML MCP config copied to clipboard.": "RA3 Mod XML MCP config copied to clipboard.",
"RA3 Mod XML: failed to enable AI Agent access: {0}": "RA3 Mod XML: failed to enable AI Agent access: {0}",
"Default (~/.agents/skills)": "Default (~/.agents/skills)",
"Claude Code (~/.claude/skills)": "Claude Code (~/.claude/skills)",
"Current project .agents/skills": "Current project .agents/skills",
"Current project .claude/skills": "Current project .claude/skills",
"Choose a custom folder…": "Choose a custom folder…",
"The skill is installed as <folder>/{0}": "The skill is installed as <folder>/{0}",
"Select Agent Skill install locations": "Select Agent Skill install locations",
"Choose a skill folder": "Choose a skill folder",
"Choose the folder that should contain the {0} skill": "Choose the folder that should contain the {0} skill",
"RA3 Mod XML: could not write the Agent Skill (0 of {0} locations).": "RA3 Mod XML: could not write the Agent Skill (0 of {0} locations).",
"RA3 Mod XML Agent Skill installed to {0} location(s); {1} failed.": "RA3 Mod XML Agent Skill installed to {0} location(s); {1} failed.",
"RA3 Mod XML Agent Skill installed to {0} location(s).": "RA3 Mod XML Agent Skill installed to {0} location(s).",
"Show installed skills": "Show installed skills",
"RA3 Mod XML: no recorded Agent Skill installation to remove.": "RA3 Mod XML: no recorded Agent Skill installation to remove.",
"missing — will be dropped from the record": "missing — will be dropped from the record",
"installed by this extension (v{0})": "installed by this extension (v{0})",
"not managed by this extension — will be skipped": "not managed by this extension — will be skipped",
"No RA3 Mod XML skill marker found; remove it manually if you want it gone.": "No RA3 Mod XML skill marker found; remove it manually if you want it gone.",
"Select Agent Skill installations to remove": "Select Agent Skill installations to remove",
"RA3 Mod XML: removed {0} Agent Skill installation(s); {1} skipped (not managed by this extension).": "RA3 Mod XML: removed {0} Agent Skill installation(s); {1} skipped (not managed by this extension).",
"RA3 Mod XML: removed {0} Agent Skill installation(s).": "RA3 Mod XML: removed {0} Agent Skill installation(s).",
"RA3 Mod XML: AI Agent access disabled for this workspace. Installed skills and MCP client configurations were kept.": "RA3 Mod XML: AI Agent access disabled for this workspace. Installed skills and MCP client configurations were kept.",
"Uninstall AI Agent integration…": "Uninstall AI Agent integration…",
"Stop live AI Agent access in this window": "Stop live AI Agent access in this window",
"Remove installed Agent Skills": "Remove installed Agent Skills",
"{0} location(s)": "{0} location(s)",
"Remove MCP client configuration entries": "Remove MCP client configuration entries",
"Claude Desktop / Cursor and files recorded by this extension": "Claude Desktop / Cursor and files recorded by this extension",
"Remove the stable MCP launcher": "Remove the stable MCP launcher",
"Select what to remove (nothing is removed until you confirm)": "Select what to remove (nothing is removed until you confirm)",
"Remove the selected AI Agent components?": "Remove the selected AI Agent components?",
"Remove": "Remove",
"live access stopped": "live access stopped",
"{0} skill installation(s) removed": "{0} skill installation(s) removed",
"{0} unmanaged skill folder(s) skipped": "{0} unmanaged skill folder(s) skipped",
"MCP config removed from {0} file(s)": "MCP config removed from {0} file(s)",
"MCP launcher removed": "MCP launcher removed",
"RA3 Mod XML AI Agent cleanup: {0}.": "RA3 Mod XML AI Agent cleanup: {0}.",
"RA3 Mod XML: this version can expose the project's asset index to AI agents (MCP + Agent Skill). Enable it?": "RA3 Mod XML: this version can expose the project's asset index to AI agents (MCP + Agent Skill). Enable it?",
"Enable AI Agent access": "Enable AI Agent access",
"Learn more": "Learn more",
"Don't show again": "Don't show again",
"RA3 Mod XML: Find asset": "RA3 Mod XML: Find asset",
"Id, partial id or Type:Id (e.g. WeaponTemplate:AssaultRifle)": "Id, partial id or Type:Id (e.g. WeaponTemplate:AssaultRifle)",
"Type an id, a partial id or Type:Id to search.": "Type an id, a partial id or Type:Id to search.",
"No asset matches \"{0}\".": "No asset matches \"{0}\".",
"{0} of {1} matches — keep typing to narrow the list.": "{0} of {1} matches — keep typing to narrow the list.",
"1 asset found.": "1 asset found.",
"{0} assets found.": "{0} assets found.",
"{0} definitions": "{0} definitions",
"Select the definition to open": "Select the definition to open",
"RA3 Mod XML: no XML source location for {0} ({1}).": "RA3 Mod XML: no XML source location for {0} ({1}).",
"RA3 Mod XML: the index has no assets yet — wait for indexing to finish.": "RA3 Mod XML: the index has no assets yet — wait for indexing to finish.",
"local": "local"
}
+228
View File
@@ -0,0 +1,228 @@
{
"RA3 Mod XML: caches cleared; rebuilding from scratch…": "RA3 Mod XML:缓存已清空,正在从零重建…",
"RA3 Mod XML: index is still building — check the status bar. Most features become available after the XML phase.": "RA3 Mod XML:索引仍在构建中——请查看状态栏。大部分功能会在 XML 阶段完成后可用。",
"RA3 Mod XML: no index for the active project yet — open a mod XML document to start indexing.": "RA3 Mod XML:活动项目还没有索引——打开一个 Mod XML 文档即可开始建索引。",
"RA3 Mod XML: no index available. Open a workspace that contains Data/Mod.xml, Data/additionalmaps/mapmetadata_*.xml or a mod folder.": "RA3 Mod XML:当前没有可用索引。请打开包含 Data/Mod.xml、Data/additionalmaps/mapmetadata_*.xml 或 Mod 文件夹的工作区。",
"(stale)": "(已过期)",
"RA3 Mod XML index": "RA3 Mod XML 索引",
"Project: {0}": "项目:{0}",
"Files: {0} ({1} parsed, {2} shallow-scanned, {3} cache hits)": "文件:{0}(解析 {1},浅扫描 {2},缓存命中 {3})",
"Assets: {0} ({1} from {2} manifests)": "资产:{0}(其中 {1} 来自 {2} 个 manifest)",
"References: {0}": "引用:{0}",
"Defines: {0} · Streams: {1} · Candidates: {2}": "常量:{0} · 流:{1} · 候选:{2}",
"Phase: {0} · Complete: {1}{2}": "阶段:{0} · 完成:{1}{2}",
"Build #{0} (trigger: {1})": "构建 #{0}(触发原因:{1})",
"Indexed in {0}s": "索引耗时 {0} 秒",
"XML walk: {0}s · Candidates: {1}s · Art scan: {2}s": "XML 遍历:{0} 秒 · 候选扫描:{1} 秒 · 美术扫描:{2} 秒",
"0 references": "0 个引用",
"1 reference": "1 个引用",
"{0} references": "{0} 个引用",
"Type: {0}": "类型:{0}",
"RA3 XML · {0}": "RA3 XML · {0}",
"RA3 XML": "RA3 XML",
"Root element of every RA3 asset file": "每个 RA3 资产文件的根元素",
"**Required**": "**必填**",
"References: `{0}`": "引用:`{0}`",
"Values: {0}": "取值:{0}",
"Default: `{0}`": "默认值:`{0}`",
"Type: `{0}`": "类型:`{0}`",
"Suggest attribute values": "建议属性值",
"Instance join action": "实例合并动作",
"Controls how this element merges with the inherited definition: `Replace` or `Remove`.": "控制该元素如何与继承的定义合并:`Replace` 或 `Remove`。",
"xai namespace": "xai 命名空间",
"Include type": "Include 类型",
"xai:joinAction": "xai:joinAction",
"enum": "枚举",
"boolean": "布尔值",
"Include source": "Include 源",
"`{0}` · {1}": "`{0}` · {1}",
"relative": "相对路径",
"manifest ({0})": "manifest({0})",
"manifest": "manifest",
"**Type**: {0}": "**类型**:{0}",
"**Source**: {0}": "**来源**:{0}",
"**Origin**: {0}": "**归属**:{0}",
"Also defined as **{0}** · {1}": "也定义为 **{0}** · {1}",
"{0} · {1}": "{0} · {1}",
"Define": "定义",
"local module": "局部模块",
"Pipeline-local id in the enclosing GameObject (includes xi:include targets).": "所在 GameObject 中的管线局部 id(包含 xi:include 目标)。",
"Suggest content value": "建议内容值",
"project": "项目",
"SDK": "SDK",
"Content is not allowed before the root element": "根元素之前不允许出现内容",
"Unterminated comment": "注释未结束",
"Unterminated CDATA section": "CDATA 段未结束",
"Unterminated DOCTYPE": "DOCTYPE 未结束",
"Unterminated processing instruction": "处理指令未结束",
"Unterminated closing tag": "结束标签未闭合",
"Unterminated start tag": "开始标签未闭合",
"Malformed markup": "标记格式错误",
"Unexpected closing tag </{0}>": "意外的结束标签 </{0}>",
"Mismatched closing tag: expected </{0}>, found </{1}>": "结束标签不匹配:应为 </{0}>,实际为 </{1}>",
"Element <{0}> is never closed": "元素 <{0}> 从未闭合",
"Top-level asset <{0}> requires an id attribute": "顶层资产 <{0}> 需要 id 属性",
"Unknown element <{0}> (not in the RA3 XSD model)": "未知元素 <{0}>(不在 RA3 XSD 模型中)",
" (based on a partial index)": "(基于部分索引)",
" (index incomplete — may be a false positive)": "(索引不完整——可能是误报)",
"Include target not found: {0}": "找不到 Include 目标:{0}",
"xi:include target not found: {0}": "找不到 xi:include 目标:{0}",
"XInclude element (W3C XInclude namespace) — not part of the RA3 XSD model.": "XInclude 元素(W3C XInclude 命名空间)——不属于 RA3 XSD 模型。",
"**Top-level asset element**": "**顶层资产元素**",
"Attributes: {0} · Children: {1}": "属性:{0} · 子元素:{1}",
"Extends: `{0}`": "继承自:`{0}`",
"Simple type: `{0}`": "简单类型:`{0}`",
"Not found in the bundled XSD model.": "内置 XSD 模型中未找到。",
"Namespace/instance attribute.": "命名空间/实例属性。",
"XInclude attribute (W3C XInclude namespace) — not part of the RA3 XSD model.": "XInclude 属性(W3C XInclude 命名空间)——不属于 RA3 XSD 模型。",
"Unknown attribute for this element.": "该元素的未知属性。",
"References assets of type `{0}`": "引用类型为 `{0}` 的资产",
"Values: `{0}`": "取值:`{0}`",
"May use `$DEFINE` constants": "可使用 `$DEFINE` 常量",
"**Include source**": "**Include 源**",
"Include source: `{0}` (not in candidate index)": "Include 源:`{0}`(不在候选索引中)",
"Index is still building — references cannot be resolved yet.": "索引仍在构建中——暂时无法解析引用。",
"**Define** `{0}`": "**常量** `{0}`",
"Defined in `{0}:{1}`": "定义于 `{0}:{1}`",
"**1 definition**": "**1 个定义**",
"**{0} definitions**": "**{0} 个定义**",
"manifest `{0}`": "manifest `{0}`",
"`{0}:{1}`": "`{0}:{1}`",
"- `{0}` · {1}": "- `{0}` · {1}",
"No matching definition of type `{0}` in the current index (may exist in a compiled manifest or vanilla data).": "当前索引中没有类型为 `{0}` 的匹配定义(可能存在于编译后的 manifest 或原版数据中)。",
"No matching definition of the expected declared type in the current index (may exist in a compiled manifest or vanilla data).": "当前索引中没有符合声明类型的匹配定义(可能存在于编译后的 manifest 或原版数据中)。",
"No matching definition in the current index (may exist in a compiled manifest or vanilla data).": "当前索引中没有匹配的定义(可能存在于编译后的 manifest 或原版数据中)。",
"**Local pipeline id** `{0}`": "**局部管线 id** `{0}`",
"RA3 Mod XML: no index available yet.": "RA3 Mod XML:尚无可用索引。",
"RA3 Mod XML: no unreferenced assets found.": "RA3 Mod XML:没有找到未引用的资产。",
"{0} unreferenced": "{0} 个未引用",
"Select an asset type": "选择资产类型",
"RA3 Mod XML: no unreferenced {0} assets found.": "RA3 Mod XML:没有找到未引用的 {0} 类型资产。",
"{0}: {1} unreferenced": "{0}:{1} 个未引用",
"RA3 Mod XML: open an RA3 mod project first to configure the SDK path.": "RA3 Mod XML:请先打开 RA3 Mod 项目再配置 SDK 路径。",
"Use detected path": "使用检测到的路径",
"Choose manually…": "手动选择…",
"Not now": "暂时不用",
"RA3 Mod XML could not find a valid SDK path. Detected installed SDK: {0}": "RA3 Mod XML 未找到有效的 SDK 路径。检测到已安装的 SDK:{0}",
"Choose SDK folder…": "选择 SDK 文件夹…",
"RA3 Mod XML needs the RA3 Mod SDK path to enable vanilla data, manifests and cross-file completion/navigation. Without it, the extension runs in project-only mode.": "RA3 Mod XML 需要 RA3 Mod SDK 路径才能启用原版数据、manifest 与跨文件补全/跳转功能。未设置时插件将以项目模式运行。",
"Choose SDK root": "选择 SDK 根目录",
"Choose the RA3 Mod SDK root (should contain Schemas/xsd/CnC3Types.xsd)": "选择 RA3 Mod SDK 根目录(应包含 Schemas/xsd/CnC3Types.xsd)",
"The selected directory is not a usable RA3 Mod SDK (missing {0}). Please choose again.": "所选目录不是可用的 RA3 Mod SDK(缺少 {0})。请重新选择。",
"that directory": "该目录",
"$(warning) RA3 XML: SDK path does not exist": "$(warning) RA3 XML:SDK 路径不存在",
"$(warning) RA3 XML: SDK not configured": "$(warning) RA3 XML:未设置 SDK",
"$(warning) RA3 XML: SDK path is invalid": "$(warning) RA3 XML:SDK 路径无效",
"$(warning) RA3 XML: SDK is incomplete": "$(warning) RA3 XML:SDK 不完整",
"The directory configured in ra3modxml.sdkPath does not exist: {0}. Click to reconfigure, or clear ra3modxml.sdkPath to disable vanilla data features.": "ra3modxml.sdkPath 指向的目录不存在:{0}。点击重新设置;或将 ra3modxml.sdkPath 清空以禁用原版数据功能。",
"RA3 Mod SDK path is not configured. Click to set it, or clear ra3modxml.sdkPath to disable vanilla data features.": "未配置 RA3 Mod SDK 路径。点击设置;或将 ra3modxml.sdkPath 清空以禁用原版数据功能。",
"The directory configured in ra3modxml.sdkPath is not an RA3 Mod SDK root (missing Schemas/xsd/CnC3Types.xsd). Click to reconfigure.": "ra3modxml.sdkPath 指向的目录不是 RA3 Mod SDK 根目录(缺少 Schemas/xsd/CnC3Types.xsd)。点击重新设置。",
"RA3 Mod SDK is missing: {0}. Manifest / vanilla source / SDK search path features are unavailable.": "RA3 Mod SDK 缺少:{0}。manifest / 原版源码 / SDK 搜索路径等功能不可用。",
"RA3 Mod XML: SDK path set to {0}; rebuilding the index…": "RA3 Mod XML:SDK 路径已设置为 {0},正在重建索引…",
"$(sync~spin) RA3 XML: indexing…": "$(sync~spin) RA3 XML:正在建索引…",
"art cache": "美术缓存",
"$(error) RA3 XML: indexing failed (stale index kept)": "$(error) RA3 XML:索引失败(保留旧索引)",
"$(error) RA3 XML: indexing failed": "$(error) RA3 XML:索引失败",
"$(sync~spin) RA3 XML: validating {0} {1}/{2}…": "$(sync~spin) RA3 XML:正在校验 {0} {1}/{2}…",
"RA3 Mod XML cache report": "RA3 Mod XML 缓存报告",
"Projects: {0}": "项目数:{0}",
" builds: #{0} (last trigger: {1})": " 构建次数:#{0}(上次触发:{1})",
" disk cache: {0}": " 磁盘缓存:{0}",
"not loaded": "未加载",
" file: {0}": " 文件:{0}",
"{0} KB": "{0} KB",
"missing": "缺失",
" last load: file={0} keyMatched={1} loaded={2} validated={3} dropped={4} (load {5}ms, validate {6}ms)": " 最近加载:file={0} keyMatched={1} loaded={2} validated={3} dropped={4}(加载 {5}ms,校验 {6}ms)",
" saved after last build: {0}": " 上次构建后已保存:{0}",
"yes": "是",
"no": "否",
" last build: phase={0} assets={1} snapshotHits={2} snapshotFallbacks={3} recordsCacheHits={4} shallowCacheHits={5}": " 最近构建:阶段={0} 资产={1} snapshotHits={2} snapshotFallbacks={3} recordsCacheHits={4} shallowCacheHits={5}",
"Shared in-memory: {0} record entries · {1} documents ({2} elements) · {3} include resolutions": "共享内存:{0} 条记录 · {1} 个文档({2} 个元素)· {3} 条 include 解析",
"$(symbol-misc) RA3 XML: {0} project(s) — open a mod XML to index": "$(symbol-misc) RA3 XML:{0} 个项目——打开一个 Mod XML 开始建索引",
"$(symbol-misc) RA3 XML: {0} · {1} assets{2}": "$(symbol-misc) RA3 XML:{0} · {1} 个资产{2}",
"{0} files indexed ({1} parsed, {2} art assets shallow-scanned, {3}s)": "{0} 个文件已索引(解析 {1},浅扫描美术资产 {2},耗时 {3} 秒)",
"{0} assets ({1} from {2} manifests)": "{0} 个资产(其中 {1} 来自 {2} 个 manifest)",
"{0} reference sites": "{0} 个引用位置",
"{0} defines, {1} streams, {2} include candidates": "{0} 个常量,{1} 条流,{2} 个 include 候选",
"Disk cache: load {0}s, validate {1}s ({2}/{3} ok)": "磁盘缓存:加载 {0} 秒,校验 {1} 秒({2}/{3} 正常)",
"Duplicate id \"{0}\" for <{1}> (also defined on line {2})": "重复 id \"{0}\":<{1}>(也定义在第 {2} 行)",
"Duplicate id \"{0}\" for <{1}> (also defined in {2})": "重复 id \"{0}\":<{1}>(也定义在 {2})",
"Unknown attribute \"{0}\" for <{1}>": "未知属性 \"{0}\":<{1}>",
"Undefined define \"${0}\"": "未定义常量 \"${0}\"",
"Invalid Include type \"{0}\" (expected reference, instance or all)": "无效的 Include 类型 \"{0}\"(应为 reference、instance 或 all)",
"Reference \"{0}\" has no definition of type `{1}` (ids with the same name exist for other types)": "引用 \"{0}\" 没有类型为 `{1}` 的定义(其他类型存在同名 id)",
"Reference \"{0}\" has no definition of the expected declared type (ids with the same name exist for other types)": "引用 \"{0}\" 没有符合声明类型的定义(其他类型存在同名 id)",
"Reference \"{0}\" has no matching definition (ids with the same name exist for other types)": "引用 \"{0}\" 没有匹配的定义(其他类型存在同名 id)",
"Unresolved reference \"{0}\" (not found in the current index)": "无法解析的引用 \"{0}\"(当前索引中未找到)",
"RA3 Mod XML: no index available yet. Wait for indexing to finish before exporting an AI Agent snapshot.": "RA3 Mod XML:暂无可用索引。请等待索引完成后再导出 AI Agent 快照。",
"RA3 Mod XML: exported AI Agent index snapshot to {0}": "RA3 Mod XML:已导出 AI Agent 索引快照到 {0}",
"Reveal in Explorer": "在资源管理器中显示",
"RA3 Mod XML: failed to export AI Agent index snapshot: {0}": "RA3 Mod XML:导出 AI Agent 索引快照失败:{0}",
"RA3 Mod XML: no index available yet. Wait for indexing to finish before enabling AI Agent access.": "RA3 Mod XML:暂无可用索引。请等待索引完成后再启用 AI Agent 访问。",
"RA3 Mod XML: the AI Agent launcher will use Node from PATH. Install Node, or run VS Code from a normal installation so the bundled runtime can be used.": "RA3 Mod XML:AI Agent 启动器将使用 PATH 中的 Node。请安装 Node,或从正常安装的 VS Code 启动,以使用内置运行时。",
"Install Agent Skill (recommended)": "安装 Agent Skill(推荐)",
"Write MCP config to Claude Desktop": "将 MCP 配置写入 Claude Desktop",
"Write MCP config to Cursor (global)": "将 MCP 配置写入 Cursor(全局)",
"Write MCP config to Cursor (project)": "将 MCP 配置写入 Cursor(项目)",
"Copy MCP config": "复制 MCP 配置",
"RA3 Mod XML AI Agent access enabled. Choose an optional next step.": "RA3 Mod XML AI Agent 访问已启用。请选择可选的后续操作。",
"RA3 Mod XML Agent Skill installed to {0}": "RA3 Mod XML Agent Skill 已安装到 {0}",
"RA3 Mod XML: could not write the Agent Skill to {0}": "RA3 Mod XML:无法将 Agent Skill 写入 {0}",
"RA3 Mod XML MCP config written to {0}": "RA3 Mod XML MCP 配置已写入 {0}",
"RA3 Mod XML MCP config copied to clipboard.": "RA3 Mod XML MCP 配置已复制到剪贴板。",
"RA3 Mod XML: failed to enable AI Agent access: {0}": "RA3 Mod XML:启用 AI Agent 访问失败:{0}",
"Default (~/.agents/skills)": "默认(~/.agents/skills)",
"Claude Code (~/.claude/skills)": "Claude Code(~/.claude/skills)",
"Current project .agents/skills": "当前项目 .agents/skills",
"Current project .claude/skills": "当前项目 .claude/skills",
"Choose a custom folder…": "选择自定义文件夹…",
"The skill is installed as <folder>/{0}": "Skill 将安装到 <文件夹>/{0}",
"Select Agent Skill install locations": "选择 Agent Skill 安装位置",
"Choose a skill folder": "选择 Skill 文件夹",
"Choose the folder that should contain the {0} skill": "选择用于存放 {0} Skill 的文件夹",
"RA3 Mod XML: could not write the Agent Skill (0 of {0} locations).": "RA3 Mod XML:无法写入 Agent Skill({0} 个位置全部失败)。",
"RA3 Mod XML Agent Skill installed to {0} location(s); {1} failed.": "RA3 Mod XML Agent Skill 已安装到 {0} 个位置;{1} 个失败。",
"RA3 Mod XML Agent Skill installed to {0} location(s).": "RA3 Mod XML Agent Skill 已安装到 {0} 个位置。",
"Show installed skills": "查看已安装的 Skill",
"RA3 Mod XML: no recorded Agent Skill installation to remove.": "RA3 Mod XML:没有可移除的 Agent Skill 安装记录。",
"missing — will be dropped from the record": "已缺失——将从记录中删除",
"installed by this extension (v{0})": "由本扩展安装(v{0})",
"not managed by this extension — will be skipped": "不由本扩展管理——将跳过",
"No RA3 Mod XML skill marker found; remove it manually if you want it gone.": "未找到 RA3 Mod XML Skill 标记;如需删除请手动处理。",
"Select Agent Skill installations to remove": "选择要移除的 Agent Skill 安装",
"RA3 Mod XML: removed {0} Agent Skill installation(s); {1} skipped (not managed by this extension).": "RA3 Mod XML:已移除 {0} 个 Agent Skill 安装;跳过 {1} 个(不由本扩展管理)。",
"RA3 Mod XML: removed {0} Agent Skill installation(s).": "RA3 Mod XML:已移除 {0} 个 Agent Skill 安装。",
"RA3 Mod XML: AI Agent access disabled for this workspace. Installed skills and MCP client configurations were kept.": "RA3 Mod XML:已禁用此工作区的 AI Agent 访问。已安装的 Skill 和 MCP 客户端配置已保留。",
"Uninstall AI Agent integration…": "卸载 AI Agent 集成…",
"Stop live AI Agent access in this window": "在此窗口中停止实时 AI Agent 访问",
"Remove installed Agent Skills": "移除已安装的 Agent Skill",
"{0} location(s)": "{0} 个位置",
"Remove MCP client configuration entries": "移除 MCP 客户端配置项",
"Claude Desktop / Cursor and files recorded by this extension": "Claude Desktop / Cursor 以及本扩展记录过的配置文件",
"Remove the stable MCP launcher": "移除稳定的 MCP 启动器",
"Select what to remove (nothing is removed until you confirm)": "选择要移除的内容(确认前不会删除任何内容)",
"Remove the selected AI Agent components?": "要移除选中的 AI Agent 组件吗?",
"Remove": "移除",
"live access stopped": "已停止实时访问",
"{0} skill installation(s) removed": "已移除 {0} 个 Skill 安装",
"{0} unmanaged skill folder(s) skipped": "已跳过 {0} 个非本扩展管理的 Skill 目录",
"MCP config removed from {0} file(s)": "已从 {0} 个配置文件中移除 MCP 配置",
"MCP launcher removed": "已移除 MCP 启动器",
"RA3 Mod XML AI Agent cleanup: {0}.": "RA3 Mod XML AI Agent 清理完成:{0}。",
"RA3 Mod XML: this version can expose the project's asset index to AI agents (MCP + Agent Skill). Enable it?": "RA3 Mod XML:此版本可以把项目资产索引提供给 AI Agent(MCP + Agent Skill)。要启用吗?",
"Enable AI Agent access": "启用 AI Agent 访问",
"Learn more": "了解更多",
"Don't show again": "不再提示",
"RA3 Mod XML: Find asset": "RA3 Mod XML:查找资产",
"Id, partial id or Type:Id (e.g. WeaponTemplate:AssaultRifle)": "ID、部分 ID 或 类型:ID(例如 WeaponTemplate:AssaultRifle)",
"Type an id, a partial id or Type:Id to search.": "输入 ID、部分 ID 或 类型:ID 进行搜索。",
"No asset matches \"{0}\".": "没有匹配 \"{0}\" 的资产。",
"{0} of {1} matches — keep typing to narrow the list.": "{0}/{1} 个匹配——继续输入可缩小范围。",
"1 asset found.": "找到 1 个资产。",
"{0} assets found.": "找到 {0} 个资产。",
"{0} definitions": "{0} 处定义",
"Select the definition to open": "选择要打开的定义",
"RA3 Mod XML: no XML source location for {0} ({1}).": "RA3 Mod XML:{0}({1})没有可打开的 XML 源位置。",
"RA3 Mod XML: the index has no assets yet — wait for indexing to finish.": "RA3 Mod XML:索引中还没有资产——请等待索引完成。",
"local": "本地"
}
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "ra3-mod-xml",
"version": "0.1.1",
"version": "0.1.25",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "ra3-mod-xml",
"version": "0.1.1",
"version": "0.1.25",
"license": "MIT",
"dependencies": {
"fast-xml-parser": "^4.5.0"
+103 -18
View File
@@ -1,10 +1,27 @@
{
"name": "ra3-mod-xml",
"displayName": "RA3 Mod XML",
"description": "Red Alert 3 Mod XML tooling: syntax highlighting, completions, reference navigation and diagnostics for SAGE/BinaryAssetBuilder XML.",
"version": "0.1.1",
"publisher": "ra3-mod-xml",
"license": "MIT",
"displayName": "%ra3modxml.displayName%",
"description": "%ra3modxml.description%",
"version": "0.1.26",
"publisher": "lanyi",
"license": "SEE LICENSE IN LICENSE",
"icon": "images/icon.png",
"repository": {
"type": "git",
"url": "https://github.com/RA3CoronaDevelopers/Ra3ModXmlExt.git"
},
"homepage": "https://github.com/RA3CoronaDevelopers/Ra3ModXmlExt",
"capabilities": {
"untrustedWorkspaces": {
"supported": "limited",
"description": "The workspace-defined SDK path and additional DATA: search paths are ignored until the workspace is trusted.",
"restrictedConfigurations": [
"ra3modxml.sdkPath",
"ra3modxml.additionalDataSearchPaths"
]
}
},
"l10n": "./l10n",
"engines": {
"vscode": "^1.85.0"
},
@@ -22,9 +39,14 @@
],
"main": "./dist/extension.js",
"activationEvents": [
"onLanguage:xml",
"workspaceContains:Mod.xml",
"workspaceContains:additionalmaps/mapmetadata_*.xml",
"workspaceContains:**/Data/Mod.xml",
"workspaceContains:**/Data/additionalmaps/mapmetadata_*.xml",
"workspaceContains:**/mod.babproj",
"workspaceContains:**/*.babproj"
"workspaceContains:**/*.babproj",
"onCommand:ra3modxml.configureSdkPath"
],
"contributes": {
"grammars": [
@@ -37,17 +59,17 @@
}
],
"configuration": {
"title": "RA3 Mod XML",
"title": "%ra3modxml.configuration.title%",
"properties": {
"ra3modxml.sdkPath": {
"type": "string",
"default": "C:\\Apps\\RA3-MODSDK-X",
"description": "Path to the RA3 Mod SDK root. Used to resolve DATA:/ART:/AUDIO: includes and to index vanilla SageXml sources."
"default": "",
"description": "%ra3modxml.sdkPath.description%"
},
"ra3modxml.indexSageXml": {
"type": "boolean",
"default": true,
"description": "Index vanilla game XML sources shipped with the SDK (SageXml) so completions/references can resolve vanilla asset ids."
"description": "%ra3modxml.indexSageXml.description%"
},
"ra3modxml.reportUnresolvedReferences": {
"type": "string",
@@ -57,12 +79,12 @@
"none"
],
"default": "warning",
"description": "Severity for attribute references (CommandSet=..., inheritFrom=...) that cannot be resolved in the index. The index covers mod XML sources, SDK SageXml sources and compiled manifests."
"description": "%ra3modxml.reportUnresolvedReferences.description%"
},
"ra3modxml.diagnoseUnknownElements": {
"type": "boolean",
"default": true,
"description": "Report element/attribute names that are not known from the bundled XSD model."
"description": "%ra3modxml.diagnoseUnknownElements.description%"
},
"ra3modxml.definitionMode": {
"type": "string",
@@ -71,7 +93,7 @@
"project-only"
],
"default": "all",
"description": "Go-to-definition candidates: 'all' lists the mod definition together with any vanilla (SDK/manifest) definitions (mod first); 'project-only' jumps directly to the mod definition and skips vanilla candidates when the id is defined in the project."
"description": "%ra3modxml.definitionMode.description%"
},
"ra3modxml.additionalDataSearchPaths": {
"type": "array",
@@ -79,20 +101,82 @@
"type": "string"
},
"default": [],
"description": "Extra absolute directories appended to the DATA: search path (checked after the project folders)."
"description": "%ra3modxml.additionalDataSearchPaths.description%"
}
}
},
"commands": [
{
"command": "ra3modxml.reindex",
"title": "RA3 Mod XML: Re-index workspace"
"title": "%ra3modxml.command.reindex.title%"
},
{
"command": "ra3modxml.openIndexReport",
"title": "RA3 Mod XML: Show index report"
"title": "%ra3modxml.command.openIndexReport.title%"
},
{
"command": "ra3modxml.clearCache",
"title": "%ra3modxml.command.clearCache.title%"
},
{
"command": "ra3modxml.configureSdkPath",
"title": "%ra3modxml.command.configureSdkPath.title%"
},
{
"command": "ra3modxml.showCacheReport",
"title": "%ra3modxml.command.showCacheReport.title%"
},
{
"command": "ra3modxml.enableAgentAccess",
"title": "%ra3modxml.command.enableAgentAccess.title%"
},
{
"command": "ra3modxml.disableAgentAccess",
"title": "%ra3modxml.command.disableAgentAccess.title%"
},
{
"command": "ra3modxml.installAgentSkill",
"title": "%ra3modxml.command.installAgentSkill.title%"
},
{
"command": "ra3modxml.uninstallAgentSkill",
"title": "%ra3modxml.command.uninstallAgentSkill.title%"
},
{
"command": "ra3modxml.uninstallAgentIntegration",
"title": "%ra3modxml.command.uninstallAgentIntegration.title%"
},
{
"command": "ra3modxml.exportIndexSnapshot",
"title": "%ra3modxml.command.exportIndexSnapshot.title%"
},
{
"command": "ra3modxml.findAsset",
"title": "%ra3modxml.command.findAsset.title%"
},
{
"command": "ra3modxml.findUnreferencedAssets",
"title": "%ra3modxml.command.findUnreferencedAssets.title%"
},
{
"command": "ra3modxml.findUnreferencedAssetsOfType",
"title": "%ra3modxml.command.findUnreferencedAssetsOfType.title%"
}
]
],
"menus": {
"editor/context": [
{
"command": "ra3modxml.findAsset",
"when": "editorLangId == xml && ra3modxml.active",
"group": "navigation@45"
},
{
"command": "ra3modxml.findUnreferencedAssetsOfType",
"when": "editorLangId == xml && ra3modxml.active",
"group": "navigation@50"
}
]
}
},
"scripts": {
"build": "node esbuild.mjs",
@@ -100,7 +184,8 @@
"generate-model": "node tools/xsd-to-model.mjs",
"pretest": "tsc",
"test": "node --test \"test/*.test.mjs\"",
"package": "npm run build && vsce package"
"package": "npm run build && vsce package --no-rewrite-relative-links",
"publish": "npm run build && vsce publish --no-rewrite-relative-links"
},
"dependencies": {
"fast-xml-parser": "^4.5.0"
+25
View File
@@ -0,0 +1,25 @@
{
"ra3modxml.displayName": "RA3 Mod XML",
"ra3modxml.description": "Red Alert 3 Mod XML tooling: syntax highlighting, completions, reference navigation and diagnostics for SAGE/BinaryAssetBuilder XML.",
"ra3modxml.configuration.title": "RA3 Mod XML",
"ra3modxml.sdkPath.description": "Path to the RA3 Mod SDK root. Used to resolve DATA:/ART:/AUDIO: includes and to index vanilla SageXml sources. Leave empty to disable vanilla SDK features (project-only mode).",
"ra3modxml.indexSageXml.description": "Index vanilla game XML sources shipped with the SDK (SageXml) so completions/references can resolve vanilla asset ids.",
"ra3modxml.reportUnresolvedReferences.description": "Severity for attribute references (CommandSet=..., inheritFrom=...) that cannot be resolved in the index. The index covers mod XML sources, SDK SageXml sources and compiled manifests.",
"ra3modxml.diagnoseUnknownElements.description": "Report element/attribute names that are not known from the bundled XSD model.",
"ra3modxml.definitionMode.description": "Go-to-definition candidates: 'all' lists the mod definition together with any vanilla (SDK/manifest) definitions (mod first); 'project-only' jumps directly to the mod definition and skips vanilla candidates when the id is defined in the project.",
"ra3modxml.additionalDataSearchPaths.description": "Extra absolute directories appended to the DATA: search path (checked after the project folders).",
"ra3modxml.command.reindex.title": "RA3 Mod XML: Re-index workspace",
"ra3modxml.command.openIndexReport.title": "RA3 Mod XML: Show index report",
"ra3modxml.command.clearCache.title": "RA3 Mod XML: Clear caches and rebuild",
"ra3modxml.command.configureSdkPath.title": "RA3 Mod XML: Configure SDK path…",
"ra3modxml.command.showCacheReport.title": "RA3 Mod XML: Show cache report",
"ra3modxml.command.enableAgentAccess.title": "RA3 Mod XML: Enable AI Agent access…",
"ra3modxml.command.disableAgentAccess.title": "RA3 Mod XML: Disable AI Agent access",
"ra3modxml.command.installAgentSkill.title": "RA3 Mod XML: Install Agent Skill…",
"ra3modxml.command.uninstallAgentSkill.title": "RA3 Mod XML: Uninstall Agent Skill…",
"ra3modxml.command.uninstallAgentIntegration.title": "RA3 Mod XML: Uninstall AI Agent integration…",
"ra3modxml.command.exportIndexSnapshot.title": "RA3 Mod XML: Export AI Agent index snapshot",
"ra3modxml.command.findAsset.title": "RA3 Mod XML: Find asset (id or Type:Id)…",
"ra3modxml.command.findUnreferencedAssets.title": "RA3 Mod XML: Find unreferenced assets…",
"ra3modxml.command.findUnreferencedAssetsOfType.title": "RA3 Mod XML: Find unreferenced assets of this type"
}
+25
View File
@@ -0,0 +1,25 @@
{
"ra3modxml.displayName": "RA3 Mod XML",
"ra3modxml.description": "红警 3 Mod XML 工具:为 SAGE/BinaryAssetBuilder XML 提供语法高亮、自动补全、引用跳转与诊断。",
"ra3modxml.configuration.title": "RA3 Mod XML",
"ra3modxml.sdkPath.description": "RA3 Mod SDK 根目录路径。用于解析 DATA:/ART:/AUDIO: include,并索引原版 SageXml 源码。留空可禁用 SDK 原版功能(仅项目模式)。",
"ra3modxml.indexSageXml.description": "索引 SDK 附带的原版游戏 XML 源码(SageXml),使补全/引用可以解析原版资产 id。",
"ra3modxml.reportUnresolvedReferences.description": "索引中无法解析的属性引用(CommandSet=...、inheritFrom=...)的诊断级别。索引覆盖 mod XML 源码、SDK SageXml 源码和编译后的 manifest。",
"ra3modxml.diagnoseUnknownElements.description": "报告不在内置 XSD 模型中的元素/属性名。",
"ra3modxml.definitionMode.description": "跳转定义候选项:'all' 同时列出 mod 定义与原版(SDK/manifest)定义(mod 优先);'project-only' 在项目内已定义该 id 时直接跳转 mod 定义并跳过原版候选。",
"ra3modxml.additionalDataSearchPaths.description": "追加到 DATA: 搜索路径末尾的额外绝对目录(在项目文件夹之后检查)。",
"ra3modxml.command.reindex.title": "RA3 Mod XML: 重建索引",
"ra3modxml.command.openIndexReport.title": "RA3 Mod XML: 显示索引报告",
"ra3modxml.command.clearCache.title": "RA3 Mod XML: 清空缓存并重建",
"ra3modxml.command.configureSdkPath.title": "RA3 Mod XML: 配置 SDK 路径…",
"ra3modxml.command.showCacheReport.title": "RA3 Mod XML: 显示缓存报告",
"ra3modxml.command.enableAgentAccess.title": "RA3 Mod XML: 启用 AI Agent 访问…",
"ra3modxml.command.disableAgentAccess.title": "RA3 Mod XML: 禁用 AI Agent 访问",
"ra3modxml.command.installAgentSkill.title": "RA3 Mod XML: 安装 Agent Skill…",
"ra3modxml.command.uninstallAgentSkill.title": "RA3 Mod XML: 卸载 Agent Skill…",
"ra3modxml.command.uninstallAgentIntegration.title": "RA3 Mod XML: 卸载 AI Agent 集成…",
"ra3modxml.command.exportIndexSnapshot.title": "RA3 Mod XML: 导出 AI Agent 索引快照",
"ra3modxml.command.findAsset.title": "RA3 Mod XML: 查找资产(ID 或 类型:ID)…",
"ra3modxml.command.findUnreferencedAssets.title": "RA3 Mod XML: 查找未引用的资产…",
"ra3modxml.command.findUnreferencedAssetsOfType.title": "RA3 Mod XML: 查找该类型的未引用资产"
}
+323
View File
@@ -0,0 +1,323 @@
/**
* Thin CLI for RA3 Mod XML index queries.
*
* Deliberately thin: it does **not** reimplement the query surface. It does
* exactly two things.
*
* 1. Forward the call to the live VS Code extension through the shared
* `LiveClient` (same transport, project pinning and validation as the MCP
* server, so the two entry points cannot drift apart).
* 2. Fall back to the on-disk snapshot exported by the extension when no live
* instance is reachable.
*
* Features that need the DOM (element-level provenance) are live-only; the
* CLI reports that clearly instead of returning an empty result that would
* look like "no references exist".
*
* The CLI is not installed into PATH. It is reached through an absolute path,
* normally by an agent following the skill's discovery instructions.
*
* Usage:
* node dist/agent/cli.js status
* node dist/agent/cli.js find <id> [type]
* node dist/agent/cli.js refs <id> [type]
* node dist/agent/cli.js outgoing <id> [type] [--depth N] [--target-types A,B]
* node dist/agent/cli.js list <type> [prefix]
* node dist/agent/cli.js active <file>
* node dist/agent/cli.js define <name>
* node dist/agent/cli.js resolve <source>
* node dist/agent/cli.js projects
*/
import { resolve } from "node:path";
import { findProjectRootUpward } from "../projectRoot";
import { LiveClient, type LiveClientOptions } from "./liveClient";
import {
findAssets,
findDefine,
findReferenceGroups,
isFileActive,
listAssetsByType,
resolveIncludeSource,
statusFromSnapshot,
} from "./query";
import { readSnapshotFile, snapshotPathForProject } from "./snapshot";
import type { AgentIndexSnapshot } from "./types";
const EXIT_OK = 0;
const EXIT_USAGE = 2;
const EXIT_UNAVAILABLE = 3;
export interface CliOptions {
projectDir: string | null;
snapshotPath: string | null;
agentHome: string | undefined;
command: string;
args: string[];
depth: number | undefined;
targetTypes: string[];
maxEdges: number | undefined;
includeUnresolved: boolean;
}
export function parseArgs(argv: string[]): CliOptions {
const options: CliOptions = {
projectDir: null,
snapshotPath: null,
agentHome: undefined,
command: "status",
args: [],
depth: undefined,
targetTypes: [],
maxEdges: undefined,
includeUnresolved: false,
};
const positional: string[] = [];
for (let i = 0; i < argv.length; i++) {
const arg = argv[i];
if (arg === "--project" || arg === "-p") {
options.projectDir = argv[++i] ?? null;
} else if (arg === "--snapshot" || arg === "-s") {
options.snapshotPath = argv[++i] ?? null;
} else if (arg === "--agent-home") {
options.agentHome = argv[++i] ?? undefined;
} else if (arg === "--depth" || arg === "-d") {
const raw = argv[++i];
options.depth = raw != null ? Number(raw) : undefined;
} else if (arg === "--target-types" || arg === "-t") {
options.targetTypes = (argv[++i] ?? "")
.split(",")
.map((s) => s.trim())
.filter(Boolean);
} else if (arg === "--max-edges") {
const raw = argv[++i];
options.maxEdges = raw != null ? Number(raw) : undefined;
} else if (arg === "--include-unresolved") {
options.includeUnresolved = true;
} else if (arg === "--help" || arg === "-h") {
options.command = "help";
} else if (arg.startsWith("-")) {
// Ignore unknown flags rather than failing an agent's probing call.
} else {
positional.push(arg);
}
}
if (positional.length > 0) {
options.command = positional[0];
options.args = positional.slice(1);
}
return options;
}
function printHelp(): void {
process.stdout.write(`RA3 Mod XML agent CLI
Usage:
node cli.js [--project <dir>] <command> [args...]
node cli.js [--snapshot <file>] <command> [args...]
Project resolution order:
1. --project
2. --snapshot
3. nearest mod project root above the current directory
Commands:
status index state (+ source: live or snapshot)
find <id> [type] asset definitions
refs <id> [type] incoming semantic references
outgoing <id> [type] outgoing reference edges (live only)
--depth N --target-types A,B --max-edges N --include-unresolved
list <type> [prefix] assets of one type
active <file> whether a file is in an indexed stream
define <name> $DEFINE constants
resolve <source> Include source candidate
projects indexed project roots (live only)
help
`);
}
/** Resolves the project directory, inferring it from cwd when not given. */
export function resolveProjectDir(options: CliOptions): string | null {
if (options.projectDir) return resolve(options.projectDir);
const inferred = findProjectRootUpward(process.cwd());
return inferred;
}
/** Writes JSON to stdout and returns the exit code. */
function emit(value: unknown): number {
process.stdout.write(`${JSON.stringify(value, null, 2)}\n`);
return EXIT_OK;
}
function fail(message: string, code = EXIT_USAGE): number {
process.stderr.write(`${message}\n`);
return code;
}
/** Live-only commands, reported explicitly when live is unreachable. */
export const LIVE_ONLY = new Set(["outgoing", "projects"]);
export function liveArgsFor(options: CliOptions): Record<string, unknown> {
const [a, b] = options.args;
switch (options.command) {
case "find":
return { id: a, type: b };
case "refs":
return { id: a, type: b };
case "outgoing":
return {
id: a,
type: b,
depth: options.depth,
targetTypes: options.targetTypes?.length ? options.targetTypes : undefined,
maxEdges: options.maxEdges,
includeUnresolved: options.includeUnresolved ? true : undefined,
};
case "list":
return { type: a, prefix: b };
case "active":
return { path: a };
case "define":
return { name: a };
case "resolve":
return { source: a };
default:
return {};
}
}
/** Maps a CLI command to the live/MCP tool name. */
export function toolNameFor(command: string): string {
switch (command) {
case "find":
return "find_asset";
case "refs":
return "find_references";
case "outgoing":
return "get_asset_references";
case "list":
return "list_assets_by_type";
case "active":
return "is_file_active";
case "define":
return "find_define";
case "resolve":
return "resolve_include";
case "projects":
return "list_projects";
default:
return "get_status";
}
}
/** Runs the command against the on-disk snapshot. */
function runSnapshotCommand(
options: CliOptions,
snapshot: AgentIndexSnapshot,
): number {
const [a, b] = options.args;
switch (options.command) {
case "status":
return emit({ source: "snapshot", index: statusFromSnapshot(snapshot) });
case "find":
if (!a) return fail("find requires an id.");
return emit(findAssets(snapshot, a, b));
case "refs":
if (!a) return fail("refs requires an id.");
return emit(findReferenceGroups(snapshot, a, b));
case "list":
if (!a) return fail("list requires a type.");
return emit(listAssetsByType(snapshot, a, b ?? ""));
case "active":
if (!a) return fail("active requires a file path.");
return emit({ active: isFileActive(snapshot, a) });
case "define":
if (!a) return fail("define requires a name.");
return emit(findDefine(snapshot, a.replace(/^\$/, "")));
case "resolve":
if (!a) return fail("resolve requires a source.");
return emit(resolveIncludeSource(snapshot, a));
default:
return fail(`Unknown command: ${options.command}`);
}
}
/** Explains why a live-only command could not run. */
function liveOnlyUnavailable(options: CliOptions): number {
return emit({
index: { state: "no_index" },
source: "unavailable",
error:
options.command === "outgoing"
? "get_asset_references requires a live index: the element context it reports is not stored in the on-disk snapshot. Open the project in VS Code with AI Agent access enabled, then retry."
: "list_projects requires a live index. Open the project in VS Code with AI Agent access enabled, then retry.",
});
}
async function main(): Promise<number> {
const options = parseArgs(process.argv.slice(2));
if (options.command === "help") {
printHelp();
return EXIT_OK;
}
const projectDir = resolveProjectDir(options);
// Live first: the extension's in-memory index is the most complete source.
if (!options.snapshotPath) {
const liveOptions: LiveClientOptions = {
projectDir,
agentHome: options.agentHome,
};
const client = new LiveClient(liveOptions);
const result = await client.query(
toolNameFor(options.command),
liveArgsFor(options),
);
if (result?.mismatched) {
return emit({
index: { state: "error" },
source: "live",
error: `The live server answered for a different project than "${projectDir}"; refusing the result.`,
});
}
if (result) {
return emit({ source: "live", ...(result.payload as object) });
}
// No live index: fall through to the snapshot when the command allows it.
if (LIVE_ONLY.has(options.command)) return liveOnlyUnavailable(options);
}
// Snapshot fallback.
const snapshotPath =
options.snapshotPath ??
(projectDir ? snapshotPathForProject(projectDir, options.agentHome) : null);
if (!snapshotPath) {
return fail(
"No project found. Pass --project <dir>, --snapshot <file>, or run from inside a mod project.",
EXIT_UNAVAILABLE,
);
}
const snapshot = await readSnapshotFile(snapshotPath);
if (!snapshot) {
return fail(
`No live VS Code instance and no readable snapshot at ${snapshotPath}. Open the project in VS Code with AI Agent access enabled, or run the "Export AI Agent index snapshot" command.`,
EXIT_UNAVAILABLE,
);
}
return runSnapshotCommand(options, snapshot);
}
// Only run the CLI when executed directly, so the module stays importable by
// tests (same guard as the MCP server).
if (typeof require !== "undefined" && require.main === module) {
void main().then(
(code) => {
process.exitCode = code;
},
(err) => {
process.stderr.write(`${err instanceof Error ? err.message : String(err)}\n`);
process.exitCode = EXIT_UNAVAILABLE;
},
);
}
+153
View File
@@ -0,0 +1,153 @@
/**
* Read/write helpers for the local endpoint files used by MCP/CLI tools to
* find a live RA3 Mod XML query server.
*
* Discovery is **per project** (`endpoints/<slug>-<hash>.json`) because a
* single global `endpoint.json` breaks as soon as more than one VS Code
* window (or more than one project) has AI Agent access enabled: the last
* window to start would overwrite the file, and a client started for project
* A could silently receive project B's index.
*
* A global `endpoint.json` is still written as a legacy/"most recent" pointer
* so tooling that does not know the project can find something, but readers
* that do know the project must prefer the per-project file.
*
* Pure TypeScript: no VS Code dependency.
*/
import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
import { dirname, join, resolve } from "node:path";
import { defaultAgentHome, snapshotBaseName } from "./snapshot";
export interface AgentEndpoint {
/** Base URL of the local server, e.g. http://127.0.0.1:54321 */
url: string;
token: string;
/** Absolute project root this endpoint serves (may serve several). */
projectDir?: string;
/** Every project root the server can answer for. */
projects?: string[];
/** PID of the VS Code extension host, used to detect stale files. */
processId?: number;
/** ISO timestamp of the last write, useful for diagnostics. */
updatedAt?: string;
}
/** Path to the legacy global endpoint file. */
export function endpointPath(agentHome = defaultAgentHome()): string {
return join(agentHome, "endpoint.json");
}
/** Directory holding one endpoint file per project. */
export function endpointDir(agentHome = defaultAgentHome()): string {
return join(agentHome, "endpoints");
}
/** Path to the per-project endpoint file. */
export function endpointPathForProject(
projectDir: string,
agentHome = defaultAgentHome(),
): string {
return join(endpointDir(agentHome), `${snapshotBaseName(projectDir)}.json`);
}
async function writeJson(file: string, value: unknown): Promise<void> {
await mkdir(dirname(file), { recursive: true });
await writeFile(file, `${JSON.stringify(value, null, 2)}\n`, "utf8");
}
async function readJson<T>(file: string): Promise<T | null> {
try {
return JSON.parse(await readFile(file, "utf8")) as T;
} catch {
return null;
}
}
/** Writes the legacy global endpoint file. */
export async function writeEndpoint(
endpoint: AgentEndpoint,
agentHome = defaultAgentHome(),
): Promise<string> {
const file = endpointPath(agentHome);
await writeJson(file, endpoint);
return file;
}
/** Writes one project's endpoint file (does not touch the global pointer). */
export async function writeEndpointForProject(
projectDir: string,
endpoint: AgentEndpoint,
agentHome = defaultAgentHome(),
): Promise<string> {
const file = endpointPathForProject(projectDir, agentHome);
await writeJson(file, { ...endpoint, projectDir: resolve(projectDir) });
return file;
}
/** Reads the legacy global endpoint file. */
export async function readEndpoint(
agentHome = defaultAgentHome(),
): Promise<AgentEndpoint | null> {
const parsed = await readJson<AgentEndpoint>(endpointPath(agentHome));
if (!parsed?.url || !parsed.token) return null;
return parsed;
}
/**
* Reads one project's endpoint. Returns null when the file is missing or the
* recorded project does not match the requested one (defence in depth: the
* file name already encodes the project, but a stale/hand-edited file must
* never be able to redirect a client to another project).
*/
export async function readEndpointForProject(
projectDir: string,
agentHome = defaultAgentHome(),
): Promise<AgentEndpoint | null> {
const parsed = await readJson<AgentEndpoint>(
endpointPathForProject(projectDir, agentHome),
);
if (!parsed?.url || !parsed.token) return null;
if (parsed.projectDir && !sameProject(parsed.projectDir, projectDir)) {
return null;
}
return parsed;
}
/** Removes the legacy global endpoint file. */
export async function clearEndpoint(
agentHome = defaultAgentHome(),
): Promise<void> {
await rm(endpointPath(agentHome), { force: true });
}
/** Removes one project's endpoint file. */
export async function clearEndpointForProject(
projectDir: string,
agentHome = defaultAgentHome(),
): Promise<void> {
await rm(endpointPathForProject(projectDir, agentHome), { force: true });
}
/** True when both paths resolve to the same project root. */
export function sameProject(a: string, b: string): boolean {
return resolve(a).toLowerCase() === resolve(b).toLowerCase();
}
/**
* True when a recorded extension-host PID is still running.
*
* `process.kill(pid, 0)` only probes existence: EPERM means the process
* exists but we may not signal it, which still counts as alive. Unknown PIDs
* are treated as alive so that a missing/older endpoint file does not disable
* the live path.
*/
export function isProcessAlive(pid: number | undefined | null): boolean {
if (typeof pid !== "number" || !Number.isInteger(pid) || pid <= 0) return true;
try {
process.kill(pid, 0);
return true;
} catch (err) {
return (err as NodeJS.ErrnoException).code === "EPERM";
}
}
+503
View File
@@ -0,0 +1,503 @@
/**
* Bounded, provenance-carrying forward-reference (outgoing edge) queries.
*
* The reverse index answers "who references this asset". This module answers
* the opposite, which the index does not store: "which assets does this asset
* reference, and through which XML element/attribute?".
*
* Design decisions (see docs/ai-agent-integration-plan.md §9):
*
* - It returns **edges**, not a flat node set. Each edge carries the element
* name, parent element name and attribute that produced it, plus the exact
* file/line of the XML text. A node list without that context forces the
* agent back into reading source, which is exactly what this should avoid.
* - It is **bounded three ways**: `depth` (1 default, 3 max), `targetTypes`
* (assignability filter) and `maxEdges`. Truncation is reported together
* with a per-type summary of what was dropped, so the caller can narrow the
* query instead of silently receiving a partial answer.
* - `inheritFrom` does **not** consume depth. Inheritance is part of an
* asset's own effective definition, so the ancestor's XML is walked at the
* same level and tagged with `definedIn`. This is what makes "AthenaCannon
* has no WeaponSetUpdate, but BaseCannon does" answerable in one call.
* - It is DOM-based and therefore **live-only**: resolving element context
* needs the parse tree, and storing element names on all ~98k reference
* records would measurably inflate the persistent cache.
* - It deliberately does **not** compute merged/inherited effective values:
* `xai:joinAction` Replace/Remove semantics are too easy to get wrong.
*
* Pure TypeScript: no VS Code dependency.
*/
import type { AssetDef, ModIndex } from "../indexer/types";
import { localName } from "../indexer/xpointer";
import {
isReferenceAttributeOfType,
isReferenceContentType,
resolveContentReferenceTargets,
resolveReferenceTargetsForType,
} from "../indexer/refs";
import {
LineMap,
parseXml,
type XmlDocument,
type XmlElement,
} from "../language/xmlParser";
import { resolveElementType } from "../language/typeContext";
import { isAssignableTo } from "../model/schemaModel";
export interface ForwardRefVia {
kind: "attribute" | "content" | "inheritFrom";
/** Element carrying the reference (e.g. `Weapon`). */
element: string;
/** Parent element giving the element its context (e.g. `WeaponSlotHardpoint`). */
parent: string | null;
/** Attribute name for `attribute` kind; null for `content`/`inheritFrom`. */
attribute: string | null;
}
/** A resolved definition location. */
export interface ForwardRefTarget {
type: string;
id: string;
file: string;
line: number;
}
export interface ForwardRefEdge {
/** 1-based hop number from the queried asset. */
depth: number;
/** The asset the edge is attributed to (the queried asset for inherited XML). */
from: { type: string; id: string };
/** Resolved definition, or null for an unresolved reference. */
to: ForwardRefTarget | null;
via: ForwardRefVia;
/**
* Present only when the XML text lives in an `inheritFrom` ancestor rather
* than in `from` itself.
*/
definedIn?: { type: string; id: string };
/** Exact source position of the reference value. */
source: { file: string; line: number; character: number };
/** Raw value, present for unresolved references and `inheritFrom` edges. */
value?: string;
}
export interface ForwardRefNode extends ForwardRefTarget {
/** Shallowest depth at which this node was reached. */
depth: number;
}
export interface ForwardRefOptions {
/** Levels of assets to expand. 1 = only the queried asset (default). Max 3. */
depth?: number;
/** Only keep edges/nodes whose target is assignable to one of these types. */
targetTypes?: string[];
/** Hard cap on returned edges (default 200). */
maxEdges?: number;
/** Include edges whose reference value could not be resolved. */
includeUnresolved?: boolean;
/** Walk `inheritFrom` ancestors (default true). */
includeInheritance?: boolean;
}
export interface ForwardRefResult {
roots: AssetDef[];
edges: ForwardRefEdge[];
nodes: ForwardRefNode[];
truncated: boolean;
/** Target types dropped because `maxEdges` was reached. */
omittedByTargetType: Record<string, number>;
/** Non-fatal warnings (missing files, missing definitions, capped chains). */
warnings: string[];
}
/** A parsed XML file plus the raw text, as needed by the DOM walk. */
export interface LoadedXmlFile {
parse: XmlDocument;
lineMap: LineMap;
text: string;
}
export type XmlFileLoader = (file: string) => Promise<LoadedXmlFile | null>;
const DEFAULT_MAX_EDGES = 200;
const MAX_DEPTH_LIMIT = 3;
/**
* Inheritance is walked at the same depth, so the chain length is capped
* separately to keep pathological hierarchies from expanding without bound.
*/
const MAX_INHERIT_CHAIN = 8;
/** Parses a file's text into the shape this module needs. */
export function parseLoadedXml(text: string): LoadedXmlFile {
return { parse: parseXml(text), lineMap: new LineMap(text), text };
}
/**
* Resolves the definitions to start from, then walks their outgoing
* references. Returns an empty result (with a warning) when nothing matches.
*/
export async function collectAssetReferences(
index: ModIndex,
id: string,
type: string | null,
loadFile: XmlFileLoader,
options: ForwardRefOptions = {},
): Promise<ForwardRefResult> {
const wanted = id.toLowerCase();
const wantedType = type?.toLowerCase() ?? null;
const roots = (index.assetsById.get(wanted) ?? []).filter(
(d) => !wantedType || d.type.toLowerCase() === wantedType,
);
if (!roots.length) {
return {
roots: [],
edges: [],
nodes: [],
truncated: false,
omittedByTargetType: {},
warnings: [
`No definition found for id "${id}"${type ? ` of type "${type}"` : ""}.`,
],
};
}
const result = await collectForwardReferences(index, roots, loadFile, options);
return { ...result, roots };
}
/**
* Walks the outgoing references of `roots` and returns bounded edges.
*/
export async function collectForwardReferences(
index: ModIndex,
roots: readonly AssetDef[],
loadFile: XmlFileLoader,
options: ForwardRefOptions = {},
): Promise<ForwardRefResult> {
const depthLimit = clampDepth(options.depth);
const maxEdges = Math.max(1, Math.floor(options.maxEdges ?? DEFAULT_MAX_EDGES));
const targetTypes = (options.targetTypes ?? []).filter(Boolean);
const includeUnresolved = options.includeUnresolved ?? false;
const includeInheritance = options.includeInheritance ?? true;
const edges: ForwardRefEdge[] = [];
const nodes = new Map<string, ForwardRefNode>();
const omitted = new Map<string, number>();
const warnings: string[] = [];
let truncated = false;
let edgeCount = 0;
const fileCache = new Map<string, LoadedXmlFile | null>();
const load = async (file: string): Promise<LoadedXmlFile | null> => {
const key = file.toLowerCase();
if (!fileCache.has(key)) {
try {
fileCache.set(key, await loadFile(file));
} catch {
fileCache.set(key, null);
}
}
return fileCache.get(key) ?? null;
};
interface WorkItem {
/** Asset whose XML is walked. */
def: AssetDef;
/** 0-based expansion level. */
level: number;
/** Asset the edges are attributed to (the queried asset). */
effective: { type: string; id: string };
/** Chain from `effective` (exclusive) down to `def` (inclusive). */
trail: { type: string; id: string }[];
}
const queue: WorkItem[] = roots.map((def) => ({
def,
level: 0,
effective: { type: def.type, id: def.id },
trail: [],
}));
const visited = new Set<string>();
const matchesTargetType = (typeName: string): boolean =>
targetTypes.length === 0 ||
targetTypes.some((wanted) => isAssignableTo(typeName, wanted));
const addEdge = (
level: number,
effective: WorkItem["effective"],
trail: WorkItem["trail"],
via: ForwardRefVia,
target: ForwardRefTarget | null,
source: ForwardRefEdge["source"],
value?: string,
): void => {
// `targetTypes` drops edges the caller did not ask for. `inheritFrom`
// edges always survive: they explain where the remaining edges came from
// (an inherited weapon lives in the ancestor's file, and editing the
// derived asset would be wrong). This filter is applied before the edge
// cap so `omittedByTargetType` only reports cap-driven truncation.
if (target && via.kind !== "inheritFrom" && !matchesTargetType(target.type)) {
return;
}
if (edgeCount >= maxEdges) {
truncated = true;
const bucket = target?.type ?? "#unresolved";
omitted.set(bucket, (omitted.get(bucket) ?? 0) + 1);
return;
}
edgeCount++;
const edge: ForwardRefEdge = {
depth: level + 1,
from: { type: effective.type, id: effective.id },
to: target,
via,
source,
};
if (trail.length) {
const owner = trail[trail.length - 1];
edge.definedIn = { type: owner.type, id: owner.id };
}
if (value !== undefined) edge.value = value;
edges.push(edge);
if (target) {
const key = nodeKey(target);
const existing = nodes.get(key);
if (!existing || level + 1 < existing.depth) {
nodes.set(key, { ...target, depth: level + 1 });
}
}
};
while (queue.length) {
const item = queue.shift()!;
const { def, level, effective, trail } = item;
const visitKey = [
effective.type,
effective.id.toLowerCase(),
def.type,
def.id.toLowerCase(),
def.file.toLowerCase(),
def.line,
].join("\u0000");
if (visited.has(visitKey)) continue;
visited.add(visitKey);
const loaded = await load(def.file);
if (!loaded) {
warnings.push(`Could not read ${def.file} (definition of ${def.type}:${def.id}).`);
continue;
}
const ownerEl = findDefinitionElement(loaded, def);
if (!ownerEl) {
warnings.push(
`Could not locate <${def.type} id="${def.id}"> inside ${def.file}; the index line may be stale.`,
);
continue;
}
const sourceAt = (offset: number): ForwardRefEdge["source"] => {
const pos = loaded.lineMap.positionAt(offset);
return { file: def.file, line: pos.line + 1, character: pos.character };
};
for (const el of subtreeInDocumentOrder(ownerEl)) {
const elType = resolveElementType(el);
const elLocal = localName(el.name);
const parentLocal = el.parent ? localName(el.parent.name) : null;
for (const attr of el.attrs) {
if (!attr.hasValue) continue;
const nameLower = attr.name.toLowerCase();
// inheritFrom belongs to the asset element itself and is handled
// separately below so it can also expand the ancestor chain.
if (nameLower === "inheritfrom") continue;
const value = attr.value;
if (!value || value.startsWith("$") || value.startsWith("=")) continue;
if (!isReferenceAttributeOfType(elType, attr.name)) continue;
const via: ForwardRefVia = {
kind: "attribute",
element: elLocal,
parent: parentLocal,
attribute: attr.name,
};
const source = sourceAt(attr.valueStart);
const targets = resolveReferenceTargetsForType(index, elType, attr.name, value);
if (!targets.length) {
if (includeUnresolved) addEdge(level, effective, trail, via, null, source, value);
continue;
}
for (const target of targets) {
const to = targetOf(target.def);
addEdge(level, effective, trail, via, to, source);
if (level + 1 < depthLimit) {
queue.push({
def: target.def,
level: level + 1,
effective: { type: target.def.type, id: target.def.id },
trail: [],
});
}
}
}
// Simple-content references (e.g. <CreateObject>temp_id</CreateObject>).
if (elType && isReferenceContentType(elType) && !el.selfClosing && el.closeTagStart >= 0) {
const raw = loaded.text.slice(el.startTagEnd, el.closeTagStart);
const value = raw.trim();
if (
!value ||
value.startsWith("$") ||
value.startsWith("=") ||
value.includes("<")
) {
continue;
}
const start = el.startTagEnd + raw.indexOf(value);
const via: ForwardRefVia = {
kind: "content",
element: elLocal,
parent: parentLocal,
attribute: null,
};
const source = sourceAt(start);
const targets = resolveContentReferenceTargets(index, elType, value);
if (!targets.length) {
if (includeUnresolved) addEdge(level, effective, trail, via, null, source, value);
continue;
}
for (const target of targets) {
const to = targetOf(target.def);
addEdge(level, effective, trail, via, to, source);
if (level + 1 < depthLimit) {
queue.push({
def: target.def,
level: level + 1,
effective: { type: target.def.type, id: target.def.id },
trail: [],
});
}
}
}
}
// inheritFrom on the definition element: walk the ancestor at the SAME
// level so its XML contributes to the queried asset's effective definition.
if (includeInheritance) {
const inheritAttr = ownerEl.attrs.find(
(a) => a.name.toLowerCase() === "inheritfrom",
);
const value = inheritAttr?.value;
if (inheritAttr?.hasValue && value && !value.startsWith("$") && !value.startsWith("=")) {
const via: ForwardRefVia = {
kind: "inheritFrom",
element: localName(ownerEl.name),
parent: ownerEl.parent ? localName(ownerEl.parent.name) : null,
attribute: inheritAttr.name,
};
const source = sourceAt(inheritAttr.valueStart);
const targets = resolveReferenceTargetsForType(
index,
def.type,
"inheritFrom",
value,
);
if (!targets.length) {
if (includeUnresolved) addEdge(level, effective, trail, via, null, source, value);
} else {
for (const target of targets) {
const to = targetOf(target.def);
addEdge(level, effective, trail, via, to, source, value);
// The trail records the asset whose XML we are about to walk, so
// edges found there report the correct `definedIn`.
const nextTrail = [
...trail,
{ type: target.def.type, id: target.def.id },
];
if (nextTrail.length < MAX_INHERIT_CHAIN) {
queue.push({ def: target.def, level, effective, trail: nextTrail });
} else {
warnings.push(
`Inheritance chain for ${effective.type}:${effective.id} exceeded ${MAX_INHERIT_CHAIN} levels; deeper ancestors were not walked.`,
);
}
}
}
}
}
}
return {
roots: [...roots],
edges,
nodes: [...nodes.values()].sort(
(a, b) => a.depth - b.depth || a.type.localeCompare(b.type) || a.id.localeCompare(b.id),
),
truncated,
omittedByTargetType: Object.fromEntries(omitted),
warnings,
};
}
function clampDepth(depth: number | undefined): number {
if (depth == null || !Number.isFinite(depth)) return 1;
return Math.max(1, Math.min(MAX_DEPTH_LIMIT, Math.floor(depth)));
}
function targetOf(def: AssetDef): ForwardRefTarget {
return { type: def.type, id: def.id, file: def.file, line: def.line };
}
function nodeKey(target: ForwardRefTarget): string {
return `${target.type}\u0000${target.id.toLowerCase()}\u0000${target.file.toLowerCase()}\u0000${target.line}`;
}
/**
* Finds the element defining `def` inside a parsed file.
*
* The index stores a line number for the `id` attribute, so an exact line
* match is the strongest signal; top-level placement is the next best. This
* matters when a nested element reuses the same id.
*/
export function findDefinitionElement(
loaded: LoadedXmlFile,
def: Pick<AssetDef, "id" | "line">,
): XmlElement | null {
const wanted = def.id.toLowerCase();
const root = loaded.parse.root;
let best: XmlElement | null = null;
let bestScore = -1;
for (const el of loaded.parse.elements) {
const idAttr = el.attrs.find((a) => a.name.toLowerCase() === "id");
if (!idAttr?.hasValue) continue;
if (idAttr.value.toLowerCase() !== wanted) continue;
let score = 0;
const isTopLevel = el.parent === root || (root == null && el.parent == null);
if (isTopLevel) score += 2;
if (def.line > 0) {
const line = loaded.lineMap.positionAt(idAttr.valueStart).line + 1;
if (line === def.line) score += 4;
}
if (score > bestScore) {
bestScore = score;
best = el;
}
}
return best;
}
/** Depth-first, document-order element list for a subtree (no recursion). */
export function subtreeInDocumentOrder(root: XmlElement): XmlElement[] {
const out: XmlElement[] = [];
const stack: XmlElement[] = [root];
while (stack.length) {
const el = stack.pop()!;
out.push(el);
for (let i = el.children.length - 1; i >= 0; i--) {
stack.push(el.children[i]);
}
}
return out;
}
+268
View File
@@ -0,0 +1,268 @@
/**
* Live-instance registry.
*
* Each VS Code window that enables AI Agent access writes **its own** file
* under `instances/`. Two properties follow from that:
*
* - **No locking and no merging.** Writers never touch each other's files, so
* there is no read-modify-write race to guard. An earlier design that
* shared a single JSON file would have needed a lock file (itself another
* thing a crash can leave behind) plus a merge step.
* - **Crash recovery does not wait for the same workspace.** Any instance can
* prune entries whose recorded PID is dead, so a crashed window is cleaned
* up the next time *any* VS Code window with the extension activates.
*
* A merged, read-only `index.json` is derived from the instance files purely
* for discovery (agents/humans looking at the directory), so the machine
* coordination files and the human-readable view stay separate.
*
* Pure TypeScript: no VS Code dependency.
*/
import { mkdir, readdir, readFile, rm, writeFile } from "node:fs/promises";
import { dirname, join } from "node:path";
import { clearEndpoint, isProcessAlive, writeEndpoint, type AgentEndpoint } from "./endpoint";
import { defaultAgentHome, snapshotBaseName } from "./snapshot";
/** One live extension-host instance. */
export interface AgentInstance extends AgentEndpoint {
/** Unique per window; also the file name stem. */
instanceId: string;
}
/** Discovery manifest derived from all live instances. */
export interface AgentIndexManifest {
schemaVersion: number;
generatedAt: string;
instances: Array<{
instanceId: string;
processId?: number;
url: string;
/** Tokens are intentionally omitted: the manifest is for discovery. */
projects: string[];
}>;
projects: string[];
}
export const INSTANCE_SCHEMA_VERSION = 1;
/** Directory holding one file per live extension host. */
export function instancesDir(agentHome = defaultAgentHome()): string {
return join(agentHome, "instances");
}
/** Path to the merged discovery manifest. */
export function manifestPath(agentHome = defaultAgentHome()): string {
return join(agentHome, "index.json");
}
/** File name for one instance. */
export function instanceFileName(instanceId: string): string {
return `vscode-${instanceId}.json`;
}
/**
* Builds a process-unique instance id. Combining the PID with a random suffix
* keeps two windows of the same process id from colliding across restarts.
*/
export function makeInstanceId(pid = process.pid): string {
const rand = Math.random().toString(36).slice(2, 8);
return `${pid}-${rand}`;
}
/** Writes this instance's own file. */
export async function writeInstance(
instance: AgentInstance,
agentHome = defaultAgentHome(),
): Promise<string> {
const file = join(instancesDir(agentHome), instanceFileName(instance.instanceId));
await mkdir(dirname(file), { recursive: true });
await writeFile(file, `${JSON.stringify(instance, null, 2)}\n`, "utf8");
return file;
}
/** Reads every instance file, skipping malformed ones. */
export async function readInstances(
agentHome = defaultAgentHome(),
): Promise<AgentInstance[]> {
const dir = instancesDir(agentHome);
let names: string[];
try {
names = await readdir(dir);
} catch {
return [];
}
const out: AgentInstance[] = [];
for (const name of names) {
if (!name.endsWith(".json")) continue;
try {
const parsed = JSON.parse(
await readFile(join(dir, name), "utf8"),
) as AgentInstance;
if (parsed?.url && parsed?.token) {
// Fall back to the file name when an older file lacks the field.
parsed.instanceId ??= name.replace(/^vscode-/, "").replace(/\.json$/, "");
out.push(parsed);
}
} catch {
// Skip unreadable/corrupt entries.
}
}
return out;
}
/** Removes this instance's own file. */
export async function clearInstance(
instanceId: string,
agentHome = defaultAgentHome(),
): Promise<void> {
await rm(join(instancesDir(agentHome), instanceFileName(instanceId)), {
force: true,
});
}
export interface PruneResult {
removed: string[];
kept: AgentInstance[];
}
/**
* Removes instance files whose recorded PID is no longer alive.
*
* This is how crashes are cleaned up without waiting for the same workspace to
* be reopened. Only clearly-dead PIDs are pruned: `isProcessAlive` treats an
* unknown or unparseable PID as alive, so an older file that predates the
* `processId` field is never deleted by mistake.
*/
export async function pruneInstances(
agentHome = defaultAgentHome(),
): Promise<PruneResult> {
const instances = await readInstances(agentHome);
const removed: string[] = [];
const kept: AgentInstance[] = [];
for (const instance of instances) {
if (isProcessAlive(instance.processId)) {
kept.push(instance);
} else {
removed.push(instance.instanceId);
await clearInstance(instance.instanceId, agentHome).catch(() => undefined);
}
}
return { removed, kept };
}
/** Collects every project root across live instances. */
export function projectsOf(instances: readonly AgentInstance[]): string[] {
const seen = new Set<string>();
const out: string[] = [];
for (const instance of instances) {
const candidates = [
...(instance.projects ?? []),
...(instance.projectDir ? [instance.projectDir] : []),
];
for (const project of candidates) {
const key = project.toLowerCase();
if (seen.has(key)) continue;
seen.add(key);
out.push(project);
}
}
return out;
}
/**
* Regenerates the merged read-only manifest from the live instances.
* Best-effort: failures are swallowed because the manifest is a convenience,
* not a correctness requirement (readers can always scan `instances/`).
*/
export async function writeManifest(
instances: readonly AgentInstance[],
agentHome = defaultAgentHome(),
): Promise<AgentIndexManifest> {
const manifest: AgentIndexManifest = {
schemaVersion: INSTANCE_SCHEMA_VERSION,
generatedAt: new Date().toISOString(),
instances: instances.map((instance) => ({
instanceId: instance.instanceId,
processId: instance.processId,
url: instance.url,
projects: [
...(instance.projects ?? []),
...(instance.projectDir ? [instance.projectDir] : []),
],
})),
projects: projectsOf(instances),
};
try {
const file = manifestPath(agentHome);
await mkdir(dirname(file), { recursive: true });
await writeFile(file, `${JSON.stringify(manifest, null, 2)}\n`, "utf8");
} catch {
// Discovery only: never fail the caller over this.
}
return manifest;
}
/** Reads the discovery manifest, or null when absent/malformed. */
export async function readManifest(
agentHome = defaultAgentHome(),
): Promise<AgentIndexManifest | null> {
try {
return JSON.parse(
await readFile(manifestPath(agentHome), "utf8"),
) as AgentIndexManifest;
} catch {
return null;
}
}
/**
* Re-derives the legacy global endpoint pointer and the merged discovery
* manifest from the instance files that still exist and whose recorded
* process is alive.
*
* Called after an instance file is removed (window closed, or pruned as
* crashed). Closing one window must never make another still-running window
* undiscoverable: whichever writer changed the instance set has to rebuild
* both derived files from the survivors instead of clearing them.
*
* Best-effort: the pointer/manifest are discovery conveniences, and readers
* can always scan `instances/`, so failures never propagate to the caller.
*/
export async function refreshDiscovery(
agentHome = defaultAgentHome(),
): Promise<AgentIndexManifest> {
const { kept } = await pruneInstances(agentHome);
const first = kept[0];
try {
if (first) {
await writeEndpoint(endpointOf(first), agentHome);
} else {
await clearEndpoint(agentHome);
}
} catch {
// Discovery pointer only; the manifest below is still worth writing.
}
return writeManifest(kept, agentHome);
}
/**
* The endpoint fields of an instance file, without the registry-only
* `instanceId` (endpoint.json predates the instance registry and readers do
* not expect that field).
*/
function endpointOf(instance: AgentInstance): AgentEndpoint {
return {
url: instance.url,
token: instance.token,
projectDir: instance.projectDir,
projects: instance.projects,
processId: instance.processId,
updatedAt: instance.updatedAt,
};
}
/** Snapshot path for a project, re-exported for discovery convenience. */
export function projectKey(projectDir: string): string {
return snapshotBaseName(projectDir);
}
+272
View File
@@ -0,0 +1,272 @@
/**
* Shared live-index client used by both the MCP server and the CLI.
*
* Keeping this in one place matters because the forwarding path carries safety
* logic that must not drift between entry points:
*
* - the requested project is always pinned on the request, so the server
* cannot answer from whichever project its active editor points at;
* - a response reporting a different `projectDir` is refused rather than
* shown, because a plausible wrong answer is worse than no answer;
* - a dead extension-host PID marks the instance file stale;
* - failed attempts are negatively cached so every tool call does not pay a
* connection timeout.
*
* Transport is currently loopback HTTP. Swapping it for a named pipe / Unix
* domain socket only requires changing this file.
*
* Pure TypeScript: no VS Code dependency.
*/
import {
isProcessAlive,
readEndpoint,
readEndpointForProject,
sameProject,
type AgentEndpoint,
} from "./endpoint";
import { readInstances } from "./instances";
/** Cooldown after a failed live attempt, to avoid a probe per tool call. */
const LIVE_RETRY_COOLDOWN_MS = 5000;
/** Per-request timeout for a live query. */
const LIVE_TIMEOUT_MS = 1500;
export interface LiveQueryResult {
payload: unknown;
/** True when the live server answered but for a different project. */
mismatched: boolean;
/** Which endpoint produced the answer (for diagnostics). */
endpoint: AgentEndpoint;
}
/** Normalizes a path for case/separator-insensitive comparison. */
export function normalizePath(p: string): string {
return p.replace(/\\/g, "/").replace(/\/+$/, "").toLowerCase();
}
/**
* Rejects a live response that belongs to a different project than the one
* the client was started for. See docs/ai-agent-integration-plan.md §10 for
* why this guard exists: in a multi-window setup a client configured for
* project A could otherwise silently receive project B's index.
*/
export function responseProjectMismatch(
payload: unknown,
projectDir: string | null,
): boolean {
if (!projectDir) return false;
const index = (payload as { index?: { projectDir?: string } } | null)?.index;
const reported = index?.projectDir;
if (!reported) return false;
return normalizePath(reported) !== normalizePath(projectDir);
}
/** Tools that can be answered by the live index and their HTTP paths. */
const TOOL_PATHS: Record<string, string> = {
get_status: "/status",
find_asset: "/find_asset",
find_references: "/find_references",
get_asset_references: "/get_asset_references",
list_assets_by_type: "/list_assets",
is_file_active: "/is_file_active",
find_define: "/find_define",
resolve_include: "/resolve_include",
list_projects: "/projects",
};
/**
* Builds the live request URL for a tool call, always pinning the project.
* Returns null for tools the live server does not serve.
*/
export function liveUrlForTool(
endpointUrl: string,
projectDir: string | null,
toolName: string,
args: Record<string, unknown>,
): string | null {
const path = TOOL_PATHS[toolName];
if (!path) return null;
const base = endpointUrl.replace(/\/$/, "");
const q = new URLSearchParams();
// Always pin the requested project. Without this the server would silently
// answer from whatever project its active editor points at.
if (projectDir) q.set("project", projectDir);
switch (toolName) {
case "get_status":
case "list_projects":
break;
case "find_asset":
case "find_references":
case "get_asset_references":
q.set("id", String(args.id ?? ""));
if (args.type != null) q.set("type", String(args.type));
if (toolName === "get_asset_references") {
if (args.depth != null) q.set("depth", String(args.depth));
if (Array.isArray(args.targetTypes)) {
q.set("targetTypes", (args.targetTypes as unknown[]).map(String).join(","));
}
if (args.maxEdges != null) q.set("maxEdges", String(args.maxEdges));
if (args.includeUnresolved != null) {
q.set("includeUnresolved", String(args.includeUnresolved));
}
}
break;
case "list_assets_by_type":
q.set("type", String(args.type ?? ""));
if (args.prefix != null) q.set("prefix", String(args.prefix));
if (args.limit != null) q.set("limit", String(args.limit));
break;
case "is_file_active":
q.set("path", String(args.path ?? ""));
break;
case "find_define":
q.set("name", String(args.name ?? ""));
break;
case "resolve_include":
q.set("source", String(args.source ?? ""));
break;
default:
return null;
}
const query = q.toString();
return query ? `${base}${path}?${query}` : `${base}${path}`;
}
export interface LiveClientOptions {
/** Project the client was started for (pins every request). */
projectDir?: string | null;
/** Override the agent home directory (used by tests). */
agentHome?: string;
/** Clock injection for deterministic negative-cache tests. */
now?: () => number;
}
/**
* Finds a usable endpoint for this client's project.
*
* Order: per-project file, then any live instance whose `projects` list
* contains this project, then the legacy global pointer (only when its
* recorded project matches). Endpoints with a dead PID are skipped.
*/
export async function findEndpoint(
options: LiveClientOptions = {},
): Promise<AgentEndpoint | null> {
const projectDir = options.projectDir ?? null;
const agentHome = options.agentHome;
if (projectDir) {
const direct = await readEndpointForProject(projectDir, agentHome);
if (direct && isProcessAlive(direct.processId)) return direct;
}
// Scan live instances: this is what makes a freshly started window work
// even if its per-project file has not been written yet.
try {
const instances = await readInstances(agentHome);
for (const instance of instances) {
if (!isProcessAlive(instance.processId)) continue;
if (projectDir && instance.projectDir && !sameProject(instance.projectDir, projectDir)) {
continue;
}
if (
projectDir &&
instance.projects?.length &&
!instance.projects.some((p) => sameProject(p, projectDir))
) {
continue;
}
return instance;
}
} catch {
// Instance scanning is best-effort.
}
const fallback = await readEndpoint(agentHome);
if (fallback && isProcessAlive(fallback.processId)) {
if (
!projectDir ||
!fallback.projectDir ||
sameProject(fallback.projectDir, projectDir)
) {
return fallback;
}
}
return null;
}
/**
* Queries the live extension server. Returns null when no live index is
* reachable, so callers can fall back to the on-disk snapshot.
*/
export class LiveClient {
private unavailableUntil = 0;
private readonly now: () => number;
constructor(private readonly options: LiveClientOptions = {}) {
this.now = options.now ?? Date.now;
}
/** True while the negative cache is suppressing attempts. */
get suppressed(): boolean {
return this.now() < this.unavailableUntil;
}
/** Clears the negative cache (e.g. after the user re-enables access). */
reset(): void {
this.unavailableUntil = 0;
}
/** Marks the live path unavailable for the cooldown period. */
markUnavailable(): void {
this.unavailableUntil = this.now() + LIVE_RETRY_COOLDOWN_MS;
}
async query(
toolName: string,
args: Record<string, unknown> = {},
): Promise<LiveQueryResult | null> {
if (this.suppressed) return null;
if (typeof fetch !== "function") return null;
const projectDir = this.options.projectDir ?? null;
const endpoint = await findEndpoint(this.options);
if (!endpoint) return null;
const url = liveUrlForTool(endpoint.url, projectDir, toolName, args);
if (!url) return null;
const controller = new AbortController();
const timeout = setTimeout(() => controller.abort(), LIVE_TIMEOUT_MS);
try {
const res = await fetch(url, {
headers: { authorization: `Bearer ${endpoint.token}` },
signal: controller.signal,
});
if (!res.ok) {
// 401/404 mean the endpoint is stale rather than merely slow.
if (res.status === 401 || res.status === 404) this.markUnavailable();
return null;
}
const payload: unknown = await res.json();
return {
payload,
mismatched: responseProjectMismatch(payload, projectDir),
endpoint,
};
} catch {
this.markUnavailable();
return null;
} finally {
clearTimeout(timeout);
}
}
}
/** Convenience one-shot query using a fresh client. */
export async function queryLive(
toolName: string,
args: Record<string, unknown> = {},
options: LiveClientOptions = {},
): Promise<LiveQueryResult | null> {
return new LiveClient(options).query(toolName, args);
}
+147
View File
@@ -0,0 +1,147 @@
/**
* Query helpers that operate directly on the live in-memory ModIndex.
*
* These are useful for local HTTP/live services where converting the full
* index to an external snapshot on every query would be wasteful.
*
* Pure TypeScript: no VS Code dependency.
*/
import { resolve } from "node:path";
import type { AssetDef, DefineDef, ModIndex, ReferenceSite } from "../indexer/types";
import { statusFromIndex } from "./snapshot";
import type { AgentIndexStatus, AgentReferenceGroup } from "./types";
function normalizePath(p: string): string {
return resolve(p).replace(/\\/g, "/").toLowerCase();
}
/** Finds asset definitions by id in the live index. */
export function findAssetsLive(
index: ModIndex,
id: string,
type?: string | null,
): AssetDef[] {
const wanted = id.toLowerCase();
const wantedType = type?.toLowerCase();
const candidates = index.assetsById.get(wanted) ?? [];
if (!wantedType) return candidates;
return candidates.filter((a) => a.type.toLowerCase() === wantedType);
}
/** Lists assets of one type in the live index. */
export function listAssetsByTypeLive(
index: ModIndex,
type: string,
idPrefix = "",
limit?: number,
): AssetDef[] {
const wantedType = type.toLowerCase();
const wantedPrefix = idPrefix.toLowerCase();
const byType = index.assets.get(type);
if (!byType) return [];
const out: AssetDef[] = [];
for (const [id, defs] of byType) {
if (!id.startsWith(wantedPrefix)) continue;
for (const def of defs) {
if (def.type.toLowerCase() !== wantedType) continue;
out.push(def);
if (limit != null && out.length >= limit) return out;
}
}
return out;
}
/**
* Converts the reverse reference map into groups for one asset id.
* Reference map keys are `type\0id\0file\0line`.
*/
export function findReferenceGroupsLive(
index: ModIndex,
id: string,
type?: string | null,
): AgentReferenceGroup[] {
const wanted = id.toLowerCase();
const wantedType = type?.toLowerCase();
const groups: AgentReferenceGroup[] = [];
for (const [key, sites] of index.references) {
const parts = key.split("\u0000");
if (parts.length !== 4) continue;
const [typeName, defId, file, lineText] = parts;
if (defId.toLowerCase() !== wanted) continue;
if (wantedType && typeName.toLowerCase() !== wantedType) continue;
groups.push({
type: typeName,
id: defId,
file,
line: Number(lineText) || 0,
sites,
});
}
return groups;
}
/** Flattens live reference groups into sites. */
export function findReferenceSitesLive(
index: ModIndex,
id: string,
type?: string | null,
): ReferenceSite[] {
return findReferenceGroupsLive(index, id, type).flatMap((g) => g.sites);
}
/** Returns streams containing a file in the live index. */
export function streamsForFileLive(
index: ModIndex,
file: string,
): ModIndex["streams"] {
const key = normalizePath(file);
return index.streams.filter((s) =>
[...s.files].some((candidate) => normalizePath(candidate) === key),
);
}
/** True when a file belongs to a live stream. */
export function isFileActiveLive(index: ModIndex, file: string): boolean {
return streamsForFileLive(index, file).length > 0;
}
/** Finds defines by name in the live index. */
export function findDefineLive(
index: ModIndex,
name: string,
): DefineDef[] {
const wanted = name.toLowerCase();
return index.defines.get(wanted) ?? [];
}
/** Resolves Include source using the live source-candidate list. */
export function resolveIncludeLive(
index: ModIndex,
source: string,
): { source: string; path: string } | null {
const wanted = source.toLowerCase();
const hit = index.sourceCandidates.find(
(c) => c.source.toLowerCase() === wanted,
);
return hit ? { source: hit.source, path: hit.path } : null;
}
/**
* Returns a status object for the live index.
*
* `requestedProjectDir` is only echoed when no index is available, so callers
* can still verify which server they reached. It is never used to fake a
* `projectDir` when an index exists — the index is the source of truth.
*/
export function liveStatus(
index: ModIndex | null | undefined,
requestedProjectDir?: string,
): AgentIndexStatus {
return statusFromIndex(index, requestedProjectDir);
}
/** Every project root this index belongs to (for `/projects` listing). */
export function knownProjectDirs(index: ModIndex | null | undefined): string[] {
return index ? [index.projectDir] : [];
}
+268
View File
@@ -0,0 +1,268 @@
/**
* Local read-only HTTP server for live RA3 Mod XML index queries.
*
* The server runs inside the VS Code extension host when the user has enabled
* AI Agent access. It listens only on 127.0.0.1 and requires a bearer token so
* unrelated local processes cannot query it by accident.
*
* Requests may carry `?project=<dir>` to select which project's index answers
* the query. When omitted, the server falls back to the active project. Every
* response echoes `index.projectDir` so the caller can verify it reached the
* server/project it asked for — see docs/ai-agent-integration-plan.md §10 for
* why that check is required in multi-window setups.
*
* Pure TypeScript: no VS Code dependency.
*/
import { createServer, type IncomingMessage, type ServerResponse } from "node:http";
import type { AddressInfo } from "node:net";
import type { ModIndex } from "../indexer/types";
import {
collectAssetReferences,
type ForwardRefOptions,
type XmlFileLoader,
} from "./forwardRefs";
import {
findAssetsLive,
findDefineLive,
findReferenceGroupsLive,
isFileActiveLive,
listAssetsByTypeLive,
liveStatus,
resolveIncludeLive,
} from "./liveQuery";
const USAGE_GUIDE = `RA3 Mod XML live index query API
Endpoints (all require Authorization: Bearer <token>):
GET /status
GET /projects
GET /find_asset?id=...&type=...
GET /find_references?id=...&type=...
GET /get_asset_references?id=...&type=...&depth=1&targetTypes=A,B&maxEdges=200
GET /list_assets?type=...&prefix=...&limit=...
GET /is_file_active?path=...
GET /find_define?name=...
GET /resolve_include?source=...
GET /get_usage_guide
All endpoints accept an optional ?project=<absolute dir> selector. Responses
echo index.projectDir; treat the result as belonging to a different project
when it does not match what you asked for.
`;
export interface LocalServerHandle {
port: number;
token: string;
close(): Promise<void>;
}
export interface LocalServerOptions {
/** Returns the current in-memory index for a project (null when unknown). */
getIndex: (projectDir?: string) => ModIndex | null;
/** Every project root the live workspace currently knows about. */
listProjects?: () => string[];
/**
* Reads + parses one XML file. Required by /get_asset_references, which
* needs element context that the index does not store.
*/
loadFile?: XmlFileLoader;
token?: string;
/** Defaults to an OS-assigned port on 127.0.0.1. */
port?: number;
}
function sendJson(res: ServerResponse, status: number, value: unknown): void {
const body = JSON.stringify(value);
res.writeHead(status, {
"content-type": "application/json; charset=utf-8",
"content-length": Buffer.byteLength(body),
});
res.end(body);
}
function sendText(res: ServerResponse, status: number, text: string): void {
res.writeHead(status, {
"content-type": "text/plain; charset=utf-8",
"content-length": Buffer.byteLength(text),
});
res.end(text);
}
function isAuthorized(req: IncomingMessage, token: string): boolean {
const header = req.headers.authorization ?? "";
return header === `Bearer ${token}`;
}
/** Parses a comma-separated `targetTypes` parameter. */
function parseList(raw: string | null): string[] {
if (!raw) return [];
return raw
.split(",")
.map((s) => s.trim())
.filter(Boolean);
}
function parseNumber(raw: string | null): number | undefined {
if (raw == null || raw === "") return undefined;
const value = Number(raw);
return Number.isFinite(value) ? value : undefined;
}
function forwardRefOptionsFrom(q: URLSearchParams): ForwardRefOptions {
return {
depth: parseNumber(q.get("depth")),
targetTypes: parseList(q.get("targetTypes")),
maxEdges: parseNumber(q.get("maxEdges")),
includeUnresolved: q.get("includeUnresolved") === "true",
};
}
async function handle(
options: LocalServerOptions,
token: string,
req: IncomingMessage,
res: ServerResponse,
): Promise<void> {
if (!isAuthorized(req, token)) {
sendJson(res, 401, { error: "Unauthorized" });
return;
}
const url = new URL(req.url ?? "/", "http://127.0.0.1");
const q = url.searchParams;
const projectDir = q.get("project") ?? undefined;
const index = options.getIndex(projectDir);
// When an index exists its own projectDir is authoritative; the selector is
// only echoed for no-index responses so callers can still verify the server.
const status = liveStatus(index, projectDir);
switch (url.pathname) {
case "/status":
sendJson(res, 200, status);
return;
case "/projects":
sendJson(res, 200, {
index: status,
data: options.listProjects?.() ?? [],
});
return;
case "/find_asset":
sendJson(res, 200, {
index: status,
data: index ? findAssetsLive(index, q.get("id") ?? "", q.get("type")) : [],
});
return;
case "/find_references":
sendJson(res, 200, {
index: status,
data: index
? findReferenceGroupsLive(index, q.get("id") ?? "", q.get("type"))
: [],
});
return;
case "/list_assets": {
const limit = parseNumber(q.get("limit"));
sendJson(res, 200, {
index: status,
data: index
? listAssetsByTypeLive(index, q.get("type") ?? "", q.get("prefix") ?? "", limit)
: [],
});
return;
}
case "/is_file_active":
sendJson(res, 200, {
index: status,
data: { active: index ? isFileActiveLive(index, q.get("path") ?? "") : false },
});
return;
case "/find_define":
sendJson(res, 200, {
index: status,
data: index
? findDefineLive(index, (q.get("name") ?? "").replace(/^\$/, ""))
: [],
});
return;
case "/resolve_include":
sendJson(res, 200, {
index: status,
data: index ? resolveIncludeLive(index, q.get("source") ?? "") : null,
});
return;
case "/get_asset_references": {
if (!index) {
sendJson(res, 200, {
index: status,
data: null,
error:
"get_asset_references requires a live index (VS Code must be open with the project indexed).",
});
return;
}
if (!options.loadFile) {
sendJson(res, 200, {
index: status,
data: null,
error: "The live server was started without XML file access.",
});
return;
}
const result = await collectAssetReferences(
index,
q.get("id") ?? "",
q.get("type"),
options.loadFile,
forwardRefOptionsFrom(q),
);
sendJson(res, 200, { index: status, data: result });
return;
}
case "/get_usage_guide":
sendText(res, 200, USAGE_GUIDE);
return;
default:
sendJson(res, 404, { error: `Not found: ${url.pathname}` });
}
}
/** Starts a local HTTP server; resolves once it is listening. */
export async function startLocalServer(
options: LocalServerOptions,
): Promise<LocalServerHandle> {
const token = options.token ?? randomToken();
const server = createServer((req, res) => {
void handle(options, token, req, res).catch((err) => {
sendJson(res, 500, {
error: err instanceof Error ? err.message : String(err),
});
});
});
await new Promise<void>((resolveListen, reject) => {
server.once("error", reject);
server.listen(options.port ?? 0, "127.0.0.1", () => resolveListen());
});
const address = server.address() as AddressInfo;
return {
port: address.port,
token,
close: () =>
new Promise<void>((resolveClose, rejectClose) => {
server.close((err) => (err ? rejectClose(err) : resolveClose()));
}),
};
}
function randomToken(): string {
return `ra3-${Date.now().toString(36)}-${Math.random().toString(36).slice(2)}`;
}
+379
View File
@@ -0,0 +1,379 @@
/**
* Minimal MCP (Model Context Protocol) stdio server exposing the RA3 Mod XML
* agent snapshot query API.
*
* This is intentionally dependency-free. It speaks the JSON-RPC-over-stdio
* subset used by MCP clients:
*
* initialize
* notifications/initialized
* ping
* tools/list
* tools/call
*
* Usage:
* node out/agent/mcpServer.js --project D:/Mods/Example
* node out/agent/mcpServer.js --snapshot /path/to/snapshot.json.gz
*/
import { createInterface } from "node:readline";
import { LiveClient } from "./liveClient";
import { pruneInstances } from "./instances";
import { readSnapshotFile, snapshotPathForProject } from "./snapshot";
import {
findAssets,
findDefine,
findReferenceGroups,
isFileActive,
listAssetsByType,
resolveIncludeSource,
statusFromSnapshot,
} from "./query";
import type { AgentIndexSnapshot } from "./types";
interface McpTool {
name: string;
description: string;
inputSchema: Record<string, unknown>;
handler: (args: Record<string, unknown>, snapshot: AgentIndexSnapshot | null) => unknown;
}
const USAGE_GUIDE = `RA3 Mod XML index query tools
This MCP server exposes the semantic index built by the RA3 Mod XML VS Code extension.
Use these tools instead of full-text grepping the XML tree when you need exact facts:
- find_asset(id, type?) -> definition sites (file/line/origin/stream)
- find_references(id, type?) -> semantic reference sites
- get_asset_references(id, type?, depth?, targetTypes?) -> outgoing reference EDGES with element context
- list_assets_by_type(type, prefix?, limit?) -> assets of a type
- is_file_active(path) -> whether a file is part of an indexed include stream
- find_define(name) -> $DEFINE definitions
- resolve_include(source) -> candidate source file
- list_projects() -> project roots the live extension has indexed
- get_status() -> current index state
Tips:
- Asset ids are case-insensitive.
- Prefer passing type when the same id exists for multiple asset types.
- Always check the returned index state; if it is stale/incomplete, treat results as provisional.
- Use get_asset_references to follow "which weapon/model/upgrade does this asset use" chains.
It returns edges annotated with the element name, parent element and attribute that produced
them, plus the exact XML file/line, so you do not have to read source to find the link.
Start with depth 1 (the default) and pass targetTypes (e.g. ["WeaponTemplate"]) to cut noise.
Edges with a "definedIn" field come from an inheritFrom ancestor's XML.
When "truncated" is true, read "omittedByTargetType" and narrow the query instead of retrying.
- Do not attempt to read the entire snapshot file; query narrowly.`;
const TOOLS: McpTool[] = [
{
name: "get_status",
description: "Returns the current index state and basic statistics.",
inputSchema: { type: "object", properties: {} },
handler: (_args, snapshot) => statusFromSnapshot(snapshot),
},
{
name: "find_asset",
description: "Finds asset definitions by id, optionally filtered by asset type.",
inputSchema: {
type: "object",
properties: {
id: { type: "string", description: "Asset id to find" },
type: { type: "string", description: "Optional asset type filter" },
},
required: ["id"],
},
handler: (args, snapshot) => {
const id = String(args.id ?? "");
if (!snapshot) return statusFromSnapshot(snapshot);
return {
index: statusFromSnapshot(snapshot),
data: findAssets(snapshot, id, args.type ? String(args.type) : null),
};
},
},
{
name: "find_references",
description: "Finds semantic reference sites pointing to an asset id, optionally filtered by type.",
inputSchema: {
type: "object",
properties: {
id: { type: "string", description: "Asset id whose references to find" },
type: { type: "string", description: "Optional asset type filter" },
},
required: ["id"],
},
handler: (args, snapshot) => {
const id = String(args.id ?? "");
if (!snapshot) return statusFromSnapshot(snapshot);
return {
index: statusFromSnapshot(snapshot),
data: findReferenceGroups(snapshot, id, args.type ? String(args.type) : null),
};
},
},
{
name: "list_assets_by_type",
description: "Lists asset definitions of one type, optionally filtered by id prefix.",
inputSchema: {
type: "object",
properties: {
type: { type: "string", description: "Asset type" },
prefix: { type: "string", description: "Optional id prefix" },
limit: { type: "number", description: "Maximum number of results" },
},
required: ["type"],
},
handler: (args, snapshot) => {
const type = String(args.type ?? "");
if (!snapshot) return statusFromSnapshot(snapshot);
const limit = typeof args.limit === "number" ? args.limit : undefined;
return {
index: statusFromSnapshot(snapshot),
data: listAssetsByType(snapshot, type, args.prefix ? String(args.prefix) : "", limit),
};
},
},
{
name: "is_file_active",
description: "Returns whether a file belongs to an indexed include stream (i.e. is not a dead file).",
inputSchema: {
type: "object",
properties: {
path: { type: "string", description: "Absolute file path" },
},
required: ["path"],
},
handler: (args, snapshot) => {
const path = String(args.path ?? "");
if (!snapshot) return statusFromSnapshot(snapshot);
return {
index: statusFromSnapshot(snapshot),
data: { active: isFileActive(snapshot, path) },
};
},
},
{
name: "find_define",
description: "Finds $DEFINE constants by name.",
inputSchema: {
type: "object",
properties: {
name: { type: "string", description: "Define name (with or without leading $)" },
},
required: ["name"],
},
handler: (args, snapshot) => {
const name = String(args.name ?? "").replace(/^\$/, "");
if (!snapshot) return statusFromSnapshot(snapshot);
return {
index: statusFromSnapshot(snapshot),
data: findDefine(snapshot, name),
};
},
},
{
name: "resolve_include",
description: "Resolves an Include source string from the snapshot's candidate list.",
inputSchema: {
type: "object",
properties: {
source: { type: "string", description: "Include source, e.g. DATA:Units/Example.xml" },
},
required: ["source"],
},
handler: (args, snapshot) => {
const source = String(args.source ?? "");
if (!snapshot) return statusFromSnapshot(snapshot);
return {
index: statusFromSnapshot(snapshot),
data: resolveIncludeSource(snapshot, source),
};
},
},
{
name: "get_asset_references",
description:
"Returns the outgoing references (edges) of an asset: which assets it references, through which element/attribute, and at which file/line. Also follows inheritFrom ancestors (marked with definedIn). Live index required.",
inputSchema: {
type: "object",
properties: {
id: { type: "string", description: "Asset id whose outgoing references to return" },
type: { type: "string", description: "Optional asset type filter" },
depth: {
type: "number",
description:
"Levels of assets to expand: 1 (default) = the asset itself, including inherited XML; max 3.",
},
targetTypes: {
type: "array",
items: { type: "string" },
description:
"Only keep edges whose target is assignable to one of these types, e.g. [\"WeaponTemplate\"].",
},
maxEdges: { type: "number", description: "Hard cap on returned edges (default 200)." },
includeUnresolved: {
type: "boolean",
description: "Also return edges whose reference value could not be resolved.",
},
},
required: ["id"],
},
// Live-only: element context is not stored in the on-disk snapshot.
handler: () => ({
index: { state: "no_index" },
error:
"get_asset_references requires a live index. Open the project in VS Code (with AI Agent access enabled) and retry.",
}),
},
{
name: "list_projects",
description:
"Lists the project roots the live extension currently has indexed. Use it to discover which projects this server can answer for.",
inputSchema: { type: "object", properties: {} },
handler: () => ({
index: { state: "no_index" },
error:
"list_projects requires a live index. Open the project in VS Code with AI Agent access enabled, then retry.",
}),
},
{
name: "get_usage_guide",
description: "Returns guidance for using the RA3 Mod XML index tools.",
inputSchema: { type: "object", properties: {} },
handler: () => ({ text: USAGE_GUIDE }),
},
];
/** Tools that can only be answered by the live extension server. */
const LIVE_ONLY_TOOLS = new Set(["get_asset_references", "list_projects"]);
function sendMessage(message: unknown): void {
process.stdout.write(`${JSON.stringify(message)}\n`);
}
function resultFor(id: unknown, result: unknown): unknown {
return { jsonrpc: "2.0", id, result };
}
function errorFor(id: unknown, code: number, message: string): unknown {
return { jsonrpc: "2.0", id, error: { code, message } };
}
async function handleRequest(
message: Record<string, unknown>,
snapshot: AgentIndexSnapshot | null,
projectDir: string | null,
live: LiveClient,
): Promise<unknown | null> {
const method = String(message.method ?? "");
const id = message.id;
const params = (message.params ?? {}) as Record<string, unknown>;
switch (method) {
case "initialize":
return resultFor(id, {
protocolVersion: params.protocolVersion ?? "2024-11-05",
capabilities: { tools: {} },
serverInfo: { name: "ra3-mod-xml", version: "0.1.0" },
});
case "ping":
return resultFor(id, {});
case "tools/list":
return resultFor(id, {
tools: TOOLS.map((tool) => ({
name: tool.name,
description: tool.description,
inputSchema: tool.inputSchema,
})),
});
case "tools/call": {
const toolName = String(params.name ?? "");
const tool = TOOLS.find((t) => t.name === toolName);
if (!tool) return errorFor(id, -32602, `Unknown tool: ${toolName}`);
const args = (params.arguments ?? {}) as Record<string, unknown>;
const result = await live.query(toolName, args);
if (result?.mismatched) {
// The server answered for another project. Refuse it: a plausible
// wrong answer is worse than an explicit failure.
live.markUnavailable();
return textResult(id, {
index: { state: "error", projectDir: projectDir ?? undefined },
error: `The live server answered for a different project than "${projectDir}"; refusing the result. Re-run "RA3 Mod XML: Enable AI Agent access…" for this project.`,
});
}
if (LIVE_ONLY_TOOLS.has(toolName)) {
// Report a clear reason instead of an empty result, so the agent does
// not conclude "this asset has no references".
return textResult(
id,
result?.payload ?? {
index: { state: "no_index", projectDir: projectDir ?? undefined },
error: `"${toolName}" requires a live index. Open the project in VS Code with AI Agent access enabled, then retry.`,
},
);
}
const output = result?.payload ?? tool.handler(args, snapshot);
return textResult(id, output);
}
default:
// Notifications have no id; ignore them.
if (id === undefined) return null;
return errorFor(id, -32601, `Method not found: ${method}`);
}
}
/** Wraps any tool payload into an MCP text content result. */
function textResult(id: unknown, payload: unknown): unknown {
const text = typeof payload === "string" ? payload : JSON.stringify(payload, null, 2);
return resultFor(id, { content: [{ type: "text", text }] });
}
async function main(): Promise<void> {
const args = process.argv.slice(2);
let projectDir: string | null = null;
let snapshotPath: string | null = null;
let agentHome: string | undefined;
for (let i = 0; i < args.length; i++) {
if (args[i] === "--project" || args[i] === "-p") projectDir = args[++i] ?? null;
else if (args[i] === "--snapshot" || args[i] === "-s") snapshotPath = args[++i] ?? null;
else if (args[i] === "--agent-home") agentHome = args[++i] ?? undefined;
}
const resolvedSnapshotPath =
snapshotPath ??
(projectDir ? snapshotPathForProject(projectDir, agentHome) : null);
let snapshot: AgentIndexSnapshot | null = null;
if (resolvedSnapshotPath) snapshot = await readSnapshotFile(resolvedSnapshotPath);
// One-shot crash cleanup: a window that died without disposing leaves its
// instance file behind, and whichever instance starts next prunes it.
void pruneInstances(agentHome).catch(() => undefined);
const live = new LiveClient({ projectDir, agentHome });
const rl = createInterface({
input: process.stdin,
crlfDelay: Infinity,
});
rl.on("line", (line) => {
if (!line.trim()) return;
let message: Record<string, unknown>;
try {
message = JSON.parse(line) as Record<string, unknown>;
} catch {
return;
}
void handleRequest(message, snapshot, projectDir, live).then((response) => {
if (response != null) sendMessage(response);
});
});
}
// Only run the stdio loop when executed directly, so the module stays
// importable by tests.
if (typeof require !== "undefined" && require.main === module) {
void main();
}
+61
View File
@@ -0,0 +1,61 @@
/**
* One-time "this version can expose the index to AI agents" notification.
*
* Pure decision logic (no VS Code dependency) so the anti-nag rules can be
* unit tested:
*
* - a fresh install is informed once;
* - an upgrade from a build that predates the feature is informed once;
* - an upgrade from a build that already had the feature stays silent;
* - "Don't show again" (and simply ignoring the message) is remembered, so
* the prompt never becomes a recurring nag.
*/
/** Extension version that introduced AI Agent access. */
export const AGENT_FEATURE_VERSION = "0.1.26";
export interface AgentOnboardingState {
/** Extension version whose notification was already shown. */
informedVersion?: string;
/** The user explicitly chose "Don't show again". */
dismissed?: boolean;
}
/**
* True when the AI Agent introduction should be shown for this version.
*/
export function shouldOfferAgentOnboarding(
state: AgentOnboardingState | undefined,
currentVersion: string,
): boolean {
if (state?.dismissed) return false;
if (!state?.informedVersion) return true; // First run with this feature.
if (state.informedVersion === currentVersion) return false;
// Already informed by a build that had the feature: never repeat.
// Only upgrades from before the feature introduce it once.
return compareVersions(state.informedVersion, AGENT_FEATURE_VERSION) < 0;
}
/**
* Compares dotted numeric versions ("1.2.3" > "1.2"). Non-numeric segments
* count as 0, and a missing segment is smaller than a present one, so
* "0.1.26" > "0.1" and "0.1.26" > "0.1.26-beta".
*/
export function compareVersions(a: string, b: string): number {
const parse = (value: string): number[] =>
String(value)
.split(".")
.map((part) => {
const match = /^(\d+)/.exec(part.trim());
return match ? Number(match[1]) : 0;
});
const left = parse(a);
const right = parse(b);
const length = Math.max(left.length, right.length);
for (let i = 0; i < length; i++) {
const l = left[i] ?? 0;
const r = right[i] ?? 0;
if (l !== r) return l < r ? -1 : 1;
}
return 0;
}
+158
View File
@@ -0,0 +1,158 @@
/**
* Query helpers over the stable AgentIndexSnapshot.
*
* Pure TypeScript and dependency-free, so the same functions can back a CLI,
* MCP tools, or a local HTTP API.
*/
import { resolve } from "node:path";
import type { AssetDef, ReferenceSite } from "../indexer/types";
import type {
AgentDefine,
AgentIndexSnapshot,
AgentIndexStatus,
AgentReferenceGroup,
AgentStream,
} from "./types";
function normalizePath(p: string): string {
return resolve(p).replace(/\\/g, "/").toLowerCase();
}
/** Returns all asset definitions whose id equals `id`, optionally filtered by type. */
export function findAssets(
snapshot: AgentIndexSnapshot,
id: string,
type?: string | null,
): AssetDef[] {
const wanted = id.toLowerCase();
const wantedType = type?.toLowerCase();
const out: AssetDef[] = [];
for (const asset of snapshot.assets) {
if (asset.id.toLowerCase() !== wanted) continue;
if (wantedType && asset.type.toLowerCase() !== wantedType) continue;
out.push(asset);
}
return out;
}
/** Returns asset definitions whose type and id prefix match. */
export function listAssetsByType(
snapshot: AgentIndexSnapshot,
type: string,
idPrefix = "",
limit?: number,
): AssetDef[] {
const wantedType = type.toLowerCase();
const wantedPrefix = idPrefix.toLowerCase();
const out: AssetDef[] = [];
for (const asset of snapshot.assets) {
if (asset.type.toLowerCase() !== wantedType) continue;
if (!asset.id.toLowerCase().startsWith(wantedPrefix)) continue;
out.push(asset);
if (limit != null && out.length >= limit) break;
}
return out;
}
/** Returns reference groups pointing to definitions matching `id` and optional `type`. */
export function findReferenceGroups(
snapshot: AgentIndexSnapshot,
id: string,
type?: string | null,
): AgentReferenceGroup[] {
const wanted = id.toLowerCase();
const wantedType = type?.toLowerCase();
return snapshot.references.filter((r) => {
if (r.id.toLowerCase() !== wanted) return false;
if (wantedType && r.type.toLowerCase() !== wantedType) return false;
return true;
});
}
/** Flattens reference groups into plain reference sites. */
export function findReferenceSites(
snapshot: AgentIndexSnapshot,
id: string,
type?: string | null,
): ReferenceSite[] {
return findReferenceGroups(snapshot, id, type).flatMap((g) => g.sites);
}
/** True when a file belongs to at least one indexed stream. */
export function isFileActive(snapshot: AgentIndexSnapshot, file: string): boolean {
const key = normalizePath(file);
return snapshot.streams.some((s) =>
s.files.some((candidate) => normalizePath(candidate) === key),
);
}
/** Returns the streams that contain a file. */
export function streamsForFile(
snapshot: AgentIndexSnapshot,
file: string,
): AgentStream[] {
const key = normalizePath(file);
return snapshot.streams.filter((s) =>
s.files.some((candidate) => normalizePath(candidate) === key),
);
}
/** Finds a define by case-insensitive name. */
export function findDefine(
snapshot: AgentIndexSnapshot,
name: string,
): AgentDefine[] {
const wanted = name.toLowerCase();
return snapshot.defines.filter((d) => d.name.toLowerCase() === wanted);
}
/** Resolves an Include source using the snapshot's candidate list. */
export function resolveIncludeSource(
snapshot: AgentIndexSnapshot,
source: string,
): { source: string; path: string } | null {
const wanted = source.toLowerCase();
const hit = snapshot.sourceCandidates.find(
(c) => c.source.toLowerCase() === wanted,
);
return hit ? { source: hit.source, path: hit.path } : null;
}
/** Returns the snapshot's status (ready_xml/ready/stale). */
export function statusFromSnapshot(
snapshot: AgentIndexSnapshot | null | undefined,
): AgentIndexStatus {
if (!snapshot) {
return { state: "no_index", detail: "No index snapshot is available." };
}
const state: AgentIndexStatus["state"] = snapshot.stale
? "stale"
: !snapshot.complete
? "ready_xml"
: "ready";
return {
state,
projectDir: snapshot.projectDir,
phase: snapshot.phase,
complete: snapshot.complete,
stale: snapshot.stale,
generatedAt: snapshot.generatedAt,
buildId: snapshot.buildId,
stats: snapshot.stats,
};
}
/** Convenience aggregate returned by MCP/CLI query tools. */
export interface QueryResult<T> {
index: AgentIndexStatus;
data: T;
}
/** Wraps any query data with current index status. */
export function withStatus<T>(snapshot: AgentIndexSnapshot | null, data: T): QueryResult<T> {
return {
index: statusFromSnapshot(snapshot),
data,
};
}
+256
View File
@@ -0,0 +1,256 @@
/**
* Runtime resolution for the agent launcher and CLI.
*
* The extension must not assume the user has Node installed. VS Code ships an
* Electron binary that can run as a plain Node process when launched with
* `ELECTRON_RUN_AS_NODE=1`, which makes it a zero-dependency runtime that is
* already present wherever the extension is installed.
*
* Verified on Windows with VS Code 1.135.0 / Electron 42.8.1 (Node 24.18.1):
* `fs`, `fs/promises`, `path`, `os`, `http`, `readline`, `zlib`, `crypto`,
* `util`, `net`, `child_process` and even `node:test` are all available, and
* the bundled `dist/agent/mcpServer.js` completes a full stdio MCP session.
*
* Pure TypeScript: no VS Code dependency, so the same rules are used by the
* launcher generator, the CLI and the tests.
*/
import { existsSync } from "node:fs";
const isWin = process.platform === "win32";
const isMac = process.platform === "darwin";
export type AgentRuntimeKind = "electron" | "node";
export interface AgentRuntime {
kind: AgentRuntimeKind;
/**
* Executable to spawn. For `electron` this is the VS Code / Electron binary
* (or a bare product name when only a hint is known).
*/
executable: string;
/** Extra environment variables required to run the executable as Node. */
env: Record<string, string>;
/**
* True when the executable is a bare command name resolved through PATH
* rather than an absolute path.
*/
viaPath: boolean;
}
/**
* True when the current process is a VS Code / Electron host.
*
* Desktop VS Code runs its extension host as the Electron binary with
* `ELECTRON_RUN_AS_NODE=1`, so `process.versions.electron` is set and
* `process.execPath` points at the VS Code executable. That is exactly the
* binary the launcher wants.
*/
export function isElectronHost(): boolean {
return typeof process.versions.electron === "string";
}
/**
* Resolves the runtime to bake into the launcher.
*
* Returns the Electron runtime when running inside VS Code (the normal case),
* and falls back to a PATH-resolved `node` otherwise (e.g. when the launcher
* is generated from a plain Node CLI or a unit test).
*/
export function resolveRuntime(): AgentRuntime {
if (isElectronHost()) {
return {
kind: "electron",
executable: process.execPath,
env: { ELECTRON_RUN_AS_NODE: "1" },
viaPath: false,
};
}
return { kind: "node", executable: "node", env: {}, viaPath: true };
}
/**
* Builds the runtime descriptor for an explicit Electron/VSCode executable.
* Used when the extension knows the host path but is not itself running as
* Electron, and by tests.
*/
export function electronRuntime(executable: string): AgentRuntime {
return {
kind: "electron",
executable,
env: { ELECTRON_RUN_AS_NODE: "1" },
viaPath: false,
};
}
/**
* Product names that indicate a VS Code-family Electron binary.
*
* Covers both the branded Windows/Linux launchers (`Code.exe`, `code-oss`,
* `codium`, `cursor`) and the macOS bundle executable, which is literally
* named `Electron`.
*/
const ELECTRON_PRODUCT_NAMES = [
"code",
"code-insiders",
"codium",
"cursor",
"electron",
];
/**
* Best-effort candidates for a VS Code / Electron binary when running under a
* plain Node process. These are only fallbacks: the authoritative path always
* comes from `process.execPath` inside the extension host.
*/
export function electronExecutableCandidates(): string[] {
const candidates: string[] = [];
if (isWin && process.env.LOCALAPPDATA) {
candidates.push(
`${process.env.LOCALAPPDATA}\\Programs\\Microsoft VS Code\\Code.exe`,
`${process.env.LOCALAPPDATA}\\Programs\\Microsoft VS Code Insiders\\Code - Insiders.exe`,
);
}
if (isWin && process.env.PROGRAMFILES) {
candidates.push(`${process.env.PROGRAMFILES}\\Microsoft VS Code\\Code.exe`);
}
if (isMac) {
candidates.push("/Applications/Visual Studio Code.app/Contents/MacOS/Electron");
} else if (!isWin) {
candidates.push("/usr/share/code/code", "/usr/bin/code");
}
return candidates;
}
/** The first existing Electron candidate, or null. */
export function findElectronExecutable(): string | null {
for (const candidate of electronExecutableCandidates()) {
try {
if (existsSync(candidate)) return candidate;
} catch {
// ignore
}
}
return null;
}
/** Renders a path for a POSIX shell single-quoted string. */
function shQuote(value: string): string {
return `'${value.replace(/'/g, `'\\''`)}'`;
}
/** Renders a path for a Windows `cmd.exe` double-quoted `set` value. */
function cmdValue(value: string): string {
// `set "VAR=value"` keeps quotes out of the value; embedded `"` would break
// it, so strip them rather than emit a broken script.
return value.replace(/"/g, "");
}
export interface LauncherScriptOptions {
runtime: AgentRuntime;
/** Absolute path to the bundled MCP server entry. */
serverPath: string;
/** Project root passed to the MCP server. */
projectDir: string;
/**
* Optional absolute path to a `node` executable used when the Electron
* binary is missing. When omitted the script falls back to `node` on PATH.
*/
nodeFallback?: string | null;
}
/**
* Generates the stable launcher script.
*
* The script prefers the Electron runtime (works without Node installed) and
* falls back to Node only when that binary is gone, so a moved/uninstalled
* VS Code does not leave the user with a dead launcher.
*/
export function launcherScript(
options: LauncherScriptOptions,
platform: NodeJS.Platform = process.platform,
): string {
const { runtime, serverPath, projectDir } = options;
const node = options.nodeFallback ?? "node";
const paths = { serverPath: cmdValue(serverPath), projectDir: cmdValue(projectDir) };
if (platform === "win32") {
// A `goto` jump is used instead of a parenthesised `if (...)` block:
// inside such a block `%errorlevel%` is expanded when the whole block is
// parsed, not when each command runs, so the exit code would be wrong.
const lines = ["@echo off", "setlocal"];
if (runtime.kind === "node") {
// No Electron available: the launcher is Node-only.
lines.push(
`set "RA3_NODE=${cmdValue(node)}"`,
`set "RA3_SERVER=${paths.serverPath}"`,
`set "RA3_PROJECT=${paths.projectDir}"`,
'"%RA3_NODE%" "%RA3_SERVER%" --project "%RA3_PROJECT%"',
"exit /b %errorlevel%",
);
return lines.join("\r\n") + "\r\n";
}
lines.push(
`set "RA3_RUNTIME=${cmdValue(runtime.executable)}"`,
`set "RA3_SERVER=${paths.serverPath}"`,
`set "RA3_PROJECT=${paths.projectDir}"`,
`set "RA3_NODE=${cmdValue(node)}"`,
'if not exist "%RA3_RUNTIME%" goto :ra3_node',
"set ELECTRON_RUN_AS_NODE=1",
'"%RA3_RUNTIME%" "%RA3_SERVER%" --project "%RA3_PROJECT%"',
"exit /b %errorlevel%",
":ra3_node",
'"%RA3_NODE%" "%RA3_SERVER%" --project "%RA3_PROJECT%"',
"exit /b %errorlevel%",
);
return lines.join("\r\n") + "\r\n";
}
const lines = ["#!/usr/bin/env sh"];
if (runtime.kind === "node") {
lines.push(
`exec ${shQuote(node)} ${shQuote(serverPath)} --project ${shQuote(projectDir)}`,
);
} else {
lines.push(
`RA3_RUNTIME=${shQuote(runtime.executable)}`,
`RA3_SERVER=${shQuote(serverPath)}`,
`RA3_PROJECT=${shQuote(projectDir)}`,
'if [ -x "$RA3_RUNTIME" ]; then',
' ELECTRON_RUN_AS_NODE=1 exec "$RA3_RUNTIME" "$RA3_SERVER" --project "$RA3_PROJECT"',
"fi",
`exec ${shQuote(node)} "$RA3_SERVER" --project "$RA3_PROJECT"`,
);
}
return lines.join("\n") + "\n";
}
/**
* True when the launcher is able to run without a Node installation: the
* Electron runtime is used unconditionally (no PATH lookup of `node`).
*
* Used by tests and by the enable flow to warn when the launcher would depend
* on Node being installed.
*/
export function isNodeFreeLauncher(script: string, platform: NodeJS.Platform = process.platform): boolean {
if (platform === "win32") {
return (
script.includes("ELECTRON_RUN_AS_NODE=1") &&
script.includes('set "RA3_RUNTIME=') &&
// The Node path must only be reachable through the guard jump.
script.includes('if not exist "%RA3_RUNTIME%" goto :ra3_node') &&
!/^\s*"node"\s/m.test(script)
);
}
return (
script.includes("ELECTRON_RUN_AS_NODE=1") &&
script.includes("RA3_RUNTIME=") &&
!/^exec node /m.test(script)
);
}
/** Product names that indicate a VS Code-family Electron binary. */
export function looksLikeElectronExecutable(path: string): boolean {
const base = path.replace(/\\/g, "/").split("/").pop()?.toLowerCase() ?? "";
return ELECTRON_PRODUCT_NAMES.some((name) => base.includes(name));
}
+359
View File
@@ -0,0 +1,359 @@
/**
* Helpers for creating the stable MCP launcher and MCP client configuration.
*
* The launcher lives outside the VS Code extension install directory (under
* ~/.ra3modxml) so AI client configs do not break when the extension is
* updated to a new version. The extension refreshes the launcher on every
* activation/update.
*
* Pure TypeScript: no VS Code dependency.
*/
import { chmod, mkdir, readFile, rm, writeFile } from "node:fs/promises";
import { homedir } from "node:os";
import { dirname, join, resolve } from "node:path";
import { defaultAgentHome } from "./snapshot";
import {
launcherScript,
resolveRuntime,
type AgentRuntime,
} from "./runtime";
/** Key this extension uses for its MCP server entry in every client config. */
export const MCP_SERVER_KEY = "ra3-mod-xml";
export interface McpConfigTarget {
id: string;
label: string;
path: string;
}
/** Result of writing the stable launcher. */
export interface LauncherResult {
path: string;
serverPath: string;
runtime: AgentRuntime;
/**
* True when the launcher runs on the VS Code Electron runtime and therefore
* does not need a Node installation.
*/
nodeFree: boolean;
}
/** File name of the stable launcher on the current platform. */
export function launcherFileName(): string {
return process.platform === "win32" ? "ra3-mod-xml-mcp.cmd" : "ra3-mod-xml-mcp";
}
/** Absolute path to the stable launcher under the agent home. */
export function launcherPath(agentHome = defaultAgentHome()): string {
return join(agentHome, launcherFileName());
}
/**
* Path to the bundled MCP server inside an extension install/dev directory.
* The packaged extension ships this file under dist/agent/mcpServer.js.
*/
export function bundledMcpServerPath(extensionRoot: string): string {
return join(extensionRoot, "dist", "agent", "mcpServer.js");
}
/**
* Creates the stable launcher script. It prefers the VS Code Electron runtime
* (so no Node installation is required) and falls back to Node only when that
* binary is missing.
*
* Returns the launcher path plus the resolved runtime, so callers can warn
* when the launcher will depend on Node being on PATH.
*/
export async function writeLauncher(
extensionRoot: string,
projectDir: string,
agentHome = defaultAgentHome(),
runtime?: AgentRuntime,
): Promise<LauncherResult> {
const server = bundledMcpServerPath(extensionRoot);
const launcher = launcherPath(agentHome);
const resolved = runtime ?? resolveRuntime();
const script = launcherScript({
runtime: resolved,
serverPath: server,
projectDir,
});
await mkdir(dirname(launcher), { recursive: true });
await writeFile(launcher, script, "utf8");
if (process.platform !== "win32") {
await chmod(launcher, 0o755);
}
return {
path: launcher,
serverPath: server,
runtime: resolved,
nodeFree: resolved.kind === "electron",
};
}
/** MCP client config entry for one project. */
export function mcpServerConfig(
launcher: string,
projectDir: string,
): Record<string, unknown> {
return {
mcpServers: {
"ra3-mod-xml": {
command: launcher,
args: ["--project", projectDir],
},
},
};
}
/** Human-readable JSON config block users can paste into AI clients. */
export function mcpConfigJson(
launcher: string,
projectDir: string,
): string {
return JSON.stringify(mcpServerConfig(launcher, projectDir), null, 2);
}
/** Claude Desktop config path (Windows/macOS/Linux common locations). */
export function claudeDesktopConfigPath(): string {
if (process.env.APPDATA) return join(process.env.APPDATA, "Claude", "claude_desktop_config.json");
return join(homedir(), ".config", "Claude", "claude_desktop_config.json");
}
/** Cursor's global MCP config path. */
export function cursorGlobalConfigPath(): string {
return join(homedir(), ".cursor", "mcp.json");
}
/** Cursor's project-scoped MCP config path. */
export function cursorProjectConfigPath(projectDir: string): string {
return join(projectDir, ".cursor", "mcp.json");
}
/** Common local MCP config files this extension can offer to update. */
export function commonMcpConfigTargets(projectDir: string): McpConfigTarget[] {
return [
{
id: "claude-desktop",
label: "Claude Desktop",
path: claudeDesktopConfigPath(),
},
{
id: "cursor-global",
label: "Cursor (global)",
path: cursorGlobalConfigPath(),
},
{
id: "cursor-project",
label: "Cursor (current project)",
path: cursorProjectConfigPath(projectDir),
},
];
}
/**
* Adds the RA3 Mod XML MCP server entry to a JSON config file, preserving any
* existing keys and `mcpServers`. Creates the file when it does not exist.
*/
export async function addMcpServerToConfigFile(
filePath: string,
launcher: string,
projectDir: string,
serverKey = MCP_SERVER_KEY,
): Promise<void> {
let config: Record<string, unknown> = {};
try {
config = JSON.parse(await readFile(filePath, "utf8")) as Record<string, unknown>;
} catch {
// File absent or malformed: start fresh.
}
const servers = (config.mcpServers as Record<string, unknown> | undefined) ?? {};
servers[serverKey] = {
command: launcher,
args: ["--project", projectDir],
};
config.mcpServers = servers;
await mkdir(dirname(filePath), { recursive: true });
await writeFile(filePath, `${JSON.stringify(config, null, 2)}\n`, "utf8");
}
/**
* Removes this extension's server entry from a JSON config file, preserving
* every other server and top-level key. Handles both the widely used
* `mcpServers` container and VS Code's `servers` container, and deletes a
* container that becomes empty.
*
* Returns true only when an entry was actually removed; a missing, malformed
* or already-clean file is left untouched.
*/
export async function removeMcpServerFromConfigFile(
filePath: string,
serverKey = MCP_SERVER_KEY,
): Promise<boolean> {
let config: Record<string, unknown>;
try {
config = JSON.parse(await readFile(filePath, "utf8")) as Record<string, unknown>;
} catch {
return false;
}
let removed = false;
for (const containerKey of ["mcpServers", "servers"] as const) {
const container = config[containerKey];
if (!container || typeof container !== "object" || Array.isArray(container)) {
continue;
}
const servers = container as Record<string, unknown>;
if (!(serverKey in servers)) continue;
delete servers[serverKey];
removed = true;
if (Object.keys(servers).length === 0) delete config[containerKey];
}
if (!removed) return false;
await writeFile(filePath, `${JSON.stringify(config, null, 2)}\n`, "utf8");
return true;
}
/** One MCP config file this extension wrote, so uninstall can undo exactly that. */
export interface McpInstallRecord {
path: string;
serverKey: string;
/** Top-level JSON container the entry was written under. */
format: "mcpServers" | "servers";
/** Human label (Claude Desktop / Cursor global / ...). */
label?: string;
sourceVersion?: string;
}
/** Path to the managed MCP config install record under the agent home. */
export function mcpInstallRecordPath(agentHome = defaultAgentHome()): string {
return join(agentHome, "mcp-install.json");
}
/** Reads the managed MCP config install record, or returns an empty list. */
export async function readMcpInstallRecord(
agentHome = defaultAgentHome(),
): Promise<McpInstallRecord[]> {
try {
const parsed = JSON.parse(
await readFile(mcpInstallRecordPath(agentHome), "utf8"),
) as { installed?: McpInstallRecord[] };
return Array.isArray(parsed.installed) ? parsed.installed : [];
} catch {
return [];
}
}
/** Writes the managed MCP config install record. */
export async function writeMcpInstallRecord(
installed: McpInstallRecord[],
agentHome = defaultAgentHome(),
): Promise<void> {
const file = mcpInstallRecordPath(agentHome);
await mkdir(dirname(file), { recursive: true });
await writeFile(file, JSON.stringify({ installed }, null, 2), "utf8");
}
export interface InstallMcpConfigOptions {
filePath: string;
launcher: string;
projectDir: string;
label?: string;
sourceVersion?: string;
serverKey?: string;
agentHome?: string;
}
/**
* Writes the server entry into a config file and remembers that we did, so
* "uninstall AI Agent integration" can remove exactly what this extension
* created without touching the user's other MCP servers.
*/
export async function installMcpServerConfigToFile(
options: InstallMcpConfigOptions,
): Promise<void> {
const serverKey = options.serverKey ?? MCP_SERVER_KEY;
await addMcpServerToConfigFile(
options.filePath,
options.launcher,
options.projectDir,
serverKey,
);
const agentHome = options.agentHome ?? defaultAgentHome();
const path = resolve(options.filePath);
const installed = (await readMcpInstallRecord(agentHome)).filter(
(r) => resolve(r.path).toLowerCase() !== path.toLowerCase(),
);
installed.push({
path,
serverKey,
format: "mcpServers",
label: options.label,
sourceVersion: options.sourceVersion,
});
await writeMcpInstallRecord(installed, agentHome);
}
export interface UninstallMcpConfigOptions {
/** Also scan the conventional client paths for this project. */
projectDir?: string | null;
agentHome?: string;
serverKey?: string;
}
/**
* Removes the server entry from every config file this extension recorded,
* plus the conventional client config paths for `projectDir` (which covers
* configs written before the install record existed).
*
* Returns the paths that actually changed. Missing/malformed files count as
* "nothing to remove" and are not reported.
*/
export async function uninstallMcpServerConfigs(
options: UninstallMcpConfigOptions = {},
): Promise<string[]> {
const serverKey = options.serverKey ?? MCP_SERVER_KEY;
const agentHome = options.agentHome ?? defaultAgentHome();
const record = await readMcpInstallRecord(agentHome);
const candidates = new Map<string, string>();
for (const entry of record) {
if (entry.serverKey && entry.serverKey !== serverKey) continue;
candidates.set(resolve(entry.path).toLowerCase(), entry.path);
}
if (options.projectDir) {
for (const target of commonMcpConfigTargets(options.projectDir)) {
candidates.set(resolve(target.path).toLowerCase(), target.path);
}
}
const changed: string[] = [];
for (const path of candidates.values()) {
try {
if (await removeMcpServerFromConfigFile(path, serverKey)) changed.push(path);
} catch {
// Best effort; keep going through the remaining files.
}
}
const changedKeys = new Set(changed.map((p) => resolve(p).toLowerCase()));
await writeMcpInstallRecord(
record.filter((r) => !changedKeys.has(resolve(r.path).toLowerCase())),
agentHome,
);
return changed;
}
/** Deletes the stable MCP launcher. Returns false when nothing was removable. */
export async function removeLauncher(agentHome = defaultAgentHome()): Promise<boolean> {
try {
await rm(launcherPath(agentHome), { force: true });
return true;
} catch {
return false;
}
}
/** Default path used for the agent home. */
export function defaultAgentHomeForSetup(): string {
return join(homedir(), ".ra3modxml");
}
+496
View File
@@ -0,0 +1,496 @@
/**
* Agent Skill generator/installer for the RA3 Mod XML MCP tools.
*
* The Skill focuses on the functionality itself: when to use it and how to
* use the RA3 Mod XML MCP query tools. It intentionally avoids referencing
* any project-specific docs (e.g. docs/codebase-navigation-guide.md) so the
* agent is not distracted by unrelated workspace guidance.
*
* Pure TypeScript: no VS Code dependency.
*/
import { mkdir, readFile, rm, stat, writeFile } from "node:fs/promises";
import { homedir } from "node:os";
import { dirname, join, resolve } from "node:path";
import { defaultAgentHome } from "./snapshot";
export const SKILL_NAME = "ra3-mod-xml";
export const SKILL_MARKER_FILE = ".ra3modxml-skill.json";
const SKILL_MD = `---
name: ra3-mod-xml
description: Use the RA3 Mod XML semantic index to find asset definitions, references, outgoing references, active files, defines, and include sources in SAGE / BinaryAssetBuilder XML projects such as Command & Conquer: Red Alert 3 mods. Use this when you need exact facts about mod assets instead of guessing or full-text searching the XML tree.
---
# RA3 Mod XML Index
This skill provides access to the semantic index built by the RA3 Mod XML VS Code extension.
## When this skill applies
Use these tools only for SAGE / BinaryAssetBuilder mod XML projects — the kind
used by Command & Conquer: Red Alert 3 mods.
Positive signals (any single one is enough to try the tools):
- \`Data/Mod.xml\` exists.
- \`Data/additionalmaps/mapmetadata_*.xml\` exists.
- A \`*.babproj\` file exists.
- XML whose root element is \`<AssetDeclaration>\`.
- XML that uses \`<Includes><Include source="DATA:…" /></Includes>\` or declares
\`xmlns="uri:ea.com:eala:asset"\`.
Do **not** use these tools for unrelated repositories. SAGE-looking XML, a
build script, copied \`.xsd\` schema files, or a folder named \`Data\` are not
by themselves evidence of a Red Alert 3 mod project: require at least one of
the positive signals above. When the repository is not a SAGE / RA3 mod
project, ignore this skill entirely.
If you are unsure whether the current project is in scope, call \`get_status\`
first: it is cheap and reports the \`projectDir\` the index belongs to. Stop
using the index tools when:
- the state is \`no_index\`, or
- the reported \`projectDir\` does not match the workspace you are working in.
In those cases read the files directly instead. Never present index results
from one project as if they belonged to another.
## When to use
Use this skill when you need any of the following:
- Find where an asset id is defined (GameObject, WeaponTemplate, Texture, etc.).
- Find which files/positions reference an asset id.
- Find which assets an asset references, and through which element/attribute.
- List assets of a particular type.
- Check whether a file is actually part of the active include graph (i.e. not a dead file).
- Resolve an Include source string.
- Look up a $DEFINE constant.
- Get the current index status and statistics.
Do not use full-text search over the XML tree when one of the MCP query tools
can answer the question directly.
## Reaching the index
Work down this list and stop at the first step that works.
1. **The query tools are already in your tool list** (names like
\`find_asset\`, \`get_status\`). Use them directly. You do not need to
configure anything.
2. **The tools are not available, but you can run commands.** The index is
reachable without any MCP setup, because the MCP server speaks JSON-RPC over
stdio. Read \`~/.ra3modxml/index.json\` first: it is a small, stable
discovery manifest listing the live instances and their project roots.
- If it does not exist, live discovery has not been enabled on this
machine yet (or no VS Code window is running). Tell the user to open the
project in VS Code and run
"RA3 Mod XML: Enable AI Agent access…". Do not guess or search further.
- If it exists, use the launcher at \`~/.ra3modxml/ra3-mod-xml-mcp.cmd\`
(Windows) or \`~/.ra3modxml/ra3-mod-xml-mcp\` (elsewhere), or call the
bundled server directly through that instance's runtime. Feed it one
JSON-RPC request per line on stdin, for example:
\`\`\`
{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"find_asset","arguments":{"id":"AthenaCannon","type":"GameObject"}}}
\`\`\`
A CLI with the same capabilities is bundled alongside the MCP server
(\`cli.js\` next to \`mcpServer.js\` in the extension's \`dist/agent/\`).
It is a plain Node script: run it with
\`node <path-to-cli.js> <command>\`. If Node is not installed, do not
install anything — run the same file with the VS Code runtime recorded in
the launcher instead:
\`ELECTRON_RUN_AS_NODE=1 <runtime executable from the launcher> <path-to-cli.js> <command>\`.
\`cli.js help\` lists the commands. The CLI answers from the live index
when VS Code is running and falls back to the last exported snapshot
otherwise. Commands that need element context (\`outgoing\`, \`projects\`)
require the live index and will say so explicitly instead of returning an
empty result.
3. **You can write configuration, if the user agrees.** You may add the MCP
server to your own client's configuration. Most clients only load MCP
servers at startup, so tell the user the change takes effect in a new session;
check what your own client supports before promising otherwise.
Never fabricate index results. If none of the steps work, say the index is
unavailable and read the XML files directly.
## How to use
1. Call \`get_status\` first when you are unsure whether an index is available,
current, or belongs to the project you are working in.
2. Use narrow queries:
- \`find_asset(id, type?)\` for definition locations.
- \`find_references(id, type?)\` for incoming semantic references.
- \`get_asset_references(id, type?, depth?, targetTypes?)\` for outgoing
references (what this asset uses, and where that link is written).
- \`list_assets_by_type(type, prefix?, limit?)\` for browsing assets.
- \`is_file_active(path)\` to determine whether a file is included in an indexed stream.
- \`find_define(name)\` for $DEFINE constants.
- \`resolve_include(source)\` for Include source candidates.
3. Asset ids are case-insensitive.
4. If an id exists for multiple asset types, pass the type filter to avoid mixing definitions.
5. If the returned index state is \`stale\`, \`ready_xml\`, or \`building\`, treat
results as provisional.
6. Never read or dump the whole index snapshot; query narrowly.
See [query-guide.md](./references/query-guide.md) for the full tool reference,
parameter defaults and result shapes.
## Following references with get_asset_references
Use \`get_asset_references\` to answer "which weapon / model / upgrade / die-object
does this asset actually use" without reading source first. It returns **edges**,
not a flat list, so provenance is preserved:
- \`from\` is the asset you asked about.
- \`to\` is the resolved definition (file + line), or null when unresolved.
- \`via.element\` / \`via.parent\` / \`via.attribute\` say exactly which XML
element and attribute created the link.
- \`source\` is the file/line where that link is written.
- \`definedIn\` is present when the link comes from an \`inheritFrom\` ancestor's
XML rather than from the asset's own file. Inheritance is walked at the same
depth, so a base asset's weapon slot configuration is reported together with
the derived asset's own modules.
Practical rules:
- Start with the default \`depth: 1\` (the queried asset only). Raise it to 2 or 3
only for a specific node you already decided to follow. The maximum is 3.
- Pass \`targetTypes\` to cut noise, e.g. \`["WeaponTemplate"]\`, or
\`["GameObject"]\` for \`CreateObjectDie\`-style die-object links.
- If \`truncated\` is true, read \`omittedByTargetType\` and narrow the query
(smaller \`targetTypes\`, lower \`depth\`) instead of blindly retrying.
- Call \`find_references\` in the opposite direction: it tells you who else would
be affected by a change.
- Merged/inherited *effective values* are not computed. When \`xai:joinAction\`
(\`Replace\` / \`Remove\`) appears in the merge path, open the file and confirm
the real result yourself.
`;
const QUERY_GUIDE_MD = `# RA3 Mod XML query tool reference
The MCP server exposes these tools:
- get_status()
- find_asset(id, type?)
- find_references(id, type?)
- get_asset_references(id, type?, depth?, targetTypes?, maxEdges?, includeUnresolved?)
- list_assets_by_type(type, prefix?, limit?)
- is_file_active(path)
- find_define(name)
- resolve_include(source)
- list_projects()
- get_usage_guide()
\`get_asset_references\` and \`list_projects\` require a live index (VS Code
running with the project indexed). All other tools also answer from the last
exported snapshot when VS Code is closed.
## Result metadata
Every query result includes an \`index\` object:
\`\`\`json
{
"state": "ready",
"projectDir": "D:/Mods/Example",
"complete": true,
"stale": false
}
\`\`\`
Possible states:
- no_index: no index snapshot exists.
- building: a rebuild is in progress.
- ready_xml: XML assets are available but art assets may be incomplete.
- ready: complete index.
- stale: index may be outdated.
- error: last build failed.
Always check \`index.projectDir\`. If it does not match the project you are
working on, discard the result and read files directly instead.
## get_asset_references
Returns outgoing reference edges with full provenance:
\`\`\`json
{
"index": { "state": "ready", "projectDir": "D:/Mods/Example" },
"data": {
"roots": [{ "type": "GameObject", "id": "AthenaCannon", "file": "...", "line": 12 }],
"edges": [
{
"depth": 1,
"from": { "type": "GameObject", "id": "AthenaCannon" },
"to": { "type": "WeaponTemplate", "id": "AthenaCannonWeapon", "file": "...", "line": 88 },
"via": { "kind": "attribute", "element": "Weapon", "parent": "WeaponSlotHardpoint", "attribute": "Template" },
"source": { "file": "D:/Mods/Example/Data/Allied/Units/AthenaCannon.xml", "line": 40, "character": 24 }
}
],
"nodes": [],
"truncated": false,
"omittedByTargetType": {},
"warnings": []
}
}
\`\`\`
\`via.kind\` is one of \`attribute\`, \`content\` or \`inheritFrom\`. Edges carrying
\`definedIn\` come from an \`inheritFrom\` ancestor's XML.
This tool requires a **live** index (VS Code open with the project indexed).
It is not available from the on-disk snapshot because element context is not
stored there. When live is unavailable the tool returns an explicit error
instead of an empty result.
`;
export interface SkillInstallRecord {
/** Skill directory (the directory containing SKILL.md). */
path: string;
/** Extension version that installed/updated this copy. */
sourceVersion: string;
}
/**
* Writes a managed copy of the Skill into `targetDir` (the directory that
* should contain SKILL.md).
*/
export async function writeSkillTo(
targetDir: string,
sourceVersion: string,
): Promise<void> {
await mkdir(join(targetDir, "references"), { recursive: true });
await writeFile(join(targetDir, "SKILL.md"), SKILL_MD, "utf8");
await writeFile(
join(targetDir, "references", "query-guide.md"),
QUERY_GUIDE_MD,
"utf8",
);
const marker: SkillInstallRecord = {
path: targetDir,
sourceVersion,
};
await writeFile(
join(targetDir, SKILL_MARKER_FILE),
JSON.stringify(marker, null, 2),
"utf8",
);
}
/** Conventional ~/.agents/skills/<skill-name> path. */
export function agentsSkillsDirForUser(home = homedir()): string {
return join(home, ".agents", "skills", SKILL_NAME);
}
/** Conventional ~/.claude/skills/<skill-name> path (Claude Code). */
export function claudeSkillsDirForUser(home = homedir()): string {
return join(home, ".claude", "skills", SKILL_NAME);
}
/** Path to the managed-install record under the agent home. */
export function skillInstallRecordPath(agentHome = defaultAgentHome()): string {
return join(agentHome, "skill-install.json");
}
/** Reads the managed skill install record, or returns an empty list. */
export async function readSkillInstallRecord(
agentHome = defaultAgentHome(),
): Promise<SkillInstallRecord[]> {
try {
const text = await readFile(skillInstallRecordPath(agentHome), "utf8");
const parsed = JSON.parse(text) as { installed?: SkillInstallRecord[] };
return Array.isArray(parsed.installed) ? parsed.installed : [];
} catch {
return [];
}
}
/** Writes the managed skill install record. */
export async function writeSkillInstallRecord(
installed: SkillInstallRecord[],
agentHome = defaultAgentHome(),
): Promise<void> {
const file = skillInstallRecordPath(agentHome);
await mkdir(dirname(file), { recursive: true });
await writeFile(
file,
JSON.stringify({ installed }, null, 2),
"utf8",
);
}
/**
* Installs the Skill into several directories and records each managed copy.
* Returns the directories successfully written.
*/
export async function installSkillToDirectories(
directories: string[],
sourceVersion: string,
agentHome = defaultAgentHome(),
): Promise<string[]> {
const installed = await readSkillInstallRecord(agentHome);
const succeeded: string[] = [];
for (const dir of directories) {
try {
await writeSkillTo(dir, sourceVersion);
if (!installed.some((r) => r.path === dir)) {
installed.push({ path: dir, sourceVersion });
} else {
const record = installed.find((r) => r.path === dir);
if (record) record.sourceVersion = sourceVersion;
}
succeeded.push(dir);
} catch {
// Keep going; caller can surface per-directory failures.
}
}
await writeSkillInstallRecord(installed, agentHome);
return succeeded;
}
/** Removes one managed Skill directory and its install record entry. */
export async function uninstallSkillFromDirectory(
directory: string,
agentHome = defaultAgentHome(),
): Promise<void> {
await rm(directory, { recursive: true, force: true });
const installed = (await readSkillInstallRecord(agentHome)).filter(
(r) => r.path !== directory,
);
await writeSkillInstallRecord(installed, agentHome);
}
/**
* Reads the managed marker of a Skill directory.
*
* Returns null when the directory has no `.ra3modxml-skill.json`, or when the
* marker does not describe that exact directory. A hand-copied or
* third-party skill is therefore never treated as ours, which is what makes
* uninstall/update safe.
*/
export async function readSkillMarker(
directory: string,
): Promise<SkillInstallRecord | null> {
try {
const parsed = JSON.parse(
await readFile(join(directory, SKILL_MARKER_FILE), "utf8"),
) as SkillInstallRecord;
if (!parsed?.path) return null;
if (resolve(parsed.path) !== resolve(directory)) return null;
return parsed;
} catch {
return null;
}
}
export interface InstalledSkillStatus extends SkillInstallRecord {
/** The recorded directory currently exists. */
exists: boolean;
/** The directory still carries our marker (safe to update/remove). */
managed: boolean;
}
/** Status of every recorded Skill copy (drives the manage/uninstall UI). */
export async function installedSkillStatus(
agentHome = defaultAgentHome(),
): Promise<InstalledSkillStatus[]> {
const installed = await readSkillInstallRecord(agentHome);
const out: InstalledSkillStatus[] = [];
for (const record of installed) {
let exists = false;
try {
exists = (await stat(record.path)).isDirectory();
} catch {
exists = false;
}
const managed = exists ? (await readSkillMarker(record.path)) != null : false;
out.push({ ...record, exists, managed });
}
return out;
}
/**
* Removes recorded Skill copies that still carry our marker. Directories that
* are missing, replaced by the user, or lack the marker are skipped and
* reported instead of being deleted.
*/
export async function uninstallRecordedSkills(
directories: readonly string[],
agentHome = defaultAgentHome(),
): Promise<{ removed: string[]; skipped: string[] }> {
const removed: string[] = [];
const skipped: string[] = [];
for (const dir of directories) {
const marker = await readSkillMarker(dir);
if (!marker) {
skipped.push(dir);
continue;
}
try {
await uninstallSkillFromDirectory(dir, agentHome);
removed.push(dir);
} catch {
skipped.push(dir);
}
}
return { removed, skipped };
}
/**
* Drops record entries for directories that are already gone, without
* touching the filesystem. Used by the uninstall UI when a recorded copy no
* longer exists.
*/
export async function forgetSkillInstallRecords(
directories: readonly string[],
agentHome = defaultAgentHome(),
): Promise<void> {
const wanted = new Set(directories.map((d) => resolve(d)));
const installed = (await readSkillInstallRecord(agentHome)).filter(
(r) => !wanted.has(resolve(r.path)),
);
await writeSkillInstallRecord(installed, agentHome);
}
/**
* Re-writes every recorded Skill copy with the current extension version.
*
* Copies that no longer carry our marker are never overwritten (that would
* clobber user content), but stay in the record so the uninstall UI can still
* show them. Records whose directory disappeared are dropped.
*/
export async function syncInstalledSkills(
sourceVersion: string,
agentHome = defaultAgentHome(),
): Promise<SkillInstallRecord[]> {
const installed = await readSkillInstallRecord(agentHome);
const synced: SkillInstallRecord[] = [];
for (const record of installed) {
let exists = false;
try {
exists = (await stat(record.path)).isDirectory();
} catch {
exists = false;
}
if (!exists) continue; // Nothing left to manage.
if (!(await readSkillMarker(record.path))) {
synced.push(record); // User-owned now: keep the record, never rewrite.
continue;
}
try {
await writeSkillTo(record.path, sourceVersion);
synced.push({ path: record.path, sourceVersion });
} catch {
synced.push(record); // Keep so a later run can retry.
}
}
await writeSkillInstallRecord(synced, agentHome);
return synced;
}
+204
View File
@@ -0,0 +1,204 @@
/**
* Convert an internal ModIndex into a stable, external agent snapshot and
* read/write those snapshots on disk.
*
* Pure TypeScript: no VS Code dependency, so CLI/MCP/tools can reuse this
* module outside the extension.
*/
import { createHash } from "node:crypto";
import { mkdir, readFile, rename, writeFile } from "node:fs/promises";
import { homedir } from "node:os";
import { basename, dirname, join, resolve } from "node:path";
import { gunzip, gzip } from "node:zlib";
import { promisify } from "node:util";
import type { ModIndex } from "../indexer/types";
import {
AGENT_SNAPSHOT_SCHEMA_VERSION,
type AgentIndexSnapshot,
type AgentIndexStatus,
} from "./types";
const gzipAsync = promisify(gzip);
const gunzipAsync = promisify(gunzip);
/** Default directory used for launcher/snapshots/skill installation state. */
export function defaultAgentHome(): string {
return join(homedir(), ".ra3modxml");
}
/** Directory where current external snapshots are stored. */
export function defaultSnapshotDir(agentHome = defaultAgentHome()): string {
return join(agentHome, "snapshots");
}
/**
* Stable, collision-resistant identity for one project directory.
* Case-insensitive (Windows paths) and independent of the current drive
* mapping case, so the same project always maps to the same key.
*/
export function projectHash(projectDir: string): string {
return createHash("sha1")
.update(resolve(projectDir).toLowerCase(), "utf8")
.digest("hex")
.slice(0, 12);
}
/**
* Short, filesystem-safe, human-readable prefix for a project (directory
* basename, sanitized). Falls back to "project" when the basename has no
* usable characters.
*/
export function projectSlug(projectDir: string): string {
const raw = basename(resolve(projectDir));
const slug = raw
.replace(/[^A-Za-z0-9._-]+/g, "-")
.replace(/^-+|-+$/g, "")
.toLowerCase();
return slug || "project";
}
/**
* A stable, readable file name for one project:
* `<slug>-<sha1-12>` (e.g. `corona-9f3a1c2b4d5e`).
*/
export function snapshotBaseName(projectDir: string): string {
return `${projectSlug(projectDir)}-${projectHash(projectDir)}`;
}
/** Converts the internal ModIndex to the stable external snapshot shape. */
export function snapshotFromIndex(index: ModIndex, buildId?: number): AgentIndexSnapshot {
const assets: AgentIndexSnapshot["assets"] = [];
for (const byId of index.assets.values()) {
for (const defs of byId.values()) {
assets.push(...defs);
}
}
const defines: AgentIndexSnapshot["defines"] = [];
for (const defs of index.defines.values()) {
defines.push(...defs);
}
const references: AgentIndexSnapshot["references"] = [];
for (const [key, sites] of index.references) {
const parts = key.split("\u0000");
if (parts.length !== 4) continue;
references.push({
type: parts[0],
id: parts[1],
file: parts[2],
line: Number(parts[3]) || 0,
sites,
});
}
const streams: AgentIndexSnapshot["streams"] = index.streams.map((s) => ({
name: s.name,
entry: s.entry,
files: [...s.files],
}));
return {
schemaVersion: AGENT_SNAPSHOT_SCHEMA_VERSION,
projectDir: index.projectDir,
sdkDir: index.sdkDir,
phase: index.phase,
complete: index.complete,
stale: index.stale,
generatedAt: new Date().toISOString(),
buildId,
stats: {
assetCount: assets.length,
referenceCount: index.references.size,
defineCount: defines.length,
fileCount: index.files.size,
streamCount: streams.length,
sourceCandidateCount: index.sourceCandidates.length,
manifestFileCount: index.manifests.size,
manifestAssetCount: index.stats.manifestAssetCount,
},
assets,
defines,
references,
streams,
sourceCandidates: index.sourceCandidates,
diagnostics: index.diagnostics,
};
}
/** Returns a status object for a missing/not-yet-built index. */
export function noIndexStatus(projectDir?: string, detail?: string): AgentIndexStatus {
return {
state: "no_index",
projectDir,
detail: detail ?? "No index has been built yet.",
};
}
/** Returns a status object for the current index state. */
export function statusFromIndex(index: ModIndex | null | undefined, projectDir?: string): AgentIndexStatus {
if (!index) return noIndexStatus(projectDir);
const state: AgentIndexStatus["state"] = index.stale
? "stale"
: !index.complete
? "ready_xml"
: "ready";
return {
state,
projectDir: index.projectDir,
phase: index.phase,
complete: index.complete,
stale: index.stale,
generatedAt: new Date().toISOString(),
stats: {
assetCount: index.stats.assetCount,
referenceCount: index.stats.referenceCount,
defineCount: index.stats.defineCount,
fileCount: index.stats.indexedFiles,
streamCount: index.stats.streams,
sourceCandidateCount: index.stats.sourceCandidates,
manifestFileCount: index.stats.manifestFiles,
manifestAssetCount: index.stats.manifestAssetCount,
},
};
}
/** Serializes a snapshot to a JSON string (not compressed). */
export function snapshotToJson(snapshot: AgentIndexSnapshot): string {
return JSON.stringify(snapshot);
}
/** Writes a snapshot as gzip-compressed JSON using atomic temp+rename. */
export async function writeSnapshotFile(
filePath: string,
snapshot: AgentIndexSnapshot,
): Promise<string> {
const payload = Buffer.from(snapshotToJson(snapshot), "utf8");
const buf = await gzipAsync(payload);
const target = resolve(filePath);
await mkdir(dirname(target), { recursive: true });
const tmp = `${target}.tmp`;
await writeFile(tmp, buf);
await rename(tmp, target);
return target;
}
/** Reads a gzip-compressed JSON snapshot written by writeSnapshotFile. */
export async function readSnapshotFile(filePath: string): Promise<AgentIndexSnapshot | null> {
try {
const buf = await readFile(filePath);
const text = (await gunzipAsync(buf)).toString("utf8");
return JSON.parse(text) as AgentIndexSnapshot;
} catch {
return null;
}
}
/** Builds the conventional snapshot path for a project under the agent home. */
export function snapshotPathForProject(
projectDir: string,
agentHome = defaultAgentHome(),
): string {
return join(defaultSnapshotDir(agentHome), `${snapshotBaseName(projectDir)}.json.gz`);
}
+103
View File
@@ -0,0 +1,103 @@
/**
* Public, stable data types for exposing RA3 Mod XML indexes to AI Agents
* and external tools.
*
* These types intentionally mirror the internal index model but use plain
* serializable arrays instead of Maps/Sets. They are independent of the VS
* Code API and of the extension's internal workspaceStorage layout.
*/
import type {
AssetDef,
DefineDef,
IndexerDiagnostic,
ReferenceSite,
SourceCandidate,
} from "../indexer/types";
/** Current external snapshot schema version. */
export const AGENT_SNAPSHOT_SCHEMA_VERSION = 1;
export type AgentIndexState =
| "no_index"
| "building"
| "ready_xml"
| "ready"
| "stale"
| "error";
export interface AgentIndexStats {
assetCount: number;
referenceCount: number;
defineCount: number;
fileCount: number;
streamCount: number;
sourceCandidateCount: number;
manifestFileCount: number;
manifestAssetCount: number;
}
export interface AgentAsset extends AssetDef {
// AssetDef is already plain/serializable.
}
export interface AgentDefine extends DefineDef {
// DefineDef is already plain/serializable.
}
/** A stream (static or global:<name>) with the normalized file paths in it. */
export interface AgentStream {
name: string;
entry: string;
files: string[];
}
/** Reference sites grouped by the definition they point to. */
export interface AgentReferenceGroup {
type: string;
id: string;
file: string;
line: number;
sites: ReferenceSite[];
}
/**
* Immutable, tool-facing snapshot of one project index.
*/
export interface AgentIndexSnapshot {
schemaVersion: number;
projectDir: string;
sdkDir: string;
/** Last finished phase: "xml" or "art". */
phase: "xml" | "art";
complete: boolean;
stale?: boolean;
generatedAt: string;
/** Build counter from the workspace; useful for change detection. */
buildId?: number;
stats: AgentIndexStats;
assets: AgentAsset[];
defines: AgentDefine[];
/**
* Reverse references grouped by target definition key.
* Consumers normally filter by `type` + `id`, then aggregate groups.
*/
references: AgentReferenceGroup[];
streams: AgentStream[];
sourceCandidates: SourceCandidate[];
diagnostics: IndexerDiagnostic[];
}
/** Status returned by query interfaces when an index may not be ready. */
export interface AgentIndexStatus {
state: AgentIndexState;
projectDir?: string;
phase?: "xml" | "art";
complete?: boolean;
stale?: boolean;
generatedAt?: string;
buildId?: number;
stats?: AgentIndexStats;
/** Human-readable explanation for no_index/error states. */
detail?: string;
}
+917 -16
View File
File diff suppressed because it is too large Load Diff
+283
View File
@@ -0,0 +1,283 @@
/**
* Pure asset-search core for the "Find asset…" command.
*
* A query is matched against the live `ModIndex` maps (type -> id ->
* definitions) plus the document-local overlay, so assets that only exist in
* the current file's include chain (including unsaved edits) are searchable
* too. Keeping the parsing/matching/ranking logic free of the VS Code API
* makes it unit-testable and reusable by other surfaces (CLI, tools).
*
* Supported query forms (all case-insensitive):
* - `Type:Id` — type filter plus id filter (both may be partial);
* - `Id` — exact / prefix / substring id match; type names match as
* well, so `GameObject` also lists the assets of that type;
* - `Type:` — every asset of that type.
*
* Manifest-style qualified names can carry several colon segments
* (`W3DContainer:W3DContainer:AUGunship`). Asset ids never contain ":", so the
* segment after the last colon is the id, exactly like `normalizeReferenceId`.
*/
import type { AssetDef, ModIndex } from "../indexer/types";
/** Default result cap; the UI reports how many matches were hidden. */
export const ASSET_SEARCH_LIMIT = 200;
export interface AssetSearchQuery {
/** Trimmed original text (used in messages). */
raw: string;
/** Lowercased type filter, or null when the query has no `Type:` part. */
type: string | null;
/** Lowercased id filter; "" when the query only filters by type. */
id: string;
}
/**
* One searchable asset (a `type:id` pair). The same id can be defined in
* several places (project + SDK + manifest, or duplicated files); the pair is
* what users search for, so the list is de-duplicated and the best-ranked
* definition is kept while `definitionCount` records the other sites.
*/
export interface AssetSearchCandidate {
def: AssetDef;
/** Distinct definition sites (file + line) for this type:id. */
definitionCount: number;
}
export interface AssetSearchResult {
matches: AssetSearchCandidate[];
/** Total matches before the limit was applied. */
total: number;
}
/** `0` exact, `1` prefix, `2` substring, `3` no match. */
const RANK_NONE = 3;
/** Parses a user query into a type filter and an id filter. */
export function parseAssetSearchQuery(rawInput: string): AssetSearchQuery {
const raw = rawInput.trim();
const colon = raw.indexOf(":");
if (colon < 0) return { raw, type: null, id: raw.toLowerCase() };
const type = raw.slice(0, colon).trim().toLowerCase();
const rest = raw.slice(colon + 1).trim();
const lastColon = rest.lastIndexOf(":");
const id = (lastColon >= 0 ? rest.slice(lastColon + 1) : rest)
.trim()
.toLowerCase();
return { raw, type: type || null, id };
}
/** True when the query asks for nothing (the UI shows only the placeholder). */
export function isEmptyAssetSearchQuery(query: AssetSearchQuery): boolean {
return !query.type && !query.id;
}
/**
* Lower rank = better. Document-local (unsaved) definitions win, then mod
* definitions, then SDK sources, then compiled manifests.
*/
export function assetOriginRank(def: AssetDef): number {
if (def.stream === "local") return 0;
switch (def.origin) {
case "project":
return 1;
case "sdk":
return 2;
default:
return 3;
}
}
/**
* Flattens the index (and the optional local overlay) into one de-duplicated
* candidate per `type:id`, keeping the best-ranked definition for each pair.
*/
export function collectAssetSearchCandidates(
index: ModIndex,
): AssetSearchCandidate[] {
const byKey = new Map<
string,
{ def: AssetDef; sites: Set<string>; count: number }
>();
const add = (def: AssetDef): void => {
const key = `${def.type}\u0000${def.id.toLowerCase()}`;
const site = `${def.file.toLowerCase()}\u0000${def.line}`;
let entry = byKey.get(key);
if (!entry) {
entry = { def, sites: new Set(), count: 0 };
byKey.set(key, entry);
}
if (entry.sites.has(site)) return;
entry.sites.add(site);
entry.count++;
if (assetOriginRank(def) < assetOriginRank(entry.def)) entry.def = def;
};
// Local overlay first: on equal origin rank the first definition wins, and
// the overlay carries the freshest text of the current file chain.
if (index.local) {
for (const byId of index.local.assets.values()) {
for (const defs of byId.values()) for (const def of defs) add(def);
}
}
for (const byId of index.assets.values()) {
for (const defs of byId.values()) for (const def of defs) add(def);
}
return [...byKey.values()].map((entry) => ({
def: entry.def,
definitionCount: entry.count,
}));
}
interface ScoredCandidate {
candidate: AssetSearchCandidate;
/** Lower is better: how strongly the query matched. */
tier: number;
/** id match rank (RANK_NONE when the query has no id part). */
idRank: number;
/** type match rank (RANK_NONE when the query has no type part). */
typeRank: number;
originRank: number;
}
/**
* Ranks the candidates for one query and returns the best `limit` matches
* plus the total number of matches (so the UI can say "N of M").
*/
export function searchAssetCandidates(
candidates: readonly AssetSearchCandidate[],
query: AssetSearchQuery,
limit: number = ASSET_SEARCH_LIMIT,
): AssetSearchResult {
if (isEmptyAssetSearchQuery(query)) return { matches: [], total: 0 };
const scored: ScoredCandidate[] = [];
for (const candidate of candidates) {
const score = scoreCandidate(candidate, query);
if (score) scored.push(score);
}
scored.sort(compareScoredCandidates);
const capped = Math.max(0, limit);
return {
matches: scored.slice(0, capped).map((entry) => entry.candidate),
total: scored.length,
};
}
function scoreCandidate(
candidate: AssetSearchCandidate,
query: AssetSearchQuery,
): ScoredCandidate | null {
const id = candidate.def.id.toLowerCase();
const type = candidate.def.type.toLowerCase();
const idRank = query.id ? rankMatch(id, query.id) : RANK_NONE;
// With a bare query the same text also matches type names, so
// `GameObject` lists that type's assets as well as every id containing
// "gameobject".
const typeRank = query.type
? rankMatch(type, query.type)
: query.id
? rankMatch(type, query.id)
: RANK_NONE;
if (query.id && query.type) {
if (idRank === RANK_NONE || typeRank === RANK_NONE) return null;
} else if (query.id) {
if (idRank === RANK_NONE && typeRank === RANK_NONE) return null;
} else if (typeRank === RANK_NONE) {
return null;
}
return {
candidate,
tier: bestTier(idRank, typeRank, query.type != null),
idRank,
typeRank,
originRank: assetOriginRank(candidate.def),
};
}
/** 0 exact, 1 prefix, 2 substring, 3 no match. */
function rankMatch(value: string, filter: string): number {
if (value === filter) return 0;
if (value.startsWith(filter)) return 1;
return value.includes(filter) ? 2 : RANK_NONE;
}
/**
* Match strength tiers. When the user filtered by type explicitly, only the
* id quality ranks the results (the type part is a filter, not a signal).
* Otherwise the strongest of the two matches wins.
*/
function bestTier(
idRank: number,
typeRank: number,
typeFiltered: boolean,
): number {
if (typeFiltered) {
if (idRank === 0) return 0;
if (idRank === 1) return 2;
if (idRank === 2) return 4;
return 6; // `Type:` alone: list the whole type
}
if (idRank === 0) return 0;
if (typeRank === 0) return 1;
if (idRank === 1) return 2;
if (typeRank === 1) return 3;
if (idRank === 2) return 4;
return 5;
}
function compareScoredCandidates(a: ScoredCandidate, b: ScoredCandidate): number {
return (
a.tier - b.tier ||
a.originRank - b.originRank ||
a.idRank - b.idRank ||
a.typeRank - b.typeRank ||
compareText(a.candidate.def.id, b.candidate.def.id) ||
compareText(a.candidate.def.type, b.candidate.def.type)
);
}
/**
* Plain code-unit comparison: asset ids and type names are ASCII, and this is
* much cheaper than `localeCompare` when a short query matches thousands of
* candidates (the list is re-ranked on every keystroke).
*/
function compareText(a: string, b: string): number {
return a < b ? -1 : a > b ? 1 : 0;
}
/**
* Every definition site of one search result, local overlay first and then by
* origin rank. Used by the UI when several definitions share a `type:id`
* (e.g. a mod override of a vanilla asset) so the user can pick which one to
* open.
*/
export function assetDefsForCandidate(
index: ModIndex,
candidate: AssetSearchCandidate,
): AssetDef[] {
const { type, id } = candidate.def;
const key = id.toLowerCase();
const out: AssetDef[] = [];
const seen = new Set<string>();
const push = (defs: readonly AssetDef[] | undefined): void => {
if (!defs) return;
for (const def of defs) {
const site = `${def.file.toLowerCase()}\u0000${def.line}`;
if (seen.has(site)) continue;
seen.add(site);
out.push(def);
}
};
push(index.local?.assets.get(type)?.get(key));
push(index.assets.get(type)?.get(key));
out.sort((a, b) => assetOriginRank(a) - assetOriginRank(b));
return out;
}
+150
View File
@@ -0,0 +1,150 @@
import * as vscode from "vscode";
import { LineMap, parseXml } from "../language/xmlParser";
import { resolveElementType } from "../language/typeContext";
import { isReferenceTargetType } from "../indexer/refs";
import { scheduleRebuildIfRecordsDesync } from "../indexer/referenceIndex";
import type { ModIndex } from "../indexer/types";
import {
collectReferenceSites,
definitionsForReference,
type ShowReferencesArgs,
} from "./references";
import type { ModWorkspace } from "../workspace";
import { t } from "../localize";
/** Never build a DOM for huge files just to show counts (w3x safety). */
const MAX_CODELENS_TEXT = 4 * 1024 * 1024;
/**
* CodeLens reference counts on top-level assets.
*
* Only types that are reference targets by design get a lens (settings, map
* metadata, w3x sub-assets etc. would otherwise show a permanent, misleading
* "0 references"). Zero is still shown for the meaningful types: that is the
* signal users can click to inspect an unused asset.
*/
export class Ra3CodeLensProvider implements vscode.CodeLensProvider {
private changeEmitter = new vscode.EventEmitter<void>();
readonly onDidChangeCodeLenses = this.changeEmitter.event;
/** URIs for which "no global snapshot yet" has already been logged. */
private suppressedLogged = new Set<string>();
constructor(private ws: ModWorkspace) {}
/** Tells VS Code to re-query lenses (used after index snapshots). */
refresh(): void {
this.changeEmitter.fire();
}
/** Called when a new snapshot is published; allows re-logging suppression. */
resetSuppressionLog(): void {
this.suppressedLogged.clear();
}
async provideCodeLenses(
document: vscode.TextDocument,
_token: vscode.CancellationToken,
): Promise<vscode.CodeLens[]> {
if (!this.ws.isRa3Workspace()) return [];
const startedAt = Date.now();
const uri = document.uri.toString();
let idx: ModIndex | null = null;
try {
idx = (await this.ws.getCodeLensScope(document)).merged;
} catch (err) {
this.ws.log(
`[codelens] scope error for ${uri}: ${err instanceof Error ? err.message : String(err)}`,
);
return [];
}
if (!idx) return [];
// Before the first global snapshot exists the merged index is a
// local-only index (stats.indexedFiles === 0) with no real references.
// Rendering "0 references" then would be misleading, so wait until a
// snapshot is published. Once a snapshot exists, "0" is meaningful and
// must still be displayed for reference-target types.
if (!idx.complete && idx.stats.indexedFiles === 0) {
if (!this.suppressedLogged.has(uri)) {
this.suppressedLogged.add(uri);
this.ws.log(
`[codelens] suppressed for ${uri} (no global snapshot yet)`,
);
}
return [];
}
const text = document.getText();
if (text.length > MAX_CODELENS_TEXT) {
this.ws.log(
`[codelens] skipped for ${uri} (${text.length} bytes > ${MAX_CODELENS_TEXT})`,
);
return [];
}
scheduleRebuildIfRecordsDesync(
this.ws.recordsSyncSurfaceFor(document),
document,
);
const doc = parseXml(text);
const root = doc.root;
if (!root) return [];
const lineMap = new LineMap(text);
const lenses: vscode.CodeLens[] = [];
for (const child of root.children) {
const local = localName(child.name);
if (local === "Tags" || local === "Includes" || local === "Defines") continue;
const idAttr = child.attrs.find((a) => a.name === "id");
if (!idAttr?.hasValue) continue;
const elType = resolveElementType(child);
if (!isReferenceTargetType(elType)) continue;
const id = idAttr.value;
const line = lineMap.positionAt(idAttr.valueStart).line + 1;
// Same definition union as Find All References: document-local
// overlay + every same-id definition in the global index. This keeps
// the lens count and the references peek consistent even when the
// file itself is not part of the global include graph.
const defs = definitionsForReference(idx, {
id,
refType: null,
selfType: null,
});
const count = collectReferenceSites(idx, defs).length;
const range = new vscode.Range(
document.positionAt(child.start),
document.positionAt(child.startTagEnd),
);
const args: ShowReferencesArgs = {
uri: document.uri,
position: document.positionAt(idAttr.valueStart),
id,
type: local,
file: document.uri.fsPath,
line,
};
lenses.push(
new vscode.CodeLens(range, {
title:
count === 0
? t("0 references")
: count === 1
? t("1 reference")
: t("{0} references", count),
command: "ra3modxml.showReferences",
arguments: [args],
}),
);
}
const elapsed = Date.now() - startedAt;
if (elapsed > 250) {
this.ws.log(
`[codelens] slow provider for ${uri}: ${lenses.length} lenses in ${elapsed}ms`,
);
}
return lenses;
}
}
function localName(tag: string): string {
const idx = tag.lastIndexOf(":");
return idx >= 0 ? tag.slice(idx + 1) : tag;
}
File diff suppressed because it is too large Load Diff
+342 -57
View File
@@ -1,33 +1,59 @@
import * as vscode from "vscode";
import { dirname } from "node:path";
import { LineMap, parseXml, type XmlElement } from "../language/xmlParser";
import {
LineMap,
type XmlElement,
type XmlParseError,
} from "../language/xmlParser";
import { resolveElementType } from "../language/typeContext";
import { resolveSource, buildSearchPaths } from "../indexer/includeResolver";
import { validateSdkPath } from "../sdk";
import * as model from "../model/schemaModel";
import type { ModWorkspace } from "../workspace";
import type { ModIndex } from "../indexer/types";
import {
isReferenceContentType,
isReferenceAttributeOfType,
mergeLocalAndGlobalDefs,
resolveContentReferenceTargets,
resolveReferenceTargetsForType,
} from "../indexer/refs";
import type { LogicalElement } from "../indexer/logicalTree";
import { scopePathKey } from "../indexer/localScope";
import { t } from "../localize";
export class Ra3Diagnostics {
private collection: vscode.DiagnosticCollection;
private sdkCache: { path: string; unusable: boolean } | null = null;
constructor(private ws: ModWorkspace) {
this.collection = vscode.languages.createDiagnosticCollection("ra3modxml");
}
/** True when the SDK is missing or not an SDK root (project-only mode). */
private sdkUnusable(): boolean {
const path = this.ws.settings.sdkPath;
if (this.sdkCache?.path === path) return this.sdkCache.unusable;
const status = validateSdkPath(path).status;
const unusable = status === "missing" || status === "not-sdk";
this.sdkCache = { path, unusable };
return unusable;
}
async update(document: vscode.TextDocument): Promise<void> {
const idx = this.ws.index;
if (!idx) {
if (!this.ws.isRa3Workspace()) {
this.collection.set(document.uri, []);
return;
}
const scope = await this.ws.getScope(document);
const idx = scope.merged;
const text = document.getText();
const lineMap = new LineMap(text);
const doc = parseXml(text);
const doc = scope.parse;
const diags: vscode.Diagnostic[] = [];
// Reference/duplicate checks are provisional while the index is
// incomplete or stale: "not found" may be a false positive.
const provisional = idx ? !idx.complete || idx.stale === true : false;
for (const err of doc.errors) {
diags.push(
@@ -36,7 +62,7 @@ export class Ra3Diagnostics {
new vscode.Position(err.line, err.character),
new vscode.Position(err.line, err.character + 1),
),
err.message,
this.parseErrorMessage(err),
vscode.DiagnosticSeverity.Error,
"xml-syntax",
),
@@ -44,12 +70,56 @@ export class Ra3Diagnostics {
}
if (doc.root) {
this.checkElements(doc.root, doc, lineMap, idx, document, diags);
this.checkElements(
scope.expanded.root,
scope.expanded,
lineMap,
idx,
document,
diags,
provisional,
);
}
this.collection.set(document.uri, diags);
}
private parseErrorMessage(err: XmlParseError): string {
switch (err.code) {
case "content-before-root":
return t("Content is not allowed before the root element");
case "unterminated-comment":
return t("Unterminated comment");
case "unterminated-cdata":
return t("Unterminated CDATA section");
case "unterminated-doctype":
return t("Unterminated DOCTYPE");
case "unterminated-processing-instruction":
return t("Unterminated processing instruction");
case "unterminated-closing-tag":
return t("Unterminated closing tag");
case "unterminated-start-tag":
return t("Unterminated start tag");
case "malformed-markup":
return t("Malformed markup");
case "unexpected-closing-tag":
return t(
"Unexpected closing tag </{0}>",
err.params?.name ?? "",
);
case "mismatched-closing-tag":
return t(
"Mismatched closing tag: expected </{0}>, found </{1}>",
err.params?.expected ?? "",
err.params?.found ?? "",
);
case "element-never-closed":
return t("Element <{0}> is never closed", err.params?.name ?? "");
default:
return err.message;
}
}
clear(uri: vscode.Uri): void {
this.collection.delete(uri);
}
@@ -59,29 +129,50 @@ export class Ra3Diagnostics {
}
private checkElements(
root: XmlElement,
doc: { elements: XmlElement[] },
root: LogicalElement | null,
doc: { elements: LogicalElement[] },
lineMap: LineMap,
idx: ModIndex,
idx: ModIndex | null,
document: vscode.TextDocument,
diags: vscode.Diagnostic[],
provisional: boolean,
): void {
const settings = this.ws.settings;
const fileDuplicates = new Map<string, { line: number }>();
// A file whose root is not AssetDeclaration is an xi:include fragment
// (e.g. Data/Includes/GenericCelestialBuildingSuicide.xml). It is not a
// standalone RA3 document: top-level id / duplicate checks do not apply,
// and references/defines can only be resolved in the includer's context.
// When the fragment root itself is a known XSD element (e.g.
// CreateObjectDie), the root supplies the type context for its whole
// subtree, so element/attribute validation is still reliable.
const rootName = root ? localName(root.name) : "";
const isFragment = rootName !== "AssetDeclaration";
const validateTree =
!isFragment || (root !== null && model.elementTypeName(rootName) !== null);
for (const el of doc.elements) {
// Only report diagnostics for nodes that belong to the document being
// edited. Nodes spliced in through xi:include keep their own source
// file and are diagnosed when that file is opened.
if (scopePathKey(el.sourceFile) !== scopePathKey(document.uri.fsPath)) {
continue;
}
const local = localName(el.name);
const isTopLevel = el.parent === root && !["Tags", "Includes", "Defines"].includes(local);
const isTopLevel =
root !== null &&
el.parent === root &&
!["Tags", "Includes", "Defines"].includes(local);
const range = tagRange(document, el);
// Top-level assets must have an id.
if (isTopLevel) {
if (!isFragment && isTopLevel) {
const idAttr = el.attrs.find((a) => a.name === "id");
if (!idAttr || !idAttr.value) {
diags.push(
this.diag(
range,
`Top-level asset <${local}> requires an id attribute`,
t("Top-level asset <{0}> requires an id attribute", local),
vscode.DiagnosticSeverity.Error,
"missing-id",
),
@@ -97,7 +188,12 @@ export class Ra3Diagnostics {
diags.push(
this.diag(
where,
`Duplicate id "${idAttr.value}" for <${local}> (also defined on line ${prev.line})`,
t(
'Duplicate id "{0}" for <{1}> (also defined on line {2})',
idAttr.value,
local,
prev.line,
),
vscode.DiagnosticSeverity.Error,
"duplicate-id",
),
@@ -111,6 +207,7 @@ export class Ra3Diagnostics {
document,
idx,
diags,
provisional,
);
}
}
@@ -120,13 +217,13 @@ export class Ra3Diagnostics {
const isXsdElement = model.isXsdElementName(el.name);
// Unknown element.
if (settings.diagnoseUnknownElements && isXsdElement) {
if (settings.diagnoseUnknownElements && isXsdElement && validateTree) {
const knownType = model.elementTypeName(local);
if (!knownType) {
diags.push(
this.diag(
range,
`Unknown element <${local}> (not in the RA3 XSD model)`,
t("Unknown element <{0}> (not in the RA3 XSD model)", local),
vscode.DiagnosticSeverity.Warning,
"unknown-element",
),
@@ -135,7 +232,7 @@ export class Ra3Diagnostics {
}
// Attributes.
if (isXsdElement) {
if (isXsdElement && validateTree) {
const elType = resolveElementType(el);
const knownAttrs = model.attributesOfType(elType);
const knownNames = new Set(knownAttrs.map((a) => a.name));
@@ -147,49 +244,99 @@ export class Ra3Diagnostics {
continue;
}
if (settings.diagnoseUnknownElements && !knownNames.has(aName)) {
diags.push(
this.diag(
new vscode.Range(
document.positionAt(attr.nameStart),
document.positionAt(attr.nameEnd),
diags.push(
this.diag(
new vscode.Range(
document.positionAt(attr.nameStart),
document.positionAt(attr.nameEnd),
),
t('Unknown attribute "{0}" for <{1}>', aName, local),
vscode.DiagnosticSeverity.Warning,
"unknown-attribute",
),
`Unknown attribute "${aName}" for <${local}>`,
vscode.DiagnosticSeverity.Warning,
"unknown-attribute",
),
);
}
if (!attr.hasValue) continue;
this.checkValueReferences(
elType,
attr.name,
attr.value,
attr,
document,
idx,
diags,
);
// References and $DEFINE constants inside fragments depend on the
// includer's context; don't report them until P1 resolves the real
// include sites.
if (!isFragment) {
this.checkValueReferences(
elType,
attr.name,
attr.value,
attr,
document,
idx,
diags,
provisional,
);
}
}
if (!isFragment) {
this.checkContentReferences(el, elType, document, idx, diags, provisional);
}
}
// Include-specific checks.
if (local === "Include") {
this.checkInclude(el, document, idx, diags);
} else if (local === "include" && el.name.toLowerCase().startsWith("xi:")) {
this.checkXiInclude(el, document, idx, diags);
}
}
}
private checkXiInclude(
el: XmlElement,
document: vscode.TextDocument,
idx: ModIndex | null,
diags: vscode.Diagnostic[],
): void {
const hrefAttr = el.attrs.find((a) => a.name === "href");
if (!hrefAttr?.hasValue) return;
const searchPaths = idx
? buildSearchPaths(idx.sdkDir, idx.projectDir)
: this.ws.searchPaths(document);
if (!searchPaths) return;
const resolved = resolveSource(
hrefAttr.value,
dirname(document.uri.fsPath),
searchPaths,
);
if (resolved.path) return;
if (/^(DATA|ART|AUDIO):/i.test(hrefAttr.value.trim())) {
if (this.sdkUnusable()) return;
}
diags.push(
this.diag(
new vscode.Range(
document.positionAt(hrefAttr.valueStart),
document.positionAt(hrefAttr.valueEnd),
),
t("xi:include target not found: {0}", hrefAttr.value),
vscode.DiagnosticSeverity.Warning,
"include-not-found",
),
);
}
private checkCrossFileDuplicate(
type: string,
id: string,
document: vscode.TextDocument,
idx: ModIndex,
idx: ModIndex | null,
diags: vscode.Diagnostic[],
provisional: boolean,
): void {
if (!idx) return;
const byType = idx.assets.get(type);
const defs = byType?.get(id.toLowerCase());
if (!defs || defs.length < 2) return;
const defs = mergeLocalAndGlobalDefs(
idx.local?.assets.get(type)?.get(id.toLowerCase()),
byType?.get(id.toLowerCase()),
);
if (defs.length < 2) return;
const self = defs.filter(
(d) =>
d.origin === "project" &&
@@ -211,7 +358,12 @@ export class Ra3Diagnostics {
diags.push(
this.diag(
range,
`Duplicate id "${id}" for <${type}> (also defined in ${other.file})`,
t(
'Duplicate id "{0}" for <{1}> (also defined in {2})',
id,
type,
other.file,
) + (provisional ? t(" (based on a partial index)") : ""),
vscode.DiagnosticSeverity.Error,
"duplicate-id",
),
@@ -225,8 +377,9 @@ export class Ra3Diagnostics {
value: string,
attr: { valueStart: number; valueEnd: number },
document: vscode.TextDocument,
idx: ModIndex,
idx: ModIndex | null,
diags: vscode.Diagnostic[],
provisional: boolean,
): void {
if (!value) return;
const range = new vscode.Range(
@@ -238,13 +391,19 @@ export class Ra3Diagnostics {
const defineRe = /\$([A-Za-z_][A-Za-z0-9_]*)/g;
let m: RegExpExecArray | null;
while ((m = defineRe.exec(value)) !== null) {
if (!idx.defines.has(m[1].toLowerCase())) {
if (
idx &&
!(idx.local?.defines.has(m[1].toLowerCase()) ??
idx.defines.has(m[1].toLowerCase()))
) {
const code = provisional ? "undefined-define-indexing" : "undefined-define";
diags.push(
this.diag(
range,
`Undefined define "$${m[1]}"`,
t('Undefined define "${0}"', m[1]) +
(provisional ? t(" (index incomplete — may be a false positive)") : ""),
vscode.DiagnosticSeverity.Warning,
"undefined-define",
code,
),
);
}
@@ -253,28 +412,112 @@ export class Ra3Diagnostics {
if (value.startsWith("$") || value.startsWith("=")) return;
const severity = this.ws.settings.reportUnresolvedReferences;
if (severity === "none") return;
if (!idx) return;
if (!isReferenceAttributeOfType(elType, attrName)) return;
const targets = resolveReferenceTargetsForType(idx, elType, attrName, value);
if (targets.length) return;
const anyDef = idx.assetsById.has(value.toLowerCase());
const anyDef =
(idx.local?.assetsById.has(value.toLowerCase()) ?? false) ||
idx.assetsById.has(value.toLowerCase());
const attrRef = model
.attributesOfType(elType)
.find((a) => a.name === attrName);
const expected = attrRef?.refType
? `of type \`${attrRef.refType}\``
: attrRef?.isRef
? "of the expected declared type"
: "matching";
const code = provisional ? "unresolved-reference-indexing" : "unresolved-reference";
const baseMessage = unresolvedReferenceMessage(
value,
anyDef,
attrRef?.refType ?? null,
attrRef?.isRef ?? false,
);
diags.push(
this.diag(
range,
anyDef
? `Reference "${value}" has no definition ${expected} (ids with the same name exist for other types)`
: `Unresolved reference "${value}" (not found in the current index)`,
provisional
? baseMessage + t(" (index incomplete — may be a false positive)")
: baseMessage,
severity === "warning"
? vscode.DiagnosticSeverity.Warning
: vscode.DiagnosticSeverity.Information,
"unresolved-reference",
code,
),
);
}
private checkContentReferences(
el: XmlElement,
elType: string | null,
document: vscode.TextDocument,
idx: ModIndex | null,
diags: vscode.Diagnostic[],
provisional: boolean,
): void {
// Only simple-content elements carry a text value (simple types and
// simpleContent complex types); ordinary complex elements' "content" is
// child markup and must not be scanned for value refs.
const info = elType ? model.contentInfoOfType(elType) : undefined;
if (!info) return;
if (el.selfClosing || el.closeTagStart < 0) return;
const text = document.getText();
const raw = text.slice(el.startTagEnd, el.closeTagStart);
const value = raw.trim();
if (!value) return;
const valueStart = el.startTagEnd + raw.indexOf(value);
const range = new vscode.Range(
document.positionAt(valueStart),
document.positionAt(valueStart + value.length),
);
// Undefined $DEFINE references.
const defineRe = /\$([A-Za-z_][A-Za-z0-9_]*)/g;
let m: RegExpExecArray | null;
while ((m = defineRe.exec(value)) !== null) {
if (
idx &&
!(
idx.local?.defines.has(m[1].toLowerCase()) ??
idx.defines.has(m[1].toLowerCase())
)
) {
const code = provisional ? "undefined-define-indexing" : "undefined-define";
diags.push(
this.diag(
range,
t('Undefined define "${0}"', m[1]) +
(provisional ? t(" (index incomplete — may be a false positive)") : ""),
vscode.DiagnosticSeverity.Warning,
code,
),
);
}
}
if (value.startsWith("$") || value.startsWith("=")) return;
const severity = this.ws.settings.reportUnresolvedReferences;
if (severity === "none" || !idx) return;
if (!isReferenceContentType(elType)) return;
const targets = resolveContentReferenceTargets(idx, elType, value);
if (targets.length) return;
const anyDef =
(idx.local?.assetsById.has(value.toLowerCase()) ?? false) ||
idx.assetsById.has(value.toLowerCase());
const refType = info.refType;
const code = provisional ? "unresolved-reference-indexing" : "unresolved-reference";
const baseMessage = unresolvedReferenceMessage(
value,
anyDef,
refType ?? null,
!refType,
);
diags.push(
this.diag(
range,
provisional
? baseMessage + t(" (index incomplete — may be a false positive)")
: baseMessage,
severity === "warning"
? vscode.DiagnosticSeverity.Warning
: vscode.DiagnosticSeverity.Information,
code,
),
);
}
@@ -282,7 +525,7 @@ export class Ra3Diagnostics {
private checkInclude(
el: XmlElement,
document: vscode.TextDocument,
idx: ModIndex,
idx: ModIndex | null,
diags: vscode.Diagnostic[],
): void {
const typeAttr = el.attrs.find((a) => a.name === "type");
@@ -294,26 +537,40 @@ export class Ra3Diagnostics {
document.positionAt(typeAttr.valueStart),
document.positionAt(typeAttr.valueEnd),
),
`Invalid Include type "${typeAttr.value}" (expected reference, instance or all)`,
t(
'Invalid Include type "{0}" (expected reference, instance or all)',
typeAttr.value,
),
vscode.DiagnosticSeverity.Error,
"include-type",
),
);
}
if (!sourceAttr?.hasValue) return;
const searchPaths = idx
? buildSearchPaths(idx.sdkDir, idx.projectDir)
: this.ws.searchPaths(document);
if (!searchPaths) return;
const resolved = resolveSource(
sourceAttr.value,
dirname(document.uri.fsPath),
buildSearchPaths(idx.sdkDir, idx.projectDir),
searchPaths,
);
if (!resolved.path && !idx.sourceCandidates.some((c) => c.source === sourceAttr.value)) {
const candidateHit =
idx?.sourceCandidates.some((c) => c.source === sourceAttr.value) ?? false;
if (!resolved.path && !candidateHit) {
// Without a usable SDK, prefixed includes are expected to be missing;
// report one project-level hint instead of warning on every line.
if (this.sdkUnusable() && /^(DATA|ART|AUDIO):/i.test(sourceAttr.value.trim())) {
return;
}
diags.push(
this.diag(
new vscode.Range(
document.positionAt(sourceAttr.valueStart),
document.positionAt(sourceAttr.valueEnd),
),
`Include target not found: ${sourceAttr.value}`,
t("Include target not found: {0}", sourceAttr.value),
vscode.DiagnosticSeverity.Warning,
"include-not-found",
),
@@ -339,6 +596,34 @@ function localName(tag: string): string {
return idx >= 0 ? tag.slice(idx + 1) : tag;
}
function unresolvedReferenceMessage(
value: string,
anyDef: boolean,
refType: string | null,
isRef: boolean,
): string {
if (anyDef) {
if (refType) {
return t(
'Reference "{0}" has no definition of type `{1}` (ids with the same name exist for other types)',
value,
refType,
);
}
if (isRef) {
return t(
'Reference "{0}" has no definition of the expected declared type (ids with the same name exist for other types)',
value,
);
}
return t(
'Reference "{0}" has no matching definition (ids with the same name exist for other types)',
value,
);
}
return t('Unresolved reference "{0}" (not found in the current index)', value);
}
function tagRange(document: vscode.TextDocument, el: XmlElement): vscode.Range {
return new vscode.Range(
document.positionAt(el.start),
+243
View File
@@ -0,0 +1,243 @@
/**
* "RA3 Mod XML: Find asset…" — quick-pick search over indexed assets.
*
* One picker does both the typing and the selection: results are filtered by
* the extension itself rather than by VS Code's built-in label filter, so the
* `Type:Id` form (where the type never appears in the visible label) keeps
* working. Accepting a result jumps to its definition; when the same
* `type:id` exists in several places (mod override + SDK + compiled
* manifest) a second picker chooses which definition to open.
*/
import * as vscode from "vscode";
import { relative } from "node:path";
import {
ASSET_SEARCH_LIMIT,
assetDefsForCandidate,
collectAssetSearchCandidates,
parseAssetSearchQuery,
searchAssetCandidates,
type AssetSearchCandidate,
type AssetSearchQuery,
} from "./assetSearch";
import { assetDefinitionLocation } from "./navigation";
import { referenceSitesForDef } from "../indexer/referenceIndex";
import type { AssetDef, ModIndex } from "../indexer/types";
import type { ModWorkspace } from "../workspace";
import { t } from "../localize";
interface AssetPickItem extends vscode.QuickPickItem {
candidate: AssetSearchCandidate;
}
interface DefinitionPickItem extends vscode.QuickPickItem {
def: AssetDef;
}
/** Entry point for the `ra3modxml.findAsset` command. */
export async function findAsset(
ws: ModWorkspace,
initialQuery = "",
): Promise<void> {
const index = await searchIndexFor(ws);
if (!index) {
void vscode.window.showInformationMessage(
t("RA3 Mod XML: no index available yet."),
);
return;
}
const candidates = collectAssetSearchCandidates(index);
if (!candidates.length) {
void vscode.window.showInformationMessage(
t("RA3 Mod XML: the index has no assets yet — wait for indexing to finish."),
);
return;
}
const picked = await pickAsset(index, candidates, initialQuery.trim());
if (!picked) return;
await revealAsset(ws, index, picked);
}
/**
* Index used for searching: the active XML document's project index with its
* local overlay attached when possible (so unsaved edits are searchable),
* otherwise the active project's last published snapshot.
*/
async function searchIndexFor(ws: ModWorkspace): Promise<ModIndex | null> {
const editor = vscode.window.activeTextEditor;
if (editor && editor.document.languageId === "xml" && ws.isRa3Workspace()) {
try {
const scope = await ws.getScope(editor.document);
if (scope.merged) return scope.merged;
} catch {
// Fall through to the plain snapshot.
}
}
return ws.activeIndex();
}
function pickAsset(
index: ModIndex,
candidates: readonly AssetSearchCandidate[],
initialQuery: string,
): Promise<AssetSearchCandidate | undefined> {
return new Promise<AssetSearchCandidate | undefined>((resolve) => {
const picker = vscode.window.createQuickPick<AssetPickItem>();
picker.title = t("RA3 Mod XML: Find asset");
picker.placeholder = t(
"Id, partial id or Type:Id (e.g. WeaponTemplate:AssaultRifle)",
);
let settled = false;
const finish = (value: AssetSearchCandidate | undefined): void => {
if (settled) return;
settled = true;
resolve(value);
picker.dispose();
};
const refresh = (value: string): void => {
const query = parseAssetSearchQuery(value);
const { matches, total } = searchAssetCandidates(
candidates,
query,
ASSET_SEARCH_LIMIT,
);
picker.items = matches.map((candidate) => toPickItem(index, candidate));
picker.prompt = promptFor(query, matches.length, total);
if (picker.items.length) picker.activeItems = [picker.items[0]];
};
picker.onDidChangeValue((value) => refresh(value));
picker.onDidAccept(() => {
const item = picker.activeItems[0] ?? picker.items[0];
if (item) finish(item.candidate);
});
picker.onDidHide(() => finish(undefined));
picker.value = initialQuery;
refresh(initialQuery);
picker.show();
});
}
function toPickItem(
index: ModIndex,
candidate: AssetSearchCandidate,
): AssetPickItem {
const def = candidate.def;
const refs = referenceSitesForDef(index, def).length;
const description = [def.type, originLabel(def)];
if (refs > 0) {
description.push(refs === 1 ? t("1 reference") : t("{0} references", refs));
}
const detail = [`${displayPath(index.projectDir, def.file)}:${def.line}`];
if (candidate.definitionCount > 1) {
detail.push(t("{0} definitions", candidate.definitionCount));
}
return {
label: def.id,
description: description.join(" · "),
detail: detail.join(" · "),
// The picker filters the list itself: a `Type:Id` query never appears in
// the visible label, so VS Code's built-in filter must not hide it.
alwaysShow: true,
candidate,
};
}
function promptFor(
query: AssetSearchQuery,
shown: number,
total: number,
): string {
if (!query.type && !query.id) {
return t("Type an id, a partial id or Type:Id to search.");
}
if (total === 0) return t('No asset matches "{0}".', query.raw);
if (total > shown) {
return t(
"{0} of {1} matches — keep typing to narrow the list.",
shown,
total,
);
}
return total === 1 ? t("1 asset found.") : t("{0} assets found.", total);
}
/**
* Opens a search result. Definitions of the same `type:id` are offered when
* there is more than one (e.g. the mod override and the vanilla source).
*/
async function revealAsset(
ws: ModWorkspace,
index: ModIndex,
candidate: AssetSearchCandidate,
): Promise<void> {
const defs = assetDefsForCandidate(index, candidate);
let def = defs[0] ?? candidate.def;
if (defs.length > 1) {
const picked = await vscode.window.showQuickPick(
defs.map((d) => toDefinitionItem(index, d)),
{
title: `${def.type}:${def.id}`,
placeHolder: t("Select the definition to open"),
matchOnDescription: true,
},
);
if (!picked) return;
def = picked.def;
}
const location = await assetDefinitionLocation(ws, def, index);
if (!location) {
void vscode.window.showInformationMessage(
t(
"RA3 Mod XML: no XML source location for {0} ({1}).",
`${def.type}:${def.id}`,
displayPath(index.projectDir, def.file),
),
);
return;
}
const document = await vscode.workspace.openTextDocument(location.uri);
await vscode.window.showTextDocument(document, {
selection: location.range,
preview: true,
});
}
function toDefinitionItem(
index: ModIndex,
def: AssetDef,
): DefinitionPickItem {
return {
label: `${displayPath(index.projectDir, def.file)}:${def.line}`,
description: originLabel(def),
detail: `${def.type}:${def.id}`,
def,
};
}
function originLabel(def: AssetDef): string {
if (def.stream === "local") return t("local");
switch (def.origin) {
case "sdk":
return t("SDK");
case "manifest":
return t("manifest");
default:
return t("project");
}
}
function displayPath(projectDir: string, file: string): string {
const rel = relative(projectDir, file);
return rel && !rel.startsWith("..") ? rel : file;
}
+233 -69
View File
@@ -1,15 +1,25 @@
import * as vscode from "vscode";
import { findElementAt, parseXml } from "../language/xmlParser";
import { findElementAt, textContentTokenAt } from "../language/xmlParser";
import { resolveElementType } from "../language/typeContext";
import * as model from "../model/schemaModel";
import type { ModWorkspace } from "../workspace";
import type { ModIndex } from "../indexer/types";
import {
isLocalReferenceAttribute,
isReferenceAttributeOfType,
isReferenceContentType,
resolveContentReferenceTargets,
resolveReferenceTargetsForType,
type ReferenceTarget,
} from "../indexer/refs";
import {
findContainingGameObject,
findLocalId,
type LogicalElement,
} from "../indexer/logicalTree";
import { scopePathKey, type DocumentScope } from "../indexer/localScope";
import { dirname } from "node:path";
import { buildSearchPaths, resolveSource } from "../indexer/includeResolver";
import { t } from "../localize";
export class Ra3HoverProvider implements vscode.HoverProvider {
constructor(private ws: ModWorkspace) {}
@@ -19,9 +29,11 @@ export class Ra3HoverProvider implements vscode.HoverProvider {
position: vscode.Position,
_token: vscode.CancellationToken,
): Promise<vscode.Hover | null> {
const text = document.getText();
if (!this.ws.isRa3Workspace()) return null;
const offset = document.offsetAt(position);
const doc = parseXml(text);
const text = document.getText();
const scope = await this.ws.getScope(document);
const doc = scope.expanded;
const el = findElementAt(doc, offset);
if (!el) return null;
const elType = resolveElementType(el);
@@ -35,43 +47,62 @@ export class Ra3HoverProvider implements vscode.HoverProvider {
// Attribute value.
for (const attr of el.attrs) {
if (attr.hasValue && offset >= attr.valueStart && offset <= attr.valueEnd) {
return this.valueHover(el, elType, attr.name, attr.value, document, this.ws.index);
return this.valueHover(el, elType, attr.name, attr.value, document, scope);
}
}
// Element text content (e.g. <CreateObject>CrateDebris_01</CreateObject>).
const contentToken = textContentTokenAt(text, el, offset);
if (contentToken) {
const h = this.contentHover(elType, contentToken.value, document, scope);
if (h) return h;
}
// Element name.
const nameStart = el.start + 1;
if (offset >= nameStart && offset <= nameStart + el.name.length) {
return this.elementHover(el.name);
return this.elementHover(el.name, elType);
}
return null;
}
private elementHover(name: string): vscode.Hover | null {
private elementHover(
name: string,
resolvedType: string | null = null,
): vscode.Hover | null {
if (name.startsWith("xi:")) {
const md = new vscode.MarkdownString();
md.appendCodeblock(`<${name}>`, "xml");
md.appendMarkdown(
"XInclude element (W3C XInclude namespace) — not part of the RA3 XSD model.",
t(
"XInclude element (W3C XInclude namespace) — not part of the RA3 XSD model.",
),
);
return new vscode.Hover(md);
}
const type = model.elementTypeName(name);
const type =
resolvedType ??
(model.topLevelElementType(name) ?? model.elementTypeName(name));
const info = type ? model.typeInfo(type) : undefined;
const md = new vscode.MarkdownString();
md.appendCodeblock(`<${name}>`, "xml");
if (model.isTopLevelElement(name)) md.appendMarkdown(`**Top-level asset element** \n`);
if (model.isTopLevelElement(name)) {
md.appendMarkdown(`${t("**Top-level asset element**")} \n`);
}
if (info?.kind === "complex") {
if (info.doc) md.appendMarkdown(`${info.doc} \n`);
md.appendMarkdown(
`Attributes: ${info.attributes.length} · Children: ${info.children.length} \n`,
`${t(
"Attributes: {0} · Children: {1}",
model.attributesOfType(type).length,
info.children.length,
)} \n`,
);
if (info.base) md.appendMarkdown(`Extends: \`${info.base}\``);
if (info.base) md.appendMarkdown(t("Extends: `{0}`", info.base));
} else if (info?.kind === "simple") {
md.appendMarkdown(`Simple type: \`${type}\``);
md.appendMarkdown(t("Simple type: `{0}`", type ?? ""));
} else if (type) {
md.appendMarkdown(`Type: \`${type}\``);
md.appendMarkdown(t("Type: `{0}`", type));
} else {
md.appendMarkdown("Not found in the bundled XSD model.");
md.appendMarkdown(t("Not found in the bundled XSD model."));
}
return new vscode.Hover(md);
}
@@ -87,26 +118,38 @@ export class Ra3HoverProvider implements vscode.HoverProvider {
md.appendCodeblock(`${attrName}=""`, "xml");
if (!attr) {
if (/^(xmlns|xai:)/.test(attrName)) {
md.appendMarkdown(`Namespace/instance attribute.`);
md.appendMarkdown(t("Namespace/instance attribute."));
return new vscode.Hover(md);
}
if (!model.isXsdElementName(el.name)) {
md.appendMarkdown(
`XInclude attribute (W3C XInclude namespace) — not part of the RA3 XSD model.`,
t(
"XInclude attribute (W3C XInclude namespace) — not part of the RA3 XSD model.",
),
);
return new vscode.Hover(md);
}
md.appendMarkdown("Unknown attribute for this element.");
md.appendMarkdown(t("Unknown attribute for this element."));
return new vscode.Hover(md);
}
if (attr.doc) md.appendMarkdown(`${attr.doc} \n`);
if (attr.required) md.appendMarkdown(`**Required** \n`);
if (attr.refType) md.appendMarkdown(`References assets of type \`${attr.refType}\` \n`);
if (attr.required) md.appendMarkdown(`${t("**Required**")} \n`);
if (attr.refType) {
md.appendMarkdown(
`${t("References assets of type `{0}`", attr.refType)} \n`,
);
}
if (attr.enumValues.length)
md.appendMarkdown(`Values: \`${attr.enumValues.join("`, `")}\` \n`);
if (attr.default != null) md.appendMarkdown(`Default: \`${attr.default}\` \n`);
if (attr.allowsDefine) md.appendMarkdown(`May use \`$DEFINE\` constants \n`);
md.appendMarkdown(`Type: \`${attr.type ?? "string"}\``);
md.appendMarkdown(
`${t("Values: `{0}`", attr.enumValues.join("`, `"))} \n`,
);
if (attr.default != null) {
md.appendMarkdown(`${t("Default: `{0}`", attr.default)} \n`);
}
if (attr.allowsDefine) {
md.appendMarkdown(`${t("May use `$DEFINE` constants")} \n`);
}
md.appendMarkdown(t("Type: `{0}`", attr.type ?? "string"));
return new vscode.Hover(md);
}
@@ -116,22 +159,19 @@ export class Ra3HoverProvider implements vscode.HoverProvider {
attrName: string,
value: string,
document: vscode.TextDocument,
idx: ModIndex | null,
scope: DocumentScope,
): vscode.Hover | null {
const idx = scope.merged;
const md = new vscode.MarkdownString();
// $DEFINE reference.
const defineMatch = /\$([A-Za-z_][A-Za-z0-9_]*)/.exec(value);
if (defineMatch && idx) {
const defs = idx.defines.get(defineMatch[1].toLowerCase());
if (defs?.length) {
const d = defs[0];
md.appendMarkdown(`**Define** \`$${d.name}\` \n`);
md.appendCodeblock(d.value);
const rel = relativePath(document, d.file);
md.appendMarkdown(`Defined in \`${rel}:${d.line}\``);
return new vscode.Hover(md);
}
const defs =
idx.local?.defines.get(defineMatch[1].toLowerCase()) ??
idx.defines.get(defineMatch[1].toLowerCase());
const h = this.defineHover(defs, document);
if (h) return h;
}
// Include source.
@@ -139,60 +179,184 @@ export class Ra3HoverProvider implements vscode.HoverProvider {
(el.name === "Include" && attrName === "source") ||
(el.name === "xi:include" && attrName === "href")
) {
const resolved = idx
const searchPaths = idx
? buildSearchPaths(idx.sdkDir, idx.projectDir)
: this.ws.searchPaths(document);
const resolved = searchPaths
? resolveSource(
value,
dirname(document.uri.fsPath),
buildSearchPaths(idx.sdkDir, idx.projectDir),
searchPaths,
).path
: null;
if (resolved) {
md.appendMarkdown(`**Include source** \n`);
md.appendMarkdown(`${t("**Include source**")} \n`);
md.appendCodeblock(resolved);
return new vscode.Hover(md);
}
const cand = idx?.sourceCandidates.find((c) => c.source === value);
if (cand) {
md.appendMarkdown(`**Include source** \n`);
md.appendMarkdown(`${t("**Include source**")} \n`);
md.appendCodeblock(cand.path);
return new vscode.Hover(md);
}
md.appendMarkdown(`Include source: \`${value}\` (not in candidate index)`);
return new vscode.Hover(md);
}
// Asset reference / inheritFrom.
if (idx) {
if (!isReferenceAttributeOfType(elType, attrName)) return null;
const targets = resolveReferenceTargetsForType(idx, elType, attrName, value);
if (targets.length) {
const md2 = new vscode.MarkdownString();
md2.appendMarkdown(`**${targets.length} definition${targets.length > 1 ? "s" : ""}** \n`);
for (const { def: d } of targets.slice(0, 8)) {
const loc =
d.origin === "manifest"
? `manifest \`${d.manifestSource ?? d.file}\``
: `\`${relativePath(document, d.file)}:${d.line}\``;
md2.appendMarkdown(`- \`${d.type}\` · ${loc} \n`);
}
return new vscode.Hover(md2);
}
const attrRef = model
.attributesOfType(elType)
.find((a) => a.name === attrName);
const expected = attrRef?.refType
? ` of type \`${attrRef.refType}\``
: attrRef?.isRef
? " of the expected declared type"
: "";
md.appendMarkdown(
`No matching definition${expected} in the current index` +
" (may exist in a compiled manifest or vanilla data).",
t("Include source: `{0}` (not in candidate index)", value),
);
return new vscode.Hover(md);
}
return null;
// Pipeline-local (Poid) references: resolve inside the enclosing
// GameObject's logical subtree (including xi:include targets).
if (
isLocalReferenceAttribute(elType, attrName) &&
attrName.toLowerCase() !== "id"
) {
return this.localIdHover(scope, el as LogicalElement, value, document);
}
// Asset reference / inheritFrom.
if (!idx) {
if (isReferenceAttributeOfType(elType, attrName)) {
md.appendMarkdown(
t("Index is still building — references cannot be resolved yet."),
);
return new vscode.Hover(md);
}
return null;
}
{
if (!isReferenceAttributeOfType(elType, attrName)) return null;
const targets = resolveReferenceTargetsForType(idx, elType, attrName, value);
if (targets.length) return this.definitionsHover(targets, document);
const attrRef = model
.attributesOfType(elType)
.find((a) => a.name === attrName);
return this.noDefinitionHover(
attrRef?.refType
? "typed"
: attrRef?.isRef
? "untyped"
: "generic",
attrRef?.refType ?? undefined,
);
}
}
/**
* Hover for text inside a simple-content element whose type is a typed
* asset reference (e.g. <CreateObject> with GameObjectWeakRef).
*/
private contentHover(
elType: string | null,
value: string,
document: vscode.TextDocument,
scope: DocumentScope,
): vscode.Hover | null {
const idx = scope.merged;
const defineMatch = /\$([A-Za-z_][A-Za-z0-9_]*)/.exec(value);
if (defineMatch && idx) {
const defs =
idx.local?.defines.get(defineMatch[1].toLowerCase()) ??
idx.defines.get(defineMatch[1].toLowerCase());
const h = this.defineHover(defs, document);
if (h) return h;
}
if (!isReferenceContentType(elType)) return null;
if (!idx) {
const md = new vscode.MarkdownString();
md.appendMarkdown(
t("Index is still building — references cannot be resolved yet."),
);
return new vscode.Hover(md);
}
const targets = resolveContentReferenceTargets(idx, elType, value);
if (targets.length) return this.definitionsHover(targets, document);
const info = elType ? model.contentInfoOfType(elType) : undefined;
const refType = info?.refType ?? null;
return this.noDefinitionHover(refType ? "typed" : "untyped", refType ?? undefined);
}
private defineHover(
defs: { name: string; value: string; file: string; line: number }[] | undefined,
document: vscode.TextDocument,
): vscode.Hover | null {
if (!defs?.length) return null;
const d = defs[0];
const md = new vscode.MarkdownString();
md.appendMarkdown(`${t("**Define** `{0}`", `$${d.name}`)} \n`);
md.appendCodeblock(d.value);
const rel = relativePath(document, d.file);
md.appendMarkdown(t("Defined in `{0}:{1}`", rel, d.line));
return new vscode.Hover(md);
}
private definitionsHover(
targets: ReferenceTarget[],
document: vscode.TextDocument,
): vscode.Hover {
const md2 = new vscode.MarkdownString();
md2.appendMarkdown(
`${targets.length === 1 ? t("**1 definition**") : t("**{0} definitions**", targets.length)} \n`,
);
for (const { def: d } of targets.slice(0, 8)) {
const loc =
d.origin === "manifest"
? t("manifest `{0}`", d.manifestSource ?? d.file)
: t("`{0}:{1}`", relativePath(document, d.file), d.line);
md2.appendMarkdown(`${t("- `{0}` · {1}", d.type, loc)} \n`);
}
return new vscode.Hover(md2);
}
private noDefinitionHover(
kind: "typed" | "untyped" | "generic",
refType?: string,
): vscode.Hover {
const md = new vscode.MarkdownString();
if (kind === "typed" && refType) {
md.appendMarkdown(
t(
"No matching definition of type `{0}` in the current index (may exist in a compiled manifest or vanilla data).",
refType,
),
);
} else if (kind === "untyped") {
md.appendMarkdown(
t(
"No matching definition of the expected declared type in the current index (may exist in a compiled manifest or vanilla data).",
),
);
} else {
md.appendMarkdown(
t(
"No matching definition in the current index (may exist in a compiled manifest or vanilla data).",
),
);
}
return new vscode.Hover(md);
}
private localIdHover(
scope: DocumentScope,
el: LogicalElement,
value: string,
document: vscode.TextDocument,
): vscode.Hover | null {
const root = findContainingGameObject(el);
if (!root) return null;
const target = findLocalId(root, value);
if (!target) return null;
const idAttr = target.attrs.find((a) => a.name === "id");
if (!idAttr?.hasValue) return null;
const lineMap = scope.lineMaps.get(scopePathKey(target.sourceFile));
const line = lineMap ? lineMap.positionAt(idAttr.valueStart).line + 1 : 0;
const md = new vscode.MarkdownString();
md.appendMarkdown(`${t("**Local pipeline id** `{0}`", value)} \n`);
md.appendCodeblock(`<${target.name}>`);
const rel = relativePath(document, target.sourceFile);
md.appendMarkdown(t("Defined in `{0}:{1}`", rel, line));
return new vscode.Hover(md);
}
}
+285 -97
View File
@@ -1,15 +1,35 @@
import * as vscode from "vscode";
import { dirname } from "node:path";
import { findElementAt, parseXml } from "../language/xmlParser";
import {
findElementAt,
LineMap,
parseXml,
textContentTokenAt,
} from "../language/xmlParser";
import { resolveElementType } from "../language/typeContext";
import {
buildSearchPaths,
buildVanillaSearchPaths,
resolveSource,
type SearchPaths,
} from "../indexer/includeResolver";
import { resolveReferenceTargetsForType } from "../indexer/refs";
import {
isLocalReferenceAttribute,
isReferenceContentType,
resolveContentReferenceTargets,
resolveReferenceTargetsForType,
type ReferenceTarget,
} from "../indexer/refs";
import { findReferenceLocations } from "./references";
import {
findContainingGameObject,
findLocalId,
type LogicalElement,
} from "../indexer/logicalTree";
import { scopePathKey, type DocumentScope } from "../indexer/localScope";
import type { ModWorkspace } from "../workspace";
import type { AssetDef, ModIndex } from "../indexer/types";
import { t } from "../localize";
function searchPathsFor(idx: ModIndex): SearchPaths {
return buildSearchPaths(idx.sdkDir, idx.projectDir);
@@ -25,11 +45,11 @@ export class Ra3DefinitionProvider implements vscode.DefinitionProvider {
position: vscode.Position,
_token: vscode.CancellationToken,
): Promise<vscode.Location | vscode.Location[] | null> {
const idx = this.ws.index;
if (!idx) return null;
const text = document.getText();
if (!this.ws.isRa3Workspace()) return null;
const scope = await this.ws.getScope(document);
const idx = scope.merged;
const offset = document.offsetAt(position);
const doc = parseXml(text);
const doc = scope.expanded;
const el = findElementAt(doc, offset);
if (!el) return null;
const elType = resolveElementType(el);
@@ -37,7 +57,19 @@ export class Ra3DefinitionProvider implements vscode.DefinitionProvider {
const attr = el.attrs.find(
(a) => a.hasValue && offset >= a.valueStart && offset <= a.valueEnd,
);
if (!attr) return null;
if (!attr) {
// Element text content (e.g. <CreateObject>CrateDebris_01</CreateObject>).
if (idx && isReferenceContentType(elType)) {
const token = textContentTokenAt(document.getText(), el, offset);
if (token && !token.value.startsWith("$")) {
const targets = resolveContentReferenceTargets(idx, elType, token.value);
if (targets.length) {
return this.referenceLocations(scope, idx, targets, document);
}
}
}
return null;
}
const value = attr.value;
const nameLower = attr.name.toLowerCase();
@@ -46,34 +78,87 @@ export class Ra3DefinitionProvider implements vscode.DefinitionProvider {
(el.name === "Include" && nameLower === "source") ||
(el.name === "include" && nameLower === "href")
) {
const resolved =
resolveSource(value, dirname(document.uri.fsPath), searchPathsFor(idx)).path ??
idx.sourceCandidates.find((c) => c.source === value)?.path ??
null;
return resolved
? new vscode.Location(vscode.Uri.file(resolved), new vscode.Position(0, 0))
const searchPaths = idx
? searchPathsFor(idx)
: this.ws.searchPaths(document);
const resolved = searchPaths
? resolveSource(value, dirname(document.uri.fsPath), searchPaths).path
: null;
const fallback = idx?.sourceCandidates.find((c) => c.source === value)?.path;
const target = resolved ?? fallback ?? null;
return target
? new vscode.Location(vscode.Uri.file(target), new vscode.Position(0, 0))
: null;
}
// Asset reference / inheritFrom (filtered by the attribute's ref type).
if (!idx) return null;
if (value && !value.startsWith("$")) {
let targets = resolveReferenceTargetsForType(idx, elType, attr.name, value);
if (!targets.length) return null;
if (
this.ws.settings.definitionMode === "project-only" &&
targets.some((t) => t.def.origin === "project")
isLocalReferenceAttribute(elType, attr.name) &&
nameLower !== "id"
) {
targets = targets.filter((t) => t.def.origin === "project");
const local = this.localIdLocation(
scope,
el as LogicalElement,
value,
);
if (local) return local;
}
const locations: vscode.Location[] = [];
for (const { def } of targets.slice(0, 8)) {
const loc = await assetDefLocation(this.ws, def, idx);
if (loc) locations.push(loc);
}
return locations.length ? locations : null;
const targets = resolveReferenceTargetsForType(idx, elType, attr.name, value);
if (!targets.length) return null;
return this.referenceLocations(scope, idx, targets, document);
}
return null;
}
private async referenceLocations(
scope: DocumentScope,
idx: ModIndex,
targets: ReferenceTarget[],
document: vscode.TextDocument,
): Promise<vscode.Location[] | null> {
let filtered = targets;
if (
this.ws.settings.definitionMode === "project-only" &&
targets.some((t) => t.def.origin === "project")
) {
filtered = targets.filter((t) => t.def.origin === "project");
}
const locations: vscode.Location[] = [];
for (const { def } of filtered.slice(0, 8)) {
const loc = await assetDefLocation(this.ws, def, idx, scope, document);
if (loc) locations.push(loc);
}
return locations.length ? locations : null;
}
private localIdLocation(
scope: DocumentScope,
el: LogicalElement,
value: string,
): vscode.Location | null {
const root = findContainingGameObject(el);
if (!root) return null;
const target = findLocalId(root, value);
if (!target) return null;
const idAttr = target.attrs.find((a) => a.name === "id");
if (!idAttr?.hasValue) return null;
const lineMap = scope.lineMaps.get(scopePathKey(target.sourceFile));
if (!lineMap) {
return new vscode.Location(
vscode.Uri.file(target.sourceFile),
new vscode.Position(0, 0),
);
}
return new vscode.Location(
vscode.Uri.file(target.sourceFile),
new vscode.Range(
toVscodePosition(lineMap.positionAt(idAttr.valueStart)),
toVscodePosition(lineMap.positionAt(idAttr.valueEnd)),
),
);
}
}
/**
@@ -85,14 +170,40 @@ async function assetDefLocation(
ws: ModWorkspace,
def: AssetDef,
idx: ModIndex,
scope: DocumentScope,
currentDocument: vscode.TextDocument,
): Promise<vscode.Location | null> {
// While a rebuild is running, avoid readDom() mutating the live indexer's
// caches mid-build; a line-based location is a fine temporary fallback.
if (ws.isBuilding) {
const line = Math.max(0, def.line - 1);
return new vscode.Location(
vscode.Uri.file(def.file),
new vscode.Range(
new vscode.Position(line, 0),
new vscode.Position(line, 1),
),
);
}
if (def.origin === "manifest") {
const src = def.manifestSource;
if (src?.toUpperCase().startsWith("DATA:")) {
const resolved = resolveSource(src, null, searchPathsFor(idx)).path;
if (src) {
// manifestSource is a path recorded by the vanilla build, not an
// Include path in the current mod. Resolve it with SDK-only search
// paths so a mod file shadowing the same DATA: path cannot hijack the
// jump (e.g. mod Data/globaldata/weapon.xml vs SageXml/...). If the SDK
// source is missing (user removed/renamed a SageXml file), keep the
// definition manifest-only instead of opening the wrong file.
const resolved = resolveSource(
src,
null,
buildVanillaSearchPaths(idx.sdkDir),
).path;
if (resolved) {
// The recorded source file is XML (e.g. SageXml) when available:
// jump to the precise definition inside it, not just the file.
// jump to the precise definition inside it. If the file was modified
// and no longer contains the id, fall back to opening the file at the
// top rather than inventing a precise location.
const precise = await locationInDocument(ws, resolved, def.id);
return precise ?? new vscode.Location(vscode.Uri.file(resolved), new vscode.Position(0, 0));
}
@@ -100,6 +211,11 @@ async function assetDefLocation(
return null;
}
if (scopePathKey(def.file) === scopePathKey(currentDocument.uri.fsPath)) {
const precise = locationInCurrentDocument(scope, def.id, currentDocument);
if (precise) return precise;
}
return (
(await locationInDocument(ws, def.file, def.id)) ??
new vscode.Location(
@@ -109,6 +225,124 @@ async function assetDefLocation(
);
}
/**
* Location of one asset definition for the asset search command.
*
* Unlike {@link assetDefLocation} this needs no document scope: an already
* open (possibly unsaved) document wins, then manifest sources are resolved
* with the SDK-only search paths, then the owning indexer's cached DOM is
* asked for the precise `id` attribute range. Returns null only when a
* manifest definition has no resolvable XML source at all.
*/
export async function assetDefinitionLocation(
ws: ModWorkspace,
def: AssetDef,
idx: ModIndex,
): Promise<vscode.Location | null> {
const open = vscode.workspace.textDocuments.find(
(doc) => scopePathKey(doc.uri.fsPath) === scopePathKey(def.file),
);
if (open) {
const precise = locationInText(open.uri, open.getText(), def.id);
if (precise) return precise;
}
// While a rebuild is running, avoid readDom() mutating the live indexer's
// caches mid-build; a line-based location is a fine temporary fallback.
if (ws.isBuilding) return lineLocation(def);
if (def.origin === "manifest") {
const src = def.manifestSource;
if (!src) return null;
// manifestSource is a vanilla build path: resolve it with SDK-only search
// paths so a mod file shadowing the same DATA: path cannot hijack the
// jump. Opening the binary manifest itself would not help the user, so a
// missing SDK source stays unresolved instead.
const resolved = resolveSource(
src,
null,
buildVanillaSearchPaths(idx.sdkDir),
).path;
if (!resolved) return null;
return (
(await locationInDocument(ws, resolved, def.id)) ??
new vscode.Location(vscode.Uri.file(resolved), new vscode.Position(0, 0))
);
}
return (await locationInDocument(ws, def.file, def.id)) ?? lineLocation(def);
}
function lineLocation(def: AssetDef): vscode.Location {
const line = Math.max(0, def.line - 1);
return new vscode.Location(
vscode.Uri.file(def.file),
new vscode.Range(new vscode.Position(line, 0), new vscode.Position(line, 1)),
);
}
/** Precise `id` range inside arbitrary (possibly unsaved) document text. */
function locationInText(
uri: vscode.Uri,
text: string,
id: string,
): vscode.Location | null {
const parsed = parseXml(text);
const wanted = id.toLowerCase();
const el = parsed.elements.find((e) =>
e.attrs.some((a) => a.name === "id" && a.value.toLowerCase() === wanted),
);
if (!el) return null;
const lineMap = new LineMap(text);
const idAttr = el.attrs.find((a) => a.name === "id");
if (idAttr?.hasValue) {
return new vscode.Location(
uri,
new vscode.Range(
toVscodePosition(lineMap.positionAt(idAttr.valueStart)),
toVscodePosition(lineMap.positionAt(idAttr.valueEnd)),
),
);
}
return new vscode.Location(
uri,
new vscode.Range(
toVscodePosition(lineMap.positionAt(el.start)),
toVscodePosition(lineMap.positionAt(el.startTagEnd)),
),
);
}
function locationInCurrentDocument(
scope: DocumentScope,
id: string,
document: vscode.TextDocument,
): vscode.Location | null {
const el = scope.parse.elements.find((e) =>
e.attrs.some(
(a) => a.name === "id" && a.value.toLowerCase() === id.toLowerCase(),
),
);
if (!el) return null;
const idAttr = el.attrs.find((a) => a.name === "id");
if (idAttr?.hasValue) {
return new vscode.Location(
document.uri,
new vscode.Range(
document.positionAt(idAttr.valueStart),
document.positionAt(idAttr.valueEnd),
),
);
}
return new vscode.Location(
document.uri,
new vscode.Range(
document.positionAt(el.start),
document.positionAt(el.startTagEnd),
),
);
}
/**
* Finds the precise range of an asset definition inside an XML file: the id
* attribute value when present, otherwise the element start tag.
@@ -118,7 +352,9 @@ async function locationInDocument(
file: string,
id: string,
): Promise<vscode.Location | null> {
const parsed = await ws.indexer?.readDocument(file);
// readDom (not readDocument) guarantees a DOM even when the compact
// records cache already has an entry for the file.
const parsed = await ws.indexer?.readDom(file);
if (parsed?.parse && parsed.lineMap) {
const el = parsed.parse.elements.find(
(e) =>
@@ -156,39 +392,15 @@ function toVscodePosition(p: { line: number; character: number }): vscode.Positi
// ── Find all references ─────────────────────────────────────────────
export class Ra3ReferenceProvider implements vscode.ReferenceProvider {
constructor(private ws: ModWorkspace) {}
async provideReferences(
document: vscode.TextDocument,
position: vscode.Position,
_context: vscode.ReferenceContext,
_token: vscode.CancellationToken,
): Promise<vscode.Location[] | null> {
const text = document.getText();
const offset = document.offsetAt(position);
const doc = parseXml(text);
const el = findElementAt(doc, offset);
if (!el) return null;
const attr = el.attrs.find(
(a) =>
(a.hasValue && offset >= a.valueStart && offset <= a.valueEnd) ||
(offset >= a.nameStart && offset <= a.nameEnd),
);
if (!attr?.hasValue) return null;
const id = attr.value;
if (!id || id.startsWith("$")) return null;
const locations: vscode.Location[] = [];
const pattern = `["']${escapeRegExp(id)}["']`;
await findTextInWorkspace(
{ pattern, isRegExp: true },
{ include: "**/*.xml", maxResults: 2000 },
(result: { uri: vscode.Uri; matches: { range: vscode.Range }[] }) => {
if (!result.uri) return;
for (const m of result.matches) {
locations.push(new vscode.Location(result.uri, m.range));
}
},
);
return locations.length ? locations : null;
return findReferenceLocations(this.ws, document, position);
}
}
@@ -201,8 +413,12 @@ export class Ra3DocumentLinkProvider implements vscode.DocumentLinkProvider {
document: vscode.TextDocument,
_token: vscode.CancellationToken,
): Promise<vscode.DocumentLink[]> {
const idx = this.ws.index;
if (!idx) return [];
if (!this.ws.isRa3Workspace()) return [];
const idx = this.ws.indexForDocument(document) ?? this.ws.activeIndex();
const searchPaths = idx
? searchPathsFor(idx)
: this.ws.searchPaths(document);
if (!searchPaths) return [];
const text = document.getText();
const doc = parseXml(text);
const links: vscode.DocumentLink[] = [];
@@ -214,9 +430,9 @@ export class Ra3DocumentLinkProvider implements vscode.DocumentLinkProvider {
resolveSource(
srcAttr.value,
dirname(document.uri.fsPath),
searchPathsFor(idx),
searchPaths,
).path ??
idx.sourceCandidates.find((c) => c.source === srcAttr.value)?.path ??
idx?.sourceCandidates.find((c) => c.source === srcAttr.value)?.path ??
null;
if (!target) continue;
links.push(
@@ -236,10 +452,13 @@ export class Ra3DocumentLinkProvider implements vscode.DocumentLinkProvider {
// ── Document symbols (outline) ──────────────────────────────────────
export class Ra3DocumentSymbolProvider implements vscode.DocumentSymbolProvider {
constructor(private ws: ModWorkspace) {}
async provideDocumentSymbols(
document: vscode.TextDocument,
_token: vscode.CancellationToken,
): Promise<vscode.DocumentSymbol[]> {
if (!this.ws.isRa3Workspace()) return [];
const text = document.getText();
const doc = parseXml(text);
const root = doc.root;
@@ -279,7 +498,13 @@ export class Ra3DocumentSymbolProvider implements vscode.DocumentSymbolProvider
document.positionAt(define.end),
);
symbols.push(
new vscode.DocumentSymbol(`$${name}`, "Define", vscode.SymbolKind.Constant, range, range),
new vscode.DocumentSymbol(
`$${name}`,
t("Define"),
vscode.SymbolKind.Constant,
range,
range,
),
);
}
}
@@ -291,40 +516,3 @@ function localName(tag: string): string {
const idx = tag.lastIndexOf(":");
return idx >= 0 ? tag.slice(idx + 1) : tag;
}
function escapeRegExp(s: string): string {
return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
}
/**
* `workspace.findTextInFiles` is a stable VS Code API (since 1.66) but is
* missing from the published typings, so we declare the subset we need and
* call it via a safe cast.
*/
interface TextSearchQuery {
pattern: string;
isRegExp?: boolean;
isCaseSensitive?: boolean;
isWordMatch?: boolean;
}
interface TextSearchOptions {
include?: string;
exclude?: string;
maxResults?: number;
}
function findTextInWorkspace(
query: TextSearchQuery,
options: TextSearchOptions,
callback: (result: { uri: vscode.Uri; matches: { range: vscode.Range }[] }) => void,
): Promise<void> {
const api = vscode.workspace as unknown as {
findTextInFiles(
query: TextSearchQuery,
options: TextSearchOptions,
callback: (result: { uri: vscode.Uri; matches: { range: vscode.Range }[] }) => void,
): Promise<unknown>;
};
return api.findTextInFiles(query, options, callback).then(() => undefined);
}
+239
View File
@@ -0,0 +1,239 @@
/**
* Shared semantic reference logic used by Find All References, the CodeLens
* "N references" command and (indirectly) the unreferenced-assets report.
*
* Unlike the old text-search implementation, every result here comes from
* the reverse reference index built during indexing, so the count shown on a
* top-level asset always matches the references peek opened by clicking it.
*/
import * as vscode from "vscode";
import {
findElementAt,
parseXml,
textContentTokenAt,
} from "../language/xmlParser";
import { resolveElementType } from "../language/typeContext";
import { attributesOfType, contentInfoOfType } from "../model/schemaModel";
import {
filterAndScoreDefs,
isReferenceAttributeOfType,
isReferenceContentType,
mergeLocalAndGlobalDefs,
normalizeReferenceId,
} from "../indexer/refs";
import {
referenceSitesForDef,
scheduleRebuildIfRecordsDesync,
} from "../indexer/referenceIndex";
import type { AssetDef, ModIndex, ReferenceSite } from "../indexer/types";
import type { ModWorkspace } from "../workspace";
export interface ReferenceContext {
id: string;
/** XSD refType when the cursor is on a typed reference; null otherwise. */
refType: string | null;
/** Element type for inheritFrom filtering; null otherwise. */
selfType: string | null;
}
/**
* Extracts the referenced id and its XSD context from the cursor position.
* Works on reference attribute values/names, simple-content text and on an
* asset's own `id` definition (where every same-id definition is a target).
*/
export function referenceContextAt(
document: vscode.TextDocument,
offset: number,
): ReferenceContext | null {
const text = document.getText();
const doc = parseXml(text);
const el = findElementAt(doc, offset);
if (!el) return null;
const elType = resolveElementType(el);
const attr = el.attrs.find(
(a) =>
(a.hasValue && offset >= a.valueStart && offset <= a.valueEnd) ||
(offset >= a.nameStart && offset <= a.nameEnd),
);
if (attr?.hasValue) {
const value = attr.value;
if (!value || value.startsWith("$") || value.startsWith("=")) return null;
const nameLower = attr.name.toLowerCase();
if (nameLower === "id") {
return { id: value, refType: null, selfType: null };
}
if (!isReferenceAttributeOfType(elType, attr.name)) return null;
if (nameLower === "inheritfrom") {
return { id: value, refType: null, selfType: elType };
}
const attrInfo = elType
? attributesOfType(elType).find((a) => a.name === attr.name)
: undefined;
return { id: value, refType: attrInfo?.refType ?? null, selfType: null };
}
if (elType && isReferenceContentType(elType)) {
const token = textContentTokenAt(text, el, offset);
if (token && !token.value.startsWith("$") && !token.value.startsWith("=")) {
const info = contentInfoOfType(elType);
return {
id: token.value,
refType: info?.refType ?? null,
selfType: null,
};
}
}
return null;
}
/** Definitions matching a reference context (strict type filtering). */
export function definitionsForReference(
idx: ModIndex,
ctx: ReferenceContext,
): AssetDef[] {
const lookupId = normalizeReferenceId(ctx.id);
const defs = mergeLocalAndGlobalDefs(
idx.local?.assetsById.get(lookupId.toLowerCase()),
idx.assetsById.get(lookupId.toLowerCase()),
);
return filterAndScoreDefs(defs, ctx.refType, ctx.selfType).map((t) => t.def);
}
/** Union of reference sites for a set of definitions, de-duplicated. */
export function collectReferenceSites(
idx: ModIndex,
defs: readonly AssetDef[],
): ReferenceSite[] {
const sites: ReferenceSite[] = [];
const seen = new Set<string>();
for (const def of defs) {
for (const site of referenceSitesForDef(idx, def)) {
const key = `${site.file}\u0000${site.start}\u0000${site.end}\u0000${site.kind}`;
if (seen.has(key)) continue;
seen.add(key);
sites.push(site);
}
}
return sites;
}
/** Converts stored offsets to precise editor locations (fallback: line). */
export async function sitesToLocations(
ws: ModWorkspace,
sites: readonly ReferenceSite[],
): Promise<vscode.Location[]> {
const byFile = new Map<string, ReferenceSite[]>();
for (const site of sites) {
let list = byFile.get(site.file);
if (!list) {
list = [];
byFile.set(site.file, list);
}
list.push(site);
}
const locations: vscode.Location[] = [];
for (const [file, fileSites] of byFile) {
const parsed = await (ws.indexerForFile(file) ?? ws.activeIndexer())?.readDom(
file,
);
const lineMap = parsed?.lineMap ?? null;
for (const site of fileSites) {
if (lineMap) {
const start = lineMap.positionAt(site.start);
const end = lineMap.positionAt(site.end);
locations.push(
new vscode.Location(
vscode.Uri.file(file),
new vscode.Range(
new vscode.Position(start.line, start.character),
new vscode.Position(end.line, end.character),
),
),
);
} else {
const line = Math.max(0, site.line - 1);
locations.push(
new vscode.Location(
vscode.Uri.file(file),
new vscode.Range(
new vscode.Position(line, 0),
new vscode.Position(line, 1),
),
),
);
}
}
}
return locations;
}
/**
* Semantic Find All References (used by the reference provider).
*
* Only real reference sites are returned — the asset's own `id` definition is
* never included, regardless of VS Code's `includeDeclaration` flag, so the
* result set matches the CodeLens reference count exactly.
*/
export async function findReferenceLocations(
ws: ModWorkspace,
document: vscode.TextDocument,
position: vscode.Position,
): Promise<vscode.Location[] | null> {
if (!ws.isRa3Workspace()) return null;
scheduleRebuildIfRecordsDesync(ws.recordsSyncSurfaceFor(document), document);
const scope = await ws.getScope(document);
const idx = scope.merged;
if (!idx) return null;
const ctx = referenceContextAt(document, document.offsetAt(position));
if (!ctx) return null;
const defs = definitionsForReference(idx, ctx);
if (!defs.length) return null;
const locations = await sitesToLocations(ws, collectReferenceSites(idx, defs));
return locations.length ? locations : null;
}
/** Arguments passed from the CodeLens to the showReferences command. */
export interface ShowReferencesArgs {
uri: vscode.Uri;
position: vscode.Position;
id: string;
type: string;
file: string;
line: number;
}
/** Opens the references peek for one specific asset definition. */
export async function showReferencesForDef(
ws: ModWorkspace,
args: ShowReferencesArgs,
): Promise<void> {
const doc = vscode.workspace.textDocuments.find(
(d) => d.uri.toString() === args.uri.toString(),
);
if (!doc) return;
let idx: ModIndex | null = null;
try {
idx = (await ws.getCodeLensScope(doc)).merged;
} catch {
return;
}
if (!idx) return;
// Same definition union as the lens count / Find All References.
const defs = definitionsForReference(idx, {
id: args.id,
refType: null,
selfType: null,
});
const sites = collectReferenceSites(idx, defs);
const locations = await sitesToLocations(ws, sites);
await vscode.commands.executeCommand(
"editor.action.showReferences",
args.uri,
args.position,
locations,
);
}
+6
View File
@@ -1,6 +1,7 @@
import * as vscode from "vscode";
import { parseXml } from "../language/xmlParser";
import { buildSemanticTokenRanges } from "../language/semanticTokens";
import type { ModWorkspace } from "../workspace";
const TOKEN_TYPES = ["type", "property", "string"] as const;
@@ -20,10 +21,15 @@ export const RA3_SEMANTIC_TOKENS_LEGEND = new vscode.SemanticTokensLegend([
export class Ra3SemanticTokensProvider
implements vscode.DocumentSemanticTokensProvider
{
constructor(private ws: ModWorkspace) {}
async provideDocumentSemanticTokens(
document: vscode.TextDocument,
_token: vscode.CancellationToken,
): Promise<vscode.SemanticTokens> {
if (!this.ws.isRa3Workspace()) {
return new vscode.SemanticTokens(new Uint32Array(0));
}
const text = document.getText();
const doc = parseXml(text);
if (doc.errors.length === 0) {
+125
View File
@@ -0,0 +1,125 @@
import * as vscode from "vscode";
import { relative } from "node:path";
import { findElementAt, parseXml } from "../language/xmlParser";
import { unreferencedByType } from "../indexer/referenceIndex";
import type { ModWorkspace } from "../workspace";
import { t } from "../localize";
interface TypePickItem extends vscode.QuickPickItem {
type: string;
}
interface AssetPickItem extends vscode.QuickPickItem {
file: string;
line: number;
}
/**
* Palette command: pick an asset type, then jump to any project asset of
* that type that has zero incoming references. Only types that are reference
* targets by design are offered, so auto-registered data (settings, map
* metadata, w3x sub-assets...) is not reported as "unused".
*/
export async function findUnreferencedAssets(
ws: ModWorkspace,
args?: { type?: string },
): Promise<void> {
const idx = ws.activeIndex();
if (!ws.isRa3Workspace() || !idx) {
void vscode.window.showInformationMessage(
t("RA3 Mod XML: no index available yet."),
);
return;
}
const byType = unreferencedByType(idx);
let type = args?.type;
if (!type) {
if (!byType.size) {
void vscode.window.showInformationMessage(
t("RA3 Mod XML: no unreferenced assets found."),
);
return;
}
const pickedType = await vscode.window.showQuickPick<TypePickItem>(
[...byType.entries()].map(([typeName, defs]) => ({
label: typeName,
description: t("{0} unreferenced", defs.length),
type: typeName,
})),
{
placeHolder: t("Select an asset type"),
matchOnDescription: true,
},
);
if (!pickedType) return;
type = pickedType.type;
}
const defs = byType.get(type) ?? [];
if (!defs.length) {
void vscode.window.showInformationMessage(
t("RA3 Mod XML: no unreferenced {0} assets found.", type),
);
return;
}
const pickedAsset = await vscode.window.showQuickPick<AssetPickItem>(
defs.map((d) => ({
label: d.id,
description: `${displayPath(idx.projectDir, d.file)}:${d.line}`,
file: d.file,
line: d.line,
})),
{
placeHolder: t("{0}: {1} unreferenced", type, defs.length),
matchOnDescription: true,
},
);
if (!pickedAsset) return;
const uri = vscode.Uri.file(pickedAsset.file);
const document = await vscode.workspace.openTextDocument(uri);
const line = Math.max(0, pickedAsset.line - 1);
await vscode.window.showTextDocument(document, {
selection: new vscode.Range(
new vscode.Position(line, 0),
new vscode.Position(line, 1),
),
preview: true,
});
}
/**
* Editor context-menu entry: pre-selects the asset type under the cursor.
* Falls back to the type picker when the cursor is not on a top-level asset.
*/
export async function findUnreferencedAssetsOfType(
ws: ModWorkspace,
): Promise<void> {
const editor = vscode.window.activeTextEditor;
if (editor && ws.isRa3Workspace()) {
const document = editor.document;
const offset = document.offsetAt(editor.selection.active);
const doc = parseXml(document.getText());
const el = findElementAt(doc, offset);
if (el && el.parent === doc.root) {
const local = localName(el.name);
const isStructural = local === "Tags" || local === "Includes" || local === "Defines";
const hasId = el.attrs.some((a) => a.name === "id" && a.hasValue);
if (!isStructural && hasId) {
return findUnreferencedAssets(ws, { type: local });
}
}
}
return findUnreferencedAssets(ws);
}
function localName(tag: string): string {
const idx = tag.lastIndexOf(":");
return idx >= 0 ? tag.slice(idx + 1) : tag;
}
function displayPath(projectDir: string, file: string): string {
const rel = relative(projectDir, file);
return rel && !rel.startsWith("..") ? rel : file;
}
+74
View File
@@ -10,6 +10,7 @@
*/
import { resolve } from "node:path";
import { createHash } from "node:crypto";
import type { IndexedFile, ParsedFile } from "./types";
import type { IndexRecords } from "./records";
import type { ResolveResult } from "./includeResolver";
@@ -19,6 +20,28 @@ export function normKey(path: string): string {
return resolve(path).toLowerCase();
}
/**
* SHA-1 of the BOM-stripped text a file's records were extracted from.
* Lets force rebuilds verify that a stat-matching cache entry is not stale
* (FAT32/exFAT timestamps can match after a rewrite), and lets features
* detect "open document != indexed snapshot" without reading the whole index.
*/
export function contentHash(text: string): string {
return createHash("sha1").update(text, "utf8").digest("hex");
}
/**
* Hash of a file's compact index records. Semantic records (assets, defines,
* includes, references) are what the index actually consumes, so comparing
* records hashes ignores cosmetic text changes (line endings, whitespace)
* and only fires the self-heal when the index would really be out of date.
*/
export function recordsHash(records: IndexRecords): string {
return createHash("sha1")
.update(JSON.stringify(records), "utf8")
.digest("hex");
}
/**
* LRU cache for fully parsed XML documents.
*
@@ -119,6 +142,20 @@ export interface IndexRecordsCacheEntry {
records: IndexRecords;
/** "shallow" for art-asset scans (.w3x), "full" for parsed XML. */
kind: "shallow" | "full";
/**
* Hash of the BOM-stripped file text (full parses only). Absent for
* shallow scans (avoid hashing multi-MB model files) and for cache entries
* produced before this field existed.
*/
contentHash?: string;
/**
* False when the entry was seeded from disk but its stat has not been
* checked against the current disk yet. Such entries may only be used
* for deferred art registration during phase A; the indexer must not
* consume their records until `validated` is true (set by the stat pass
* or by a build that re-read the file).
*/
validated?: boolean;
}
/**
@@ -146,6 +183,11 @@ export class IndexRecordsCache {
return this.map.size;
}
/** Iterates [normalized key, entry] pairs (used by disk persistence). */
entries(): IterableIterator<[string, IndexRecordsCacheEntry]> {
return this.map.entries();
}
set(path: string, entry: IndexRecordsCacheEntry): void {
const key = normKey(path);
this.map.delete(key);
@@ -224,3 +266,35 @@ export class IncludeResolveCache {
return this.map.size;
}
}
/**
* Monotonic counter for workspace-level invalidations.
*
* A build captures `snapshot()` when it starts; if `changedSince()` is true
* when a phase snapshot is about to be published, files may have changed
* mid-build, so the published index is marked stale (and the workspace's
* dirty/rebuild mechanism converges to fresh data shortly after).
*/
export class InvalidationsEpoch {
private value = 0;
/** Records a new invalidation (content, creation or deletion). */
mark(): void {
this.value++;
}
/** Returns the current epoch value. */
snapshot(): number {
return this.value;
}
/** True when at least one invalidation happened since `epoch`. */
changedSince(epoch: number): boolean {
return this.value !== epoch;
}
/** Current epoch value (read-only accessor). */
get current(): number {
return this.value;
}
}
+281
View File
@@ -0,0 +1,281 @@
/**
* On-disk persistence for per-file index records.
*
* The records cache (top-level assets / defines / includes / xi:include with
* line numbers) is tiny compared to the source corpus (Corona: ~9k files,
* ~10 MB in memory), but rebuilding it from scratch means reading ~2.6 GB of
* art assets again. Persisting it makes a cold start cost a stat validation
* pass (~seconds on SSD, a few to tens of seconds on a mechanical drive)
* instead of a full rebuild.
*
* Correctness model (layered):
* - every cached record stores a multi-signal stamp
* `{ size, mtimeMs, birthtimeMs, ctimeMs }`;
* - a cold start seeds the in-memory cache immediately (`load`) and runs the
* stat pass in the background (`validate`, no content reads); mismatches
* and missing files are invalidated and re-read by a follow-up rebuild
* (the workspace's stale/dirty mechanism converges);
* - during a session the file watcher invalidates entries precisely;
* - `ra3modxml.reindex` / `ra3modxml.clearCache` remain the final authority.
*
* The file is gzip-compressed JSON written atomically (temp + rename), keyed
* by project identity + settings so stale caches are ignored automatically.
*
* Pure TypeScript: no vscode dependency.
*/
import { createHash } from "node:crypto";
import { mkdir, readFile, rename, rm, stat, writeFile } from "node:fs/promises";
import { dirname } from "node:path";
import { gzip, gunzip } from "node:zlib";
import { promisify } from "node:util";
import type { IndexRecordsCacheEntry } from "./caches";
import type { IndexRecords } from "./records";
import type { IndexedFile } from "./types";
const gzipAsync = promisify(gzip);
const gunzipAsync = promisify(gunzip);
/**
* v2: per-file records now carry typed reference records (`references`),
* so caches produced by v1 (assets/defines/includes only) are stale.
* v3: full XML records carry `contentHash`, and snapshots publish per-file
* `recordsHashes` for the desync self-heal; caches without hashes cannot be
* verified, so v2 files are regenerated once.
*/
export const DISK_CACHE_VERSION = 3;
/** How many stat validations run concurrently on load. */
const VALIDATE_CONCURRENCY = 32;
/** Settings that change what the index contains; a mismatch ignores the cache. */
export interface DiskCacheIdentity {
projectDir: string;
sdkDir: string;
indexSageXml: boolean;
additionalDataSearchPaths: string[];
builtmodsDirs: string[];
}
export interface DiskCacheRecord {
/** Normalized cache key (see `normKey`). */
key: string;
stat: NonNullable<IndexedFile["stat"]>;
records: IndexRecords;
kind: "full" | "shallow";
/** Content hash for full XML parses (see `IndexRecordsCacheEntry`). */
contentHash?: string;
}
interface DiskCacheFile {
version: number;
key: string;
savedAt: string;
records: DiskCacheRecord[];
}
export interface DiskCacheLoadStats {
fileExists: boolean;
keyMatched: boolean;
/** Records stored in the file. */
loaded: number;
/** Records whose stat still matches (kept). */
validated: number;
/** Records dropped because the file changed, moved or was deleted. */
dropped: number;
/** Milliseconds spent reading / decompressing / parsing the cache file. */
loadMs: number;
/** Milliseconds spent stat-validating cached entries. */
validateMs: number;
}
function emptyLoadStats(): DiskCacheLoadStats {
return {
fileExists: false,
keyMatched: false,
loaded: 0,
validated: 0,
dropped: 0,
loadMs: 0,
validateMs: 0,
};
}
export function diskCacheKey(identity: DiskCacheIdentity): string {
return createHash("sha256")
.update(JSON.stringify(identity))
.digest("hex")
.slice(0, 16);
}
export class DiskRecordsCache {
constructor(
private readonly filePath: string,
private readonly identity: DiskCacheIdentity,
) {}
get path(): string {
return this.filePath;
}
/**
* Loads the cache file without validating entries. This is fast (read +
* gunzip + JSON parse) so a cold start can seed the in-memory records
* cache immediately and let stat validation run in the background.
* Missing/corrupt/key-mismatched caches yield an empty result instead of
* an error.
*/
async load(): Promise<{
records: DiskCacheRecord[];
stats: DiskCacheLoadStats;
}> {
const start = Date.now();
const stats = emptyLoadStats();
let raw: DiskCacheFile | null = null;
try {
const buf = await readFile(this.filePath);
stats.fileExists = true;
const text = (await gunzipAsync(buf)).toString("utf8");
const parsed = JSON.parse(text);
if (
parsed &&
parsed.version === DISK_CACHE_VERSION &&
parsed.key === diskCacheKey(this.identity) &&
Array.isArray(parsed.records)
) {
raw = parsed as DiskCacheFile;
}
} catch {
// Missing or corrupt cache: fall through with an empty result.
}
stats.loadMs = Date.now() - start;
if (!raw) return { records: [], stats };
stats.keyMatched = true;
stats.loaded = raw.records.length;
return { records: raw.records, stats };
}
/**
* Stat-validates cached records. Returns the entries that still match
* plus the keys that must be re-read (missing / changed / moved).
*/
async validate(
records: DiskCacheRecord[],
onProgress?: (validatedCount: number, total: number) => void,
): Promise<{
stats: DiskCacheLoadStats;
kept: DiskCacheRecord[];
invalidKeys: string[];
}> {
const start = Date.now();
const stats = emptyLoadStats();
stats.fileExists = true;
stats.keyMatched = true;
stats.loaded = records.length;
const kept: DiskCacheRecord[] = [];
const invalidKeys: string[] = [];
for (let i = 0; i < records.length; i += VALIDATE_CONCURRENCY) {
const chunk = records.slice(i, i + VALIDATE_CONCURRENCY);
const results = await Promise.all(
chunk.map(async (rec, index): Promise<{ rec: DiskCacheRecord | null; index: number }> => {
try {
const s = await stat(rec.key);
if (
s.isFile() &&
s.size === rec.stat.size &&
s.mtimeMs === rec.stat.mtimeMs &&
s.birthtimeMs === rec.stat.birthtimeMs &&
s.ctimeMs === rec.stat.ctimeMs
) {
return { rec, index };
}
} catch {
// File missing or inaccessible.
}
return { rec: null, index };
}),
);
for (const { rec, index } of results) {
if (rec) {
kept.push(rec);
stats.validated++;
} else {
stats.dropped++;
invalidKeys.push(chunk[index].key);
}
}
onProgress?.(stats.validated, records.length);
}
stats.validateMs = Date.now() - start;
return { stats, kept, invalidKeys };
}
/**
* Loads and stat-validates the cache (blocking validation). Used by
* tests and kept as a convenience; the workspace normally prefers
* `load()` + background `validate()`.
*/
async loadValidated(): Promise<{
records: DiskCacheRecord[];
stats: DiskCacheLoadStats;
}> {
const { records, stats } = await this.load();
if (!records.length) return { records, stats };
const validation = await this.validate(records);
return {
records: validation.kept,
stats: {
...stats,
validated: validation.stats.validated,
dropped: validation.stats.dropped,
validateMs: validation.stats.validateMs,
},
};
}
/** Writes the current records cache atomically (temp file + rename). */
async save(
entries: Iterable<[string, IndexRecordsCacheEntry]>,
): Promise<void> {
const records: DiskCacheRecord[] = [];
for (const [key, entry] of entries) {
if (!entry.stat) continue;
records.push({
key,
stat: entry.stat,
records: entry.records,
kind: entry.kind,
contentHash: entry.contentHash,
});
}
const payload: DiskCacheFile = {
version: DISK_CACHE_VERSION,
key: diskCacheKey(this.identity),
savedAt: new Date().toISOString(),
records,
};
const buf = await gzipAsync(Buffer.from(JSON.stringify(payload), "utf8"));
await mkdir(dirname(this.filePath), { recursive: true });
const tmp = `${this.filePath}.tmp`;
await writeFile(tmp, buf);
await rename(tmp, this.filePath);
}
/** Deletes the cache file (used by the clear-cache command). */
async clear(): Promise<void> {
try {
await rm(this.filePath, { force: true });
} catch {
// Best effort.
}
}
async status(): Promise<{ exists: boolean; sizeBytes: number }> {
try {
const s = await stat(this.filePath);
return { exists: s.isFile(), sizeBytes: s.size };
} catch {
return { exists: false, sizeBytes: 0 };
}
}
}
+117
View File
@@ -0,0 +1,117 @@
/**
* Lazy file-existence snapshot for include resolution.
*
* `resolveSource` performs synchronous `statSync` existence checks against
* every search base; a cold Corona build does ~110k of them (tens of seconds
* on a mechanical drive). Instead, existence is answered by reading the
* candidate's **parent directory** once (`readdir`, no per-file stat) and
* caching the entry set for the rest of the build. Only directories that are
* actually queried are ever listed, so a cold build pays a handful of
* readdir calls instead of an upfront recursive enumeration of every search
* root (which measurably slowed the XML phase).
*
* Correctness: the workspace clears `IncludeResolveCache` on file
* create/delete; each rebuild creates a fresh snapshot, and the debounced
* rebuild triggered by the watcher converges if anything changed mid-build.
*
* Pure TypeScript: no vscode dependency.
*/
import { existsSync, readdirSync } from "node:fs";
import { basename, dirname, parse, resolve, sep } from "node:path";
import { normKey } from "./caches";
import type { SearchPaths } from "./includeResolver";
/**
* Answers file-existence questions from lazily read directory listings.
* `has()` is authoritative for paths inside the roots and returns null for
* paths the snapshot does not cover (the caller falls back to `statSync`).
*/
export class ExistenceSnapshot {
private roots: string[] = [];
/** parent dir (normalized) -> lowercased file names, or null (no dir). */
private dirCache = new Map<string, Set<string> | null>();
/** Existence answers served from cached directory listings. */
hits = 0;
/** Paths outside the snapshot that required a statSync fallback. */
fallbacks = 0;
constructor(roots: string[]) {
// Roots and lookups must use the same normalization (case-insensitive on
// Windows), otherwise `startsWith` misses due to case differences.
this.roots = roots.map((r) => {
const n = normKey(r);
return n.endsWith(sep) ? n : n + sep;
});
}
/** true/false when covered by the snapshot, null when not covered. */
has(absPath: string): boolean | null {
const parentKey = normKey(dirname(absPath));
if (!this.isCovered(parentKey)) {
this.fallbacks++;
return null;
}
let entries = this.dirCache.get(parentKey);
if (entries === undefined) {
entries = listDirEntries(parentKey);
this.dirCache.set(parentKey, entries);
}
this.hits++;
return entries ? entries.has(basename(absPath).toLowerCase()) : false;
}
private isCovered(dirKey: string): boolean {
const key = dirKey.endsWith(sep) ? dirKey : dirKey + sep;
for (const root of this.roots) {
if (key.startsWith(root)) return true;
}
return false;
}
}
function listDirEntries(dir: string): Set<string> | null {
try {
const out = new Set<string>();
for (const entry of readdirSync(dir, { withFileTypes: true })) {
if (entry.isFile()) out.add(entry.name.toLowerCase());
}
return out;
} catch {
return null;
}
}
/**
* True when `dir` is a filesystem root (e.g. "C:\" or "/"). Such roots are
* never treated as search bases (they may contain the whole disk).
*/
export function isDriveRoot(dir: string): boolean {
const resolved = resolve(dir);
return parse(resolved).root === resolved;
}
/**
* Builds the snapshot root list from the search bases: drive roots and
* missing directories are skipped, and a root covered by a broader root is
* dropped (e.g. `sdkDir` covers `sdkDir/SageXml`). No directory is listed
* here; listings happen lazily per queried parent directory.
*/
export function buildExistenceSnapshot(searchPaths: SearchPaths): ExistenceSnapshot {
const candidates = [
...searchPaths.DATA,
...searchPaths.ART,
...searchPaths.AUDIO,
].map((r) => resolve(r));
candidates.sort((a, b) => a.length - b.length);
const roots: string[] = [];
for (const root of candidates) {
if (isDriveRoot(root)) continue;
if (!existsSync(root)) continue;
const normalized = normKey(root);
if (roots.some((r) => normalized.startsWith(r + sep))) continue;
roots.push(normalized);
}
return new ExistenceSnapshot(roots);
}
+32
View File
@@ -61,6 +61,38 @@ export class CachedDirectoryWalker implements FileWalker {
}
}
/**
* True for paths whose changes can never affect the index: `.git` internals
* touched by background fetch/maintenance, and transient temp/backup files
* created by editors or other extensions (`UnitCrate.xml.git`, `*.tmp`,
* `*.lock`, `file~`, `.#file`, ...). Such events are ignored by the file
* watcher instead of triggering rebuilds.
*/
export function isWatcherNoisePath(fsPath: string): boolean {
const segments = fsPath.split(/[\\/]/);
if (segments.some((seg) => seg.toLowerCase() === ".git")) return true;
const base = segments[segments.length - 1] ?? "";
const lower = base.toLowerCase();
const noiseSuffixes = [".git", ".tmp", ".lock", "~", ".swp", ".bak", ".orig"];
if (noiseSuffixes.some((suffix) => lower.endsWith(suffix))) return true;
return lower.startsWith(".#") || lower.startsWith(".~");
}
/**
* True for files whose *content* participates in the index: XML documents
* and art-asset XML (.w3x). Reasonable text formats in RA3 mods are `.xml`,
* `.w3x` and `.lua`; lua is not indexed yet, and compiled manifests are
* binary `*.manifest` (there is no `.manifestxml` source format). Files
* already in the index with other extensions (e.g. sniffed XML) are handled
* separately via `ModIndexer.isIndexedFile`. Content changes to binary art
* (e.g. textures, `.w3d`) cannot change index records, so they do not need
* to trigger a rebuild.
*/
export function isContentRelevantPath(fsPath: string): boolean {
const ext = extname(fsPath).toLowerCase();
return ext === ".xml" || ext === ".w3x";
}
/**
* Builds the candidate list for Include/@source completion from a set of
* search directories. For DATA directories only *.xml files are listed; for
+61 -16
View File
@@ -8,6 +8,7 @@
import { join, resolve, normalize, isAbsolute } from "node:path";
import { statSync } from "node:fs";
import type { ExistenceSnapshot } from "./existence";
export type IncludeKind = "all" | "instance" | "reference";
export type SourcePrefix = "DATA" | "ART" | "AUDIO" | null;
@@ -43,39 +44,66 @@ export function buildSearchPaths(
): SearchPaths {
const modParentPath = resolve(projectDir, "..");
const modGranParent = resolve(modParentPath, "..");
const sdk = sdkDir && sdkDir.trim() ? resolve(sdkDir) : "";
const sdkItems = (items: string[]): string[] => (sdk ? items : []);
return {
DATA: [
sdkDir,
...sdkItems([sdk]),
modGranParent,
join(projectDir, "Data"),
join(sdkDir, "Mods"),
...sdkItems([join(sdk, "Mods")]),
modParentPath,
join(sdkDir, "SageXml"),
...sdkItems([join(sdk, "SageXml")]),
...(extra?.DATA ?? []),
],
ART: [
sdkDir,
...sdkItems([sdk]),
modGranParent,
join(projectDir, "Art1"),
join(projectDir, "Art"),
join(sdkDir, "Mods"),
...sdkItems([join(sdk, "Mods")]),
modParentPath,
join(sdkDir, "Art"),
...sdkItems([join(sdk, "Art")]),
...(extra?.ART ?? []),
],
AUDIO: [
sdkDir,
...sdkItems([sdk]),
modGranParent,
join(projectDir, "Audio1"),
join(projectDir, "Audio"),
join(sdkDir, "Mods"),
...sdkItems([join(sdk, "Mods")]),
modParentPath,
join(sdkDir, "Audio"),
...sdkItems([join(sdk, "Audio")]),
...(extra?.AUDIO ?? []),
],
};
}
/**
* Search paths used to resolve a `manifestSource` back to the original
* vanilla SDK source file.
*
* `manifestSource` records where the asset came from when the vanilla
* manifest was compiled; it is not an Include path that should be resolved
* with the current mod's BAB search order. If a mod shadows the same DATA:
* path (for example `Data/globaldata/weapon.xml` exists in both the mod and
* `SageXml`), the manifest definition must still point at the SageXml file.
*
* DATA/ART/AUDIO are resolved against the SDK root first (matching the
* vanilla BAB `/data "/art" /audio` order), then against the corresponding
* SDK source folder. ART/AUDIO source files are not shipped for most assets,
* so those resolutions usually return null and callers fall back to
* manifest-only behavior.
*/
export function buildVanillaSearchPaths(sdkDir: string): SearchPaths {
const sdk = sdkDir && sdkDir.trim() ? resolve(sdkDir) : "";
return {
DATA: sdk ? [sdk, join(sdk, "SageXml")] : [],
ART: sdk ? [sdk, join(sdk, "Art")] : [],
AUDIO: sdk ? [sdk, join(sdk, "Audio")] : [],
};
}
function splitPrefix(source: string): { prefix: SourcePrefix; rest: string } {
for (const prefix of PREFIXES) {
if (source.toUpperCase().startsWith(`${prefix}:`)) {
@@ -99,41 +127,58 @@ export function resolveSource(
source: string,
currentDir: string | null,
searchPaths: SearchPaths,
existence?: ExistenceSnapshot,
): ResolveResult {
const raw = source.trim().replace(/\\/g, "/");
const { prefix, rest } = splitPrefix(raw);
if (prefix) {
const bases = searchPaths[prefix] ?? [];
const direct = findInBases(rest, bases);
const direct = findInBases(rest, bases, existence);
if (direct) return { path: direct, prefix, raw };
if (prefix === "ART" && !rest.includes("/")) {
const two = rest.slice(0, 2).toLowerCase();
const prefixed = findInBases(`${two}/${rest}`, bases);
const prefixed = findInBases(`${two}/${rest}`, bases, existence);
if (prefixed) return { path: prefixed, prefix, raw };
}
return { path: null, prefix, raw };
}
if (currentDir && isAbsolute(rest)) {
return { path: fileExists(rest) ? rest : null, prefix: null, raw };
return {
path: fileExists(rest, existence) ? rest : null,
prefix: null,
raw,
};
}
if (currentDir) {
const candidate = resolve(currentDir, rest);
return { path: fileExists(candidate) ? candidate : null, prefix: null, raw };
return {
path: fileExists(candidate, existence) ? candidate : null,
prefix: null,
raw,
};
}
return { path: null, prefix: null, raw };
}
function findInBases(relPath: string, bases: string[]): string | null {
function findInBases(
relPath: string,
bases: string[],
existence?: ExistenceSnapshot,
): string | null {
for (const base of bases) {
const candidate = normalize(resolve(base, relPath));
if (fileExists(candidate)) return candidate;
if (fileExists(candidate, existence)) return candidate;
}
return null;
}
function fileExists(path: string): boolean {
function fileExists(path: string, existence?: ExistenceSnapshot): boolean {
if (existence) {
const known = existence.has(path);
if (known !== null) return known;
}
try {
return statSync(path).isFile();
} catch {
+397 -84
View File
@@ -18,7 +18,6 @@ import {
LineMap,
parseXml,
stripBom,
type XmlDocument,
type XmlElement,
} from "../language/xmlParser";
import {
@@ -28,6 +27,12 @@ import {
type ResolveResult,
type SearchPaths,
} from "./includeResolver";
import { validateSdkPath } from "../sdk";
import {
buildExistenceSnapshot,
type ExistenceSnapshot,
} from "./existence";
import { findXPointerContainer, localName } from "./xpointer";
import {
deriveAssetId,
deriveAssetType,
@@ -36,14 +41,26 @@ import {
} from "./manifestParser";
import { canonicalTypeName } from "../model/schemaModel";
import { collectSourceCandidates } from "./fileScanner";
import { DocumentCache, IncludeResolveCache, IndexRecordsCache, normKey } from "./caches";
import {
contentHash,
DocumentCache,
IncludeResolveCache,
IndexRecordsCache,
normKey,
recordsHash,
} from "./caches";
import type { IndexRecordsCacheEntry } from "./caches";
import { scanXmlShallow } from "./shallowScan";
import {
extractIndexRecords,
recordsFromShallow,
type IndexRecords,
type IndexRecordXi,
} from "./records";
import {
buildReferenceIndex,
type ReferenceRecordSource,
} from "./referenceIndex";
import type {
AssetDef,
DefineDef,
@@ -51,6 +68,7 @@ import type {
IndexedFile,
ModIndex,
ParsedFile,
ReferenceSite,
SourceCandidate,
StreamInfo,
} from "./types";
@@ -59,10 +77,11 @@ const MAX_DEPTH = 300;
/** Files above this size are never parsed (safety against binary blobs). */
const MAX_PARSE_BYTES = 4 * 1024 * 1024;
/**
* Fully parsed XML documents. `.xml` / `.manifestxml` files are small enough
* that a full DOM is affordable.
* Fully parsed XML documents. `.xml` files are small enough that a full DOM
* is affordable. (Compiled manifests are binary `*.manifest` files parsed by
* `manifestParser`; there is no `.manifestxml` source format.)
*/
const FULL_XML_EXTENSIONS = new Set([".xml", ".manifestxml"]);
const FULL_XML_EXTENSIONS = new Set([".xml"]);
/**
* XML documents whose top-level structure is all the index needs (art-asset
* files exported by modeling tools, e.g. .w3x). They are shallow-scanned so
@@ -79,6 +98,8 @@ export class ModIndexer {
private docs: DocumentCache;
private recordsCache: IndexRecordsCache;
private resolveCache: IncludeResolveCache;
/** Directory-based file existence snapshot (avoids cold statSync storms). */
private existence: ExistenceSnapshot | null = null;
private scanCounters = {
shallowScannedFiles: 0,
shallowCacheHits: 0,
@@ -86,11 +107,33 @@ export class ModIndexer {
resolveCacheHits: 0,
resolveCalls: 0,
};
private phase = { candidatesMs: 0, walkMs: 0 };
private timings = { candidatesMs: 0, walkMs: 0, artScanMs: 0 };
/**
* Phase A ("xml") registers art-asset XML files (`.w3x` and sniffed XML)
* without reading their content; the queue is drained by phase B ("art"),
* which shallow-scans them and walks any includes they contain.
*/
private deferArtScan = false;
private artQueue: {
path: string;
stream: StreamInfo;
depth: number;
viaInstance: boolean;
}[] = [];
private assets = new Map<string, Map<string, AssetDef[]>>();
private assetsById = new Map<string, AssetDef[]>();
private defines = new Map<string, DefineDef[]>();
private files = new Map<string, IndexedFile>();
/**
* Records exactly as the current build's walk saw them (path -> records +
* content hash). The reverse reference index is built from this map, never
* from the shared records cache, so a watcher invalidation or a feature
* re-read (readDom) mid-build cannot desync references from assets.
*/
private buildRecords = new Map<
string,
{ file: string; records: IndexRecords; recordsHash: string }
>();
private streams: StreamInfo[] = [];
private manifests = new Map<string, ManifestInfo>();
private sourceCandidates: SourceCandidate[] = [];
@@ -98,11 +141,17 @@ export class ModIndexer {
private visitedAll = new Set<string>();
private visitedInstance = new Set<string>();
private manifestAssetKeys = new Set<string>();
/** True when the SDK is missing/not an SDK: SDK-only includes are suppressed. */
private sdkUnusable: boolean;
private suppressedSdkIncludeCount = 0;
constructor(private opts: IndexOptions) {
this.searchPaths = buildSearchPaths(opts.sdkDir, opts.projectDir, {
DATA: opts.additionalDataSearchPaths,
});
const sdkStatus = validateSdkPath(opts.sdkDir);
this.sdkUnusable =
sdkStatus.status === "missing" || sdkStatus.status === "not-sdk";
// Caches may be owned by the workspace so they survive rebuilds.
this.docs = opts.documentCache ?? new DocumentCache();
this.recordsCache = opts.recordsCache ?? new IndexRecordsCache();
@@ -111,8 +160,7 @@ export class ModIndexer {
/**
* Returns a document for indexing/navigation:
* - `.xml` / `.manifestxml` files are fully parsed (bounded by
* MAX_PARSE_BYTES);
* - `.xml` files are fully parsed (bounded by MAX_PARSE_BYTES);
* - `.w3x` (and unknown-extension files whose content looks like XML) are
* shallow-scanned, so huge model files never become a DOM;
* - everything else is registered as a file but never parsed.
@@ -120,7 +168,10 @@ export class ModIndexer {
* Cached entries are reused when the file stat is unchanged, which lets a
* workspace-owned cache survive rebuilds.
*/
async readDocument(path: string): Promise<ParsedFile | null> {
async readDocument(
path: string,
opts?: { deferArt?: boolean },
): Promise<ParsedFile | null> {
const key = normKey(path);
const trust =
this.opts.trustUnchanged === true && !this.opts.changedFiles?.has(key);
@@ -131,7 +182,27 @@ export class ModIndexer {
// ~2.6 GB of art assets on a mechanical drive).
if (trust) {
const rec = this.recordsCache.get(key);
if (rec) return this.recordsParsed(path, rec);
if (rec) {
if (rec.validated === false) {
// Seeded from disk but not stat-validated yet. During phase A an
// art file only needs registration (no content), so reuse the
// cached stamp; its records are consumed only after validation.
if (opts?.deferArt && rec.kind === "shallow" && rec.stat) {
const file: IndexedFile = { path: resolve(path), stat: rec.stat };
this.files.set(key, file);
return {
file,
parse: null,
records: null,
lineMap: null,
deferredArt: true,
};
}
// Fall through: the stat-verifying path below checks this entry.
} else {
return this.recordsParsed(path, rec);
}
}
const cached = this.docs.get(key);
if (cached) {
this.files.set(key, cached.file);
@@ -143,48 +214,93 @@ export class ModIndexer {
try {
const st = await stat(path);
const rec = this.recordsCache.get(key);
if (rec?.stat && rec.stat.mtimeMs === st.mtimeMs && rec.stat.size === st.size) {
if (
rec?.stat &&
rec.stat.mtimeMs === st.mtimeMs &&
rec.stat.size === st.size &&
rec.stat.birthtimeMs === st.birthtimeMs &&
rec.stat.ctimeMs === st.ctimeMs
) {
rec.validated = true;
// Force rebuilds (Re-index workspace) verify full-XML content even
// when every stat signal matches: external drives (FAT32/exFAT) can
// rewrite a file with the same size and coarse timestamps.
if (
this.opts.trustUnchanged === false &&
rec.kind === "full" &&
rec.contentHash
) {
const text = stripBom(await readFile(path, "utf8"));
if (contentHash(text) === rec.contentHash) {
return this.recordsParsed(path, rec);
}
return this.parseFullXml(path, st, text);
}
return this.recordsParsed(path, rec);
}
const hit = this.docs.get(key);
if (
hit?.file.stat &&
hit.file.stat.mtimeMs === st.mtimeMs &&
hit.file.stat.size === st.size
hit.file.stat.size === st.size &&
hit.file.stat.birthtimeMs === st.birthtimeMs &&
hit.file.stat.ctimeMs === st.ctimeMs
) {
this.files.set(key, hit.file);
return hit;
}
const mode = await this.detectXmlMode(path);
if (mode === "shallow") return this.scanShallow(path, st);
if (mode === "shallow") {
// Phase A: register the art file, defer the shallow scan to phase B.
if (opts?.deferArt) {
const file: IndexedFile = {
path: resolve(path),
stat: {
mtimeMs: st.mtimeMs,
size: st.size,
birthtimeMs: st.birthtimeMs,
ctimeMs: st.ctimeMs,
},
};
// Deliberately NOT stored in the DocumentCache: a deferred entry
// has no records, and a later phase-B read must re-scan it.
this.files.set(key, file);
return { file, parse: null, records: null, lineMap: null, deferredArt: true };
}
return this.scanShallow(path, st);
}
if (mode === "binary") {
const file: IndexedFile = { path: resolve(path), stat: { mtimeMs: st.mtimeMs, size: st.size } };
const file: IndexedFile = {
path: resolve(path),
stat: {
mtimeMs: st.mtimeMs,
size: st.size,
birthtimeMs: st.birthtimeMs,
ctimeMs: st.ctimeMs,
},
};
const parsed: ParsedFile = { file, parse: null, records: null, lineMap: null };
this.docs.set(parsed);
this.files.set(key, file);
return parsed;
}
if (st.size > MAX_PARSE_BYTES) {
const file: IndexedFile = { path: resolve(path), stat: { mtimeMs: st.mtimeMs, size: st.size } };
const file: IndexedFile = {
path: resolve(path),
stat: {
mtimeMs: st.mtimeMs,
size: st.size,
birthtimeMs: st.birthtimeMs,
ctimeMs: st.ctimeMs,
},
};
const parsed: ParsedFile = { file, parse: null, records: null, lineMap: null };
this.docs.set(parsed);
this.files.set(key, file);
return parsed;
}
const text = stripBom(await readFile(path, "utf8"));
const lineMap = new LineMap(text);
const parse = parseXml(text);
const records = extractIndexRecords(parse, lineMap);
const parsed: ParsedFile = {
file: { path: resolve(path), stat: { mtimeMs: st.mtimeMs, size: st.size } },
parse,
records,
lineMap,
};
this.docs.set(parsed);
this.recordsCache.set(key, { stat: parsed.file.stat, records, kind: "full" });
this.files.set(key, parsed.file);
return parsed;
return this.parseFullXml(path, st, text);
} catch {
const parsed: ParsedFile = {
file: { path: resolve(path), stat: null },
@@ -211,7 +327,15 @@ export class ModIndexer {
const lineMap = new LineMap(text);
const records = recordsFromShallow(scanXmlShallow(text), lineMap);
const parsed: ParsedFile = {
file: { path: resolve(path), stat: { mtimeMs: st.mtimeMs, size: st.size } },
file: {
path: resolve(path),
stat: {
mtimeMs: st.mtimeMs,
size: st.size,
birthtimeMs: st.birthtimeMs,
ctimeMs: st.ctimeMs,
},
},
parse: null,
records,
lineMap: null,
@@ -235,11 +359,45 @@ export class ModIndexer {
}
/**
* Reads a document and guarantees a DOM parse tree. Used only for
* root-level <xi:include> xpointer selection (rare), where the target's
* container children are needed.
* Parses a full XML document from its text, caches records (with a content
* hash) and the DOM, and registers the file in this build.
*/
private async readDom(path: string): Promise<ParsedFile | null> {
private parseFullXml(path: string, st: Stats, text: string): ParsedFile {
const key = normKey(path);
const lineMap = new LineMap(text);
const parse = parseXml(text);
const records = extractIndexRecords(parse, lineMap, text);
const parsed: ParsedFile = {
file: {
path: resolve(path),
stat: {
mtimeMs: st.mtimeMs,
size: st.size,
birthtimeMs: st.birthtimeMs,
ctimeMs: st.ctimeMs,
},
},
parse,
records,
lineMap,
};
this.docs.set(parsed);
this.recordsCache.set(key, {
stat: parsed.file.stat,
records,
kind: "full",
contentHash: contentHash(text),
});
this.files.set(key, parsed.file);
return parsed;
}
/**
* Reads a document and guarantees a DOM parse tree. Used for root-level
* <xi:include> xpointer selection (rare) and by the document-local scope
* (logical include expansion + precise definition locations).
*/
async readDom(path: string): Promise<ParsedFile | null> {
const key = normKey(path);
const cached = this.docs.get(key);
if (cached?.parse?.root) {
@@ -253,26 +411,16 @@ export class ModIndexer {
hit?.parse?.root &&
hit.file.stat &&
hit.file.stat.mtimeMs === st.mtimeMs &&
hit.file.stat.size === st.size
hit.file.stat.size === st.size &&
hit.file.stat.birthtimeMs === st.birthtimeMs &&
hit.file.stat.ctimeMs === st.ctimeMs
) {
this.files.set(key, hit.file);
return hit;
}
if (st.size > MAX_PARSE_BYTES) return null;
const text = stripBom(await readFile(path, "utf8"));
const lineMap = new LineMap(text);
const parse = parseXml(text);
const records = extractIndexRecords(parse, lineMap);
const parsed: ParsedFile = {
file: { path: resolve(path), stat: { mtimeMs: st.mtimeMs, size: st.size } },
parse,
records,
lineMap,
};
this.docs.set(parsed);
this.recordsCache.set(key, { stat: parsed.file.stat, records, kind: "full" });
this.files.set(key, parsed.file);
return parsed;
return this.parseFullXml(path, st, text);
} catch {
return null;
}
@@ -299,7 +447,12 @@ export class ModIndexer {
return hit;
}
this.scanCounters.resolveCalls++;
const result = resolveSource(source, currentDir, this.searchPaths);
const result = resolveSource(
source,
currentDir,
this.searchPaths,
this.existence ?? undefined,
);
this.resolveCache.set(key, result);
return result;
}
@@ -323,14 +476,28 @@ export class ModIndexer {
return this.docs.get(path);
}
async build(): Promise<ModIndex> {
/** True when the file is part of the current build's index. */
isIndexedFile(path: string): boolean {
return this.files.has(normKey(path));
}
async build(onPhase?: (index: ModIndex) => void | Promise<void>): Promise<ModIndex> {
const start = Date.now();
this.buildRecords.clear();
this.suppressedSdkIncludeCount = 0;
// Root list only; directories are listed lazily on first query, so the
// XML phase does not pay an upfront recursive enumeration of the SDK.
this.existence = buildExistenceSnapshot(this.searchPaths);
const projectData = await findCaseInsensitiveDir(join(this.opts.projectDir, "Data"));
const additionalMaps = projectData
? await findCaseInsensitiveDir(join(projectData, "additionalmaps"))
: null;
// ── Streams ──
// Phase A: walk the include graph without reading art-asset content.
// `.w3x` (and sniffed XML) files are registered and queued; their
// top-level assets and nested includes are processed in phase B.
this.deferArtScan = true;
const walkStart = Date.now();
const staticEntry = projectData ? join(projectData, "Mod.xml") : null;
if (staticEntry) {
@@ -360,7 +527,18 @@ export class ModIndexer {
await this.walk(entry, "all", stream, 0);
}
}
this.phase.walkMs = Date.now() - walkStart;
this.timings.walkMs = Date.now() - walkStart;
if (this.suppressedSdkIncludeCount > 0) {
this.diagnostics.push({
file:
staticEntry ?? join(this.opts.projectDir, "Data"),
line: 0,
message:
"SDK path is not configured or invalid; DATA:/ART:/AUDIO: includes are not resolved (set ra3modxml.sdkPath).",
severity: "information",
code: "sdk-not-configured",
});
}
// ── Source completion candidates ──
const candidatesStart = Date.now();
@@ -395,9 +573,17 @@ export class ModIndexer {
// global.xml, audio.xml placeholders) but only its shallow XML files are
// relevant. These candidates take precedence over same-named files found
// deeper in the search paths (e.g. SageXml/Static.xml).
const sdkRootXml = (await readdir(this.opts.sdkDir)).filter(
(f) => f.toLowerCase().endsWith(".xml"),
);
let sdkRootXml: string[] = [];
if (this.opts.sdkDir) {
try {
sdkRootXml = (await readdir(this.opts.sdkDir)).filter(
(f) => f.toLowerCase().endsWith(".xml"),
);
} catch {
// Missing/inaccessible SDK root: run in project-only mode. All other
// SDK search roots already degrade to empty lists.
}
}
const sdkRootCandidates: SourceCandidate[] = sdkRootXml.map((f) => ({
source: `DATA:${f}`,
path: resolve(this.opts.sdkDir, f),
@@ -408,49 +594,142 @@ export class ModIndexer {
...sdkRootCandidates,
...this.sourceCandidates,
]);
this.phase.candidatesMs = Date.now() - candidatesStart;
this.timings.candidatesMs = Date.now() - candidatesStart;
// Publish the XML phase as an immutable snapshot: features get usable
// completions/navigation/diagnostics for XML + manifest data immediately,
// while the slow art scan continues in the background.
const xmlPhase = this.snapshotIndex("xml", false, start);
if (onPhase) await onPhase(xmlPhase);
// ── Phase B: art assets ──
this.deferArtScan = false;
const artStart = Date.now();
while (this.artQueue.length) {
const entry = this.artQueue.shift()!;
const parsed = await this.readDocument(entry.path);
if (parsed?.records) {
await this.applyRecords(parsed, entry.stream, entry.depth, entry.viaInstance);
}
}
this.timings.artScanMs = Date.now() - artStart;
return this.snapshotIndex("art", true, start);
}
/**
* Produces a copy of the current index state. Phase-A snapshots must be
* immutable: phase B keeps mutating the live maps after the snapshot has
* been handed to features, so every nested map/array is cloned here.
*/
private snapshotIndex(
phase: "xml" | "art",
complete: boolean,
startedAt: number,
): ModIndex {
const manifestAssetCount = [...this.manifests.values()].reduce(
(sum, m) => sum + m.assets.length,
0,
);
const assets = new Map<string, Map<string, AssetDef[]>>();
for (const [type, byId] of this.assets) {
const copied = new Map<string, AssetDef[]>();
for (const [id, defs] of byId) copied.set(id, defs.slice());
assets.set(type, copied);
}
const assetsById = new Map<string, AssetDef[]>();
for (const [id, defs] of this.assetsById) assetsById.set(id, defs.slice());
const defines = new Map<string, DefineDef[]>();
for (const [name, defs] of this.defines) defines.set(name, defs.slice());
const references = this.buildReferences();
const referenceCount = [...references.values()].reduce(
(sum, sites) => sum + sites.length,
0,
);
const recordsHashes = new Map<string, string>();
for (const [key, entry] of this.buildRecords) {
recordsHashes.set(key, entry.recordsHash);
}
return {
projectDir: resolve(this.opts.projectDir),
sdkDir: resolve(this.opts.sdkDir),
assets: this.assets,
assetsById: this.assetsById,
defines: this.defines,
files: this.files,
streams: this.streams,
manifests: this.manifests,
sourceCandidates: this.sourceCandidates,
diagnostics: this.diagnostics,
complete,
phase,
assets,
assetsById,
defines,
files: new Map(this.files),
streams: this.streams.map((s) => ({ ...s, files: new Set(s.files) })),
manifests: new Map(this.manifests),
sourceCandidates: this.sourceCandidates.slice(),
diagnostics: this.diagnostics.slice(),
references,
recordsHashes,
stats: {
projectDir: resolve(this.opts.projectDir),
sdkDir: resolve(this.opts.sdkDir),
phase,
complete,
indexedFiles: this.files.size,
parsedFiles: [...this.files.values()].filter(
(f) => f.stat != null && f.stat.size <= MAX_PARSE_BYTES,
).length,
shallowScannedFiles: this.scanCounters.shallowScannedFiles,
deferredArtFiles: this.artQueue.length,
shallowCacheHits: this.scanCounters.shallowCacheHits,
recordsCacheHits: this.scanCounters.recordsCacheHits,
resolveCacheHits: this.scanCounters.resolveCacheHits,
resolveCalls: this.scanCounters.resolveCalls,
candidatesMs: this.phase.candidatesMs,
walkMs: this.phase.walkMs,
snapshotHits: this.existence?.hits ?? 0,
snapshotFallbacks: this.existence?.fallbacks ?? 0,
candidatesMs: this.timings.candidatesMs,
walkMs: this.timings.walkMs,
artScanMs: this.timings.artScanMs,
assetCount: [...this.assets.values()].reduce((sum, byId) => sum + byId.size, 0),
referenceCount,
defineCount: this.defines.size,
manifestFiles: this.manifests.size,
manifestAssetCount,
streams: this.streams.length,
sourceCandidates: this.sourceCandidates.length,
elapsedMs: Date.now() - start,
elapsedMs: Date.now() - startedAt,
},
};
}
/**
* Resolves the per-file reference records collected during this build
* against the current asset maps. Only files touched by this build are
* included, so stale cache entries for files that left the include graph
* never leak into the reverse index.
*/
private buildReferences(): Map<string, ReferenceSite[]> {
const sources: ReferenceRecordSource[] = [];
for (const { file, records } of this.buildRecords.values()) {
sources.push({ file, records });
}
return buildReferenceIndex(sources, {
assets: this.assets,
assetsById: this.assetsById,
});
}
/**
* Remembers the records exactly as this build saw them (plus the content
* hash when the file was fully parsed / cached with one), so snapshots can
* build references from the same source of truth as the asset maps.
*/
private noteBuildRecords(parsed: ParsedFile): void {
if (!parsed.records) return;
const key = normKey(parsed.file.path);
this.buildRecords.set(key, {
file: parsed.file.path,
records: parsed.records,
recordsHash: recordsHash(parsed.records),
});
}
// ── Include walk ──────────────────────────────────────────────────
private async walk(
@@ -483,9 +762,19 @@ export class ModIndexer {
// readDocument returns compact index records for every indexable XML
// document (full parse or shallow scan), or a bare file registration
// for binary / unparseable targets.
const parsed = await this.readDocument(path);
// for binary / unparseable targets. During phase A, art-asset XML files
// are registered and queued instead of scanned (deferredArt).
const parsed = await this.readDocument(path, this.deferArtScan ? { deferArt: true } : undefined);
if (!parsed) return;
if (parsed.deferredArt) {
this.artQueue.push({
path: parsed.file.path,
stream,
depth,
viaInstance: mode === "instance",
});
return;
}
if (parsed.records) {
await this.applyRecords(parsed, stream, depth, mode === "instance");
return;
@@ -505,6 +794,7 @@ export class ModIndexer {
): Promise<void> {
const records = parsed.records;
if (!records) return;
this.noteBuildRecords(parsed);
const file = parsed.file.path;
const origin = this.originOf(file);
@@ -536,6 +826,10 @@ export class ModIndexer {
for (const inc of records.includes) {
const resolved = this.resolveCached(inc.source, dirname(file));
if (!resolved.path) {
if (this.shouldSuppressMissingInclude(inc.source)) {
this.suppressedSdkIncludeCount++;
continue;
}
this.diagnostics.push({
file,
line: inc.line,
@@ -566,6 +860,10 @@ export class ModIndexer {
for (const xi of records.nestedXiIncludes) {
const resolved = this.resolveCached(xi.href, dirname(file));
if (!resolved.path) {
if (this.shouldSuppressMissingInclude(xi.href)) {
this.suppressedSdkIncludeCount++;
continue;
}
this.diagnostics.push({
file,
line: xi.line,
@@ -597,6 +895,10 @@ export class ModIndexer {
): Promise<void> {
const resolved = this.resolveCached(xi.href, dirname(parentFile));
if (!resolved.path) {
if (this.shouldSuppressMissingInclude(xi.href)) {
this.suppressedSdkIncludeCount++;
return;
}
this.diagnostics.push({
file: parentFile,
line: xi.line,
@@ -688,12 +990,19 @@ export class ModIndexer {
private originOf(path: string): "project" | "sdk" {
const p = resolve(path).toLowerCase();
const project = resolve(this.opts.projectDir).toLowerCase();
const sdk = resolve(this.opts.sdkDir).toLowerCase();
const sdk = this.opts.sdkDir
? resolve(this.opts.sdkDir).toLowerCase()
: "";
if (p.startsWith(project + "\\")) return "project";
if (sdk && p.startsWith(sdk + "\\")) return "sdk";
return "project";
}
/** DATA:/ART:/AUDIO: misses are expected when no usable SDK is configured. */
private shouldSuppressMissingInclude(source: string): boolean {
return this.sdkUnusable && /^(DATA|ART|AUDIO):/i.test(source.trim());
}
private addAsset(def: AssetDef): void {
// Keep the original case: type names are matched against the XSD model.
const typeKey = def.type;
@@ -705,14 +1014,32 @@ export class ModIndexer {
}
const arr = byId.get(idKey);
if (arr) {
if (arr.some((a) => a.file === def.file && a.line === def.line)) return;
if (
arr.some(
(a) =>
a.type === def.type &&
a.file === def.file &&
a.line === def.line,
)
) {
return;
}
arr.push(def);
} else {
byId.set(idKey, [def]);
}
const all = this.assetsById.get(idKey);
if (all) {
if (all.some((a) => a.file === def.file && a.line === def.line)) return;
if (
all.some(
(a) =>
a.type === def.type &&
a.file === def.file &&
a.line === def.line,
)
) {
return;
}
all.push(def);
} else {
this.assetsById.set(idKey, [def]);
@@ -722,11 +1049,6 @@ export class ModIndexer {
// ── Module-level helpers ─────────────────────────────────────────────
function localName(tag: string): string {
const idx = tag.lastIndexOf(":");
return idx >= 0 ? tag.slice(idx + 1) : tag;
}
function lineOf(parsed: ParsedFile, offset: number): number {
if (!parsed.lineMap) return 0;
return parsed.lineMap.positionAt(offset).line + 1;
@@ -774,15 +1096,6 @@ async function findCaseInsensitiveDir(dir: string): Promise<string | null> {
}
}
function findXPointerContainer(doc: XmlDocument, xpointer: string): XmlElement | null {
// Supports the form used by the mods:
// xmlns(n=uri:ea.com:eala:asset) xpointer(/n:ElementName/child::*)
const m = /xpointer\(\/\w+:(\w+)\/child::\*\)/.exec(xpointer);
if (!m) return null;
const name = m[1];
return doc.elements.find((el) => localName(el.name) === name) ?? null;
}
/** Keeps the first candidate for each case-insensitive source string. */
function dedupeSourceCandidates(candidates: SourceCandidate[]): SourceCandidate[] {
const seen = new Set<string>();
+287
View File
@@ -0,0 +1,287 @@
import { dirname, resolve } from "node:path";
import { LineMap, parseXml, type XmlDocument } from "../language/xmlParser";
import { extractIndexRecords } from "./records";
import { resolveSource, type SearchPaths } from "./includeResolver";
import { expandDocument, type LogicalDocument } from "./logicalTree";
import type {
AssetDef,
DefineDef,
LocalOverlay,
ModIndex,
ParsedFile,
} from "./types";
export interface LocalScopeContext {
projectDir: string;
sdkDir: string;
searchPaths: SearchPaths;
/** Reads a file's compact index records (full parse or shallow scan). */
readRecords(path: string): Promise<ParsedFile | null>;
/** Reads a file and guarantees a DOM parse tree. */
readDom(path: string): Promise<ParsedFile | null>;
}
/**
* Everything the features need for the currently open document: the original
* parse, the expanded logical tree, per-source line maps, the local overlay
* and the overlay-aware index for lookups.
*/
export interface DocumentScope {
uri: string;
version: number;
parse: XmlDocument;
lineMap: LineMap;
expanded: LogicalDocument;
/** scopePathKey(file) -> line map (current file + expanded include targets). */
lineMaps: Map<string, LineMap>;
/** Local assets/defines from the document itself and its include chain. */
overlay: LocalOverlay;
/** Global index with `local` attached (or a minimal standalone index). */
merged: ModIndex | null;
}
/** Normalized key used for source-file identity / line-map lookup. */
export function scopePathKey(path: string): string {
return path.replace(/\\/g, "/").toLowerCase();
}
/**
* Builds the document scope for the current (possibly unsaved) text:
* - a local overlay of assets/defines reachable from this file;
* - a logical tree with supported xi:include targets spliced in place.
*/
export async function buildDocumentScope(
uri: string,
text: string,
version: number,
ctx: LocalScopeContext,
): Promise<DocumentScope> {
const lineMap = new LineMap(text);
const parse = parseXml(text);
const builder = new OverlayBuilder(ctx);
await builder.addEntry(uri, parse, lineMap, text);
const expanded = await expandDocument(uri, parse, {
resolve: (source, currentDir) =>
resolveSource(source, currentDir, ctx.searchPaths).path,
readDom: async (path) => {
const parsed = await ctx.readDom(path);
return parsed?.parse && parsed.lineMap
? { parse: parsed.parse, lineMap: parsed.lineMap }
: null;
},
});
const lineMaps = new Map<string, LineMap>();
lineMaps.set(scopePathKey(uri), lineMap);
for (const [path, lm] of builder.lineMaps) {
if (!lineMaps.has(path)) lineMaps.set(path, lm);
}
return {
uri,
version,
parse,
lineMap,
expanded,
lineMaps,
overlay: builder.overlay,
merged: null,
};
}
/**
* Attaches a document-local overlay to a global index without copying the
* global maps. When there is no global index yet, returns a minimal standalone
* index so the local chain alone can serve completions / references.
*/
export function withLocalOverlay(
global: ModIndex | null,
overlay: LocalOverlay,
projectDir: string,
sdkDir: string,
): ModIndex {
if (!global) {
return {
projectDir,
sdkDir,
complete: false,
phase: "xml",
assets: new Map(),
assetsById: new Map(),
defines: new Map(),
files: new Map(),
streams: [],
manifests: new Map(),
sourceCandidates: [],
diagnostics: [],
references: new Map(),
recordsHashes: new Map(),
stats: {
projectDir,
sdkDir,
phase: "xml",
complete: false,
indexedFiles: 0,
parsedFiles: 0,
shallowScannedFiles: 0,
deferredArtFiles: 0,
shallowCacheHits: 0,
recordsCacheHits: 0,
resolveCacheHits: 0,
resolveCalls: 0,
snapshotHits: 0,
snapshotFallbacks: 0,
candidatesMs: 0,
walkMs: 0,
artScanMs: 0,
assetCount: 0,
referenceCount: 0,
defineCount: 0,
manifestFiles: 0,
manifestAssetCount: 0,
streams: 0,
sourceCandidates: 0,
elapsedMs: 0,
},
local: overlay,
};
}
return { ...global, local: overlay };
}
const MAX_LOCAL_DEPTH = 64;
class OverlayBuilder {
readonly overlay: LocalOverlay = {
assets: new Map(),
assetsById: new Map(),
defines: new Map(),
};
readonly lineMaps = new Map<string, LineMap>();
private visited = new Set<string>();
constructor(private ctx: LocalScopeContext) {}
async addEntry(
path: string,
parse: XmlDocument,
lineMap: LineMap,
text: string,
): Promise<void> {
this.lineMaps.set(scopePathKey(path), lineMap);
await this.addParsed({
file: { path: resolve(path), stat: null },
parse,
records: extractIndexRecords(parse, lineMap, text),
lineMap,
}, 0);
}
async addFile(path: string, depth: number): Promise<void> {
if (depth > MAX_LOCAL_DEPTH) return;
const parsed = await this.ctx.readRecords(path);
if (parsed) await this.addParsed(parsed, depth);
}
private async addParsed(parsed: ParsedFile, depth: number): Promise<void> {
const path = parsed.file.path;
const key = scopePathKey(path);
if (!parsed.records || this.visited.has(key)) return;
this.visited.add(key);
if (parsed.lineMap) this.lineMaps.set(key, parsed.lineMap);
const origin = this.originOf(path);
for (const asset of parsed.records.assets) {
this.addAsset({
type: asset.type,
id: asset.id,
file: path,
line: asset.line,
origin,
stream: "local",
});
}
for (const define of parsed.records.defines) {
const entry: DefineDef = {
name: define.name,
value: define.value,
file: path,
line: define.line,
origin,
};
const arr = this.overlay.defines.get(define.name.toLowerCase());
if (arr) arr.push(entry);
else this.overlay.defines.set(define.name.toLowerCase(), [entry]);
}
for (const inc of parsed.records.includes) {
const resolved = resolveSource(inc.source, dirname(path), this.ctx.searchPaths);
if (!resolved.path) continue;
if (inc.type === "all" || inc.type === "instance") {
await this.addFile(resolved.path, depth + 1);
}
// type="reference" points at compiled manifests; their assets are
// provided by the global index, so the local text overlay skips them.
}
for (const xi of [
...parsed.records.nestedXiIncludes,
...parsed.records.rootXiIncludes,
]) {
const resolved = resolveSource(xi.href, dirname(path), this.ctx.searchPaths);
if (resolved.path) await this.addFile(resolved.path, depth + 1);
}
}
private addAsset(def: AssetDef): void {
const typeKey = def.type;
const idKey = def.id.toLowerCase();
let byId = this.overlay.assets.get(typeKey);
if (!byId) {
byId = new Map();
this.overlay.assets.set(typeKey, byId);
}
const arr = byId.get(idKey);
if (arr) {
if (
arr.some(
(a) =>
a.type === def.type &&
a.file === def.file &&
a.line === def.line,
)
) {
return;
}
arr.push(def);
} else {
byId.set(idKey, [def]);
}
const all = this.overlay.assetsById.get(idKey);
if (all) {
if (
all.some(
(a) =>
a.type === def.type &&
a.file === def.file &&
a.line === def.line,
)
) {
return;
}
all.push(def);
} else {
this.overlay.assetsById.set(idKey, [def]);
}
}
private originOf(path: string): "project" | "sdk" | "manifest" {
const p = resolve(path).toLowerCase();
const project = resolve(this.ctx.projectDir).toLowerCase();
const sdk = this.ctx.sdkDir ? resolve(this.ctx.sdkDir).toLowerCase() : "";
if (p.startsWith(project + "\\")) return "project";
if (sdk && p.startsWith(sdk + "\\")) return "sdk";
return "project";
}
}
+263
View File
@@ -0,0 +1,263 @@
import { dirname } from "node:path";
import type {
LineMap,
XmlDocument,
XmlElement,
XmlParseError,
} from "../language/xmlParser";
import { resolveElementType } from "../language/typeContext";
import { isAssignableTo } from "../model/schemaModel";
import { findXPointerContainer, localName } from "./xpointer";
/**
* A logical document is the parsed tree of the currently open file with
* supported `xi:include` targets spliced in place. Every node keeps its
* original source file and offsets so diagnostics / hover / navigation can
* map back to the real file.
*/
export interface LogicalElement extends Omit<XmlElement, "parent" | "children"> {
parent: LogicalElement | null;
children: LogicalElement[];
sourceFile: string;
}
export interface LogicalDocument {
root: LogicalElement | null;
elements: LogicalElement[];
/** Mirrors XmlDocument so existing helpers (findElementAt etc.) work. */
errors: XmlParseError[];
declarationEnd: number;
}
export interface ExpandContext {
/** Resolves an xi:include href (BAB search order). */
resolve(source: string, currentDir: string): string | null;
/** Reads a target and guarantees a DOM parse tree. */
readDom(path: string): Promise<{ parse: XmlDocument; lineMap: LineMap } | null>;
/** Include-depth guard. Defaults to 64. */
maxDepth?: number;
}
const DEFAULT_MAX_DEPTH = 64;
/**
* Builds the logical document for `entryPath` by replacing supported
* `xi:include` elements with their selected target children.
*
* The original xi:include node stays in `elements` (so hover keeps working)
* but is removed from the logical child list; its selected content is spliced
* in as siblings. Nodes are shallow-cloned shells with a rebuilt parent/child
* chain, so cached parse trees in the indexer are never mutated.
*/
export async function expandDocument(
entryPath: string,
parse: XmlDocument,
ctx: ExpandContext,
): Promise<LogicalDocument> {
const elements: LogicalElement[] = [];
const map = new Map<XmlElement, LogicalElement>();
// Pre-create a logical shell for every original element (including orphan
// nodes produced by the parser's unterminated-quote recovery). Parent
// pointers follow the original tree so type context is preserved.
for (const orig of parse.elements) {
const parent = orig.parent ? map.get(orig.parent) ?? null : null;
const clone = cloneNode(orig, parent, entryPath);
map.set(orig, clone);
elements.push(clone);
}
// Cycle guard is a recursion stack, not a global visited set: the same
// fragment may legitimately be included under several parents.
const stack = new Set<string>();
const root = parse.root ? map.get(parse.root) ?? null : null;
// Traverse from the real root plus any parser-recovery orphans (elements
// whose parent is null but are not the root).
const roots = new Set<XmlElement>();
if (parse.root) roots.add(parse.root);
for (const orig of parse.elements) {
if (orig !== parse.root && orig.parent === null) roots.add(orig);
}
for (const origRoot of roots) {
const logicalRoot = map.get(origRoot)!;
await expandChildren(
origRoot,
logicalRoot,
entryPath,
0,
ctx,
elements,
stack,
map,
);
}
return { root, elements, errors: parse.errors, declarationEnd: parse.declarationEnd };
}
function cloneNode(
el: XmlElement,
parent: LogicalElement | null,
sourceFile: string,
): LogicalElement {
return { ...el, parent, children: [], sourceFile };
}
async function expandChildren(
origParent: XmlElement,
logicalParent: LogicalElement,
file: string,
depth: number,
ctx: ExpandContext,
elements: LogicalElement[],
stack: Set<string>,
map?: Map<XmlElement, LogicalElement>,
): Promise<void> {
for (const child of origParent.children) {
await handleChild(child, logicalParent, file, depth, ctx, elements, stack, map);
}
}
async function handleChild(
orig: XmlElement,
logicalParent: LogicalElement,
file: string,
depth: number,
ctx: ExpandContext,
elements: LogicalElement[],
stack: Set<string>,
map?: Map<XmlElement, LogicalElement>,
): Promise<void> {
const isXi = orig.name.toLowerCase().startsWith("xi:") &&
localName(orig.name).toLowerCase() === "include";
if (isXi) {
// Keep the xi:include itself discoverable (hover), but let its selected
// content replace it in the logical child list.
if (!map?.has(orig)) elements.push(cloneNode(orig, logicalParent, file));
await expandXi(orig, logicalParent, file, depth, ctx, elements, stack);
return;
}
let clone = map?.get(orig);
if (!clone) {
clone = cloneNode(orig, logicalParent, file);
elements.push(clone);
}
logicalParent.children.push(clone);
await expandChildren(orig, clone, file, depth + 1, ctx, elements, stack, map);
}
async function expandXi(
xi: XmlElement,
logicalParent: LogicalElement,
parentFile: string,
depth: number,
ctx: ExpandContext,
elements: LogicalElement[],
stack: Set<string>,
): Promise<void> {
const href = xi.attrs.find((a) => a.name === "href")?.value;
if (!href) return;
const resolved = ctx.resolve(href, dirname(parentFile));
if (!resolved) return;
const key = normPath(resolved);
if (stack.has(key)) return; // include cycle
if (depth > (ctx.maxDepth ?? DEFAULT_MAX_DEPTH)) return;
stack.add(key);
try {
const target = await ctx.readDom(resolved);
if (!target?.parse?.root) return;
const xpointer = xi.attrs.find((a) => a.name === "xpointer")?.value ?? "";
if (xpointer) {
const container = findXPointerContainer(target.parse, xpointer);
if (!container) return;
for (const sel of container.children) {
await handleChild(sel, logicalParent, resolved, depth + 1, ctx, elements, stack);
}
} else {
// XInclude semantics: without an xpointer the whole target document is
// included, i.e. its root element replaces the <xi:include> node.
// RA3 fragments such as GenericCelestialBuildingSuicide.xml rely on this
// to splice the module element itself (CreateObjectDie) into the parent.
await handleChild(
target.parse.root,
logicalParent,
resolved,
depth + 1,
ctx,
elements,
stack,
);
}
} finally {
stack.delete(key);
}
}
/** True when a logical element's resolved XSD type is a GameObject. */
export function isGameObjectElement(el: LogicalElement): boolean {
const type = resolveElementType(el);
return type != null && isAssignableTo(type, "GameObject");
}
/** Nearest ancestor whose resolved type is a GameObject (or subclass). */
export function findContainingGameObject(
el: LogicalElement,
): LogicalElement | null {
let cur = el.parent;
while (cur) {
if (isGameObjectElement(cur)) return cur;
cur = cur.parent;
}
return null;
}
export interface LocalIdInfo {
id: string;
el: LogicalElement;
}
/**
* Collects every `id` defined inside a GameObject subtree (including modules
* spliced in through xi:include). These are the candidates for Poid-typed
* pipeline-local references such as AttachModuleId / ModuleId.
*/
export function collectLocalIds(root: LogicalElement): LocalIdInfo[] {
const out: LocalIdInfo[] = [];
const seen = new Set<string>();
const stack: LogicalElement[] = [root];
while (stack.length) {
const el = stack.pop()!;
const idAttr = el.attrs.find((a) => a.name === "id");
if (idAttr?.hasValue) {
const key = idAttr.value.toLowerCase();
if (!seen.has(key)) {
seen.add(key);
out.push({ id: idAttr.value, el });
}
}
for (const child of el.children) stack.push(child);
}
return out;
}
/** Finds an id inside a GameObject subtree (case-insensitive). */
export function findLocalId(
root: LogicalElement,
id: string,
): LogicalElement | null {
const wanted = id.toLowerCase();
const stack: LogicalElement[] = [root];
while (stack.length) {
const el = stack.pop()!;
const idAttr = el.attrs.find((a) => a.name === "id");
if (idAttr?.hasValue && idAttr.value.toLowerCase() === wanted) return el;
for (const child of el.children) stack.push(child);
}
return null;
}
function normPath(path: string): string {
return path.replace(/\\/g, "/").toLowerCase();
}
+2
View File
@@ -2,6 +2,8 @@
* Parser for SAGE `.manifest` files, ported from OpenSAGE
* (src/OpenSage.Game/Data/StreamFS/ManifestFile.cs, commit d45d361).
*
* Licensed under LGPL-3.0 (derived from OpenSAGE); see LICENSE.
*
* The manifest is a binary index produced by BinaryAssetBuilder: every asset
* compiled into a stream is listed with hashed type/instance ids, an offset
* into the asset-name string buffer, and an optional source file name.
+119 -3
View File
@@ -12,6 +12,12 @@
import type { LineMap, XmlDocument } from "../language/xmlParser";
import type { ShallowDocument } from "./shallowScan";
import { attributesOfType, contentInfoOfType } from "../model/schemaModel";
import { resolveElementType } from "../language/typeContext";
import {
isReferenceAttributeOfType,
isReferenceContentType,
} from "./refs";
export interface IndexRecordAsset {
/** Top-level element name, e.g. "W3DContainer". */
@@ -42,6 +48,27 @@ export interface IndexRecordXi {
line: number;
}
export interface IndexRecordReference {
/** "attr" for attribute values, "content" for simple-content text. */
kind: "attr" | "content";
/**
* XSD reference target type (from `xas:refType`), or null for untyped
* `isRef` references and `inheritFrom` (which filters by the element's own
* type via `selfType`).
*/
refType: string | null;
/** Element type used by `inheritFrom` filtering; null otherwise. */
selfType: string | null;
/** The referenced id text (whole attribute value / trimmed content). */
value: string;
/** 1-based line of the value. */
line: number;
/** Character offset of the value start (relative to the file text). */
start: number;
/** Character offset one past the value end. */
end: number;
}
export interface IndexRecords {
assets: IndexRecordAsset[];
defines: IndexRecordDefine[];
@@ -50,6 +77,8 @@ export interface IndexRecords {
rootXiIncludes: IndexRecordXi[];
/** <xi:include> elements nested anywhere else in the document. */
nestedXiIncludes: IndexRecordXi[];
/** Typed global-asset references (attribute values + simple content). */
references: IndexRecordReference[];
}
const INCLUDE_TYPES = new Set(["all", "instance", "reference"]);
@@ -69,14 +98,21 @@ function localName(tag: string): string {
* Tags/Includes/Defines), $DEFINE constants, the top-level <Includes> block
* and root/nested <xi:include> elements.
*/
export function extractIndexRecords(parse: XmlDocument, lineMap: LineMap): IndexRecords {
export function extractIndexRecords(
parse: XmlDocument,
lineMap: LineMap,
text: string,
): IndexRecords {
const assets: IndexRecordAsset[] = [];
const defines: IndexRecordDefine[] = [];
const includes: IndexRecordInclude[] = [];
const rootXiIncludes: IndexRecordXi[] = [];
const nestedXiIncludes: IndexRecordXi[] = [];
const references: IndexRecordReference[] = [];
const root = parse.root;
if (!root) return { assets, defines, includes, rootXiIncludes, nestedXiIncludes };
if (!root) {
return { assets, defines, includes, rootXiIncludes, nestedXiIncludes, references };
}
for (const child of root.children) {
const local = localName(child.name);
@@ -142,7 +178,86 @@ export function extractIndexRecords(parse: XmlDocument, lineMap: LineMap): Index
});
}
return { assets, defines, includes, rootXiIncludes, nestedXiIncludes };
collectReferenceRecords(parse, lineMap, text, references);
return { assets, defines, includes, rootXiIncludes, nestedXiIncludes, references };
}
/**
* Walks every element of a fully parsed document and records typed
* global-asset references: reference attributes, `inheritFrom` and
* simple-content reference text. Local `id` definitions, Poid pipeline-local
* references and `$DEFINE`/`=` values are intentionally skipped (the same
* semantics as diagnostics / hover / navigation).
*
* The stored `refType` / `selfType` pair is exactly what
* `resolveReferenceTargetsForType` derives from the element context, so the
* reverse reference index can resolve these records after the whole index is
* built without re-walking the document or re-resolving element types.
*/
function collectReferenceRecords(
parse: XmlDocument,
lineMap: LineMap,
text: string,
out: IndexRecordReference[],
): void {
for (const el of parse.elements) {
const elType = resolveElementType(el);
for (const attr of el.attrs) {
if (!attr.hasValue) continue;
if (!isReferenceAttributeOfType(elType, attr.name)) continue;
const value = attr.value;
if (!value || value.startsWith("$") || value.startsWith("=")) continue;
let refType: string | null = null;
let selfType: string | null = null;
if (attr.name.toLowerCase() === "inheritfrom") {
selfType = elType;
} else if (elType) {
refType =
attributesOfType(elType).find((a) => a.name === attr.name)?.refType ??
null;
}
out.push({
kind: "attr",
refType,
selfType,
value,
line: lineOf(lineMap, attr.valueStart),
start: attr.valueStart,
end: attr.valueEnd,
});
}
if (
elType &&
isReferenceContentType(elType) &&
!el.selfClosing &&
el.closeTagStart >= 0
) {
const raw = text.slice(el.startTagEnd, el.closeTagStart);
const value = raw.trim();
if (
!value ||
value.startsWith("$") ||
value.startsWith("=") ||
value.includes("<")
) {
continue;
}
const start = el.startTagEnd + raw.indexOf(value);
const info = contentInfoOfType(elType);
out.push({
kind: "content",
refType: info?.refType ?? null,
selfType: null,
value,
line: lineOf(lineMap, start),
start,
end: start + value.length,
});
}
}
}
/** Converts a shallow scan (offsets) into index records (1-based lines). */
@@ -173,5 +288,6 @@ export function recordsFromShallow(scan: ShallowDocument, lineMap: LineMap): Ind
xpointer: x.xpointer,
line: lineOf(lineMap, x.start),
})),
references: [],
};
}
+225
View File
@@ -0,0 +1,225 @@
/**
* Reverse reference index built from per-file reference records.
*
* The indexer stores compact reference records per file (attribute values,
* simple-content text and inheritFrom, with XSD `refType`/`selfType` context
* captured at parse time). After the include walk, this module resolves every
* record against the final asset maps and produces:
*
* definition key -> reference sites
*
* which powers CodeLens reference counts, semantic Find All References and
* the "unreferenced assets" report. Pure TypeScript: no vscode dependency.
*/
import { extractIndexRecords, type IndexRecords } from "./records";
import {
filterAndScoreDefs,
isReferenceTargetType,
normalizeReferenceId,
type ReferenceLookup,
} from "./refs";
import { buildVanillaSearchPaths, resolveSource } from "./includeResolver";
import { normKey, recordsHash } from "./caches";
import { LineMap, parseXml } from "../language/xmlParser";
import type { AssetDef, ModIndex, ReferenceSite } from "./types";
/** A file whose reference records should be resolved. */
export interface ReferenceRecordSource {
/** Absolute path of the referencing file. */
file: string;
records: IndexRecords;
}
/** Stable key identifying one specific asset definition. */
export function assetDefKey(
def: Pick<AssetDef, "type" | "id" | "file" | "line">,
): string {
return `${def.type}\u0000${def.id.toLowerCase()}\u0000${def.file.toLowerCase()}\u0000${def.line}`;
}
/**
* Resolves per-file reference records against the asset lookup and returns
* the reverse map. A record resolves to every definition that satisfies its
* `refType` / `selfType` context (same strict filtering as go-to-definition),
* so same-name ids of different types never share reference counts.
*/
export function buildReferenceIndex(
sources: Iterable<ReferenceRecordSource>,
lookup: ReferenceLookup,
): Map<string, ReferenceSite[]> {
const map = new Map<string, ReferenceSite[]>();
for (const { file, records } of sources) {
for (const ref of records.references) {
const defs = lookup.assetsById.get(
normalizeReferenceId(ref.value).toLowerCase(),
);
if (!defs?.length) continue;
const targets = filterAndScoreDefs(defs, ref.refType, ref.selfType);
for (const target of targets) {
const key = assetDefKey(target.def);
let sites = map.get(key);
if (!sites) {
sites = [];
map.set(key, sites);
}
sites.push({
file,
line: ref.line,
start: ref.start,
end: ref.end,
kind: ref.kind,
});
}
}
}
return map;
}
/** Reference sites for one definition (empty when the index has none). */
export function referenceSitesForDef(
idx: Pick<ModIndex, "references"> | null | undefined,
def: Pick<AssetDef, "type" | "id" | "file" | "line">,
): ReferenceSite[] {
return idx?.references?.get(assetDefKey(def)) ?? [];
}
function normFileKey(path: string): string {
return path.replace(/\\/g, "/").toLowerCase();
}
/**
* Reference sites that belong to a definition opened in the editor.
*
* Besides the definition's own reverse-index bucket, this unions the sites
* of manifest definitions that map back to the same XML source file via
* `manifestSource`. `manifestSource` is resolved with the SDK-only search
* paths (not the current mod's BAB order), so a mod file shadowing the same
* DATA: path is never mistaken for the vanilla source. A manifest asset with
* a resolvable SageXml source is semantically the same asset as that XML
* definition, so references to it should show up on the source file's
* CodeLens too (Find All References already sees them because it unions
* every same-id/type definition).
*/
export function referenceSitesForDefinition(
idx: ModIndex,
def: Pick<AssetDef, "type" | "id" | "file" | "line">,
): ReferenceSite[] {
const sites = referenceSitesForDef(idx, def);
const byId = idx.assets.get(def.type)?.get(def.id.toLowerCase());
if (!byId?.length) return sites;
const defFile = normFileKey(def.file);
const vanillaPaths = buildVanillaSearchPaths(idx.sdkDir);
const seen = new Set(
sites.map((s) => `${s.file}\u0000${s.start}\u0000${s.end}\u0000${s.kind}`),
);
for (const other of byId) {
if (other.origin !== "manifest" || !other.manifestSource) continue;
const resolved = resolveSource(other.manifestSource, null, vanillaPaths).path;
if (!resolved || normFileKey(resolved) !== defFile) continue;
for (const site of referenceSitesForDef(idx, other)) {
const key = `${site.file}\u0000${site.start}\u0000${site.end}\u0000${site.kind}`;
if (seen.has(key)) continue;
seen.add(key);
sites.push(site);
}
}
return sites;
}
export interface UnreferencedOptions {
/**
* When true (default), only report types that are reference targets by
* design. Auto-registered / structural types (settings, map metadata,
* w3x sub-assets...) are excluded because zero references is their normal
* state.
*/
onlyReferenceTargetTypes?: boolean;
}
/**
* Project asset definitions with zero incoming references, grouped by type.
* Manifest / SDK definitions and `instance`-only assets are never reported
* (they are not part of the compiled stream in the same way).
*/
export function unreferencedByType(
idx: ModIndex,
options: UnreferencedOptions = {},
): Map<string, AssetDef[]> {
const onlyReferenceTargets = options.onlyReferenceTargetTypes ?? true;
const out = new Map<string, AssetDef[]>();
for (const [type, byId] of idx.assets) {
if (onlyReferenceTargets && !isReferenceTargetType(type)) continue;
const defs: AssetDef[] = [];
for (const arr of byId.values()) {
for (const def of arr) {
if (def.origin !== "project" || def.viaInstance) continue;
if (referenceSitesForDef(idx, def).length > 0) continue;
defs.push(def);
}
}
if (defs.length) {
defs.sort((a, b) => a.id.localeCompare(b.id));
out.set(type, defs);
}
}
return out;
}
/** Minimal workspace surface needed by the records-desync self-heal. */
export interface RecordsSyncWorkspace {
index: ModIndex | null;
invalidate(path: string): void;
scheduleRebuild(reason: string): void;
}
/** Minimal document surface (vscode.TextDocument subset, no vscode dep). */
export interface RecordsSyncDocument {
uri: { fsPath: string; scheme?: string };
isDirty?: boolean;
getText(): string;
}
/**
* True when a clean (saved) document's text no longer matches the records the
* published snapshot was built from. This catches cache entries that slipped
* through stat validation (e.g. a rewrite with preserved timestamps on an
* external drive) or watcher events lost during a drive reconnect.
*/
export function documentRecordsDesynced(
idx: ModIndex,
fsPath: string,
text: string,
): boolean {
const expected = idx.recordsHashes?.get(normKey(fsPath));
if (expected == null) return false;
const lineMap = new LineMap(text);
const records = extractIndexRecords(parseXml(text), lineMap, text);
return recordsHash(records) !== expected;
}
/**
* Self-heal: when the open, saved document's content differs from the
* snapshot's records hash, invalidate exactly that file and schedule a
* rebuild. Returns true when a rebuild was scheduled. Unsaved (dirty)
* documents are skipped — the editor text is intentionally ahead of disk.
*/
export function scheduleRebuildIfRecordsDesync(
ws: RecordsSyncWorkspace,
document: RecordsSyncDocument,
): boolean {
if (
document.isDirty ||
(document.uri.scheme != null && document.uri.scheme !== "file")
) {
return false;
}
const idx = ws.index;
if (!idx) return false;
const fsPath = document.uri.fsPath;
if (!documentRecordsDesynced(idx, fsPath, document.getText())) return false;
ws.invalidate(fsPath);
ws.scheduleRebuild("records-desync");
return true;
}
+186 -6
View File
@@ -1,15 +1,52 @@
import {
allTypeNames,
attributesOfType,
canonicalTypeName,
contentInfoOfType,
elementTypeName,
isAssetType,
isAssignableTo,
typeChain,
typeInfo,
} from "../model/schemaModel";
import type { AssetDef, ModIndex } from "./types";
import type { AssetDef, LocalOverlay } from "./types";
export interface ReferenceTarget {
def: AssetDef;
score: number;
}
/**
* Normalizes a reference value that may use the manifest-style qualified
* form `Type:Id` (e.g. `inheritFrom="AudioEvent:BaseSoundEffect"`,
* `Sound="AudioEvent:JAP_Refinery_Select"` or
* `Side="PlayerTemplate:Allies"`). XML asset ids never contain ":" (the same
* InstanceId rule the manifest parser relies on), so the referenceable id is
* the last colon-separated segment, exactly like `deriveAssetId`. Plain ids
* are returned unchanged. A trailing colon with an empty remainder is left
* unchanged so a half-typed value cannot accidentally match an id.
*/
export function normalizeReferenceId(value: string): string {
const idx = value.lastIndexOf(":");
if (idx < 0) return value;
const id = value.slice(idx + 1);
return id.length > 0 ? id : value;
}
/**
* The subset of `ModIndex` that reference resolution needs. Kept narrow so
* the reverse reference index can resolve records against the indexer's live
* maps without constructing a full index snapshot.
*/
export interface ReferenceLookup {
/** type -> id -> definitions. */
assets: Map<string, Map<string, AssetDef[]>>;
/** id -> definitions across all types. */
assetsById: Map<string, AssetDef[]>;
/** Optional document-local overlay (consulted first). */
local?: LocalOverlay;
}
/**
* True when an attribute is a "pipeline-local" reference that the global
* asset index cannot judge:
@@ -56,7 +93,7 @@ export function isReferenceAttributeOfType(
typeName: string | null,
attrName: string,
): boolean {
if (attrName.toLowerCase() === "inheritfrom") return true;
if (attrName.toLowerCase() === "inheritfrom") return isAssetType(typeName);
const attr = attributesOfType(typeName).find((a) => a.name === attrName);
if (attr == null || !(attr.refType != null || attr.isRef)) return false;
// Definitions (id) and pipeline-local references (Poid) are not references
@@ -76,7 +113,7 @@ export function isReferenceAttributeOfType(
* Returns [] when the attribute is not a typed reference or nothing matches.
*/
export function resolveReferenceTargets(
idx: ModIndex,
idx: ReferenceLookup,
elementType: string,
attrName: string,
id: string,
@@ -91,19 +128,24 @@ export function resolveReferenceTargets(
/** Same resolution, driven by a resolved XSD type name. */
export function resolveReferenceTargetsForType(
idx: ModIndex,
idx: ReferenceLookup,
typeName: string | null,
attrName: string,
id: string,
): ReferenceTarget[] {
const defs = idx.assetsById.get(id.toLowerCase());
if (!defs?.length) return [];
const lookupId = normalizeReferenceId(id);
const defs = mergeLocalAndGlobalDefs(
idx.local?.assetsById.get(lookupId.toLowerCase()),
idx.assetsById.get(lookupId.toLowerCase()),
);
if (!defs.length) return [];
const nameLower = attrName.toLowerCase();
let refType: string | null = null;
let selfType: string | null = null;
if (nameLower === "inheritfrom") {
if (!isAssetType(typeName)) return [];
selfType = typeName;
} else {
const attr = attributesOfType(typeName).find((a) => a.name === attrName);
@@ -114,6 +156,59 @@ export function resolveReferenceTargetsForType(
refType = attr.refType;
}
return filterAndScoreDefs(defs, refType, selfType);
}
/**
* True when an element's text content is a typed reference to a global
* asset: the element's resolved XSD type is a simple type carrying an
* `xas:refType`, or a simpleContent complex type carrying `xas:refType`
* (e.g. `<CreateObject>` with `GameObjectWeakRef`, `<Sound>` with
* `AudioFileRefWithWeight`).
*
* Only *typed* refs are treated as content references. Generic untyped
* `AssetReference` content is used by real data for shader constants,
* mesh sub-object names and other values that are not global asset ids
* (`FXShaderConstantTexture@Value`, `RenderSubObjectReference@Mesh`), so
* resolving those globally would produce false hover/navigation/diagnostics.
* Poid pipeline-local ids are excluded for the same reason.
*/
export function isReferenceContentType(typeName: string | null): boolean {
if (!typeName) return false;
const info = contentInfoOfType(typeName);
if (!info) return false;
if (typeChain(typeName).includes("Poid")) return false;
return info.refType != null;
}
/**
* Resolves the definitions an element's text content should point to,
* filtered by the element type's `xas:refType`
* (e.g. `GameObjectWeakRef` -> `GameObject`).
*/
export function resolveContentReferenceTargets(
idx: ReferenceLookup,
typeName: string | null,
id: string,
): ReferenceTarget[] {
if (!isReferenceContentType(typeName)) return [];
if (!typeName) return [];
const lookupId = normalizeReferenceId(id);
const defs = mergeLocalAndGlobalDefs(
idx.local?.assetsById.get(lookupId.toLowerCase()),
idx.assetsById.get(lookupId.toLowerCase()),
);
if (!defs.length) return [];
const info = contentInfoOfType(typeName);
const refType = info?.refType ?? null;
return filterAndScoreDefs(defs, refType, null);
}
export function filterAndScoreDefs(
defs: readonly AssetDef[],
refType: string | null,
selfType: string | null,
): ReferenceTarget[] {
const targets: ReferenceTarget[] = [];
for (const def of defs) {
if (refType && !isAssignableTo(def.type, refType)) continue;
@@ -127,3 +222,88 @@ export function resolveReferenceTargetsForType(
targets.sort((a, b) => a.score - b.score || a.def.id.localeCompare(b.def.id));
return targets;
}
/**
* Merges document-local definitions with the global index, keeping local
* entries first and de-duplicating definitions that exist in both.
*/
export function mergeLocalAndGlobalDefs(
local: readonly AssetDef[] | undefined,
global: readonly AssetDef[] | undefined,
): AssetDef[] {
const seen = new Set<string>();
const out: AssetDef[] = [];
for (const list of [local, global]) {
if (!list) continue;
for (const def of list) {
const key = `${def.type}\u0000${def.id.toLowerCase()}\u0000${def.file}\u0000${def.line}`;
if (seen.has(key)) continue;
seen.add(key);
out.push(def);
}
}
return out;
}
let referenceTargetTypeSet: Set<string> | null = null;
/**
* True when the XSD itself declares `inheritFrom` for the type. This is the
* narrower "designed reference target" signal used by CodeLens / unreferenced
* reports; the universal BAB `inheritFrom` attribute must not widen it to
* every BaseAssetType descendant.
*/
function xsdDeclaresInheritFrom(typeName: string): boolean {
const info = typeInfo(typeName);
return (
info?.kind === "complex" &&
info.attributes.some((a) => a.name.toLowerCase() === "inheritfrom")
);
}
/**
* The set of XSD types that are "reference targets by design": at least one
* typed reference attribute / simple-content reference points at them, or
* the XSD explicitly declares them inheritable (`inheritFrom`). The universal
* BAB `inheritFrom` attribute on every BaseAssetType descendant is a separate
* legality concern and intentionally does NOT widen this set. Types outside
* this set are auto-registered / structural (settings, map metadata, w3x
* sub-assets...), so a zero reference count is their normal state and counts
* would only be noise.
*/
export function referenceTargetTypes(): ReadonlySet<string> {
if (referenceTargetTypeSet) return referenceTargetTypeSet;
const set = new Set<string>();
const add = (t: string | null) => {
if (!t) return;
set.add(canonicalTypeName(t) ?? t);
};
for (const typeName of allTypeNames()) {
const info = typeInfo(typeName);
if (!info) continue;
if (info.kind === "complex") {
for (const attr of info.attributes) {
if (isLocalReferenceAttribute(typeName, attr.name)) continue;
if (attr.refType) add(attr.refType);
}
if (info.content?.refType) add(info.content.refType);
if (xsdDeclaresInheritFrom(typeName)) {
add(typeName);
}
} else if (
info.kind === "simple" &&
info.refType &&
!typeChain(typeName).includes("Poid")
) {
add(info.refType);
}
}
referenceTargetTypeSet = set;
return set;
}
/** True when the type is a designed reference target (see above). */
export function isReferenceTargetType(typeName: string | null): boolean {
if (!typeName) return false;
return referenceTargetTypes().has(canonicalTypeName(typeName) ?? typeName);
}
+102 -2
View File
@@ -20,10 +20,31 @@ export interface AssetDef {
viaInstance?: boolean;
/** Manifest path for origin === "manifest". */
manifest?: string;
/** Source file recorded inside a manifest (e.g. "DATA:globaldata/armor.xml"). */
/**
* Source file recorded inside a manifest (e.g. "DATA:globaldata/armor.xml").
* This is a path from the vanilla build, so callers resolve it with the
* SDK-only search paths (`buildVanillaSearchPaths`), never with the current
* mod's BAB include order.
*/
manifestSource?: string;
}
/**
* One resolved reference occurrence pointing at an asset definition.
* Produced by `buildReferenceIndex` from per-file reference records.
*/
export interface ReferenceSite {
/** Absolute path of the referencing file. */
file: string;
/** 1-based line of the reference value. */
line: number;
/** Character offset of the value start (relative to the file text). */
start: number;
/** Character offset one past the value end. */
end: number;
kind: "attr" | "content";
}
export interface DefineDef {
name: string;
value: string;
@@ -32,9 +53,36 @@ export interface DefineDef {
origin: AssetOrigin;
}
/**
* Document-local overlay produced by `localScope.ts`. It contains assets /
* defines reachable from the currently open document (its own text plus its
* include chain), even when that file is not part of any global stream.
*
* The overlay is attached to a `ModIndex` as `local` rather than merged into
* the global maps, so large indexes (Corona: ~65k assets) are never copied
* on every keystroke. Lookup helpers consult `local` first.
*/
export interface LocalOverlay {
/** type -> id -> definitions. */
assets: Map<string, Map<string, AssetDef[]>>;
/** id -> definitions across all types. */
assetsById: Map<string, AssetDef[]>;
/** `$NAME` -> definitions. */
defines: Map<string, DefineDef[]>;
}
export interface IndexedFile {
path: string;
stat: { mtimeMs: number; size: number } | null;
/**
* Multi-signal file stamp used to validate cached entries without
* re-reading content: size, last-write time, creation time and change
* time. Creation/change time catch tools that rewrite a file while
* preserving its mtime (e.g. temp-file + rename exporters) — important on
* removable drives where mtime resolution can be coarse (FAT32: 2 s).
*/
stat:
| { mtimeMs: number; size: number; birthtimeMs: number; ctimeMs: number }
| null;
}
export interface StreamInfo {
@@ -65,10 +113,16 @@ export interface IndexerDiagnostic {
export interface IndexStats {
projectDir: string;
sdkDir: string;
/** Last finished phase ("xml" or "art"). */
phase: "xml" | "art";
/** Whether the index is fully complete (art assets included). */
complete: boolean;
indexedFiles: number;
parsedFiles: number;
/** Art-asset documents indexed via shallow scan (no DOM tree). */
shallowScannedFiles: number;
/** Art files registered during the XML phase, scanned later in phase B. */
deferredArtFiles: number;
/** Shallow scans served from the persistent cache (unchanged files). */
shallowCacheHits: number;
/** Parsed XML files served from the persistent records cache. */
@@ -77,11 +131,19 @@ export interface IndexStats {
resolveCacheHits: number;
/** Include/xi:include resolutions performed during this build. */
resolveCalls: number;
/** Existence checks answered by the directory snapshot (no statSync). */
snapshotHits: number;
/** Existence checks outside the snapshot that fell back to statSync. */
snapshotFallbacks: number;
/** Time spent enumerating Include source candidates (ms). */
candidatesMs: number;
/** Time spent walking the include graph (ms). */
walkMs: number;
/** Time spent shallow-scanning deferred art assets (ms). */
artScanMs: number;
assetCount: number;
/** Total resolved reference sites in the reverse index. */
referenceCount: number;
defineCount: number;
manifestFiles: number;
manifestAssetCount: number;
@@ -93,6 +155,19 @@ export interface IndexStats {
export interface ModIndex {
projectDir: string;
sdkDir: string;
/**
* True when every indexing phase (including the art-asset shallow scan)
* has finished. Features use this to decide whether unresolved references
* are final errors or provisional "may be a false positive" diagnostics.
*/
complete: boolean;
/** Last finished phase: "xml" (XML + manifests) or "art" (final). */
phase: "xml" | "art";
/**
* True when files changed while this snapshot was being built, so some
* entries may be stale. A follow-up rebuild is scheduled by the workspace.
*/
stale?: boolean;
/** type -> id -> definitions (project + sdk + manifest, deduplicated). */
assets: Map<string, Map<string, AssetDef[]>>;
/** id -> definitions across all types. */
@@ -107,7 +182,27 @@ export interface ModIndex {
sourceCandidates: SourceCandidate[];
/** Problems found while indexing (unresolved includes, cycles, ...). */
diagnostics: IndexerDiagnostic[];
/**
* Reverse reference index: asset definition key (see
* `referenceIndex.assetDefKey`) -> reference sites. Built from the compact
* per-file reference records when a snapshot is published, so counts and
* Find All References share one semantic source of truth.
*/
references: Map<string, ReferenceSite[]>;
/**
* normKey(file) -> SHA-1 of the file's compact index records as this
* snapshot consumed them. Lets open documents detect "my file changed on
* disk but the index still uses older records" and trigger a targeted
* rebuild, while ignoring cosmetic text changes (line endings, whitespace).
*/
recordsHashes: Map<string, string>;
stats: IndexStats;
/**
* Document-local overlay (when the index was obtained through the
* workspace's `getScope` / `getIndex` path). Optional so plain indexer
* snapshots remain overlay-free.
*/
local?: LocalOverlay;
}
export interface IndexOptions {
@@ -160,4 +255,9 @@ export interface ParsedFile {
*/
records: IndexRecords | null;
lineMap: LineMap | null;
/**
* True when the file is an art-asset XML that was only registered during
* the XML phase (its shallow scan is deferred to the art phase).
*/
deferredArt?: boolean;
}
+24
View File
@@ -0,0 +1,24 @@
import type { XmlDocument, XmlElement } from "../language/xmlParser";
/** Lowercases nothing; returns the part after the last ":" in a tag name. */
export function localName(tag: string): string {
const idx = tag.lastIndexOf(":");
return idx >= 0 ? tag.slice(idx + 1) : tag;
}
/**
* Resolves the xpointer subset used by real RA3 mods:
* xmlns(n=uri:ea.com:eala:asset) xpointer(/n:ElementName/child::*)
*
* Returns the container element whose children are selected by the xpointer,
* or null when the form is unsupported / the container is missing.
*/
export function findXPointerContainer(
doc: XmlDocument,
xpointer: string,
): XmlElement | null {
const m = /xpointer\(\/\w+:(\w+)\/child::\*\)/.exec(xpointer);
if (!m) return null;
const name = m[1];
return doc.elements.find((el) => localName(el.name) === name) ?? null;
}
+49 -4
View File
@@ -1,4 +1,5 @@
import type { XmlAttribute, XmlDocument, XmlElement } from "./xmlParser";
import { elementContainsOffset, parseTag } from "./xmlParser";
export type ContextKind =
| "element-name"
@@ -30,18 +31,35 @@ export function analyzeContext(
let container: XmlElement | null = null;
for (const el of doc.elements) {
if (el.end < 0) continue;
if (offset >= el.start && offset <= el.end) {
if (elementContainsOffset(el, offset)) {
if (!container || el.depth > container.depth) container = el;
}
}
if (!container) return empty("none");
// Inside the start tag of the element.
if (offset >= container.start && offset <= container.startTagEnd) {
// Inside the start tag of the element. The boundary right after `>` is the
// start of the content (e.g. the `$1` cursor in
// `<CreateObject>$1</CreateObject>`), not another attribute slot; only an
// unterminated start tag whose `>` has not been typed yet still belongs to
// the start tag at its recovered end.
const atTagEnd = offset === container.startTagEnd;
const tagClosed =
atTagEnd && container.startTagEnd > container.start &&
text[container.startTagEnd - 1] === ">";
if (offset >= container.start && (offset < container.startTagEnd || (atTagEnd && !tagClosed))) {
return analyzeStartTag(container, text, offset);
}
// A start tag that had to be recovered (e.g. an attribute quote is still
// open) is truncated at the first line break, so attributes typed on later
// lines of the same tag are not part of the parsed element. Re-parse the
// partial tag up to the cursor so value/attribute completion keeps working
// while typing in the malformed tag.
if (container.recoveredStartTag) {
return analyzeRecoveredStartTag(container, text, offset);
}
// Otherwise the cursor is in element content.
return {
kind: "content",
@@ -53,6 +71,33 @@ export function analyzeContext(
};
}
/**
* Classifies the cursor inside a recovered (truncated) start tag by re-parsing
* the raw tag content up to the cursor. The original element only kept the
* attributes that fit on its first line; re-parsing the partial text recovers
* attributes typed on later lines without affecting the rest of the document.
*/
function analyzeRecoveredStartTag(
el: XmlElement,
text: string,
offset: number,
): CompletionContext {
const raw = parseTag(text.slice(el.start + 1, offset), el.start + 1);
const partial: XmlElement = {
name: raw.name,
attrs: raw.attrs,
children: [],
parent: el.parent,
start: raw.start,
startTagEnd: offset,
end: offset,
selfClosing: raw.selfClosing,
closeTagStart: -1,
depth: el.depth,
};
return analyzeStartTag(partial, text, offset);
}
function analyzeStartTag(
el: XmlElement,
text: string,
@@ -83,7 +128,7 @@ function analyzeStartTag(
attr.hasValue &&
attr.quoteStart >= 0 &&
offset >= attr.quoteStart &&
(attr.quoteEnd < 0 || offset <= attr.quoteEnd)
(attr.quoteEnd < 0 || offset < attr.quoteEnd)
) {
const start = attr.valueStart;
const prefix = offset > start ? text.slice(start, offset) : "";
+7 -2
View File
@@ -1,4 +1,4 @@
import { childTypeOf, elementTypeName } from "../model/schemaModel";
import { childTypeOf, elementTypeName, topLevelElementType } from "../model/schemaModel";
import type { XmlElement } from "./xmlParser";
/**
@@ -9,7 +9,12 @@ import type { XmlElement } from "./xmlParser";
*/
export function resolveElementType(el: XmlElement): string | null {
if (!el.parent) {
return elementTypeName(el.name);
// A document root (fragment or full AssetDeclaration) has no parent to
// provide context. When the root is a top-level asset whose name also
// appears as a nested child type (EvaEvent, UpgradeTemplate, ...),
// prefer the AssetDeclaration declaration over the global single-map
// fallback.
return topLevelElementType(el.name) ?? elementTypeName(el.name);
}
const parentType = resolveElementType(el.parent);
return childTypeOf(parentType, el.name) ?? elementTypeName(el.name);
+139 -15
View File
@@ -43,10 +43,20 @@ export interface XmlElement {
/** Offset of "</" of the closing tag, or -1 when self-closing. */
closeTagStart: number;
depth: number;
/**
* True when the start tag was unterminated and recovered at a line break.
* Attributes typed on later lines of the same tag are not part of the
* parsed element; completion re-parses the partial tag up to the cursor.
*/
recoveredStartTag?: boolean;
}
export interface XmlParseError {
message: string;
/** Stable machine-readable id used by the UI layer for localization. */
code: string;
/** Dynamic values referenced by the localized message. */
params?: Record<string, string>;
offset: number;
line: number;
character: number;
@@ -119,7 +129,7 @@ interface RawTag {
const NAME_RE = /[A-Za-z_][\w:.-]*/y;
function parseTag(content: string, contentStart: number): RawTag {
export function parseTag(content: string, contentStart: number): RawTag {
const base = contentStart;
let j = 0;
while (j < content.length && /\s/.test(content[j])) {
@@ -243,9 +253,21 @@ export function parseXml(text: string): XmlDocument {
let i = 0;
const n = text.length;
const err = (message: string, offset: number) => {
const err = (
code: string,
message: string,
offset: number,
params?: Record<string, string>,
) => {
const pos = lineMap.positionAt(offset);
errors.push({ message, offset, line: pos.line, character: pos.character });
errors.push({
code,
message,
params,
offset,
line: pos.line,
character: pos.character,
});
};
while (i < n) {
@@ -255,7 +277,11 @@ export function parseXml(text: string): XmlDocument {
// text before the root element - ignore unless it is non-whitespace
const between = text.slice(i, lt);
if (between.trim() !== "") {
err("Content is not allowed before the root element", i);
err(
"content-before-root",
"Content is not allowed before the root element",
i,
);
}
}
i = lt;
@@ -264,7 +290,7 @@ export function parseXml(text: string): XmlDocument {
if (text.startsWith("<!--", i)) {
const close = text.indexOf("-->", i + 4);
if (close < 0) {
err("Unterminated comment", i);
err("unterminated-comment", "Unterminated comment", i);
break;
}
i = close + 3;
@@ -274,7 +300,7 @@ export function parseXml(text: string): XmlDocument {
if (text.startsWith("<![CDATA[", i)) {
const close = text.indexOf("]]>", i + 9);
if (close < 0) {
err("Unterminated CDATA section", i);
err("unterminated-cdata", "Unterminated CDATA section", i);
break;
}
i = close + 3;
@@ -284,7 +310,7 @@ export function parseXml(text: string): XmlDocument {
if (text.startsWith("<!DOCTYPE", i) || text.startsWith("<!doctype", i)) {
const close = text.indexOf(">", i);
if (close < 0) {
err("Unterminated DOCTYPE", i);
err("unterminated-doctype", "Unterminated DOCTYPE", i);
break;
}
i = close + 1;
@@ -294,7 +320,11 @@ export function parseXml(text: string): XmlDocument {
if (text.startsWith("<?", i)) {
const close = text.indexOf("?>", i + 2);
if (close < 0) {
err("Unterminated processing instruction", i);
err(
"unterminated-processing-instruction",
"Unterminated processing instruction",
i,
);
break;
}
if (i === 0 && /^<\?xml\s/i.test(text.slice(i, close + 2))) {
@@ -307,15 +337,25 @@ export function parseXml(text: string): XmlDocument {
if (text.startsWith("</", i)) {
const gt = text.indexOf(">", i + 2);
if (gt < 0) {
err("Unterminated closing tag", i);
err("unterminated-closing-tag", "Unterminated closing tag", i);
break;
}
const name = text.slice(i + 2, gt).trim();
const top = stack[stack.length - 1];
if (!top) {
err(`Unexpected closing tag </${name}>`, i);
err(
"unexpected-closing-tag",
`Unexpected closing tag </${name}>`,
i,
{ name },
);
} else if (top.name !== name) {
err(`Mismatched closing tag: expected </${top.name}>, found </${name}>`, i);
err(
"mismatched-closing-tag",
`Mismatched closing tag: expected </${top.name}>, found </${name}>`,
i,
{ expected: top.name, found: name },
);
// recover: find the matching element on the stack if possible
let idx = stack.length - 1;
while (idx >= 0 && stack[idx].name !== name) idx--;
@@ -337,13 +377,13 @@ export function parseXml(text: string): XmlDocument {
}
// opening tag
if (text[i + 1] === "!" || text[i + 1] === "?") {
err("Malformed markup", i);
err("malformed-markup", "Malformed markup", i);
i++;
continue;
}
const gt = findTagEnd(text, i + 1);
if (gt < 0) {
err("Unterminated start tag", i);
err("unterminated-start-tag", "Unterminated start tag", i);
// Recovery while typing: an attribute value whose closing quote has not
// been typed yet makes the scanner run to EOF. End the malformed start
// tag at the first line break (or EOF) so the rest of the document is
@@ -357,8 +397,15 @@ export function parseXml(text: string): XmlDocument {
const raw = parseTag(content, i + 1);
if (raw.name) {
const el = buildElement(raw, stack.length);
el.recoveredStartTag = true;
elements.push(el);
root = root ?? el;
if (stack.length === 0) {
root = root ?? el;
} else {
const parent = stack[stack.length - 1];
parent.children.push(el);
el.parent = parent;
}
stack.push(el);
}
i = recoverTo + 1;
@@ -386,7 +433,9 @@ export function parseXml(text: string): XmlDocument {
for (const el of stack) {
const pos = lineMap.positionAt(el.start);
errors.push({
code: "element-never-closed",
message: `Element <${el.name}> is never closed`,
params: { name: el.name },
offset: el.start,
line: pos.line,
character: pos.character,
@@ -407,6 +456,13 @@ function findTagEnd(text: string, from: number): number {
if (c === quote) quote = null;
} else if (c === '"' || c === "'") {
quote = c;
} else if (c === "<") {
// A new tag start before the current tag's ">" means the ">" we would
// find later belongs to that other tag (typically a closing tag after
// a just-typed "<" in element content). Treat the current tag as
// unterminated so the parser recovers at the line break: the context
// stays "content" and the completion range can cover the typed "<".
return -1;
} else if (c === ">") {
return i;
}
@@ -435,7 +491,7 @@ export function findElementAt(doc: XmlDocument, offset: number): XmlElement | nu
let best: XmlElement | null = null;
for (const el of doc.elements) {
if (el.end < 0) continue;
if (offset >= el.start && offset <= el.end) {
if (elementContainsOffset(el, offset)) {
if (!best || el.depth > best.depth) {
best = el;
}
@@ -444,6 +500,74 @@ export function findElementAt(doc: XmlDocument, offset: number): XmlElement | nu
return best;
}
/**
* Whether `offset` belongs to an element's span.
*
* The end offset is exclusive for a completed element (closing tag or
* self-closing tag): a cursor right after `</Name>` belongs to the parent's
* content, not the child. The one exception is an unclosed element whose
* parser-recovered `end` is the document end: a cursor at EOF is still
* inside the element being typed.
*/
export function elementContainsOffset(el: XmlElement, offset: number): boolean {
if (offset < el.start) return false;
if (offset < el.end) return true;
if (offset > el.end) return false;
return !el.selfClosing && el.closeTagStart < 0;
}
export interface TextToken {
value: string;
/** Absolute offset of the first character of the token. */
start: number;
/** Absolute offset one past the last character of the token. */
end: number;
}
/**
* Returns the whitespace-delimited text token inside an element's content
* that contains `offset`, with absolute source offsets. Used for
* simple-content elements (e.g. `<CreateObject>CrateDebris_01</CreateObject>`)
* by completion, hover, navigation and diagnostics. Returns null when the
* offset is not inside text content (start tag, closing tag, self-closing).
*/
export function textContentTokenAt(
text: string,
el: XmlElement,
offset: number,
): TextToken | null {
if (el.selfClosing) return null;
const contentEnd = el.closeTagStart >= 0 ? el.closeTagStart : el.end;
if (contentEnd <= el.startTagEnd) return null;
if (offset <= el.startTagEnd || offset > contentEnd) return null;
const contentStart = el.startTagEnd;
// A cursor right before the closing tag is still inside the content; clamp
// the relative position to the content length in that case.
const rel = Math.min(offset - contentStart, contentEnd - contentStart);
let tokenStart = rel;
while (tokenStart > 0 && !/\s/.test(text[contentStart + tokenStart - 1])) {
tokenStart--;
}
let tokenEnd = rel;
while (
tokenEnd < contentEnd - contentStart &&
!/\s/.test(text[contentStart + tokenEnd])
) {
tokenEnd++;
}
// The cursor may sit on trailing whitespace or at the closing-tag
// boundary; trim whitespace so the token is exactly the value word.
while (tokenEnd > tokenStart && /\s/.test(text[contentStart + tokenEnd - 1])) {
tokenEnd--;
}
if (tokenEnd <= tokenStart) return null;
return {
value: text.slice(contentStart + tokenStart, contentStart + tokenEnd),
start: contentStart + tokenStart,
end: contentStart + tokenEnd,
};
}
/** Finds an element by name that contains the offset (including its start tag). */
export function findOpenTagElementAt(doc: XmlDocument, offset: number): XmlElement | null {
const el = findElementAt(doc, offset);
+63
View File
@@ -0,0 +1,63 @@
import * as vscode from "vscode";
type L10n = {
t(message: string, ...args: Array<string | number | boolean>): string;
t(
message: string,
args: Record<string, string | number | boolean>,
): string;
};
/**
* Thin wrapper around VS Code's built-in `l10n.t`.
*
* The fallback keeps the message unchanged when no bundle is loaded (for
* example in unit tests or when the extension runs with the default English
* locale), so the same call sites work in production and tests.
*/
export function t(
message: string,
...args: Array<string | number | boolean>
): string {
const l10n = (vscode as unknown as { l10n?: L10n }).l10n;
if (!l10n?.t) return formatIndexed(message, args);
try {
return l10n.t(message, ...args);
} catch {
return formatIndexed(message, args);
}
}
/** Named-placeholder variant of {@link t}. */
export function tN(
message: string,
args: Record<string, string | number | boolean>,
): string {
const l10n = (vscode as unknown as { l10n?: L10n }).l10n;
if (!l10n?.t) return formatNamed(message, args);
try {
return l10n.t(message, args);
} catch {
return formatNamed(message, args);
}
}
function formatIndexed(
message: string,
args: Array<string | number | boolean>,
): string {
return message.replace(/\{(\d+)\}/g, (match, index: string) => {
const value = args[Number(index)];
return value === undefined ? match : String(value);
});
}
function formatNamed(
message: string,
args: Record<string, string | number | boolean>,
): string {
return message.replace(/\{([a-zA-Z0-9_]+)\}/g, (match, name: string) => {
const value = args[name];
return value === undefined ? match : String(value);
});
}
File diff suppressed because one or more lines are too long
+130 -1
View File
@@ -33,6 +33,21 @@ export interface ComplexTypeInfo {
attributes: AttributeInfo[];
base: string | null;
doc: string;
/**
* Present only for complexType + simpleContent types (e.g.
* AudioFileRefWithWeight / MultisoundSubsoundRef). Describes the text
* between the tags just like a simple type's value semantics.
*/
content?: SimpleContentInfo | null;
}
export interface SimpleContentInfo {
refType: string | null;
isRef: boolean;
enumValues: string[];
isList: boolean;
allowsDefine: boolean;
base: string | null;
}
export interface SimpleTypeInfo {
@@ -48,6 +63,24 @@ export interface SimpleTypeInfo {
export type TypeInfo = ComplexTypeInfo | SimpleTypeInfo;
/**
* Unified value semantics for element text content. Both simple types
* (`<CreateObject>` -> GameObjectWeakRef) and simpleContent complex types
* (`<Sound>` -> AudioFileRefWithWeight) share this shape so the completion /
* hover / navigation / diagnostics / indexer pipelines do not have to know
* which XSD construct produced the content.
*/
export interface ContentTypeInfo {
kind: "simple" | "simpleContent";
refType: string | null;
isRef: boolean;
enumValues: string[];
isList: boolean;
allowsDefine: boolean;
base: string | null;
doc: string;
}
interface RawModel {
version: number;
rootXsd: string;
@@ -59,6 +92,33 @@ interface RawModel {
const model = schemaModel as unknown as RawModel;
/**
* `inheritFrom` is accepted by BAB / real RA3 data on BaseAssetType-derived
* assets even though the XSD only declares it on BaseInheritableAsset
* (vanilla SageXml uses it on FXList, AIMicroManagerData,
* AITargetingHeuristic, ObjectCreationList, ...). It is therefore exposed as
* a universal attribute for every asset type.
*
* This is deliberately separate from `referenceTargetTypes()` in refs.ts:
* "may legally appear in the document" and "is a designed CodeLens / FAR
* reference target" are different decisions.
*/
const UNIVERSAL_INHERIT_FROM: AttributeInfo = {
name: "inheritFrom",
required: false,
default: null,
doc: "Inherits another asset of the same type.",
kind: "simple",
type: "@attr:inheritFrom",
refType: null,
enumValues: [],
isList: false,
allowsDefine: false,
isRef: false,
isBoolean: false,
base: "string",
};
/** Lowercase type name -> canonical (XSD) type name. */
const typeNameIndex = new Map<string, string>();
for (const name of Object.keys(model.types)) {
@@ -92,6 +152,11 @@ export const modelMeta = {
typeCount: Object.keys(model.types).length,
};
/** All type names in the XSD model (complex + simple), in model order. */
export function allTypeNames(): string[] {
return Object.keys(model.types);
}
export function topLevelElements(): string[] {
return model.topLevelElements;
}
@@ -104,6 +169,43 @@ export function typeInfo(name: string): TypeInfo | undefined {
return model.types[name];
}
/**
* Returns content-value semantics for a type, or null when the element is a
* normal complex element (children, not text).
*/
export function contentInfoOfType(
typeName: string | null,
): ContentTypeInfo | null {
if (!typeName) return null;
const info = model.types[canonicalTypeName(typeName) ?? typeName];
if (!info) return null;
if (info.kind === "simple") {
return {
kind: "simple",
refType: info.refType,
isRef: info.isRef,
enumValues: info.enumValues,
isList: info.isList,
allowsDefine: info.allowsDefine,
base: info.base,
doc: info.doc,
};
}
if (info.kind === "complex" && info.content) {
return {
kind: "simpleContent",
refType: info.content.refType,
isRef: info.content.isRef,
enumValues: info.content.enumValues,
isList: info.content.isList,
allowsDefine: info.content.allowsDefine,
base: info.content.base,
doc: info.doc,
};
}
return null;
}
export function elementTypeName(name: string): string | null {
const t = elementToType.get(name);
return t ? t : null;
@@ -130,7 +232,23 @@ export function attributesOfElement(name: string): AttributeInfo[] {
export function attributesOfType(typeName: string | null): AttributeInfo[] {
if (!typeName) return [];
const info = model.types[canonicalTypeName(typeName) ?? typeName];
return info && info.kind === "complex" ? info.attributes : [];
if (!info || info.kind !== "complex") return [];
if (
isAssetType(typeName) &&
!info.attributes.some((a) => a.name === "inheritFrom")
) {
return [...info.attributes, UNIVERSAL_INHERIT_FROM];
}
return info.attributes;
}
/**
* True for types in the asset hierarchy (BaseAssetType and its descendants).
* These are the types on which BAB accepts the universal `inheritFrom`
* attribute even when the XSD does not declare it.
*/
export function isAssetType(typeName: string | null): boolean {
return !!typeName && typeChain(typeName).includes("BaseAssetType");
}
/**
@@ -165,6 +283,17 @@ export function elementTypeIn(
return elementTypeName(childName);
}
/**
* Resolves a top-level asset element name to the type declared inside
* AssetDeclaration. This is the type a fragment/standalone document root
* should use when its name collides with a nested child type (e.g. EvaEvent
* is both a top-level asset and an FXNugget child).
*/
export function topLevelElementType(name: string): string | null {
const declType = elementTypeName("AssetDeclaration");
return declType ? childTypeOf(declType, name) : null;
}
export function typeDoc(name: string): string {
const info = model.types[name];
return info?.doc ?? "";
+177
View File
@@ -0,0 +1,177 @@
/**
* Mod project root discovery for RA3 Mod XML.
*
* Pure TypeScript (no vscode dependency) so the detection rules can be unit
* tested and reused by other tools.
*
* A project root is any directory containing one of the markers the mod
* compiler (defaultscript.cs) actually consumes:
* - `Data/Mod.xml` (static data entry)
* - `Data/additionalmaps/mapmetadata_*.xml` (global data entries)
* - `*.babproj` (mod SDK project file)
*
* Discovery works in three directions:
* - upward from a folder (the workspace folder may be `Data` or a deep
* subfolder of a mod);
* - upward from a file (single-file opens without a workspace folder);
* - shallow downward from a container folder (a folder that contains
* several sibling mods).
*/
import { dirname, join, resolve } from "node:path";
import { readdirSync } from "node:fs";
export const DEFAULT_MAX_UPWARD_DEPTH = 12;
export const DEFAULT_MAX_DOWNWARD_DEPTH = 3;
export type ProjectMarkerKind = "mod" | "babproj" | "mapmetadata";
/** Directories that never contain a mod root themselves. */
const SKIP_DIRECTORY_NAMES = new Set([
"data",
"art",
"art1",
"audio",
"audio1",
"builtmods",
"builtmods-quantum",
"sageml",
"schemas",
"xsd",
"hlsl",
"node_modules",
"packages",
"dist",
"out",
"bin",
"obj",
".git",
".vs",
".vscode",
]);
/**
* Returns the marker kind found directly under `dir`, or null when `dir` is
* not a mod project root. `Data`/`mapmetadata` lookups are case-insensitive.
*/
export function projectMarkerKind(dir: string): ProjectMarkerKind | null {
const data = findCaseInsensitiveDir(dir, "Data");
if (data && hasFileIgnoreCase(data, ["Mod.xml"])) return "mod";
const entries = readDirNames(dir);
if (entries?.some((e) => e.toLowerCase().endsWith(".babproj"))) {
return "babproj";
}
if (data && hasMapMetadata(data)) return "mapmetadata";
return null;
}
/** True when `dir` is a mod project root (any marker). */
export function isProjectRoot(dir: string): boolean {
return projectMarkerKind(dir) != null;
}
/**
* Walks upward from `startDir` (up to `maxDepth` ancestors) and returns the
* nearest directory that carries a project marker, or null.
*/
export function findProjectRootUpward(
startDir: string,
maxDepth = DEFAULT_MAX_UPWARD_DEPTH,
): string | null {
let dir = resolve(startDir);
for (let i = 0; i < maxDepth; i++) {
if (isProjectRoot(dir)) return dir;
const parent = dirname(dir);
if (parent === dir) break;
dir = parent;
}
return null;
}
/** Upward discovery starting from a file's directory (single-file opens). */
export function findProjectRootForFile(
file: string,
maxDepth = DEFAULT_MAX_UPWARD_DEPTH,
): string | null {
return findProjectRootUpward(dirname(resolve(file)), maxDepth);
}
/**
* Shallow downward discovery for a workspace folder that contains one or
* more mods (e.g. the SDK `Mods` folder or a personal mods container).
*
* Descends at most `maxDepth` levels, never descends into known non-mod
* directories, and stops descending once a directory is itself a project
* root (a root's own `Data`/`Art` subtrees are never project containers).
* Results are de-duplicated by normalized path.
*/
export function discoverProjects(
folder: string,
maxDepth = DEFAULT_MAX_DOWNWARD_DEPTH,
): string[] {
const out: string[] = [];
const seen = new Set<string>();
const visit = (dir: string, depth: number): void => {
if (depth > maxDepth) return;
if (isProjectRoot(dir)) {
const key = normKey(dir);
if (!seen.has(key)) {
seen.add(key);
out.push(resolve(dir));
}
return;
}
let entries;
try {
entries = readdirSync(dir, { withFileTypes: true });
} catch {
return;
}
for (const entry of entries) {
if (!entry.isDirectory()) continue;
if (SKIP_DIRECTORY_NAMES.has(entry.name.toLowerCase())) continue;
visit(join(dir, entry.name), depth + 1);
}
};
visit(resolve(folder), 0);
return out;
}
function normKey(path: string): string {
return resolve(path).toLowerCase();
}
function readDirNames(dir: string): string[] | null {
try {
return readdirSync(dir);
} catch {
return null;
}
}
/** Case-insensitive child directory lookup under `parent`. */
function findCaseInsensitiveDir(parent: string, wanted: string): string | null {
const entries = readDirNames(parent);
if (!entries) return null;
const hit = entries.find(
(e) => e.toLowerCase() === wanted.toLowerCase(),
);
return hit ? join(parent, hit) : null;
}
/** True when `dir` contains any of `names` (case-insensitive file names). */
function hasFileIgnoreCase(dir: string, names: string[]): boolean {
const entries = readDirNames(dir);
if (!entries) return false;
const lower = new Set(entries.map((e) => e.toLowerCase()));
return names.some((n) => lower.has(n.toLowerCase()));
}
/** True when `dataDir/additionalmaps` contains a mapmetadata_*.xml file. */
function hasMapMetadata(dataDir: string): boolean {
const maps = findCaseInsensitiveDir(dataDir, "additionalmaps");
if (!maps) return false;
const entries = readDirNames(maps);
if (!entries) return false;
return entries.some((e) => /^mapmetadata_.*\.xml$/i.test(e));
}
+179
View File
@@ -0,0 +1,179 @@
/**
* SDK path normalization, validation and registry-based detection.
*
* Pure TypeScript (no vscode dependency) so the rules can be unit tested and
* reused by the indexer.
*
* The registry keys mirror what the SDK's own build script
* (`defaultscript.cs` initialize()) reads: the uninstall entry's
* InstallLocation, first in the 64-bit view and then under Wow6432Node.
* The installer path is only a hint - every candidate is validated against
* the actual SDK layout before being offered to the user.
*/
import { execFile } from "node:child_process";
import { readdirSync, statSync } from "node:fs";
import { join, resolve } from "node:path";
export type SdkValidationStatus = "ok" | "partial" | "not-sdk" | "missing";
export interface SdkValidation {
/** Resolved absolute path, or "" when nothing was configured. */
path: string;
status: SdkValidationStatus;
/** Human-readable relative paths that failed validation. */
missing: string[];
}
/** Uninstall entries queried by the SDK installer (same GUIDs as defaultscript.cs). */
export const SDK_REGISTRY_KEYS = [
"HKEY_LOCAL_MACHINE\\Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\{F6A3F605-7B10-4939-8D3D-4594332C1649}",
"HKEY_LOCAL_MACHINE\\Software\\Wow6432Node\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\{F6A3F605-7B10-4939-8D3D-4594332C1649}",
] as const;
/**
* The one required marker that identifies an RA3 Mod SDK root. The extension
* bundles its own schema model, but this file is the most distinctive SDK
* layout item (and is what `npm run generate-model` consumes).
*/
const SDK_ROOT_MARKER = ["Schemas", "xsd", "CnC3Types.xsd"] as const;
/**
* Functional items used by the extension. Missing ones degrade specific
* features (manifests, vanilla sources, SDK-side search paths), so they are
* reported as "partial" instead of rejecting the root outright.
*/
const SDK_FUNCTIONAL_ITEMS: { rel: readonly string[] }[] = [
{ rel: ["builtmods"] },
{ rel: ["SageXml"] },
{ rel: ["Mods"] },
{ rel: ["Static.xml"] },
{ rel: ["Global.xml"] },
{ rel: ["Audio.xml"] },
];
/**
* Trims quotes/whitespace and resolves to an absolute path. Returns "" for
* an empty value so callers can treat it as "no SDK configured".
*/
export function normalizeSdkPath(raw: string): string {
if (!raw) return "";
let p = String(raw).trim();
if (
p.length >= 2 &&
((p.startsWith('"') && p.endsWith('"')) ||
(p.startsWith("'") && p.endsWith("'")))
) {
p = p.slice(1, -1).trim();
}
return p ? resolve(p) : "";
}
/**
* Validates a configured/offered SDK path.
*
* - `missing`: nothing configured, or the path does not exist.
* - `not-sdk`: exists, but lacks the SDK root marker.
* - `partial`: is an SDK root, but some extension-relevant items are absent.
* - `ok`: every checked item exists.
*/
export function validateSdkPath(raw: string): SdkValidation {
const path = normalizeSdkPath(raw);
if (!path) return { path: "", status: "missing", missing: [] };
if (!isDirectory(path)) return { path, status: "missing", missing: [] };
if (!hasNestedIgnoreCase(path, SDK_ROOT_MARKER)) {
return {
path,
status: "not-sdk",
missing: [SDK_ROOT_MARKER.join("/")],
};
}
const missing: string[] = [];
for (const item of SDK_FUNCTIONAL_ITEMS) {
if (!hasNestedIgnoreCase(path, item.rel)) {
missing.push(item.rel.join("/"));
}
}
return {
path,
status: missing.length ? "partial" : "ok",
missing,
};
}
/**
* Reads InstallLocation from one registry key via `reg.exe` (Windows only).
* Returns null when the key/value is absent or the query fails.
*/
export async function readRegistryValue(
key: string,
valueName = "InstallLocation",
timeoutMs = 3000,
): Promise<string | null> {
if (process.platform !== "win32") return null;
try {
const stdout = await new Promise<string>((resolveValue, reject) => {
execFile(
"reg",
["query", key, "/v", valueName],
{ timeout: timeoutMs, windowsHide: true },
(err, stdout, _stderr) => {
if (err) reject(err);
else resolveValue(stdout);
},
);
});
return parseRegistryInstallLocation(stdout);
} catch {
return null;
}
}
/** Extracts the InstallLocation value from `reg.exe query` output. */
export function parseRegistryInstallLocation(stdout: string): string | null {
for (const line of stdout.split(/\r?\n/)) {
const m = line.match(/^\s*InstallLocation\s+REG_[A-Z_]+\s+(.+?)\s*$/i);
if (m?.[1]) return m[1].trim();
}
return null;
}
/** Queries both registry views in the same order defaultscript.cs uses. */
export async function detectSdkPathFromRegistry(): Promise<string | null> {
for (const key of SDK_REGISTRY_KEYS) {
const value = await readRegistryValue(key);
if (value?.trim()) return value.trim();
}
return null;
}
function isDirectory(path: string): boolean {
try {
return statSync(path).isDirectory();
} catch {
return false;
}
}
function readDirNames(dir: string): string[] | null {
try {
return readdirSync(dir);
} catch {
return null;
}
}
function hasNestedIgnoreCase(root: string, rel: readonly string[]): boolean {
let dir = root;
for (let i = 0; i < rel.length - 1; i++) {
const names = readDirNames(dir);
if (!names) return false;
const hit = names.find((n) => n.toLowerCase() === rel[i].toLowerCase());
if (!hit) return false;
dir = join(dir, hit);
}
const names = readDirNames(dir);
if (!names) return false;
const wanted = rel[rel.length - 1].toLowerCase();
return names.some((n) => n.toLowerCase() === wanted);
}
+193
View File
@@ -0,0 +1,193 @@
import * as vscode from "vscode";
import type { ModWorkspace } from "./workspace";
import {
detectSdkPathFromRegistry,
validateSdkPath,
type SdkValidation,
} from "./sdk";
import { t } from "./localize";
/**
* Non-intrusive SDK path guidance: a status-bar hint plus a one-time prompt
* (per session). The prompt prefers a validated registry-detected path, then
* falls back to a folder picker. Clearing `ra3modxml.sdkPath` explicitly is
* treated as "intentionally disabled" and never re-prompts.
*/
export class SdkSetup {
private readonly statusBar: vscode.StatusBarItem;
private promptAttempted = false;
constructor(
context: vscode.ExtensionContext,
private readonly getWs: () => ModWorkspace | null,
) {
this.statusBar = vscode.window.createStatusBarItem(
vscode.StatusBarAlignment.Left,
99,
);
this.statusBar.name = "RA3 Mod XML SDK";
this.statusBar.command = "ra3modxml.configureSdkPath";
context.subscriptions.push(this.statusBar);
context.subscriptions.push(
vscode.commands.registerCommand("ra3modxml.configureSdkPath", () => {
const ws = this.getWs();
if (!ws) {
void vscode.window.showInformationMessage(
t("RA3 Mod XML: open an RA3 mod project first to configure the SDK path."),
);
return;
}
void this.runSetup();
}),
);
}
async evaluate(ws: ModWorkspace): Promise<void> {
if (!ws.isRa3Workspace()) {
this.statusBar.hide();
return;
}
const config = vscode.workspace.getConfiguration("ra3modxml");
const raw = config.get<string>("sdkPath", "");
const explicit = isExplicitlyConfigured(config);
const validation = validateSdkPath(raw);
if (validation.status === "ok") {
this.statusBar.hide();
return;
}
// An explicit empty value means "no SDK, project-only mode" - never nag.
if (!raw && explicit) {
this.statusBar.hide();
return;
}
this.statusBar.text = statusBarText(validation);
this.statusBar.tooltip = describeSdkValidation(validation);
this.statusBar.show();
if (!this.promptAttempted) {
this.promptAttempted = true;
await this.runSetup();
}
}
private async runSetup(): Promise<void> {
const detected = await detectSdkPathFromRegistry();
const detectedValidation = detected ? validateSdkPath(detected) : null;
if (
detectedValidation &&
(detectedValidation.status === "ok" ||
detectedValidation.status === "partial")
) {
const useDetected = t("Use detected path");
const chooseManually = t("Choose manually…");
const notNow = t("Not now");
const pick = await vscode.window.showWarningMessage(
t(
"RA3 Mod XML could not find a valid SDK path. Detected installed SDK: {0}",
detectedValidation.path,
),
useDetected,
chooseManually,
notNow,
);
if (pick === useDetected) {
await applySdkPath(detectedValidation.path);
} else if (pick === chooseManually) {
await this.chooseAndApply();
}
return;
}
const chooseSdkFolder = t("Choose SDK folder…");
const pick = await vscode.window.showWarningMessage(
t(
"RA3 Mod XML needs the RA3 Mod SDK path to enable vanilla data, manifests and cross-file completion/navigation. Without it, the extension runs in project-only mode.",
),
chooseSdkFolder,
t("Not now"),
);
if (pick === chooseSdkFolder) await this.chooseAndApply();
}
private async chooseAndApply(): Promise<void> {
const picked = await vscode.window.showOpenDialog({
canSelectFiles: false,
canSelectFolders: true,
canSelectMany: false,
openLabel: t("Choose SDK root"),
title: t(
"Choose the RA3 Mod SDK root (should contain Schemas/xsd/CnC3Types.xsd)",
),
});
const dir = picked?.[0]?.fsPath;
if (!dir) return;
const validation = validateSdkPath(dir);
if (validation.status === "missing" || validation.status === "not-sdk") {
void vscode.window.showErrorMessage(
t(
"The selected directory is not a usable RA3 Mod SDK (missing {0}). Please choose again.",
validation.missing.join(", ") || t("that directory"),
),
);
return;
}
await applySdkPath(validation.path);
}
}
function statusBarText(validation: SdkValidation): string {
if (validation.status === "missing") {
return validation.path
? t("$(warning) RA3 XML: SDK path does not exist")
: t("$(warning) RA3 XML: SDK not configured");
}
if (validation.status === "not-sdk") {
return t("$(warning) RA3 XML: SDK path is invalid");
}
return t("$(warning) RA3 XML: SDK is incomplete");
}
function describeSdkValidation(validation: SdkValidation): string {
if (validation.status === "missing") {
return validation.path
? t(
"The directory configured in ra3modxml.sdkPath does not exist: {0}. Click to reconfigure, or clear ra3modxml.sdkPath to disable vanilla data features.",
validation.path,
)
: t(
"RA3 Mod SDK path is not configured. Click to set it, or clear ra3modxml.sdkPath to disable vanilla data features.",
);
}
if (validation.status === "not-sdk") {
return t(
"The directory configured in ra3modxml.sdkPath is not an RA3 Mod SDK root (missing Schemas/xsd/CnC3Types.xsd). Click to reconfigure.",
);
}
return t(
"RA3 Mod SDK is missing: {0}. Manifest / vanilla source / SDK search path features are unavailable.",
validation.missing.join(", "),
);
}
function isExplicitlyConfigured(
config: vscode.WorkspaceConfiguration,
): boolean {
const info = config.inspect<string>("sdkPath");
return !!(
info &&
(info.globalValue !== undefined ||
info.workspaceValue !== undefined ||
info.workspaceFolderValue !== undefined)
);
}
async function applySdkPath(path: string): Promise<void> {
await vscode.workspace
.getConfiguration("ra3modxml")
.update("sdkPath", path, vscode.ConfigurationTarget.Global);
void vscode.window.showInformationMessage(
t("RA3 Mod XML: SDK path set to {0}; rebuilding the index…", path),
);
}
+5 -2
View File
@@ -1,5 +1,6 @@
import * as vscode from "vscode";
import { join } from "node:path";
import { normalizeSdkPath } from "./sdk";
export interface ExtensionSettings {
sdkPath: string;
@@ -13,7 +14,7 @@ export interface ExtensionSettings {
export function readSettings(): ExtensionSettings {
const cfg = vscode.workspace.getConfiguration("ra3modxml");
const sdkPath = cfg.get<string>("sdkPath", "C:\\Apps\\RA3-MODSDK-X");
const sdkPath = normalizeSdkPath(cfg.get<string>("sdkPath", ""));
return {
sdkPath,
indexSageXml: cfg.get<boolean>("indexSageXml", true),
@@ -27,6 +28,8 @@ export function readSettings(): ExtensionSettings {
"all",
) as ExtensionSettings["definitionMode"],
additionalDataSearchPaths: cfg.get<string[]>("additionalDataSearchPaths", []),
builtmodsDirs: [join(sdkPath, "builtmods"), join(sdkPath, "builtmods-quantum")],
builtmodsDirs: sdkPath
? [join(sdkPath, "builtmods"), join(sdkPath, "builtmods-quantum")]
: [],
};
}
+1095 -96
View File
File diff suppressed because it is too large Load Diff
+187
View File
@@ -0,0 +1,187 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { execFileSync } from "node:child_process";
import { existsSync, mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import {
LIVE_ONLY,
liveArgsFor,
parseArgs,
toolNameFor,
} from "../out/agent/cli.js";
// ── Argument parsing and command mapping (pure) ───────────────────────
test("parseArgs reads the project, snapshot and command", () => {
const options = parseArgs(["--project", "D:/Mods/Alpha", "find", "AthenaCannon", "GameObject"]);
assert.equal(options.projectDir, "D:/Mods/Alpha");
assert.equal(options.command, "find");
assert.deepEqual(options.args, ["AthenaCannon", "GameObject"]);
});
test("parseArgs ignores unknown flags without failing the call", () => {
// An agent probing with a flag we do not know yet must not crash the CLI.
const withCommand = parseArgs(["--json", "status"]);
assert.equal(withCommand.command, "status");
const trailing = parseArgs(["find", "X", "--future-flag"]);
assert.equal(trailing.command, "find");
assert.deepEqual(trailing.args, ["X"]);
// A stray positional is still treated as the command name.
assert.equal(parseArgs([]).command, "status");
});
test("parseArgs reads outgoing-specific options", () => {
const options = parseArgs([
"outgoing", "AthenaCannon", "GameObject",
"--depth", "2",
"--target-types", "WeaponTemplate, GameObject",
"--max-edges", "25",
"--include-unresolved",
]);
assert.equal(options.command, "outgoing");
assert.equal(options.depth, 2);
assert.deepEqual(options.targetTypes, ["WeaponTemplate", "GameObject"]);
assert.equal(options.maxEdges, 25);
assert.equal(options.includeUnresolved, true);
});
test("toolNameFor maps every CLI command to a live tool", () => {
assert.equal(toolNameFor("find"), "find_asset");
assert.equal(toolNameFor("refs"), "find_references");
assert.equal(toolNameFor("outgoing"), "get_asset_references");
assert.equal(toolNameFor("list"), "list_assets_by_type");
assert.equal(toolNameFor("active"), "is_file_active");
assert.equal(toolNameFor("define"), "find_define");
assert.equal(toolNameFor("resolve"), "resolve_include");
assert.equal(toolNameFor("projects"), "list_projects");
assert.equal(toolNameFor("status"), "get_status");
});
test("LIVE_ONLY covers exactly the commands needing DOM/project context", () => {
assert.equal(LIVE_ONLY.has("outgoing"), true);
assert.equal(LIVE_ONLY.has("projects"), true);
assert.equal(LIVE_ONLY.has("find"), false);
assert.equal(LIVE_ONLY.has("status"), false);
});
test("liveArgsFor builds the right payload per command", () => {
assert.deepEqual(
liveArgsFor({ command: "find", args: ["X", "GameObject"] }),
{ id: "X", type: "GameObject" },
);
assert.deepEqual(
liveArgsFor({ command: "active", args: ["D:/f.xml"] }),
{ path: "D:/f.xml" },
);
// Outgoing omits unset options so the server applies its own defaults.
const outgoing = liveArgsFor({ command: "outgoing", args: ["X"] });
assert.equal(outgoing.id, "X");
assert.equal(outgoing.depth, undefined);
assert.equal(outgoing.targetTypes, undefined);
assert.equal(outgoing.maxEdges, undefined);
// An explicit depth of 0 is falsy but must still be forwarded.
const zero = liveArgsFor({ command: "outgoing", args: ["X"], depth: 0 });
assert.equal(zero.depth, 0);
});
// ── Project inference from the current directory ──────────────────────
function makeModProject() {
const root = mkdtempSync(join(tmpdir(), "ra3-cli-proj-"));
mkdirSync(join(root, "Data"), { recursive: true });
writeFileSync(join(root, "Data", "Mod.xml"), "<AssetDeclaration/>");
return root;
}
test("the CLI finds the project root by walking up from the cwd", async () => {
const root = makeModProject();
const nested = join(root, "Data", "Allied", "Units");
mkdirSync(nested, { recursive: true });
const previous = process.cwd();
try {
process.chdir(nested);
const options = parseArgs([]);
const resolved = (await import("../out/agent/cli.js")).resolveProjectDir(options);
assert.equal(resolved?.toLowerCase(), root.toLowerCase());
} finally {
process.chdir(previous);
rmSync(root, { recursive: true, force: true });
}
});
test("resolveProjectDir prefers an explicit --project over the cwd", async () => {
const { resolveProjectDir } = await import("../out/agent/cli.js");
const options = parseArgs(["--project", "D:/Somewhere/Else", "status"]);
assert.equal(resolveProjectDir(options), join("D:\\Somewhere\\Else").replace(/\\/g, "\\"));
});
// ── End-to-end execution (skipped when the sandbox forbids spawning) ──
function canSpawnShell() {
try {
if (process.platform === "win32") {
execFileSync("cmd.exe", ["/d", "/c", "exit 0"], { stdio: "ignore" });
} else {
execFileSync("/bin/sh", ["-c", "exit 0"], { stdio: "ignore" });
}
return true;
} catch {
return false;
}
}
const spawnable = canSpawnShell();
const cliPath = join(process.cwd(), "dist", "agent", "cli.js");
test("CLI exits 3 with a clear message outside a project", { skip: !spawnable || !existsSync(cliPath) }, (t) => {
const empty = mkdtempSync(join(tmpdir(), "ra3-cli-empty-"));
try {
let code = 0;
let stderr = "";
try {
execFileSync(process.execPath, [cliPath, "status"], {
cwd: empty,
encoding: "utf8",
stdio: ["ignore", "pipe", "pipe"],
});
} catch (err) {
if (err?.code === "EPERM") {
t.skip("sandbox forbids spawning");
return;
}
code = err.status;
stderr = err.stderr ?? "";
}
assert.equal(code, 3);
assert.match(stderr, /No project found/);
} finally {
rmSync(empty, { recursive: true, force: true });
}
});
test("CLI reports a live-only command as unavailable instead of empty", { skip: !spawnable || !existsSync(cliPath) }, (t) => {
const empty = mkdtempSync(join(tmpdir(), "ra3-cli-liveonly-"));
try {
let stdout = "";
try {
stdout = execFileSync(process.execPath, [cliPath, "--project", "D:/Mods/Nope", "outgoing", "X"], {
cwd: empty,
encoding: "utf8",
stdio: ["ignore", "pipe", "pipe"],
});
} catch (err) {
if (err?.code === "EPERM") {
t.skip("sandbox forbids spawning");
return;
}
stdout = err.stdout ?? "";
}
const payload = JSON.parse(stdout);
assert.equal(payload.source, "unavailable");
// Must explain why, never look like "this asset has no references".
assert.match(payload.error, /requires a live index/);
} finally {
rmSync(empty, { recursive: true, force: true });
}
});
+102
View File
@@ -0,0 +1,102 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import {
clearEndpoint,
clearEndpointForProject,
endpointPathForProject,
isProcessAlive,
readEndpoint,
readEndpointForProject,
sameProject,
writeEndpoint,
writeEndpointForProject,
} from "../out/agent/endpoint.js";
const PROJECT_A = "D:/Mods/ExampleA";
const PROJECT_B = "D:/Mods/ExampleB";
test("endpoint file round-trips and clears", async () => {
const home = mkdtempSync(join(tmpdir(), "ra3-endpoint-test-"));
try {
await writeEndpoint(
{ url: "http://127.0.0.1:12345", token: "abc", projectDir: PROJECT_A },
home,
);
const loaded = await readEndpoint(home);
assert.equal(loaded?.url, "http://127.0.0.1:12345");
assert.equal(loaded?.token, "abc");
await clearEndpoint(home);
assert.equal(await readEndpoint(home), null);
} finally {
rmSync(home, { recursive: true, force: true });
}
});
test("per-project endpoints do not shadow each other", async () => {
const home = mkdtempSync(join(tmpdir(), "ra3-endpoint-multi-"));
try {
// Two "windows" enable agent access for different projects.
await writeEndpointForProject(
PROJECT_A,
{ url: "http://127.0.0.1:1111", token: "token-a", processId: process.pid },
home,
);
await writeEndpointForProject(
PROJECT_B,
{ url: "http://127.0.0.1:2222", token: "token-b", processId: process.pid },
home,
);
const a = await readEndpointForProject(PROJECT_A, home);
const b = await readEndpointForProject(PROJECT_B, home);
assert.equal(a?.url, "http://127.0.0.1:1111");
assert.ok(sameProject(a.projectDir, PROJECT_A));
assert.equal(b?.url, "http://127.0.0.1:2222");
assert.ok(sameProject(b.projectDir, PROJECT_B));
// Clearing one project must not disturb the other.
await clearEndpointForProject(PROJECT_A, home);
assert.equal(await readEndpointForProject(PROJECT_A, home), null);
assert.equal((await readEndpointForProject(PROJECT_B, home))?.token, "token-b");
} finally {
rmSync(home, { recursive: true, force: true });
}
});
test("a per-project endpoint recording another project is rejected", async () => {
const home = mkdtempSync(join(tmpdir(), "ra3-endpoint-mismatch-"));
try {
const file = endpointPathForProject(PROJECT_A, home);
// Simulate a stale/edited file that claims to serve a different project.
mkdirSync(dirname(file), { recursive: true });
writeFileSync(
file,
JSON.stringify({
url: "http://127.0.0.1:3333",
token: "t",
projectDir: PROJECT_B,
}),
);
assert.equal(await readEndpointForProject(PROJECT_A, home), null);
} finally {
rmSync(home, { recursive: true, force: true });
}
});
test("isProcessAlive detects dead pids and trusts unknown ones", () => {
assert.equal(isProcessAlive(process.pid), true);
assert.equal(isProcessAlive(undefined), true);
assert.equal(isProcessAlive(0), true);
assert.equal(isProcessAlive(NaN), true);
// Not a valid Windows PID, so it cannot correspond to a running process.
assert.equal(isProcessAlive(0x7fffffff), false);
});
test("sameProject is case-insensitive", () => {
assert.equal(sameProject("D:/Mods/Example", "d:/mods/example"), true);
assert.equal(sameProject("D:/Mods/Example", "D:/Mods/Other"), false);
});
+308
View File
@@ -0,0 +1,308 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import {
collectAssetReferences,
parseLoadedXml,
} from "../out/agent/forwardRefs.js";
// ── Fixture files ────────────────────────────────────────────────────
// AthenaCannon has no WeaponSetUpdate of its own: it inherits BaseCannon,
// which owns the weapon slot, and has its own die-object content reference.
const ATHENA = `<?xml version="1.0" encoding="utf-8"?>
<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<GameObject id="AthenaCannon" inheritFrom="BaseCannon">
<CreateObjectDie>
<CreateObject>AthenaCannon_Die</CreateObject>
</CreateObjectDie>
</GameObject>
</AssetDeclaration>`;
const BASE = `<?xml version="1.0" encoding="utf-8"?>
<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<GameObject id="BaseCannon">
<WeaponSetUpdate>
<WeaponSlotHardpoint>
<Weapon Template="AthenaCannonWeapon" />
</WeaponSlotHardpoint>
</WeaponSetUpdate>
</GameObject>
</AssetDeclaration>`;
const DIE = `<?xml version="1.0" encoding="utf-8"?>
<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<GameObject id="AthenaCannon_Die">
<WeaponSetUpdate>
<WeaponSlotHardpoint>
<Weapon Template="DieExplosionWeapon" />
</WeaponSlotHardpoint>
</WeaponSetUpdate>
</GameObject>
</AssetDeclaration>`;
const FILES = {
"D:/Mods/Example/Data/AthenaCannon.xml": ATHENA,
"D:/Mods/Example/Data/BaseCannon.xml": BASE,
"D:/Mods/Example/Data/AthenaCannon_Die.xml": DIE,
};
function def(type, id, file, line) {
return { type, id, file, line, origin: "project", stream: "static" };
}
const ATHENA_DEF = def("GameObject", "AthenaCannon", "D:/Mods/Example/Data/AthenaCannon.xml", 3);
const BASE_DEF = def("GameObject", "BaseCannon", "D:/Mods/Example/Data/BaseCannon.xml", 3);
const DIE_DEF = def("GameObject", "AthenaCannon_Die", "D:/Mods/Example/Data/AthenaCannon_Die.xml", 3);
const WEAPON_DEF = def(
"WeaponTemplate",
"AthenaCannonWeapon",
"D:/Mods/Example/Data/Weapon.xml",
88,
);
const DIE_WEAPON_DEF = def(
"WeaponTemplate",
"DieExplosionWeapon",
"D:/Mods/Example/Data/Weapon.xml",
120,
);
function makeIndex() {
const all = [ATHENA_DEF, BASE_DEF, DIE_DEF, WEAPON_DEF, DIE_WEAPON_DEF];
const assetsById = new Map();
for (const d of all) {
const key = d.id.toLowerCase();
if (!assetsById.has(key)) assetsById.set(key, []);
assetsById.get(key).push(d);
}
const assets = new Map([
["GameObject", new Map([["athenacannon", [ATHENA_DEF]], ["basecannon", [BASE_DEF]], ["athenacannon_die", [DIE_DEF]]])],
["WeaponTemplate", new Map([["athenacannonweapon", [WEAPON_DEF]], ["dieexplosionweapon", [DIE_WEAPON_DEF]]])],
]);
return {
projectDir: "D:/Mods/Example",
sdkDir: "",
complete: true,
phase: "art",
assets,
assetsById,
defines: new Map(),
files: new Map(),
streams: [],
manifests: new Map(),
sourceCandidates: [],
diagnostics: [],
references: new Map(),
recordsHashes: new Map(),
stats: {},
};
}
function loader(map = FILES) {
return async (file) => {
const text = map[file];
return text ? parseLoadedXml(text) : null;
};
}
function findEdge(edges, predicate) {
return edges.find(predicate);
}
test("depth 1 returns only the queried asset's own edges", async () => {
const result = await collectAssetReferences(
makeIndex(),
"AthenaCannon",
"GameObject",
loader(),
{},
);
assert.equal(result.roots.length, 1);
// Own content ref + inherited weapon ref + the inheritFrom edge itself.
assert.ok(result.edges.length >= 3);
assert.deepEqual(
[...new Set(result.edges.map((e) => e.depth))],
[1],
"all edges must be at depth 1",
);
assert.equal(result.truncated, false);
});
test("attribute references carry element, parent and attribute provenance", async () => {
const result = await collectAssetReferences(
makeIndex(),
"AthenaCannon",
"GameObject",
loader(),
);
const weapon = findEdge(
result.edges,
(e) => e.via.kind === "attribute" && e.to?.id === "AthenaCannonWeapon",
);
assert.ok(weapon, "weapon edge should exist");
assert.equal(weapon.via.element, "Weapon");
assert.equal(weapon.via.parent, "WeaponSlotHardpoint");
assert.equal(weapon.via.attribute, "Template");
assert.equal(weapon.to.type, "WeaponTemplate");
assert.equal(weapon.to.line, 88);
assert.ok(weapon.source.file.endsWith("BaseCannon.xml"));
assert.ok(weapon.source.line > 0);
});
test("content references (CreateObjectDie) are reported with kind=content", async () => {
const result = await collectAssetReferences(
makeIndex(),
"AthenaCannon",
"GameObject",
loader(),
);
const die = findEdge(result.edges, (e) => e.via.kind === "content");
assert.ok(die, "die-object content edge should exist");
assert.equal(die.via.element, "CreateObject");
assert.equal(die.via.parent, "CreateObjectDie");
assert.equal(die.via.attribute, null);
assert.equal(die.to.type, "GameObject");
assert.equal(die.to.id, "AthenaCannon_Die");
assert.ok(die.source.file.endsWith("AthenaCannon.xml"));
});
test("inheritFrom is walked and marked with definedIn", async () => {
const result = await collectAssetReferences(
makeIndex(),
"AthenaCannon",
"GameObject",
loader(),
);
const inherit = findEdge(result.edges, (e) => e.via.kind === "inheritFrom");
assert.ok(inherit, "inheritFrom edge should exist");
assert.equal(inherit.to.id, "BaseCannon");
assert.equal(inherit.value, "BaseCannon");
assert.equal(inherit.definedIn, undefined, "the inheritFrom edge itself is on AthenaCannon");
const inheritedWeapon = findEdge(
result.edges,
(e) => e.to?.id === "AthenaCannonWeapon",
);
assert.ok(inheritedWeapon, "weapon from the ancestor must still be reported");
assert.deepEqual(inheritedWeapon.definedIn, { type: "GameObject", id: "BaseCannon" });
assert.equal(inheritedWeapon.from.id, "AthenaCannon", "edge is attributed to the queried asset");
});
test("targetTypes filters edges, but inheritFrom edges always survive", async () => {
const result = await collectAssetReferences(
makeIndex(),
"AthenaCannon",
"GameObject",
loader(),
{ targetTypes: ["WeaponTemplate"] },
);
assert.ok(result.edges.length > 0);
assert.ok(
result.edges.some((e) => e.to.type === "WeaponTemplate"),
"expected at least one WeaponTemplate edge",
);
for (const edge of result.edges) {
// inheritFrom is kept so the caller can see where the weapon is written.
if (edge.via.kind === "inheritFrom") continue;
assert.equal(edge.to.type, "WeaponTemplate", `${edge.via.element} should be filtered out`);
}
// Nodes mirror the kept edges, so the inheritFrom target may appear too.
const inheritIds = new Set(
result.edges
.filter((e) => e.via.kind === "inheritFrom")
.map((e) => e.to.id.toLowerCase()),
);
for (const node of result.nodes) {
assert.ok(
node.type === "WeaponTemplate" || inheritIds.has(node.id.toLowerCase()),
`unexpected node ${node.type}:${node.id}`,
);
}
});
test("depth 2 expands into referenced assets", async () => {
const result = await collectAssetReferences(
makeIndex(),
"AthenaCannon",
"GameObject",
loader(),
{ depth: 2 },
);
const depths = new Set(result.edges.map((e) => e.depth));
assert.ok(depths.has(2), "expected depth-2 edges from the die-object GameObject");
const dieWeapon = findEdge(result.edges, (e) => e.to?.id === "DieExplosionWeapon");
assert.ok(dieWeapon, "the die object's weapon should appear at depth 2");
assert.equal(dieWeapon.depth, 2);
assert.equal(dieWeapon.from.id, "AthenaCannon_Die");
});
test("depth is clamped to the max of 3", async () => {
const result = await collectAssetReferences(
makeIndex(),
"AthenaCannon",
"GameObject",
loader(),
{ depth: 99 },
);
for (const edge of result.edges) {
assert.ok(edge.depth <= 3, `depth ${edge.depth} exceeded the clamp`);
}
});
test("maxEdges truncates and reports what was dropped", async () => {
const result = await collectAssetReferences(
makeIndex(),
"AthenaCannon",
"GameObject",
loader(),
{ maxEdges: 1 },
);
assert.equal(result.edges.length, 1);
assert.equal(result.truncated, true);
const omitted = Object.values(result.omittedByTargetType).reduce((a, b) => a + b, 0);
assert.ok(omitted >= 1, "expected the dropped edges to be summarised");
});
test("unresolved references are opt-in", async () => {
const text = `<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<GameObject id="Ghost">
<WeaponSetUpdate><WeaponSlotHardpoint><Weapon Template="DoesNotExist" /></WeaponSlotHardpoint></WeaponSetUpdate>
</GameObject>
</AssetDeclaration>`;
const ghost = def("GameObject", "Ghost", "D:/Mods/Example/Data/Ghost.xml", 2);
const index = makeIndex();
index.assetsById.set("ghost", [ghost]);
const ghostLoader = loader({ "D:/Mods/Example/Data/Ghost.xml": text });
const without = await collectAssetReferences(index, "Ghost", "GameObject", ghostLoader);
assert.equal(without.edges.length, 0);
const withUnresolved = await collectAssetReferences(index, "Ghost", "GameObject", ghostLoader, {
includeUnresolved: true,
});
assert.equal(withUnresolved.edges.length, 1);
assert.equal(withUnresolved.edges[0].to, null);
assert.equal(withUnresolved.edges[0].value, "DoesNotExist");
});
test("unknown ids produce a warning instead of throwing", async () => {
const result = await collectAssetReferences(
makeIndex(),
"NoSuchAsset",
"GameObject",
loader(),
);
assert.equal(result.edges.length, 0);
assert.equal(result.roots.length, 0);
assert.equal(result.warnings.length, 1);
assert.match(result.warnings[0], /No definition found/);
});
test("unreadable files produce a warning and no edges", async () => {
const result = await collectAssetReferences(
makeIndex(),
"AthenaCannon",
"GameObject",
async () => null,
);
assert.equal(result.edges.length, 0);
assert.ok(result.warnings.some((w) => w.includes("Could not read")));
});
+219
View File
@@ -0,0 +1,219 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { existsSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import {
INSTANCE_SCHEMA_VERSION,
clearInstance,
instanceFileName,
instancesDir,
makeInstanceId,
manifestPath,
projectsOf,
pruneInstances,
readInstances,
readManifest,
refreshDiscovery,
writeInstance,
writeManifest,
} from "../out/agent/instances.js";
import { endpointPath, readEndpoint } from "../out/agent/endpoint.js";
function instanceHome() {
return mkdtempSync(join(tmpdir(), "ra3-instances-"));
}
function makeInstance(id, pid = process.pid) {
return {
instanceId: id,
url: `http://127.0.0.1:${10000 + (pid % 1000)}`,
token: `tok-${id}`,
projectDir: "D:/Mods/Alpha",
projects: ["D:/Mods/Alpha"],
processId: pid,
};
}
test("instances are written and read back", async () => {
const home = instanceHome();
try {
const file = await writeInstance(makeInstance("a-1"), home);
assert.ok(existsSync(file));
assert.ok(file.includes(instancesDir(home)));
assert.equal(file.endsWith(instanceFileName("a-1")), true);
const all = await readInstances(home);
assert.equal(all.length, 1);
assert.equal(all[0].instanceId, "a-1");
assert.equal(all[0].token, "tok-a-1");
} finally {
rmSync(home, { recursive: true, force: true });
}
});
test("concurrent windows do not overwrite each other", async () => {
const home = instanceHome();
try {
// Two windows enabling agent access at the same time: separate files, so
// there is no read-modify-write race to guard.
await writeInstance(makeInstance("win-a"), home);
await writeInstance(makeInstance("win-b"), home);
const ids = (await readInstances(home)).map((i) => i.instanceId).sort();
assert.deepEqual(ids, ["win-a", "win-b"]);
} finally {
rmSync(home, { recursive: true, force: true });
}
});
test("pruneInstances removes entries whose PID is dead", async () => {
const home = instanceHome();
try {
// 0x7fffffff is not a valid Windows PID, so it cannot be alive.
await writeInstance(makeInstance("alive", process.pid), home);
await writeInstance(makeInstance("dead", 0x7fffffff), home);
const result = await pruneInstances(home);
assert.deepEqual(result.removed, ["dead"]);
assert.deepEqual(
result.kept.map((i) => i.instanceId),
["alive"],
);
// The dead file must actually be gone from disk.
assert.equal(existsSync(join(instancesDir(home), instanceFileName("dead"))), false);
assert.equal((await readInstances(home)).length, 1);
} finally {
rmSync(home, { recursive: true, force: true });
}
});
test("pruneInstances keeps entries with an unknown PID", async () => {
const home = instanceHome();
try {
// An older/simpler instance file without processId must never be pruned.
await writeInstance(
{ instanceId: "no-pid", url: "http://127.0.0.1:1", token: "t" },
home,
);
const result = await pruneInstances(home);
assert.deepEqual(result.removed, []);
assert.equal(result.kept.length, 1);
} finally {
rmSync(home, { recursive: true, force: true });
}
});
test("clearInstance only removes its own file", async () => {
const home = instanceHome();
try {
await writeInstance(makeInstance("mine"), home);
await writeInstance(makeInstance("theirs"), home);
await clearInstance("mine", home);
const ids = (await readInstances(home)).map((i) => i.instanceId);
assert.deepEqual(ids, ["theirs"]);
} finally {
rmSync(home, { recursive: true, force: true });
}
});
test("readInstances tolerates corrupt and unrelated files", async () => {
const home = instanceHome();
try {
await writeInstance(makeInstance("good"), home);
writeFileSync(join(instancesDir(home), "broken.json"), "{ not json");
writeFileSync(join(instancesDir(home), "notes.txt"), "ignore me");
const all = await readInstances(home);
assert.deepEqual(all.map((i) => i.instanceId), ["good"]);
} finally {
rmSync(home, { recursive: true, force: true });
}
});
test("projectsOf unions projects across instances without duplicates", () => {
const projects = projectsOf([
{ instanceId: "a", url: "u", token: "t", projectDir: "D:/Mods/Alpha", projects: ["D:/Mods/Alpha"] },
{ instanceId: "b", url: "u", token: "t", projectDir: "D:/Mods/Beta", projects: ["D:/Mods/beta", "D:/Mods/Gamma"] },
]);
// "beta" appears twice with different casing and must collapse to one entry,
// keeping the first spelling seen.
assert.deepEqual(projects, ["D:/Mods/Alpha", "D:/Mods/beta", "D:/Mods/Gamma"]);
});
test("writeManifest produces a discovery manifest without tokens", async () => {
const home = instanceHome();
try {
const manifest = await writeManifest(
[makeInstance("a-1"), makeInstance("b-2")],
home,
);
assert.equal(manifest.schemaVersion, INSTANCE_SCHEMA_VERSION);
assert.deepEqual(manifest.projects, ["D:/Mods/Alpha"]);
assert.equal(manifest.instances.length, 2);
const raw = readFileSync(manifestPath(home), "utf8");
// The manifest is for discovery; secrets must not leak into it.
assert.equal(raw.includes("tok-a-1"), false);
assert.equal(raw.includes('"token"'), false);
const reread = await readManifest(home);
assert.equal(reread?.instances.length, 2);
} finally {
rmSync(home, { recursive: true, force: true });
}
});
test("makeInstanceId is unique across rapid calls", () => {
const ids = new Set();
for (let i = 0; i < 200; i++) ids.add(makeInstanceId(1234));
assert.equal(ids.size, 200);
for (const id of ids) assert.ok(id.startsWith("1234-"), id);
});
test("refreshDiscovery keeps surviving windows discoverable", async () => {
const home = instanceHome();
try {
const mine = makeInstance("mine");
const other = {
...makeInstance("other"),
url: "http://127.0.0.1:19999",
token: "tok-other",
projectDir: "D:/Mods/Beta",
projects: ["D:/Mods/Beta"],
};
await writeInstance(mine, home);
await writeInstance(other, home);
// This window closes: only its own instance file goes away.
await clearInstance(mine.instanceId, home);
const manifest = await refreshDiscovery(home);
assert.deepEqual(manifest.projects, ["D:/Mods/Beta"]);
assert.deepEqual(manifest.instances.map((i) => i.instanceId), ["other"]);
// The legacy global pointer must follow the survivor, not be deleted.
const endpoint = await readEndpoint(home);
assert.equal(endpoint?.url, other.url);
assert.equal(endpoint?.token, other.token);
assert.equal(existsSync(endpointPath(home)), true);
// The merged manifest on disk must agree with the returned value.
const reread = await readManifest(home);
assert.deepEqual(reread?.instances.map((i) => i.instanceId), ["other"]);
} finally {
rmSync(home, { recursive: true, force: true });
}
});
test("refreshDiscovery clears the global pointer when the last window closes", async () => {
const home = instanceHome();
try {
await writeInstance(makeInstance("only"), home);
await clearInstance("only", home);
const manifest = await refreshDiscovery(home);
assert.deepEqual(manifest.instances, []);
assert.deepEqual(manifest.projects, []);
assert.equal(existsSync(endpointPath(home)), false);
} finally {
rmSync(home, { recursive: true, force: true });
}
});
+205
View File
@@ -0,0 +1,205 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { mkdtempSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import {
LiveClient,
findEndpoint,
liveUrlForTool,
normalizePath,
queryLive,
responseProjectMismatch,
} from "../out/agent/liveClient.js";
import { writeInstance } from "../out/agent/instances.js";
import { writeEndpoint, writeEndpointForProject } from "../out/agent/endpoint.js";
const PROJECT_A = "D:/Mods/Alpha";
const PROJECT_B = "D:/Mods/Beta";
function home() {
return mkdtempSync(join(tmpdir(), "ra3-liveclient-"));
}
test("live URLs pin the requested project for every tool", () => {
const cases = [
["get_status", {}],
["find_asset", { id: "X" }],
["find_references", { id: "X" }],
["list_assets_by_type", { type: "GameObject" }],
["is_file_active", { path: "D:/f.xml" }],
["find_define", { name: "D" }],
["resolve_include", { source: "DATA:a.xml" }],
["list_projects", {}],
];
for (const [tool, args] of cases) {
const url = liveUrlForTool("http://127.0.0.1:1234", PROJECT_A, tool, args);
assert.ok(url, `${tool} should have a live URL`);
assert.equal(
new URL(url).searchParams.get("project"),
PROJECT_A,
`${tool} must pin the project`,
);
}
});
test("get_asset_references serialises all of its options", () => {
const url = liveUrlForTool("http://127.0.0.1:1234", PROJECT_A, "get_asset_references", {
id: "AthenaCannon",
type: "GameObject",
depth: 2,
targetTypes: ["WeaponTemplate", "GameObject"],
maxEdges: 25,
includeUnresolved: true,
});
const q = new URL(url).searchParams;
assert.equal(q.get("id"), "AthenaCannon");
assert.equal(q.get("type"), "GameObject");
assert.equal(q.get("depth"), "2");
assert.equal(q.get("targetTypes"), "WeaponTemplate,GameObject");
assert.equal(q.get("maxEdges"), "25");
assert.equal(q.get("includeUnresolved"), "true");
assert.equal(q.get("project"), PROJECT_A);
});
test("unknown tools have no live URL", () => {
assert.equal(liveUrlForTool("http://127.0.0.1:1", PROJECT_A, "not_a_tool", {}), null);
});
test("responseProjectMismatch refuses another project's answer", () => {
assert.equal(
responseProjectMismatch({ index: { projectDir: "d:/mods/alpha" } }, PROJECT_A),
false,
);
assert.equal(
responseProjectMismatch({ index: { projectDir: PROJECT_B } }, PROJECT_A),
true,
);
// Nothing to compare against: not a mismatch.
assert.equal(responseProjectMismatch({ index: { state: "ready" } }, PROJECT_A), false);
assert.equal(responseProjectMismatch({ index: { projectDir: PROJECT_B } }, null), false);
});
test("normalizePath ignores case and trailing separators", () => {
assert.equal(normalizePath("D:\\Mods\\Alpha\\"), normalizePath("d:/mods/alpha"));
});
test("findEndpoint prefers the per-project endpoint", async () => {
const h = home();
try {
await writeEndpointForProject(
PROJECT_A,
{ url: "http://127.0.0.1:1111", token: "tok-a", processId: process.pid },
h,
);
const endpoint = await findEndpoint({ projectDir: PROJECT_A, agentHome: h });
assert.equal(endpoint?.url, "http://127.0.0.1:1111");
} finally {
rmSync(h, { recursive: true, force: true });
}
});
test("findEndpoint finds a live instance when no per-project file exists", async () => {
const h = home();
try {
// A window that has not yet written per-project endpoints, only its own
// instance file. Discovery must still find it.
await writeInstance(
{
instanceId: "w1",
url: "http://127.0.0.1:2222",
token: "tok-inst",
projects: [PROJECT_A, PROJECT_B],
processId: process.pid,
},
h,
);
const endpoint = await findEndpoint({ projectDir: PROJECT_B, agentHome: h });
assert.equal(endpoint?.url, "http://127.0.0.1:2222");
} finally {
rmSync(h, { recursive: true, force: true });
}
});
test("findEndpoint ignores instances that do not serve the project", async () => {
const h = home();
try {
await writeInstance(
{
instanceId: "other",
url: "http://127.0.0.1:3333",
token: "tok",
projects: ["D:/Mods/Unrelated"],
processId: process.pid,
},
h,
);
assert.equal(await findEndpoint({ projectDir: PROJECT_A, agentHome: h }), null);
} finally {
rmSync(h, { recursive: true, force: true });
}
});
test("findEndpoint ignores dead instances", async () => {
const h = home();
try {
await writeInstance(
{
instanceId: "dead",
url: "http://127.0.0.1:4444",
token: "tok",
projects: [PROJECT_A],
processId: 0x7fffffff,
},
h,
);
assert.equal(await findEndpoint({ projectDir: PROJECT_A, agentHome: h }), null);
} finally {
rmSync(h, { recursive: true, force: true });
}
});
test("findEndpoint does not use a global endpoint recording another project", async () => {
const h = home();
try {
await writeEndpoint(
{ url: "http://127.0.0.1:5555", token: "tok", projectDir: PROJECT_B, processId: process.pid },
h,
);
assert.equal(await findEndpoint({ projectDir: PROJECT_A, agentHome: h }), null);
// It is still usable when asked for its own project.
assert.ok(await findEndpoint({ projectDir: PROJECT_B, agentHome: h }));
} finally {
rmSync(h, { recursive: true, force: true });
}
});
test("a query with no reachable live instance returns null", async () => {
const h = home();
try {
assert.equal(
await queryLive("get_status", {}, { projectDir: PROJECT_A, agentHome: h }),
null,
);
} finally {
rmSync(h, { recursive: true, force: true });
}
});
test("the negative cache suppresses repeated attempts and can be reset", async () => {
let now = 1_000_000;
const client = new LiveClient({ projectDir: PROJECT_A, now: () => now });
assert.equal(client.suppressed, false);
client.markUnavailable();
assert.equal(client.suppressed, true);
// Still suppressed just before the cooldown expires.
now += 4999;
assert.equal(client.suppressed, true);
// Expired afterwards.
now += 2;
assert.equal(client.suppressed, false);
client.markUnavailable();
client.reset();
assert.equal(client.suppressed, false);
});
+297
View File
@@ -0,0 +1,297 @@
/**
* End-to-end live-path test.
*
* Starts a real local HTTP live server (the same module the extension runs),
* registers it exactly the way the extension does (per-project endpoint +
* instance file + merged manifest), and then drives it through the shared
* `LiveClient` that both the MCP server and the CLI use.
*
* This is the in-process equivalent of "start the extension, then query it
* from the CLI/MCP", so it covers the transport, project pinning, project
* resolution and cross-project refusal without needing to spawn anything.
*/
import { test } from "node:test";
import assert from "node:assert/strict";
import { mkdtempSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { startLocalServer } from "../out/agent/localServer.js";
import {
clearInstance,
readManifest,
pruneInstances,
writeInstance,
writeManifest,
} from "../out/agent/instances.js";
import { writeEndpointForProject } from "../out/agent/endpoint.js";
import { LiveClient, findEndpoint } from "../out/agent/liveClient.js";
import { parseLoadedXml } from "../out/agent/forwardRefs.js";
const PROJECT_A = "D:/Mods/Alpha";
const PROJECT_B = "D:/Mods/Beta";
function def(type, id, file, line) {
return { type, id, file, line, origin: "project", stream: "static" };
}
const UNIT_FILE = `${PROJECT_A}/Data/AthenaCannon.xml`;
const BASE_FILE = `${PROJECT_A}/Data/BaseCannon.xml`;
const UNIT = def("GameObject", "AthenaCannon", UNIT_FILE, 2);
const BASE = def("GameObject", "BaseCannon", BASE_FILE, 2);
const WEAPON = def("WeaponTemplate", "AthenaCannonWeapon", `${PROJECT_A}/Data/Weapon.xml`, 88);
const ATHENA_XML = `<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<GameObject id="AthenaCannon" inheritFrom="BaseCannon">
<CreateObjectDie><CreateObject>AthenaCannon_Die</CreateObject></CreateObjectDie>
</GameObject>
</AssetDeclaration>`;
const BASE_XML = `<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<GameObject id="BaseCannon">
<WeaponSetUpdate><WeaponSlotHardpoint><Weapon Template="AthenaCannonWeapon" /></WeaponSlotHardpoint></WeaponSetUpdate>
</GameObject>
</AssetDeclaration>`;
const XML_FILES = {
[UNIT_FILE]: ATHENA_XML,
[BASE_FILE]: BASE_XML,
};
function makeIndex(projectDir) {
const assets = new Map([
["GameObject", new Map([["athenacannon", [UNIT]], ["basecannon", [BASE]]])],
["WeaponTemplate", new Map([["athenacannonweapon", [WEAPON]]])],
]);
return {
projectDir,
sdkDir: "",
complete: true,
phase: "art",
stale: false,
assets,
assetsById: new Map([
["athenacannon", [UNIT]],
["basecannon", [BASE]],
["athenacannonweapon", [WEAPON]],
]),
defines: new Map([
["d", [{ name: "D", value: "1", file: UNIT_FILE, line: 1, origin: "project" }]],
]),
files: new Map(),
streams: [
{
name: "static",
entry: `${projectDir}/Data/Mod.xml`,
files: new Set([UNIT_FILE.toLowerCase().replace(/\\/g, "/")]),
},
],
manifests: new Map(),
sourceCandidates: [],
diagnostics: [],
references: new Map([
[
`GameObject\u0000athenacannon\u0000${UNIT_FILE}\u00002`,
[{ file: `${projectDir}/Data/Other.xml`, line: 3, start: 1, end: 2, kind: "attr" }],
],
]),
recordsHashes: new Map(),
stats: {
projectDir, sdkDir: "", phase: "art", complete: true,
indexedFiles: 2, parsedFiles: 2, shallowScannedFiles: 0, deferredArtFiles: 0,
shallowCacheHits: 0, recordsCacheHits: 0, resolveCacheHits: 0, resolveCalls: 0,
snapshotHits: 0, snapshotFallbacks: 0, candidatesMs: 0, walkMs: 0, artScanMs: 0,
assetCount: 3, referenceCount: 1, defineCount: 1, manifestFiles: 0,
manifestAssetCount: 0, streams: 1, sourceCandidates: 0, elapsedMs: 1,
},
};
}
/** Boots a live server + registration files, and returns a cleanup handle. */
async function bootLive() {
const agentHome = mkdtempSync(join(tmpdir(), "ra3-e2e-"));
const handle = await startLocalServer({
getIndex: (projectDir) =>
!projectDir || projectDir === PROJECT_A ? makeIndex(PROJECT_A) : null,
listProjects: () => [PROJECT_A, PROJECT_B],
loadFile: async (file) => {
const text = XML_FILES[file];
return text ? parseLoadedXml(text) : null;
},
});
const endpoint = {
instanceId: "e2e-1",
url: `http://127.0.0.1:${handle.port}`,
token: handle.token,
projectDir: PROJECT_A,
projects: [PROJECT_A, PROJECT_B],
processId: process.pid,
updatedAt: new Date().toISOString(),
};
await writeEndpointForProject(PROJECT_A, { ...endpoint, projectDir: PROJECT_A }, agentHome);
await writeInstance(endpoint, agentHome);
await writeManifest([endpoint], agentHome);
return {
agentHome,
endpoint,
async close() {
await handle.close();
rmSync(agentHome, { recursive: true, force: true });
},
};
}
test("LiveClient reaches a real live server and answers every snapshot tool", async () => {
const live = await bootLive();
try {
const client = new LiveClient({ projectDir: PROJECT_A, agentHome: live.agentHome });
const status = await client.query("get_status");
assert.equal(status?.mismatched, false);
assert.equal(status.payload.state, "ready");
assert.equal(status.payload.projectDir, PROJECT_A);
const found = await client.query("find_asset", { id: "AthenaCannon", type: "GameObject" });
assert.equal(found.payload.data.length, 1);
const refs = await client.query("find_references", { id: "AthenaCannon" });
assert.equal(refs.payload.data.length, 1);
const active = await client.query("is_file_active", { path: UNIT_FILE });
assert.equal(active.payload.data.active, true);
const define = await client.query("find_define", { name: "D" });
assert.equal(define.payload.data.length, 1);
const list = await client.query("list_assets_by_type", { type: "GameObject" });
assert.equal(list.payload.data.length, 2);
} finally {
await live.close();
}
});
test("the live path answers get_asset_references with element provenance", async () => {
const live = await bootLive();
try {
const client = new LiveClient({ projectDir: PROJECT_A, agentHome: live.agentHome });
const result = await client.query("get_asset_references", {
id: "AthenaCannon",
type: "GameObject",
targetTypes: ["WeaponTemplate"],
});
const data = result.payload.data;
assert.ok(data, "expected edge data");
// The weapon is written in BaseCannon's XML, reached through inheritFrom.
const weapon = data.edges.find((e) => e.to?.id === "AthenaCannonWeapon");
assert.ok(weapon, "expected the inherited weapon edge");
assert.equal(weapon.via.element, "Weapon");
assert.equal(weapon.via.parent, "WeaponSlotHardpoint");
assert.equal(weapon.definedIn.id, "BaseCannon");
assert.equal(weapon.source.file, BASE_FILE);
} finally {
await live.close();
}
});
test("list_projects reports the live project roots", async () => {
const live = await bootLive();
try {
const client = new LiveClient({ projectDir: PROJECT_A, agentHome: live.agentHome });
const result = await client.query("list_projects");
assert.deepEqual(result.payload.data, [PROJECT_A, PROJECT_B]);
} finally {
await live.close();
}
});
test("a client for an unknown project cannot use another project's answer", async () => {
const live = await bootLive();
try {
// The registered instance only serves PROJECT_A/PROJECT_B, so a client
// pinned to a third project must find nothing at all rather than fall
// back to PROJECT_A's data.
const outsider = new LiveClient({
projectDir: "D:/Mods/Unrelated",
agentHome: live.agentHome,
});
assert.equal(await outsider.query("find_asset", { id: "AthenaCannon" }), null);
} finally {
await live.close();
}
});
test("discovery works through the instance file alone (no per-project endpoint)", async () => {
const live = await bootLive();
try {
// Simulate a window that registered its instance but whose per-project
// endpoint has not been written yet.
rmSync(join(live.agentHome, "endpoints"), { recursive: true, force: true });
const endpoint = await findEndpoint({
projectDir: PROJECT_A,
agentHome: live.agentHome,
});
assert.equal(endpoint?.instanceId, "e2e-1");
} finally {
await live.close();
}
});
test("the merged manifest lists projects for discovery", async () => {
const live = await bootLive();
try {
const manifest = await readManifest(live.agentHome);
assert.ok(manifest);
assert.deepEqual(new Set(manifest.projects), new Set([PROJECT_A, PROJECT_B]));
assert.equal(manifest.instances.length, 1);
} finally {
await live.close();
}
});
test("a crashed instance is pruned by a later instance and then unreachable", async () => {
const live = await bootLive();
try {
// Add a second instance that looks crashed.
await writeInstance(
{
instanceId: "dead-window",
url: "http://127.0.0.1:1",
token: "t",
projects: [PROJECT_A],
processId: 0x7fffffff,
},
live.agentHome,
);
const pruned = await pruneInstances(live.agentHome);
assert.ok(pruned.removed.includes("dead-window"));
// The surviving instance still works after the prune.
const client = new LiveClient({ projectDir: PROJECT_A, agentHome: live.agentHome });
const status = await client.query("get_status");
assert.equal(status.payload.state, "ready");
} finally {
await live.close();
}
});
test("clearing this window's instance leaves other windows untouched", async () => {
const live = await bootLive();
try {
await writeInstance(
{
instanceId: "other-window",
url: "http://127.0.0.1:9999",
token: "t2",
projects: [PROJECT_A],
processId: process.pid,
},
live.agentHome,
);
await clearInstance("e2e-1", live.agentHome);
const { readInstances } = await import("../out/agent/instances.js");
const ids = (await readInstances(live.agentHome)).map((i) => i.instanceId);
assert.deepEqual(ids, ["other-window"]);
} finally {
await live.close();
}
});
+283
View File
@@ -0,0 +1,283 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { startLocalServer } from "../out/agent/localServer.js";
import { parseLoadedXml } from "../out/agent/forwardRefs.js";
const PROJECT_A = "D:/Mods/Example";
const PROJECT_B = "D:/Mods/Other";
function makeStats() {
return {
projectDir: "P",
sdkDir: "",
phase: "art",
complete: true,
indexedFiles: 1,
parsedFiles: 1,
shallowScannedFiles: 0,
deferredArtFiles: 0,
shallowCacheHits: 0,
recordsCacheHits: 0,
resolveCacheHits: 0,
resolveCalls: 0,
snapshotHits: 0,
snapshotFallbacks: 0,
candidatesMs: 0,
walkMs: 0,
artScanMs: 0,
assetCount: 1,
referenceCount: 1,
defineCount: 1,
manifestFiles: 0,
manifestAssetCount: 0,
streams: 1,
sourceCandidates: 1,
elapsedMs: 1,
};
}
const CANNON_XML = `<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<GameObject id="AthenaCannon" inheritFrom="BaseCannon">
<CreateObjectDie><CreateObject>AthenaCannon_Die</CreateObject></CreateObjectDie>
</GameObject>
</AssetDeclaration>`;
const BASE_XML = `<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<GameObject id="BaseCannon">
<WeaponSetUpdate><WeaponSlotHardpoint><Weapon Template="AthenaCannonWeapon" /></WeaponSlotHardpoint></WeaponSetUpdate>
</GameObject>
</AssetDeclaration>`;
const FILES = {
"D:/Mods/Example/Data/AthenaCannon.xml": CANNON_XML,
"D:/Mods/Example/Data/BaseCannon.xml": BASE_XML,
};
function makeIndex(projectDir, unitId, extraDefs = []) {
const file = `${projectDir}/Data/${unitId}.xml`;
const unit = { type: "GameObject", id: unitId, file, line: 2, origin: "project", stream: "static" };
const all = [unit, ...extraDefs];
const assets = new Map();
const assetsById = new Map();
for (const d of all) {
if (!assets.has(d.type)) assets.set(d.type, new Map());
const byId = assets.get(d.type);
if (!byId.has(d.id.toLowerCase())) byId.set(d.id.toLowerCase(), []);
byId.get(d.id.toLowerCase()).push(d);
const key = d.id.toLowerCase();
if (!assetsById.has(key)) assetsById.set(key, []);
assetsById.get(key).push(d);
}
return {
projectDir,
sdkDir: "",
complete: true,
phase: "art",
stale: false,
assets,
assetsById,
defines: new Map([
["exampledefine", [{ name: "ExampleDefine", value: "1", file, line: 2, origin: "project" }]],
]),
files: new Map(),
streams: [
{
name: "static",
entry: `${projectDir}/Data/Mod.xml`,
files: new Set([file.toLowerCase().replace(/\\/g, "/")]),
},
],
manifests: new Map(),
sourceCandidates: [],
diagnostics: [],
references: new Map([
[
`GameObject\u0000${unitId.toLowerCase()}\u0000${file}\u00002`,
[{ file: `${projectDir}/Data/Other.xml`, line: 3, start: 1, end: 2, kind: "attr" }],
],
]),
recordsHashes: new Map(),
stats: makeStats(),
};
}
const PROJECT_A_RELATED = [
{
type: "GameObject",
id: "BaseCannon",
file: "D:/Mods/Example/Data/BaseCannon.xml",
line: 2,
origin: "project",
stream: "static",
},
{
type: "GameObject",
id: "AthenaCannon_Die",
file: "D:/Mods/Example/Data/AthenaCannon_Die.xml",
line: 2,
origin: "project",
stream: "static",
},
{
type: "WeaponTemplate",
id: "AthenaCannonWeapon",
file: "D:/Mods/Example/Data/Weapon.xml",
line: 88,
origin: "project",
stream: "static",
},
];
/** Routes to a distinct index per requested project, like the extension does. */
function routedServerOptions() {
const indexes = new Map([
[PROJECT_A, makeIndex(PROJECT_A, "AthenaCannon", PROJECT_A_RELATED)],
[PROJECT_B, makeIndex(PROJECT_B, "OtherUnit")],
]);
return {
getIndex: (projectDir) => (projectDir ? indexes.get(projectDir) ?? null : indexes.get(PROJECT_A)),
listProjects: () => [...indexes.keys()],
loadFile: async (file) => {
const text = FILES[file];
return text ? parseLoadedXml(text) : null;
},
};
}
async function withServer(fn) {
const handle = await startLocalServer({ ...routedServerOptions(), token: "test-token" });
const base = `http://127.0.0.1:${handle.port}`;
const headers = { authorization: "Bearer test-token" };
const get = async (path) => (await fetch(`${base}${path}`, { headers })).json();
try {
await fn({ base, headers, get });
} finally {
await handle.close();
}
}
test("local server requires the bearer token", async () => {
await withServer(async ({ base }) => {
const unauthorized = await fetch(`${base}/status`);
assert.equal(unauthorized.status, 401);
const forbidden = await fetch(`${base}/status`, {
headers: { authorization: "Bearer wrong" },
});
assert.equal(forbidden.status, 401);
});
});
test("local server exposes read-only queries", async () => {
await withServer(async ({ get }) => {
const status = await get(`/status?project=${encodeURIComponent(PROJECT_A)}`);
assert.equal(status.state, "ready");
assert.equal(status.projectDir, PROJECT_A);
const asset = await get(
`/find_asset?project=${encodeURIComponent(PROJECT_A)}&id=AthenaCannon&type=GameObject`,
);
assert.equal(asset.data.length, 1);
const refs = await get(
`/find_references?project=${encodeURIComponent(PROJECT_A)}&id=AthenaCannon`,
);
assert.equal(refs.data.length, 1);
const active = await get(
`/is_file_active?project=${encodeURIComponent(PROJECT_A)}&path=D:/Mods/Example/Data/AthenaCannon.xml`,
);
assert.equal(active.data.active, true);
});
});
test("?project= selects the index instead of the active editor's project", async () => {
await withServer(async ({ get }) => {
const a = await get(`/find_asset?project=${encodeURIComponent(PROJECT_A)}&id=AthenaCannon`);
assert.equal(a.index.projectDir, PROJECT_A);
assert.equal(a.data.length, 1);
const b = await get(`/find_asset?project=${encodeURIComponent(PROJECT_B)}&id=OtherUnit`);
assert.equal(b.index.projectDir, PROJECT_B);
assert.equal(b.data.length, 1);
// The same id must not resolve when asked about the other project.
const cross = await get(
`/find_asset?project=${encodeURIComponent(PROJECT_B)}&id=AthenaCannon`,
);
assert.equal(cross.data.length, 0);
assert.equal(cross.index.projectDir, PROJECT_B);
});
});
test("an unknown project reports no_index without faking a projectDir", async () => {
await withServer(async ({ get }) => {
const unknown = "D:/Mods/Unknown";
const result = await get(`/status?project=${encodeURIComponent(unknown)}`);
assert.equal(result.state, "no_index");
assert.equal(result.projectDir, unknown);
});
});
test("/projects lists the known roots", async () => {
await withServer(async ({ get }) => {
const result = await get("/projects");
assert.deepEqual(new Set(result.data), new Set([PROJECT_A, PROJECT_B]));
});
});
test("/get_asset_references returns provenance-carrying edges", async () => {
await withServer(async ({ get }) => {
const result = await get(
`/get_asset_references?project=${encodeURIComponent(PROJECT_A)}&id=AthenaCannon&type=GameObject`,
);
assert.equal(result.index.state, "ready");
const data = result.data;
assert.ok(data, "expected a data payload");
assert.equal(data.edges.length >= 3, true);
const weapon = data.edges.find((e) => e.to?.id === "AthenaCannonWeapon");
assert.ok(weapon, "expected the inherited weapon edge");
assert.equal(weapon.via.element, "Weapon");
assert.equal(weapon.via.parent, "WeaponSlotHardpoint");
assert.equal(weapon.definedIn.id, "BaseCannon");
assert.equal(weapon.source.file, "D:/Mods/Example/Data/BaseCannon.xml");
const die = data.edges.find((e) => e.via.kind === "content");
assert.ok(die, "expected the CreateObjectDie content edge");
assert.equal(die.to.id, "AthenaCannon_Die");
});
});
test("/get_asset_references honours targetTypes and depth parameters", async () => {
await withServer(async ({ get }) => {
const filtered = await get(
`/get_asset_references?project=${encodeURIComponent(PROJECT_A)}&id=AthenaCannon&targetTypes=WeaponTemplate`,
);
for (const edge of filtered.data.edges) {
if (edge.via.kind === "inheritFrom") continue;
assert.equal(edge.to.type, "WeaponTemplate");
}
const shallow = await get(
`/get_asset_references?project=${encodeURIComponent(PROJECT_A)}&id=AthenaCannon&depth=1`,
);
for (const edge of shallow.data.edges) {
assert.equal(edge.depth, 1);
}
const deep = await get(
`/get_asset_references?project=${encodeURIComponent(PROJECT_A)}&id=AthenaCannon&depth=2`,
);
for (const edge of deep.data.edges) {
assert.ok(edge.depth <= 2);
}
});
});
test("/get_asset_references explains itself when live data is unavailable", async () => {
await withServer(async ({ get }) => {
const missing = await get(`/get_asset_references?project=${encodeURIComponent(PROJECT_A)}&id=Nope`);
assert.equal(missing.data.roots.length, 0);
assert.ok(missing.data.warnings.length > 0);
});
});
+22
View File
@@ -0,0 +1,22 @@
import { test } from "node:test";
import assert from "node:assert/strict";
// The URL building, project pinning and cross-project refusal now live in
// `liveClient` and are covered by agentLiveClient.test.mjs. What remains
// MCP-layer-specific is that the server module is *importable*: it must not
// start its stdio loop as a side effect of being imported, otherwise tests and
// any tool that merely inspects the module would hang waiting on stdin.
test("the MCP server module imports without starting its stdio loop", async () => {
const mod = await import("../out/agent/mcpServer.js");
assert.equal(typeof mod, "object");
// Reaching this line proves main() did not run on import.
});
test("the CLI module imports without running", async () => {
const mod = await import("../out/agent/cli.js");
assert.equal(typeof mod.parseArgs, "function");
assert.equal(typeof mod.toolNameFor, "function");
assert.equal(typeof mod.liveArgsFor, "function");
assert.ok(mod.LIVE_ONLY instanceof Set);
});
+241
View File
@@ -0,0 +1,241 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { execFileSync } from "node:child_process";
import { existsSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import {
electronExecutableCandidates,
electronRuntime,
findElectronExecutable,
isElectronHost,
isNodeFreeLauncher,
launcherScript,
looksLikeElectronExecutable,
resolveRuntime,
} from "../out/agent/runtime.js";
import { writeLauncher } from "../out/agent/setup.js";
const WIN = "win32";
const LINUX = "linux";
// ── Pure launcher generation ──────────────────────────────────────────
test("electron runtime launcher runs without Node on PATH", () => {
const script = launcherScript(
{
runtime: electronRuntime("C:\\Apps\\VSCode\\Code.exe"),
serverPath: "C:\\ext\\dist\\agent\\mcpServer.js",
projectDir: "D:\\Mods\\Example",
},
WIN,
);
assert.ok(script.startsWith("@echo off"));
assert.ok(script.includes("set ELECTRON_RUN_AS_NODE=1"));
assert.ok(script.includes("C:\\Apps\\VSCode\\Code.exe"));
assert.ok(script.includes("C:\\ext\\dist\\agent\\mcpServer.js"));
// The Node path exists but must be guarded by the runtime-existence jump.
assert.ok(script.includes('if not exist "%RA3_RUNTIME%" goto :ra3_node'));
assert.ok(script.includes(":ra3_node"));
assert.equal(isNodeFreeLauncher(script, WIN), true);
});
test("Windows launcher avoids the parse-time %errorlevel% batch pitfall", () => {
const script = launcherScript(
{
runtime: electronRuntime("C:\\Apps\\VSCode\\Code.exe"),
serverPath: "C:\\ext\\mcpServer.js",
projectDir: "D:\\P",
},
WIN,
);
// Inside a parenthesised block %errorlevel% would expand at parse time.
assert.ok(!/^if exist .*\(\s*$/m.test(script), "must not use an if (...) block");
assert.equal(
(script.match(/exit \/b %errorlevel%/g) ?? []).length,
2,
"both Electron and Node endings should propagate the exit code",
);
});
test("node runtime launcher is generated when Electron is unavailable", () => {
const script = launcherScript(
{
runtime: { kind: "node", executable: "node", env: {}, viaPath: true },
serverPath: "C:\\ext\\mcpServer.js",
projectDir: "D:\\P",
},
WIN,
);
assert.ok(!script.includes("ELECTRON_RUN_AS_NODE"));
assert.ok(script.includes('set "RA3_NODE=node"'));
assert.equal(isNodeFreeLauncher(script, WIN), false);
});
test("POSIX launcher prefers Electron and falls back to Node", () => {
const script = launcherScript(
{
runtime: electronRuntime("/usr/share/code/code"),
serverPath: "/ext/mcpServer.js",
projectDir: "/mods/example",
},
LINUX,
);
assert.ok(script.startsWith("#!/usr/bin/env sh"));
assert.ok(script.includes("ELECTRON_RUN_AS_NODE=1 exec"));
assert.ok(script.includes('if [ -x "$RA3_RUNTIME" ]'));
assert.equal(isNodeFreeLauncher(script, LINUX), true);
});
test("launcher quotes paths safely", () => {
const win = launcherScript(
{
runtime: electronRuntime("C:\\Program Files\\VS Code\\Code.exe"),
serverPath: "C:\\my ext\\mcpServer.js",
projectDir: "D:\\My Mods\\Example",
},
WIN,
);
assert.ok(win.includes('set "RA3_RUNTIME=C:\\Program Files\\VS Code\\Code.exe"'));
assert.ok(win.includes('set "RA3_SERVER=C:\\my ext\\mcpServer.js"'));
const sh = launcherScript(
{
runtime: electronRuntime("/opt/it's here/code"),
serverPath: "/tmp/server.js",
projectDir: "/tmp/proj",
},
LINUX,
);
// Single quotes inside a single-quoted POSIX string must be escaped.
assert.ok(sh.includes(`'/opt/it'\\''s here/code'`));
});
test("looksLikeElectronExecutable recognises VS Code-family binaries", () => {
assert.equal(looksLikeElectronExecutable("C:\\...\\Microsoft VS Code\\Code.exe"), true);
assert.equal(looksLikeElectronExecutable("/usr/share/code/code"), true);
assert.equal(looksLikeElectronExecutable("/Applications/Visual Studio Code.app/Contents/MacOS/Electron"), true);
assert.equal(looksLikeElectronExecutable("C:\\Windows\\System32\\cmd.exe"), false);
});
test("runtime resolution falls back to Node outside an Electron host", () => {
// Tests run under plain Node, so the resolved runtime must be Node.
assert.equal(isElectronHost(), false);
const runtime = resolveRuntime();
assert.equal(runtime.kind, "node");
assert.equal(runtime.viaPath, true);
assert.deepEqual(runtime.env, {});
});
test("electronRuntime carries the ELECTRON_RUN_AS_NODE env", () => {
const runtime = electronRuntime("C:\\Code.exe");
assert.equal(runtime.kind, "electron");
assert.equal(runtime.executable, "C:\\Code.exe");
assert.deepEqual(runtime.env, { ELECTRON_RUN_AS_NODE: "1" });
assert.equal(runtime.viaPath, false);
});
test("electronExecutableCandidates returns platform-appropriate probes", () => {
const candidates = electronExecutableCandidates();
assert.ok(Array.isArray(candidates));
if (process.platform === "win32") {
assert.ok(candidates.every((c) => c.endsWith(".exe")));
}
// findElectronExecutable must never throw and returns a string or null.
const found = findElectronExecutable();
assert.ok(found === null || typeof found === "string");
});
// ── writeLauncher integration ─────────────────────────────────────────
test("writeLauncher writes an executable launcher and reports node-freeness", async () => {
const home = mkdtempSync(join(tmpdir(), "ra3-runtime-test-"));
try {
const result = await writeLauncher("C:\\ext", "D:\\Mods\\Example", home, electronRuntime("C:\\Code.exe"));
assert.ok(existsSync(result.path));
assert.equal(result.nodeFree, true);
assert.equal(result.runtime.kind, "electron");
const text = readFileSync(result.path, "utf8");
assert.ok(text.includes("ELECTRON_RUN_AS_NODE=1"));
assert.ok(text.includes("mcpServer.js"));
} finally {
rmSync(home, { recursive: true, force: true });
}
});
// ── Live launcher execution (skipped when the sandbox forbids spawning) ──
const electron = findElectronExecutable();
/**
* True when this process may launch the launcher, i.e. spawn a shell.
*
* Some sandboxes allow spawning `node` directly but deny `cmd.exe`/`sh`, so
* the probe must exercise the same capability the test needs instead of just
* spawning any child process.
*/
function canSpawnShell() {
try {
if (process.platform === "win32") {
execFileSync("cmd.exe", ["/d", "/c", "exit 0"], { stdio: "ignore" });
} else {
execFileSync("/bin/sh", ["-c", "exit 0"], { stdio: "ignore" });
}
return true;
} catch {
return false;
}
}
const spawnable = canSpawnShell();
test(
"generated launcher completes an MCP session on the Electron runtime",
{ skip: !spawnable || !electron },
(t) => {
const home = mkdtempSync(join(tmpdir(), "ra3-launcher-run-"));
try {
const serverPath = join(process.cwd(), "dist", "agent", "mcpServer.js");
const launcher = join(home, process.platform === "win32" ? "launch.cmd" : "launch.sh");
writeFileSync(
launcher,
launcherScript({
runtime: electronRuntime(electron),
serverPath,
projectDir: "D:/Mods/Example",
// Point the Node fallback at a path that cannot exist, so a
// successful session proves the Electron branch was taken and the
// launcher really is Node-free.
nodeFallback: join(home, "no-such-node"),
}),
"utf8",
);
const requests = [
JSON.stringify({ jsonrpc: "2.0", id: 1, method: "initialize", params: {} }),
JSON.stringify({ jsonrpc: "2.0", id: 2, method: "tools/list" }),
].join("\n");
let stdout;
try {
stdout = execFileSync(launcher, [], {
input: requests,
encoding: "utf8",
timeout: 60000,
shell: process.platform === "win32",
});
} catch (err) {
if (err?.code === "EPERM") {
t.skip("sandbox forbids spawning a shell");
return;
}
throw err;
}
const lines = stdout.split(/\r?\n/).filter((l) => l.trim());
const init = JSON.parse(lines[0]);
assert.equal(init.result.serverInfo.name, "ra3-mod-xml");
const tools = JSON.parse(lines[1]);
assert.ok(tools.result.tools.length >= 9);
} finally {
rmSync(home, { recursive: true, force: true });
}
},
);
+138
View File
@@ -0,0 +1,138 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { existsSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import {
addMcpServerToConfigFile,
installMcpServerConfigToFile,
launcherPath,
mcpConfigJson,
mcpServerConfig,
readMcpInstallRecord,
removeLauncher,
removeMcpServerFromConfigFile,
uninstallMcpServerConfigs,
} from "../out/agent/setup.js";
test("mcpServerConfig and mcpConfigJson use the stable launcher", () => {
const config = mcpServerConfig("C:/Users/me/.ra3modxml/ra3-mod-xml-mcp.cmd", "D:/Mods/Example");
assert.deepEqual(config.mcpServers["ra3-mod-xml"].args, ["--project", "D:/Mods/Example"]);
const json = mcpConfigJson("C:/launcher.cmd", "D:/Proj");
assert.ok(json.includes("C:/launcher.cmd"));
assert.ok(json.includes("D:/Proj"));
});
test("addMcpServerToConfigFile creates and merges config", async () => {
const dir = mkdtempSync(join(tmpdir(), "ra3-setup-test-"));
try {
const file = join(dir, "mcp.json");
await addMcpServerToConfigFile(file, "C:/launcher.cmd", "D:/Proj");
const first = JSON.parse(readFileSync(file, "utf8"));
assert.ok(first.mcpServers["ra3-mod-xml"]);
writeFileSync(file, JSON.stringify({ mcpServers: { other: { command: "x" } } }, null, 2));
await addMcpServerToConfigFile(file, "C:/launcher.cmd", "D:/Proj");
const merged = JSON.parse(readFileSync(file, "utf8"));
assert.ok(merged.mcpServers.other);
assert.ok(merged.mcpServers["ra3-mod-xml"]);
} finally {
rmSync(dir, { recursive: true, force: true });
}
});
test("removeMcpServerFromConfigFile removes only our entry and preserves the rest", async () => {
const dir = mkdtempSync(join(tmpdir(), "ra3-setup-remove-"));
try {
const file = join(dir, "mcp.json");
writeFileSync(
file,
JSON.stringify(
{
mcpServers: {
other: { command: "x" },
"ra3-mod-xml": { command: "launcher", args: ["--project", "D:/Mods/A"] },
},
someOtherKey: 1,
},
null,
2,
),
);
assert.equal(await removeMcpServerFromConfigFile(file), true);
const parsed = JSON.parse(readFileSync(file, "utf8"));
assert.ok(parsed.mcpServers.other);
assert.equal(parsed.mcpServers["ra3-mod-xml"], undefined);
assert.equal(parsed.someOtherKey, 1);
// Nothing left to remove: second call is a no-op.
assert.equal(await removeMcpServerFromConfigFile(file), false);
} finally {
rmSync(dir, { recursive: true, force: true });
}
});
test("removeMcpServerFromConfigFile handles VS Code's servers key and drops empty containers", async () => {
const dir = mkdtempSync(join(tmpdir(), "ra3-setup-vscode-"));
try {
const file = join(dir, "mcp.json");
writeFileSync(
file,
JSON.stringify({ servers: { "ra3-mod-xml": { command: "x" } }, inputs: [] }, null, 2),
);
assert.equal(await removeMcpServerFromConfigFile(file), true);
const parsed = JSON.parse(readFileSync(file, "utf8"));
assert.equal(parsed.servers, undefined);
assert.deepEqual(parsed.inputs, []);
// A missing file is "nothing to remove", not an error.
assert.equal(await removeMcpServerFromConfigFile(join(dir, "nope.json")), false);
} finally {
rmSync(dir, { recursive: true, force: true });
}
});
test("installed MCP configs can be uninstalled through the install record", async () => {
const home = mkdtempSync(join(tmpdir(), "ra3-setup-home-"));
const dir = mkdtempSync(join(tmpdir(), "ra3-setup-record-"));
try {
const file = join(dir, "mcp.json");
await installMcpServerConfigToFile({
filePath: file,
launcher: "C:/launcher.cmd",
projectDir: "D:/Mods/A",
label: "Test client",
sourceVersion: "1.2.3",
agentHome: home,
});
const record = await readMcpInstallRecord(home);
assert.equal(record.length, 1);
assert.equal(record[0].label, "Test client");
assert.equal(record[0].serverKey, "ra3-mod-xml");
assert.equal(record[0].sourceVersion, "1.2.3");
const removed = await uninstallMcpServerConfigs({ agentHome: home });
assert.deepEqual(removed, [file]);
assert.equal((await readMcpInstallRecord(home)).length, 0);
// Our entry was the only server: the empty container is dropped.
assert.deepEqual(JSON.parse(readFileSync(file, "utf8")), {});
} finally {
rmSync(home, { recursive: true, force: true });
rmSync(dir, { recursive: true, force: true });
}
});
test("removeLauncher deletes the stable launcher and tolerates its absence", async () => {
const home = mkdtempSync(join(tmpdir(), "ra3-setup-launcher-"));
try {
writeFileSync(launcherPath(home), "dummy", "utf8");
assert.equal(existsSync(launcherPath(home)), true);
assert.equal(await removeLauncher(home), true);
assert.equal(existsSync(launcherPath(home)), false);
// force: true, so removing it again is still a success.
assert.equal(await removeLauncher(home), true);
} finally {
rmSync(home, { recursive: true, force: true });
}
});
+229
View File
@@ -0,0 +1,229 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { existsSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import {
SKILL_MARKER_FILE,
forgetSkillInstallRecords,
installSkillToDirectories,
installedSkillStatus,
readSkillInstallRecord,
readSkillMarker,
uninstallRecordedSkills,
uninstallSkillFromDirectory,
writeSkillInstallRecord,
writeSkillTo,
} from "../out/agent/skill.js";
test("writeSkillTo creates SKILL.md and avoids project-doc noise", async () => {
const dir = mkdtempSync(join(tmpdir(), "ra3-skill-test-"));
try {
const skillDir = join(dir, "ra3-mod-xml");
await writeSkillTo(skillDir, "0.1.25");
assert.ok(existsSync(join(skillDir, "SKILL.md")));
assert.ok(existsSync(join(skillDir, "references", "query-guide.md")));
assert.ok(existsSync(join(skillDir, SKILL_MARKER_FILE)));
const content = readFileSync(join(skillDir, "SKILL.md"), "utf8");
assert.ok(content.includes("find_asset"));
assert.ok(!content.includes("codebase-navigation-guide"));
// The bundled reference must list every tool the MCP server exposes.
const guide = readFileSync(
join(skillDir, "references", "query-guide.md"),
"utf8",
);
for (const tool of [
"get_status",
"find_asset",
"find_references",
"get_asset_references",
"list_assets_by_type",
"is_file_active",
"find_define",
"resolve_include",
"list_projects",
"get_usage_guide",
]) {
assert.ok(guide.includes(tool), `query-guide.md must mention ${tool}`);
}
assert.equal(guide.includes("CnC3Types.xsd"), false);
} finally {
rmSync(dir, { recursive: true, force: true });
}
});
test("SKILL.md scopes itself to SAGE/RA3 projects and warns off others", async () => {
const dir = mkdtempSync(join(tmpdir(), "ra3-skill-scope-"));
try {
const skillDir = join(dir, "ra3-mod-xml");
await writeSkillTo(skillDir, "0.1.25");
const content = readFileSync(join(skillDir, "SKILL.md"), "utf8");
// Must state its applicability and list concrete positive signals.
assert.match(content, /When this skill applies/);
assert.ok(content.includes("Data/Mod.xml"));
assert.ok(content.includes("babproj"));
assert.ok(content.includes("AssetDeclaration"));
// Must give an explicit negative rule and a cheap probe.
assert.match(content, /Do \*\*not\*\* use these tools for unrelated repositories/);
assert.ok(content.includes("get_status"));
assert.ok(content.includes("projectDir"));
// `CnC3Types.xsd` is the shared SAGE base schema (the RA3 Mod SDK ships it
// too), so it must not be presented as evidence in either direction.
assert.equal(content.includes("CnC3Types.xsd"), false);
assert.equal(content.includes("Tiberium Wars"), false);
// Second-phase capability must be documented.
assert.ok(content.includes("get_asset_references"));
assert.ok(content.includes("definedIn"));
} finally {
rmSync(dir, { recursive: true, force: true });
}
});
test("SKILL.md explains how to reach the index without MCP", async () => {
const dir = mkdtempSync(join(tmpdir(), "ra3-skill-reach-"));
try {
const skillDir = join(dir, "ra3-mod-xml");
await writeSkillTo(skillDir, "0.1.25");
const content = readFileSync(join(skillDir, "SKILL.md"), "utf8");
assert.match(content, /## Reaching the index/);
// The discovery manifest is the stable entry point.
assert.ok(content.includes("~/.ra3modxml/index.json"));
// The launcher and the bundled CLI are both mentioned.
assert.ok(content.includes("ra3-mod-xml-mcp"));
assert.ok(content.includes("cli.js"));
// The CLI is a Node script, and the skill must say how to run it when Node
// is not installed (VS Code's Electron binary as Node).
assert.ok(content.includes("ELECTRON_RUN_AS_NODE=1"));
// The stdio escape hatch must be shown, since it needs no setup at all.
assert.ok(content.includes("tools/call"));
// It must not pretend configuring a client takes effect immediately.
assert.ok(content.includes("new session"));
// And it must refuse to invent results.
assert.match(content, /Never fabricate index results/);
// The bundled tool reference must be linked from SKILL.md, otherwise
// skills-compatible clients never load it (resources load on demand).
assert.ok(content.includes("./references/query-guide.md"));
// The tool list must stay a real list; a merged bullet hides an item.
assert.match(content, /indexed stream\.\n\s+- `find_define\(name\)`/);
// Instructions must not send it looking for project-specific docs.
assert.equal(content.includes("codebase-navigation-guide"), false);
} finally {
rmSync(dir, { recursive: true, force: true });
}
});
test("installSkillToDirectories records managed copies and uninstall removes them", async () => {
const home = mkdtempSync(join(tmpdir(), "ra3-skill-home-"));
const dir = mkdtempSync(join(tmpdir(), "ra3-skill-target-"));
try {
const target = join(dir, "ra3-mod-xml");
const succeeded = await installSkillToDirectories([target], "0.1.25", home);
assert.deepEqual(succeeded, [target]);
const record = await readSkillInstallRecord(home);
assert.equal(record.length, 1);
assert.equal(record[0].path, target);
await uninstallSkillFromDirectory(target, home);
assert.equal(existsSync(target), false);
assert.equal((await readSkillInstallRecord(home)).length, 0);
} finally {
rmSync(home, { recursive: true, force: true });
rmSync(dir, { recursive: true, force: true });
}
});
test("readSkillMarker requires our marker to describe the same directory", async () => {
const dir = mkdtempSync(join(tmpdir(), "ra3-skill-marker-"));
try {
const managed = join(dir, "managed");
await writeSkillTo(managed, "1.0.0");
const marker = await readSkillMarker(managed);
assert.equal(marker?.sourceVersion, "1.0.0");
// A hand-copied skill without a marker is never treated as ours.
const foreign = join(dir, "foreign");
mkdirSync(foreign, { recursive: true });
writeFileSync(join(foreign, "SKILL.md"), "user content", "utf8");
assert.equal(await readSkillMarker(foreign), null);
// A marker pointing at another directory must not make this one managed.
const spoofed = join(dir, "spoofed");
mkdirSync(spoofed, { recursive: true });
writeFileSync(
join(spoofed, SKILL_MARKER_FILE),
JSON.stringify({ path: managed, sourceVersion: "1.0.0" }),
"utf8",
);
assert.equal(await readSkillMarker(spoofed), null);
} finally {
rmSync(dir, { recursive: true, force: true });
}
});
test("uninstallRecordedSkills removes managed copies and skips user-owned ones", async () => {
const home = mkdtempSync(join(tmpdir(), "ra3-skill-uninstall-home-"));
const dir = mkdtempSync(join(tmpdir(), "ra3-skill-uninstall-"));
try {
const managed = join(dir, "managed");
await installSkillToDirectories([managed], "1.0.0", home);
// A directory the user owns: recorded, but with no marker of ours.
const foreign = join(dir, "foreign");
mkdirSync(foreign, { recursive: true });
writeFileSync(join(foreign, "SKILL.md"), "user content", "utf8");
const record = await readSkillInstallRecord(home);
record.push({ path: foreign, sourceVersion: "0.0.0" });
await writeSkillInstallRecord(record, home);
const status = await installedSkillStatus(home);
assert.equal(status.length, 2);
assert.deepEqual(
status.map((s) => ({ path: s.path, managed: s.managed })),
[
{ path: managed, managed: true },
{ path: foreign, managed: false },
],
);
const { removed, skipped } = await uninstallRecordedSkills(
[managed, foreign],
home,
);
assert.deepEqual(removed, [managed]);
assert.deepEqual(skipped, [foreign]);
assert.equal(existsSync(managed), false);
assert.equal(readFileSync(join(foreign, "SKILL.md"), "utf8"), "user content");
// The unmanaged entry stays in the record so it can still be reviewed.
const after = await readSkillInstallRecord(home);
assert.deepEqual(after.map((r) => r.path), [foreign]);
} finally {
rmSync(home, { recursive: true, force: true });
rmSync(dir, { recursive: true, force: true });
}
});
test("installedSkillStatus and forgetSkillInstallRecords handle a missing directory", async () => {
const home = mkdtempSync(join(tmpdir(), "ra3-skill-missing-home-"));
const dir = mkdtempSync(join(tmpdir(), "ra3-skill-missing-"));
try {
const gone = join(dir, "gone");
await writeSkillInstallRecord([{ path: gone, sourceVersion: "1.0.0" }], home);
const status = await installedSkillStatus(home);
assert.equal(status.length, 1);
assert.equal(status[0].exists, false);
assert.equal(status[0].managed, false);
await forgetSkillInstallRecords([gone], home);
assert.equal((await readSkillInstallRecord(home)).length, 0);
} finally {
rmSync(home, { recursive: true, force: true });
rmSync(dir, { recursive: true, force: true });
}
});
+184
View File
@@ -0,0 +1,184 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { mkdtempSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { snapshotFromIndex, writeSnapshotFile, readSnapshotFile } from "../out/agent/snapshot.js";
import {
findAssets,
findReferenceGroups,
isFileActive,
listAssetsByType,
resolveIncludeSource,
statusFromSnapshot,
} from "../out/agent/query.js";
function makeStats() {
return {
projectDir: "P",
sdkDir: "",
phase: "art",
complete: true,
indexedFiles: 3,
parsedFiles: 2,
shallowScannedFiles: 1,
deferredArtFiles: 0,
shallowCacheHits: 0,
recordsCacheHits: 0,
resolveCacheHits: 0,
resolveCalls: 0,
snapshotHits: 0,
snapshotFallbacks: 0,
candidatesMs: 0,
walkMs: 0,
artScanMs: 0,
assetCount: 2,
referenceCount: 1,
defineCount: 1,
manifestFiles: 0,
manifestAssetCount: 0,
streams: 1,
sourceCandidates: 1,
elapsedMs: 1,
};
}
function makeIndex() {
const file = "D:/Mods/Example/Data/Units/Example.xml";
const assets = new Map([
[
"GameObject",
new Map([
[
"exampleunit",
[
{
type: "GameObject",
id: "ExampleUnit",
file,
line: 5,
origin: "project",
stream: "static",
},
],
],
]),
],
]);
const references = new Map([
[
"GameObject\u0000exampleunit\u0000D:/Mods/Example/Data/Units/Example.xml\u00005",
[
{
file: "D:/Mods/Example/Data/Other.xml",
line: 3,
start: 10,
end: 21,
kind: "attr",
},
],
],
]);
return {
projectDir: "D:/Mods/Example",
sdkDir: "",
complete: true,
phase: "art",
stale: false,
assets,
assetsById: new Map([
[
"exampleunit",
[
{
type: "GameObject",
id: "ExampleUnit",
file,
line: 5,
origin: "project",
stream: "static",
},
],
],
]),
defines: new Map([
[
"exampledefine",
[
{
name: "ExampleDefine",
value: "1",
file,
line: 2,
origin: "project",
},
],
],
]),
files: new Map(),
streams: [
{
name: "static",
entry: "D:/Mods/Example/Data/Mod.xml",
files: new Set(["d:/mods/example/data/units/example.xml"]),
},
],
manifests: new Map(),
sourceCandidates: [
{
source: "DATA:Units/Example.xml",
path: "D:/Mods/Example/Data/Units/Example.xml",
prefix: "DATA",
baseDir: "D:/Mods/Example/Data",
},
],
diagnostics: [],
references,
recordsHashes: new Map(),
stats: makeStats(),
};
}
test("snapshotFromIndex flattens assets, defines, streams and references", () => {
const snapshot = snapshotFromIndex(makeIndex(), 42);
assert.equal(snapshot.schemaVersion, 1);
assert.equal(snapshot.assets.length, 1);
assert.equal(snapshot.assets[0].id, "ExampleUnit");
assert.equal(snapshot.defines.length, 1);
assert.equal(snapshot.streams.length, 1);
assert.deepEqual(snapshot.streams[0].files, [
"d:/mods/example/data/units/example.xml",
]);
assert.equal(snapshot.references.length, 1);
assert.equal(snapshot.references[0].sites.length, 1);
assert.equal(snapshot.buildId, 42);
});
test("query helpers operate on snapshots", () => {
const snapshot = snapshotFromIndex(makeIndex(), 1);
assert.equal(findAssets(snapshot, "ExampleUnit").length, 1);
assert.equal(findAssets(snapshot, "exampleunit", "GameObject").length, 1);
assert.equal(findAssets(snapshot, "exampleunit", "WeaponTemplate").length, 0);
assert.equal(listAssetsByType(snapshot, "gameobject", "exa").length, 1);
assert.equal(findReferenceGroups(snapshot, "ExampleUnit").length, 1);
assert.equal(isFileActive(snapshot, "D:/Mods/Example/Data/Units/Example.xml"), true);
assert.equal(isFileActive(snapshot, "D:/Mods/Example/Data/Dead.xml"), false);
assert.equal(resolveIncludeSource(snapshot, "data:units/example.xml")?.path, "D:/Mods/Example/Data/Units/Example.xml");
assert.equal(statusFromSnapshot(snapshot).state, "ready");
});
test("snapshot file write/read round-trips", async () => {
const dir = mkdtempSync(join(tmpdir(), "ra3-agent-test-"));
try {
const file = join(dir, "snapshot.json.gz");
const snapshot = snapshotFromIndex(makeIndex(), 7);
await writeSnapshotFile(file, snapshot);
const loaded = await readSnapshotFile(file);
assert.ok(loaded);
assert.equal(loaded.assets.length, snapshot.assets.length);
assert.equal(loaded.references[0].sites[0].file, "D:/Mods/Example/Data/Other.xml");
assert.equal(loaded.buildId, 7);
} finally {
rmSync(dir, { recursive: true, force: true });
}
});
+318
View File
@@ -0,0 +1,318 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import {
assetDefsForCandidate,
assetOriginRank,
collectAssetSearchCandidates,
isEmptyAssetSearchQuery,
parseAssetSearchQuery,
searchAssetCandidates,
} from "../out/features/assetSearch.js";
function makeDef(type, id, file, line, extra = {}) {
return { type, id, file, line, origin: "project", ...extra };
}
function put(map, d) {
let byId = map.get(d.type);
if (!byId) {
byId = new Map();
map.set(d.type, byId);
}
const key = d.id.toLowerCase();
const arr = byId.get(key);
if (arr) arr.push(d);
else byId.set(key, [d]);
}
/** Minimal ModIndex surface used by the search core. */
function makeIndex({ assets = [], local = [] } = {}) {
const index = { assets: new Map() };
for (const d of assets) put(index.assets, d);
if (local.length) {
const localAssets = new Map();
for (const d of local) put(localAssets, d);
index.local = {
assets: localAssets,
assetsById: new Map(),
defines: new Map(),
};
}
return index;
}
const PROJECT = "D:/Mods/Corona";
const SDK = "C:/Apps/RA3-MODSDK-X";
test("parseAssetSearchQuery splits Type:Id, bare id and type-only queries", () => {
assert.deepEqual(parseAssetSearchQuery(" Assault "), {
raw: "Assault",
type: null,
id: "assault",
});
assert.deepEqual(parseAssetSearchQuery("WeaponTemplate:AssaultRifle"), {
raw: "WeaponTemplate:AssaultRifle",
type: "weapontemplate",
id: "assaultrifle",
});
assert.deepEqual(parseAssetSearchQuery("Weapon:"), {
raw: "Weapon:",
type: "weapon",
id: "",
});
// A bare leading colon is just an id search.
assert.deepEqual(parseAssetSearchQuery(":Assault"), {
raw: ":Assault",
type: null,
id: "assault",
});
// Manifest-style qualified names: type = first segment, id = last segment.
assert.deepEqual(parseAssetSearchQuery("W3DContainer:W3DContainer:AU"), {
raw: "W3DContainer:W3DContainer:AU",
type: "w3dcontainer",
id: "au",
});
});
test("parseAssetSearchQuery recognises empty queries", () => {
assert.ok(isEmptyAssetSearchQuery(parseAssetSearchQuery("")));
assert.ok(isEmptyAssetSearchQuery(parseAssetSearchQuery(" ")));
assert.ok(isEmptyAssetSearchQuery(parseAssetSearchQuery(":")));
assert.ok(!isEmptyAssetSearchQuery(parseAssetSearchQuery("Weapon:")));
});
test("collectAssetSearchCandidates dedupes type:id and counts definition sites", () => {
const index = makeIndex({
assets: [
makeDef("WeaponTemplate", "AssaultRifle", `${PROJECT}/Data/weapons.xml`, 4),
makeDef("WeaponTemplate", "AssaultRifle", `${PROJECT}/Data/weapons.xml`, 9),
makeDef("WeaponTemplate", "AssaultRifle", `${SDK}/builtmods/static.manifest`, 0, {
origin: "manifest",
manifestSource: "DATA:globaldata/weapon.xml",
}),
makeDef("GameObject", "AssaultRifle", `${PROJECT}/Data/units.xml`, 2),
],
});
const candidates = collectAssetSearchCandidates(index);
assert.equal(candidates.length, 2);
const weapon = candidates.find((c) => c.def.type === "WeaponTemplate");
assert.equal(weapon.definitionCount, 3);
// The mod definition wins over the manifest one.
assert.equal(weapon.def.origin, "project");
assert.equal(weapon.def.line, 4);
const gameObject = candidates.find((c) => c.def.type === "GameObject");
assert.equal(gameObject.definitionCount, 1);
});
test("collectAssetSearchCandidates merges the local overlay (unsaved wins)", () => {
const index = makeIndex({
assets: [makeDef("GameObject", "Tank", `${PROJECT}/Data/units.xml`, 12)],
local: [
makeDef("GameObject", "Tank", `${PROJECT}/Data/units.xml`, 12, {
stream: "local",
}),
makeDef("GameObject", "TankPrototype", `${PROJECT}/Data/units.xml`, 40, {
stream: "local",
}),
],
});
const byId = new Map(
collectAssetSearchCandidates(index).map((c) => [c.def.id, c]),
);
assert.equal(byId.size, 2);
assert.equal(byId.get("Tank").def.stream, "local");
// The same file+line from overlay and global index is one definition.
assert.equal(byId.get("Tank").definitionCount, 1);
assert.equal(byId.get("TankPrototype").definitionCount, 1);
});
test("assetOriginRank orders local, project, SDK and manifest definitions", () => {
assert.equal(assetOriginRank(makeDef("A", "a", "f", 1, { stream: "local" })), 0);
assert.equal(assetOriginRank(makeDef("A", "a", "f", 1)), 1);
assert.equal(assetOriginRank(makeDef("A", "a", "f", 1, { origin: "sdk" })), 2);
assert.equal(
assetOriginRank(makeDef("A", "a", "f", 1, { origin: "manifest" })),
3,
);
});
test("searchAssetCandidates finds exact, prefix and partial ids", () => {
const index = makeIndex({
assets: [
makeDef("GameObject", "CrateDebris_01", `${PROJECT}/Data/a.xml`, 1),
makeDef("GameObject", "CrateDebris_02", `${PROJECT}/Data/a.xml`, 5),
makeDef("GameObject", "MyCrateDebris", `${PROJECT}/Data/a.xml`, 9),
makeDef("GameObject", "Unrelated", `${PROJECT}/Data/a.xml`, 13),
],
});
const candidates = collectAssetSearchCandidates(index);
const exact = searchAssetCandidates(
candidates,
parseAssetSearchQuery("CrateDebris_02"),
);
assert.equal(exact.total, 1);
assert.equal(exact.matches[0].def.id, "CrateDebris_02");
const partial = searchAssetCandidates(
candidates,
parseAssetSearchQuery("cratedebris"),
);
assert.equal(partial.total, 3);
// Prefix matches rank before substring matches.
assert.deepEqual(
partial.matches.map((m) => m.def.id),
["CrateDebris_01", "CrateDebris_02", "MyCrateDebris"],
);
const mid = searchAssetCandidates(
candidates,
parseAssetSearchQuery("Debris"),
);
assert.equal(mid.total, 3);
});
test("searchAssetCandidates is case-insensitive and type-aware for bare queries", () => {
const index = makeIndex({
assets: [
makeDef("GameObject", "Tank", `${PROJECT}/Data/a.xml`, 1),
makeDef("WeaponTemplate", "TankGun", `${PROJECT}/Data/b.xml`, 1),
makeDef("GameObject", "OxTank", `${PROJECT}/Data/a.xml`, 5),
],
});
const candidates = collectAssetSearchCandidates(index);
const upper = searchAssetCandidates(candidates, parseAssetSearchQuery("TANK"));
assert.equal(upper.total, 3);
// A bare query that matches a type name lists that type's assets too.
const byType = searchAssetCandidates(
candidates,
parseAssetSearchQuery("GameObject"),
);
assert.equal(byType.total, 2);
assert.deepEqual(
byType.matches.map((m) => m.def.id).sort(),
["OxTank", "Tank"],
);
});
test("searchAssetCandidates honours Type:Id, Type: and prefixed queries", () => {
const index = makeIndex({
assets: [
makeDef("GameObject", "Tank", `${PROJECT}/Data/a.xml`, 1),
makeDef("GameObject", "TankPrototype", `${PROJECT}/Data/a.xml`, 5),
makeDef("WeaponTemplate", "TankGun", `${PROJECT}/Data/b.xml`, 1),
makeDef("WeaponTemplate", "AssaultRifle", `${PROJECT}/Data/b.xml`, 9),
],
});
const candidates = collectAssetSearchCandidates(index);
const typed = searchAssetCandidates(
candidates,
parseAssetSearchQuery("GameObject:Tank"),
);
assert.deepEqual(
typed.matches.map((m) => m.def.id),
["Tank", "TankPrototype"],
);
// Partial type names work as a filter as well.
const partialType = searchAssetCandidates(
candidates,
parseAssetSearchQuery("weapontemplate:assault"),
);
assert.equal(partialType.total, 1);
assert.equal(partialType.matches[0].def.id, "AssaultRifle");
// `Type:` lists every asset of that type.
const typeOnly = searchAssetCandidates(
candidates,
parseAssetSearchQuery("WeaponTemplate:"),
);
assert.equal(typeOnly.total, 2);
// A mismatching type excludes otherwise matching ids.
const mismatch = searchAssetCandidates(
candidates,
parseAssetSearchQuery("WeaponTemplate:Tank"),
);
assert.equal(mismatch.total, 1); // TankGun only (prefix), not GameObject Tank
assert.equal(mismatch.matches[0].def.id, "TankGun");
});
test("searchAssetCandidates ranks mod definitions before vanilla ones", () => {
const index = makeIndex({
assets: [
makeDef("WeaponTemplate", "AssaultRifle", `${SDK}/builtmods/static.manifest`, 0, {
origin: "manifest",
}),
makeDef("WeaponTemplate", "AssaultRifle", `${PROJECT}/Data/weapon.xml`, 7),
],
});
const candidates = collectAssetSearchCandidates(index);
const result = searchAssetCandidates(
candidates,
parseAssetSearchQuery("AssaultRifle"),
);
assert.equal(result.total, 1);
assert.equal(result.matches[0].def.origin, "project");
assert.equal(result.matches[0].definitionCount, 2);
});
test("searchAssetCandidates returns no rows for an empty query and caps results", () => {
const assets = [];
for (let i = 0; i < 25; i++) {
assets.push(
makeDef("GameObject", `Target_${String(i).padStart(2, "0")}`, "f", i + 1),
);
}
const candidates = collectAssetSearchCandidates(makeIndex({ assets }));
const empty = searchAssetCandidates(candidates, parseAssetSearchQuery(""));
assert.equal(empty.total, 0);
assert.equal(empty.matches.length, 0);
const all = searchAssetCandidates(candidates, parseAssetSearchQuery("Target"));
assert.equal(all.total, 25);
assert.equal(all.matches.length, 25);
const capped = searchAssetCandidates(
candidates,
parseAssetSearchQuery("Target"),
10,
);
assert.equal(capped.total, 25);
assert.equal(capped.matches.length, 10);
});
test("assetDefsForCandidate lists distinct sites, local overlay first", () => {
const index = makeIndex({
assets: [
makeDef("GameObject", "Tank", `${PROJECT}/Data/units.xml`, 3),
makeDef("GameObject", "Tank", `${SDK}/SageXml/units.xml`, 1, {
origin: "sdk",
}),
makeDef("GameObject", "Tank", `${SDK}/SageXml/units.xml`, 1, {
origin: "sdk",
}),
],
local: [
makeDef("GameObject", "Tank", `${PROJECT}/Data/units.xml`, 3, {
stream: "local",
}),
],
});
const candidate = collectAssetSearchCandidates(index).find(
(c) => c.def.id === "Tank",
);
const defs = assetDefsForCandidate(index, candidate);
assert.equal(defs.length, 2);
assert.equal(defs[0].stream, "local");
assert.equal(defs[1].origin, "sdk");
});
+33 -3
View File
@@ -4,11 +4,15 @@ import {
DocumentCache,
IncludeResolveCache,
IndexRecordsCache,
InvalidationsEpoch,
} from "../out/indexer/caches.js";
import { resolve } from "node:path";
const stat = { mtimeMs: 1, size: 1, birthtimeMs: 1, ctimeMs: 1 };
function parsed(path, elements) {
return {
file: { path, stat: { mtimeMs: 1, size: 1 } },
file: { path, stat },
parse: { root: { name: "r" }, elements: new Array(elements), errors: [] },
records: null,
lineMap: null,
@@ -47,8 +51,8 @@ test("DocumentCache invalidate frees budget", () => {
test("IndexRecordsCache stores and invalidates entries", () => {
const cache = new IndexRecordsCache();
const entry = {
stat: { mtimeMs: 1, size: 1 },
records: { assets: [], defines: [], includes: [], rootXiIncludes: [], nestedXiIncludes: [] },
stat,
records: { assets: [], defines: [], includes: [], rootXiIncludes: [], nestedXiIncludes: [], references: [] },
kind: "full",
};
cache.set("a.xml", entry);
@@ -57,6 +61,20 @@ test("IndexRecordsCache stores and invalidates entries", () => {
assert.equal(cache.get("a.xml"), undefined);
});
test("IndexRecordsCache exposes entries for disk persistence", () => {
const cache = new IndexRecordsCache();
const entry = {
stat,
records: { assets: [], defines: [], includes: [], rootXiIncludes: [], nestedXiIncludes: [], references: [] },
kind: "full",
};
cache.set("a.xml", entry);
const list = [...cache.entries()];
assert.equal(list.length, 1);
assert.equal(list[0][0], resolve("a.xml").toLowerCase());
assert.equal(list[0][1], entry);
});
test("IncludeResolveCache stores sources and manifest lookups", () => {
const cache = new IncludeResolveCache();
const key = "dir|DATA:static.xml";
@@ -71,3 +89,15 @@ test("IncludeResolveCache stores sources and manifest lookups", () => {
assert.equal(cache.get(key), undefined);
assert.equal(cache.getManifest("static.xml"), undefined);
});
test("InvalidationsEpoch tracks changes since a snapshot", () => {
const epoch = new InvalidationsEpoch();
const before = epoch.snapshot();
assert.equal(epoch.changedSince(before), false);
epoch.mark();
assert.equal(epoch.changedSince(before), true);
assert.equal(epoch.changedSince(epoch.snapshot()), false);
epoch.mark();
epoch.mark();
assert.equal(epoch.current, 3);
});
+290
View File
@@ -0,0 +1,290 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { createRequire } from "node:module";
import { fileURLToPath } from "node:url";
import { dirname, join, resolve } from "node:path";
// Minimal vscode shim: the CodeLens provider only constructs CodeLens/Range.
class Range {
constructor(start, end) {
this.start = start;
this.end = end;
}
}
class CodeLens {
constructor(range, command) {
this.range = range;
this.command = command;
}
}
class EventEmitter {
constructor() {
this.listeners = [];
this.event = (listener) => {
this.listeners.push(listener);
return { dispose: () => {} };
};
}
fire() {
for (const listener of this.listeners) listener();
}
}
const require = createRequire(import.meta.url);
const Module = require("module");
const origResolve = Module._resolveFilename;
Module._resolveFilename = function (request, ...args) {
if (request === "vscode") return "vscode-stub";
return origResolve.call(this, request, ...args);
};
require.cache["vscode-stub"] = {
id: "vscode-stub",
filename: "vscode-stub",
loaded: true,
exports: {
Range,
CodeLens,
EventEmitter,
},
};
const { Ra3CodeLensProvider } = require("../out/features/codeLens.js");
const { assetDefKey } = require("../out/indexer/referenceIndex.js");
const { normKey } = require("../out/indexer/caches.js");
const root = dirname(dirname(fileURLToPath(import.meta.url)));
const PROJECT = join(root, "test", "fixtures", "minimod");
const SDK = join(root, "test", "fixtures", "fakesdk");
// A real file whose path matches what DATA:Includes/Units.xml resolves to.
const FILE = resolve(join(PROJECT, "Data", "Includes", "Units.xml"));
const TEXT = `<AssetDeclaration>
<GameObject id="TestTank"/>
<GameObject id="BaseVehicle"/>
<CameraSettings id="S"/>
</AssetDeclaration>`;
function makeDocument(text = TEXT) {
const lineStarts = [0];
for (let i = 0; i < text.length; i++) {
if (text.charCodeAt(i) === 10) lineStarts.push(i + 1);
}
return {
uri: { fsPath: FILE },
getText: () => text,
positionAt: (offset) => {
let lo = 0;
let hi = lineStarts.length - 1;
while (lo < hi) {
const mid = (lo + hi + 1) >> 1;
if (lineStarts[mid] <= offset) lo = mid;
else hi = mid - 1;
}
return { line: lo, character: offset - lineStarts[lo] };
},
};
}
function makeIndex() {
const tankDef = {
type: "GameObject",
id: "TestTank",
file: FILE,
line: 2,
origin: "project",
};
const baseDef = {
type: "GameObject",
id: "BaseVehicle",
file: FILE,
line: 3,
origin: "project",
};
const tankSite = {
file: "C:/mod/Data/Other.xml",
line: 7,
start: 40,
end: 48,
kind: "content",
};
const secondSite = {
file: "C:/mod/Data/Third.xml",
line: 2,
start: 12,
end: 20,
kind: "attr",
};
const references = new Map();
references.set(
assetDefKey(tankDef),
[tankSite, secondSite],
);
references.set(assetDefKey(baseDef), []);
return {
references,
assets: new Map(),
assetsById: new Map([
["testtank", [tankDef]],
["basevehicle", [baseDef]],
]),
stats: { indexedFiles: 10 },
sdkDir: SDK,
projectDir: PROJECT,
};
}
test("CodeLens shows counts on reference-target types only, including zero", async () => {
const idx = makeIndex();
const provider = new Ra3CodeLensProvider({
isRa3Workspace: () => true,
index: idx,
getCodeLensScope: async () => ({ merged: idx }),
recordsSyncSurfaceFor: () => ({}),
log: () => {},
});
const lenses = await provider.provideCodeLenses(makeDocument(), {});
assert.equal(lenses.length, 2, "no lens for auto-registered CameraSettings");
const tank = lenses.find((l) => l.command.arguments[0].id === "TestTank");
const base = lenses.find((l) => l.command.arguments[0].id === "BaseVehicle");
assert.ok(tank, "GameObject TestTank gets a lens");
assert.equal(tank.command.title, "2 references");
assert.equal(tank.command.command, "ra3modxml.showReferences");
assert.equal(tank.command.arguments[0].type, "GameObject");
assert.equal(tank.command.arguments[0].line, 2);
assert.ok(base, "zero is still displayed for reference-target types");
assert.equal(base.command.title, "0 references");
// Lenses anchor on the element start tag.
assert.equal(tank.range.start.line, 1);
assert.ok(tank.range.start.character < tank.range.end.character);
});
test("CodeLens returns nothing without a workspace or index", async () => {
const noWorkspace = new Ra3CodeLensProvider({
isRa3Workspace: () => false,
index: makeIndex(),
});
assert.deepEqual(await noWorkspace.provideCodeLenses(makeDocument(), {}), []);
const noIndex = new Ra3CodeLensProvider({
isRa3Workspace: () => true,
index: null,
getCodeLensScope: async () => ({ merged: null }),
recordsSyncSurfaceFor: () => ({}),
log: () => {},
});
assert.deepEqual(await noIndex.provideCodeLenses(makeDocument(), {}), []);
});
test("CodeLens hides lenses before the first global snapshot", async () => {
const localOnly = {
complete: false,
stats: { indexedFiles: 0 },
references: new Map(),
};
const logs = [];
const provider = new Ra3CodeLensProvider({
isRa3Workspace: () => true,
getCodeLensScope: async () => ({ merged: localOnly }),
recordsSyncSurfaceFor: () => ({}),
log: (m) => logs.push(m),
});
assert.deepEqual(await provider.provideCodeLenses(makeDocument(), {}), []);
assert.deepEqual(await provider.provideCodeLenses(makeDocument(), {}), []);
assert.equal(
logs.filter((m) => m.includes("suppressed")).length,
1,
"suppression is logged once per document",
);
provider.resetSuppressionLog();
await provider.provideCodeLenses(makeDocument(), {});
assert.equal(
logs.filter((m) => m.includes("suppressed")).length,
2,
"reset allows re-logging after a new snapshot",
);
});
test("CodeLens refresh fires onDidChangeCodeLenses", () => {
const provider = new Ra3CodeLensProvider({
isRa3Workspace: () => true,
getCodeLensScope: async () => ({ merged: null }),
recordsSyncSurfaceFor: () => ({}),
log: () => {},
});
let fired = 0;
const subscription = provider.onDidChangeCodeLenses(() => {
fired++;
});
provider.refresh();
assert.equal(fired, 1);
subscription.dispose();
});
test("CodeLens counts references attached to a manifest definition with the same SageXml source", async () => {
const manifestDef = {
type: "GameObject",
id: "TestTank",
file: resolve(join(SDK, "builtmods", "static.manifest")),
line: 0,
origin: "manifest",
manifestSource: "DATA:Includes/Units.xml",
};
const site = {
file: "C:/mod/Data/Other.xml",
line: 7,
start: 40,
end: 48,
kind: "content",
};
const references = new Map();
references.set(assetDefKey(manifestDef), [site]);
const idx = {
references,
assets: new Map([
["GameObject", new Map([["testtank", [manifestDef]]])],
]),
assetsById: new Map([["testtank", [manifestDef]]]),
stats: { indexedFiles: 10 },
sdkDir: SDK,
projectDir: PROJECT,
};
const provider = new Ra3CodeLensProvider({
isRa3Workspace: () => true,
index: idx,
getCodeLensScope: async () => ({ merged: idx }),
recordsSyncSurfaceFor: () => ({}),
log: () => {},
});
const lenses = await provider.provideCodeLenses(makeDocument(), {});
const tank = lenses.find((l) => l.command.arguments[0].id === "TestTank");
assert.ok(tank, "lens is shown for the SageXml-backed definition");
assert.equal(tank.command.title, "1 reference");
});
test("CodeLens schedules a targeted rebuild when the open document desyncs from the snapshot", async () => {
const idx = makeIndex();
idx.recordsHashes = new Map([[normKey(FILE), "stale-hash"]]);
const calls = [];
const ws = {
isRa3Workspace: () => true,
index: idx,
invalidate: (p) => calls.push(["invalidate", p]),
scheduleRebuild: (r) => calls.push(["schedule", r]),
getCodeLensScope: async () => ({ merged: idx }),
recordsSyncSurfaceFor: () => ws,
log: () => {},
};
const provider = new Ra3CodeLensProvider(ws);
await provider.provideCodeLenses(makeDocument(), {});
assert.ok(
calls.some(([kind]) => kind === "invalidate"),
"the stale file is invalidated",
);
assert.ok(
calls.some(([kind, reason]) => kind === "schedule" && reason === "records-desync"),
"a targeted rebuild is scheduled",
);
});
File diff suppressed because it is too large Load Diff
+776
View File
@@ -0,0 +1,776 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { createRequire } from "node:module";
import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
import { dirname, join } from "node:path";
import { tmpdir } from "node:os";
// Minimal vscode shim for hover / definition / diagnostics providers.
const CompletionItemKind = {};
class Position {
constructor(line, character) {
this.line = line;
this.character = character;
}
}
class Range {
constructor(start, end) {
this.start = start;
this.end = end;
}
}
class MarkdownString {
constructor(value) {
this.value = value ?? "";
}
appendMarkdown(text) {
this.value += text;
return this;
}
appendCodeblock(text) {
this.value += "\n```\n" + text + "\n```\n";
return this;
}
}
class Hover {
constructor(contents) {
this.contents = contents;
}
}
class Location {
constructor(uri, range) {
this.uri = uri;
this.range = range instanceof Position ? new Range(range, range) : range;
}
}
class Diagnostic {
constructor(range, message, severity) {
this.range = range;
this.message = message;
this.severity = severity;
}
}
class FakeDiagnosticCollection {
constructor() {
this.last = null;
}
set(uri, diags) {
this.last = { uri, diags };
}
delete() {}
dispose() {}
}
const Uri = {
file: (p) => ({ fsPath: p }),
};
const workspace = {
getWorkspaceFolder: (uri) => ({ uri: { fsPath: "C:/mod" } }),
};
const languages = {
createDiagnosticCollection: () => new FakeDiagnosticCollection(),
};
const require = createRequire(import.meta.url);
const Module = require("module");
const origResolve = Module._resolveFilename;
Module._resolveFilename = function (request, ...args) {
if (request === "vscode") return "vscode-stub";
return origResolve.call(this, request, ...args);
};
require.cache["vscode-stub"] = {
id: "vscode-stub",
filename: "vscode-stub",
loaded: true,
exports: {
CompletionItemKind,
Position,
Range,
MarkdownString,
Hover,
Location,
Diagnostic,
DiagnosticSeverity: { Error: 0, Warning: 1, Information: 2, Hint: 3 },
Uri,
workspace,
languages,
},
};
const { Ra3HoverProvider } = require("../out/features/hover.js");
const { Ra3DefinitionProvider } = require("../out/features/navigation.js");
const { Ra3Diagnostics } = require("../out/features/diagnostics.js");
const { parseXml, LineMap } = require("../out/language/xmlParser.js");
const { expandDocument } = require("../out/indexer/logicalTree.js");
const URI = "C:/mod/Data/Crates.xml";
function makeDocument(text, uri = URI) {
const lineStarts = [0];
for (let i = 0; i < text.length; i++) {
if (text.charCodeAt(i) === 10) lineStarts.push(i + 1);
}
return {
uri: { fsPath: uri },
getText: () => text,
offsetAt: (pos) => lineStarts[pos.line] + pos.character,
positionAt: (offset) => {
let lo = 0;
let hi = lineStarts.length - 1;
while (lo < hi) {
const mid = (lo + hi + 1) >> 1;
if (lineStarts[mid] <= offset) lo = mid;
else hi = mid - 1;
}
return new Position(lo, offset - lineStarts[lo]);
},
};
}
async function makeScope(text, idx) {
const lineMap = new LineMap(text);
const parse = parseXml(text);
const expanded = await expandDocument(URI, parse, {
resolve: () => null,
readDom: async () => null,
});
return {
uri: URI,
version: 1,
parse,
lineMap,
expanded,
lineMaps: new Map(),
overlay: {},
merged: idx,
};
}
function makeIdx(defs) {
const assets = new Map();
const assetsById = new Map();
for (const def of defs) {
const idKey = def.id.toLowerCase();
let byId = assets.get(def.type);
if (!byId) {
byId = new Map();
assets.set(def.type, byId);
}
byId.set(idKey, [def]);
assetsById.set(idKey, [def]);
}
return {
assets,
assetsById,
defines: new Map(),
projectDir: "C:/mod",
sdkDir: "C:/sdk",
files: new Map(),
streams: [],
manifests: new Map(),
sourceCandidates: [],
diagnostics: [],
stats: {},
};
}
const TEXT =
`<AssetDeclaration>\n` +
` <GameObject id="CrateDebris_01"/>\n` +
` <ObjectCreationList id="OCL_CrateSpawn">\n` +
` <CreateObject>\n` +
` <CreateObject>CrateDebris_01</CreateObject>\n` +
` </CreateObject>\n` +
` </ObjectCreationList>\n` +
`</AssetDeclaration>`;
test("hover on simple-content text shows the referenced definition", async () => {
const def = {
type: "GameObject",
id: "CrateDebris_01",
file: URI,
line: 2,
origin: "project",
};
const idx = makeIdx([def]);
const scope = await makeScope(TEXT, idx);
const provider = new Ra3HoverProvider({
isRa3Workspace: () => true,
getScope: async () => scope,
searchPaths: () => null,
});
const line = TEXT.split("\n")[4];
const pos = new Position(4, line.indexOf("CrateDebris_01") + 3);
const hover = await provider.provideHover(makeDocument(TEXT), pos, {});
assert.ok(hover, "hover is returned for typed content text");
assert.match(hover.contents.value, /1 definition/);
assert.match(hover.contents.value, /GameObject/);
});
test("Ctrl+click on simple-content text jumps to the definition", async () => {
const def = {
type: "GameObject",
id: "CrateDebris_01",
file: URI,
line: 2,
origin: "project",
};
const scope = await makeScope(TEXT, makeIdx([def]));
const provider = new Ra3DefinitionProvider({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: { definitionMode: "all" },
indexer: null,
});
const line = TEXT.split("\n")[4];
const pos = new Position(4, line.indexOf("CrateDebris_01") + 3);
const locations = await provider.provideDefinition(makeDocument(TEXT), pos, {});
assert.ok(locations && locations.length === 1, "content definition resolves");
const defStart = TEXT.indexOf('id="CrateDebris_01"') + 'id="'.length;
const defEnd = defStart + "CrateDebris_01".length;
assert.deepEqual(
{
start: locations[0].range.start,
end: locations[0].range.end,
},
{
start: makeDocument(TEXT).positionAt(defStart),
end: makeDocument(TEXT).positionAt(defEnd),
},
);
});
test("qualified Type:Id inheritFrom is diagnosed and navigated as resolved", async () => {
const text =
`<AssetDeclaration xmlns="uri:ea.com:eala:asset">\n` +
` <AudioEvent id="BaseSoundEffect"/>\n` +
` <AudioEvent id="X" inheritFrom="AudioEvent:BaseSoundEffect"/>\n` +
`</AssetDeclaration>`;
const def = {
type: "AudioEvent",
id: "BaseSoundEffect",
file: URI,
line: 1,
origin: "project",
};
const idx = makeIdx([def]);
const scope = await makeScope(text, idx);
// Diagnostics: the manifest-style qualified value must not be reported as
// an unresolved reference (the reported FutureTank scenario).
const collection = new FakeDiagnosticCollection();
const diagnostics = new Ra3Diagnostics({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: {
diagnoseUnknownElements: false,
reportUnresolvedReferences: "warning",
},
});
diagnostics["collection"] = collection;
await diagnostics.update(makeDocument(text));
const messages = collection.last.diags.map((d) => d.message);
assert.ok(
!messages.some((m) => m.includes("AudioEvent:BaseSoundEffect")),
"qualified inheritFrom is not unresolved",
);
// Ctrl+click on the qualified value jumps to the plain-id definition.
const provider = new Ra3DefinitionProvider({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: { definitionMode: "all" },
indexer: null,
});
const line = text.split("\n")[2];
const pos = new Position(2, line.indexOf("AudioEvent:BaseSoundEffect") + 8);
const locations = await provider.provideDefinition(makeDocument(text), pos, {});
assert.ok(locations && locations.length === 1, "qualified reference resolves");
const defLine = text.split("\n")[1];
const defStartChar =
defLine.indexOf('id="BaseSoundEffect"') + 'id="'.length;
assert.equal(locations[0].range.start.line, 1);
assert.equal(locations[0].range.start.character, defStartChar);
assert.equal(
locations[0].range.end.character,
defStartChar + "BaseSoundEffect".length,
);
});
test("hover on simpleContent complex content shows the referenced definition", async () => {
const text =
`<AssetDeclaration>\n` +
` <AudioEvent id="A">\n` +
` <Sound>VoiceFile</Sound>\n` +
` </AudioEvent>\n` +
`</AssetDeclaration>`;
const def = {
type: "AudioFile",
id: "VoiceFile",
file: URI,
line: 2,
origin: "project",
};
const scope = await makeScope(text, makeIdx([def]));
const provider = new Ra3HoverProvider({
isRa3Workspace: () => true,
getScope: async () => scope,
searchPaths: () => null,
});
const line = text.split("\n")[2];
const pos = new Position(2, line.indexOf("VoiceFile") + 3);
const hover = await provider.provideHover(makeDocument(text), pos, {});
assert.ok(hover, "hover is returned for AudioFileRefWithWeight content");
assert.match(hover.contents.value, /1 definition/);
assert.match(hover.contents.value, /AudioFile/);
});
test("Ctrl+click on simpleContent complex content jumps to the definition", async () => {
const text =
`<AssetDeclaration>\n` +
` <AudioEvent id="A">\n` +
` <Sound>VoiceFile</Sound>\n` +
` </AudioEvent>\n` +
`</AssetDeclaration>`;
const def = {
type: "AudioFile",
id: "VoiceFile",
file: URI,
line: 2,
origin: "project",
};
const scope = await makeScope(text, makeIdx([def]));
const provider = new Ra3DefinitionProvider({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: { definitionMode: "all" },
indexer: null,
});
const line = text.split("\n")[2];
const pos = new Position(2, line.indexOf("VoiceFile") + 3);
const locations = await provider.provideDefinition(makeDocument(text), pos, {});
assert.ok(locations && locations.length === 1);
assert.equal(locations[0].uri.fsPath, URI);
});
test("diagnostics report unresolved simpleContent complex content references", async () => {
const text =
`<AssetDeclaration>\n` +
` <Multisound id="M">\n` +
` <Subsound>MissingEvent</Subsound>\n` +
` </Multisound>\n` +
`</AssetDeclaration>`;
const scope = await makeScope(text, makeIdx([]));
const collection = new FakeDiagnosticCollection();
const provider = new Ra3Diagnostics({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: {
diagnoseUnknownElements: false,
reportUnresolvedReferences: "warning",
},
});
provider["collection"] = collection;
await provider.update(makeDocument(text));
const messages = collection.last.diags.map((d) => d.message);
assert.ok(
messages.some((m) => m.includes('Unresolved reference "MissingEvent"')),
"MultisoundSubsoundRef text is diagnosed as a typed content reference",
);
});
test("Ctrl+click on a manifest definition maps to SageXml even when the mod shadows the DATA path", async () => {
const tmp = mkdtempSync(join(tmpdir(), "ra3-nav-manifest-"));
try {
const sdkDir = join(tmp, "sdk");
const projectDir = join(tmp, "project");
const sageFile = join(sdkDir, "SageXml", "globaldata", "weapon.xml");
const modFile = join(projectDir, "Data", "globaldata", "weapon.xml");
mkdirSync(dirname(sageFile), { recursive: true });
mkdirSync(dirname(modFile), { recursive: true });
writeFileSync(
sageFile,
'<AssetDeclaration xmlns="uri:ea.com:eala:asset"><GameObject id="AlliedCommandoDesertEagles"/></AssetDeclaration>',
"utf8",
);
writeFileSync(
modFile,
'<AssetDeclaration xmlns="uri:ea.com:eala:asset"><GameObject id="ModOnly"/></AssetDeclaration>',
"utf8",
);
const manifestDef = {
type: "GameObject",
id: "AlliedCommandoDesertEagles",
file: join(sdkDir, "builtmods", "static.manifest"),
line: 0,
origin: "manifest",
manifestSource: "DATA:globaldata/weapon.xml",
};
const idx = makeIdx([manifestDef]);
idx.projectDir = projectDir;
idx.sdkDir = sdkDir;
const text =
'<AssetDeclaration xmlns="uri:ea.com:eala:asset">\n' +
' <GameObject id="MyUnit" inheritFrom="AlliedCommandoDesertEagles"/>\n' +
"</AssetDeclaration>";
const scope = await makeScope(text, idx);
const provider = new Ra3DefinitionProvider({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: { definitionMode: "all" },
indexer: { readDom: async () => null },
});
const line = text.split("\n")[1];
const pos = new Position(
1,
line.indexOf("AlliedCommandoDesertEagles") + 3,
);
const locations = await provider.provideDefinition(makeDocument(text), pos, {});
assert.ok(locations && locations.length === 1, "manifest definition resolves");
assert.equal(
locations[0].uri.fsPath,
sageFile,
"manifest source must resolve to SageXml, not the mod shadow file",
);
} finally {
rmSync(tmp, { recursive: true, force: true });
}
});
test("manifest definition stays manifest-only when the SageXml source is missing", async () => {
const tmp = mkdtempSync(join(tmpdir(), "ra3-nav-manifest-missing-"));
try {
const sdkDir = join(tmp, "sdk");
const projectDir = join(tmp, "project");
const modFile = join(projectDir, "Data", "globaldata", "weapon.xml");
mkdirSync(dirname(modFile), { recursive: true });
writeFileSync(
modFile,
'<AssetDeclaration xmlns="uri:ea.com:eala:asset"><GameObject id="AlliedCommandoDesertEagles"/></AssetDeclaration>',
"utf8",
);
const manifestDef = {
type: "GameObject",
id: "AlliedCommandoDesertEagles",
file: join(sdkDir, "builtmods", "static.manifest"),
line: 0,
origin: "manifest",
manifestSource: "DATA:globaldata/weapon.xml",
};
const idx = makeIdx([manifestDef]);
idx.projectDir = projectDir;
idx.sdkDir = sdkDir;
const text =
'<AssetDeclaration xmlns="uri:ea.com:eala:asset">\n' +
' <GameObject id="MyUnit" inheritFrom="AlliedCommandoDesertEagles"/>\n' +
"</AssetDeclaration>";
const scope = await makeScope(text, idx);
const provider = new Ra3DefinitionProvider({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: { definitionMode: "all" },
indexer: { readDom: async () => null },
});
const line = text.split("\n")[1];
const pos = new Position(
1,
line.indexOf("AlliedCommandoDesertEagles") + 3,
);
const locations = await provider.provideDefinition(makeDocument(text), pos, {});
assert.equal(
locations,
null,
"missing vanilla source must not fall back to the mod shadow file",
);
} finally {
rmSync(tmp, { recursive: true, force: true });
}
});
test("manifest definition opens the SageXml file at the top when the id is no longer there", async () => {
const tmp = mkdtempSync(join(tmpdir(), "ra3-nav-manifest-stale-"));
try {
const sdkDir = join(tmp, "sdk");
const projectDir = join(tmp, "project");
const sageFile = join(sdkDir, "SageXml", "globaldata", "weapon.xml");
const modFile = join(projectDir, "Data", "globaldata", "weapon.xml");
mkdirSync(dirname(sageFile), { recursive: true });
mkdirSync(dirname(modFile), { recursive: true });
writeFileSync(
sageFile,
'<AssetDeclaration xmlns="uri:ea.com:eala:asset"/>',
"utf8",
);
writeFileSync(
modFile,
'<AssetDeclaration xmlns="uri:ea.com:eala:asset"><GameObject id="AlliedCommandoDesertEagles"/></AssetDeclaration>',
"utf8",
);
const manifestDef = {
type: "GameObject",
id: "AlliedCommandoDesertEagles",
file: join(sdkDir, "builtmods", "static.manifest"),
line: 0,
origin: "manifest",
manifestSource: "DATA:globaldata/weapon.xml",
};
const idx = makeIdx([manifestDef]);
idx.projectDir = projectDir;
idx.sdkDir = sdkDir;
const text =
'<AssetDeclaration xmlns="uri:ea.com:eala:asset">\n' +
' <GameObject id="MyUnit" inheritFrom="AlliedCommandoDesertEagles"/>\n' +
"</AssetDeclaration>";
const scope = await makeScope(text, idx);
const provider = new Ra3DefinitionProvider({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: { definitionMode: "all" },
indexer: { readDom: async () => null },
});
const line = text.split("\n")[1];
const pos = new Position(
1,
line.indexOf("AlliedCommandoDesertEagles") + 3,
);
const locations = await provider.provideDefinition(makeDocument(text), pos, {});
assert.ok(locations && locations.length === 1);
assert.equal(locations[0].uri.fsPath, sageFile);
assert.equal(locations[0].range.start.line, 0);
assert.equal(locations[0].range.start.character, 0);
} finally {
rmSync(tmp, { recursive: true, force: true });
}
});
test("diagnostics report unresolved typed content references only", async () => {
const text =
`<AssetDeclaration>\n` +
` <GameObject id="CrateDebris_01"/>\n` +
` <ObjectFilter>\n` +
` <IncludeThing>SomeValue</IncludeThing>\n` +
` </ObjectFilter>\n` +
` <ObjectCreationList id="OCL">\n` +
` <CreateObject>\n` +
` <CreateObject>CrateDebris_01</CreateObject>\n` +
` <CreateObject>MissingThing</CreateObject>\n` +
` </CreateObject>\n` +
` </ObjectCreationList>\n` +
`</AssetDeclaration>`;
const def = {
type: "GameObject",
id: "CrateDebris_01",
file: URI,
line: 2,
origin: "project",
};
const scope = await makeScope(text, makeIdx([def]));
const collection = new FakeDiagnosticCollection();
const provider = new Ra3Diagnostics({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: {
diagnoseUnknownElements: false,
reportUnresolvedReferences: "warning",
},
});
provider["collection"] = collection;
await provider.update(makeDocument(text));
const messages = collection.last.diags.map((d) => d.message);
assert.ok(
messages.some((m) => m.includes('Unresolved reference "MissingThing"')),
"typed content refs are diagnosed",
);
assert.ok(
!messages.some((m) => m.includes("SomeValue")),
"untyped WeakReference content is not diagnosed as a global ref",
);
});
test("fragment diagnostics skip document-level checks but keep subtree validation", async () => {
const text =
`<CreateObjectDie xmlns="uri:ea.com:eala:asset" id="ModuleTag_X" CreationList="OCL_X">\n` +
` <DieMuxData DeathTypo="SUICIDED"/>\n` +
`</CreateObjectDie>`;
const scope = await makeScope(text, makeIdx([]));
const collection = new FakeDiagnosticCollection();
const provider = new Ra3Diagnostics({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: {
diagnoseUnknownElements: true,
reportUnresolvedReferences: "warning",
},
});
provider["collection"] = collection;
await provider.update(makeDocument(text));
const codes = collection.last.diags.map((d) => d.code);
assert.ok(
!codes.includes("missing-id"),
"fragment children are not treated as top-level assets",
);
assert.ok(
!codes.some((c) => c.startsWith("unresolved-reference")),
"fragment references are deferred to the includer context",
);
assert.ok(
codes.includes("unknown-attribute"),
"a known fragment root still validates its subtree attributes",
);
});
test("fragment diagnostics ignore unknown wrapper roots and still report missing xi:include", async () => {
const text =
`<CommonArmorDraws xmlns="uri:ea.com:eala:asset" xmlns:xi="http://www.w3.org/2001/XInclude">\n` +
` <ScriptedModelDraw id="M" Bogus="x"/>\n` +
` <xi:include href="MissingTarget.xml"/>\n` +
`</CommonArmorDraws>`;
const scope = await makeScope(text, makeIdx([]));
const collection = new FakeDiagnosticCollection();
const provider = new Ra3Diagnostics({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: {
diagnoseUnknownElements: true,
reportUnresolvedReferences: "warning",
},
});
provider["collection"] = collection;
await provider.update(makeDocument(text));
const codes = collection.last.diags.map((d) => d.code);
assert.ok(
!codes.includes("unknown-element"),
"wrapper roots are not validated as standalone documents",
);
assert.ok(
!codes.includes("unknown-attribute"),
"unknown wrapper roots do not trigger subtree attribute guessing",
);
assert.ok(
codes.includes("include-not-found"),
"missing xi:include targets inside fragments are still reported",
);
});
test("diagnostics accept universal inheritFrom on asset types", async () => {
const text =
`<AssetDeclaration>\n` +
` <FXList id="FX_A" inheritFrom="FX_Base">\n` +
` <NuggetList/>\n` +
` </FXList>\n` +
`</AssetDeclaration>`;
const scope = await makeScope(text, makeIdx([]));
const collection = new FakeDiagnosticCollection();
const provider = new Ra3Diagnostics({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: {
diagnoseUnknownElements: true,
reportUnresolvedReferences: "none",
},
});
provider["collection"] = collection;
await provider.update(makeDocument(text));
const codes = collection.last.diags.map((d) => d.code);
assert.ok(
!codes.includes("unknown-attribute"),
"FXList inheritFrom must not be flagged as unknown",
);
const badText =
`<AssetDeclaration>\n` +
` <FXList id="FX_B" Bogus="x">\n` +
` <NuggetList/>\n` +
` </FXList>\n` +
`</AssetDeclaration>`;
const badScope = await makeScope(badText, makeIdx([]));
const badCollection = new FakeDiagnosticCollection();
const badProvider = new Ra3Diagnostics({
isRa3Workspace: () => true,
getScope: async () => badScope,
settings: {
diagnoseUnknownElements: true,
reportUnresolvedReferences: "none",
},
});
badProvider["collection"] = badCollection;
await badProvider.update(makeDocument(badText));
assert.ok(
badCollection.last.diags.map((d) => d.code).includes("unknown-attribute"),
"a real unknown attribute is still reported",
);
});
test("diagnostics keep simpleContent extension attributes known", async () => {
const text =
`<AssetDeclaration>\n` +
` <AudioEvent id="A">\n` +
` <Sound Weight="100">AudioFile</Sound>\n` +
` </AudioEvent>\n` +
`</AssetDeclaration>`;
const scope = await makeScope(text, makeIdx([]));
const collection = new FakeDiagnosticCollection();
const provider = new Ra3Diagnostics({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: {
diagnoseUnknownElements: true,
reportUnresolvedReferences: "none",
},
});
provider["collection"] = collection;
await provider.update(makeDocument(text));
const codes = collection.last.diags.map((d) => d.code);
assert.ok(
!codes.includes("unknown-attribute"),
"Weight on AudioFileRefWithWeight must be known",
);
});
test("diagnostics use the top-level asset type for colliding fragment roots", async () => {
const text =
`<EvaEvent id="IncomingTransmission" Priority="100" TimeBetweenEvents="0ms" ExpirationTime="10000ms"/>`;
const scope = await makeScope(text, makeIdx([]));
const collection = new FakeDiagnosticCollection();
const provider = new Ra3Diagnostics({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: {
diagnoseUnknownElements: true,
reportUnresolvedReferences: "none",
},
});
provider["collection"] = collection;
await provider.update(makeDocument(text));
const codes = collection.last.diags.map((d) => d.code);
assert.ok(
!codes.includes("unknown-attribute"),
"EvaEvent fragment root attributes must resolve against the top-level asset type",
);
});
test("full documents still require ids on top-level assets", async () => {
const text = `<AssetDeclaration>\n <GameObject/>\n</AssetDeclaration>`;
const scope = await makeScope(text, makeIdx([]));
const collection = new FakeDiagnosticCollection();
const provider = new Ra3Diagnostics({
isRa3Workspace: () => true,
getScope: async () => scope,
settings: {
diagnoseUnknownElements: true,
reportUnresolvedReferences: "warning",
},
});
provider["collection"] = collection;
await provider.update(makeDocument(text));
const codes = collection.last.diags.map((d) => d.code);
assert.ok(
codes.includes("missing-id"),
"AssetDeclaration documents keep top-level id checks",
);
});
+72
View File
@@ -34,6 +34,78 @@ test("closed quote still resolves value context", () => {
assert.equal(ctx.valuePrefix, "GROUND");
});
test("multi-line unterminated quote keeps attribute-value context", () => {
const text =
`<AssetDeclaration>\n` +
` <ObjectCreationList id="OCL_CrateSpawn">\n` +
` <CreateObject\n` +
` Options="IGNORE_ALL_OBJECTS"\n` +
` Disposition="`;
const cursor = text.length;
const doc = parseXml(text);
const ctx = analyzeContext(doc, text, cursor);
assert.equal(ctx.kind, "attribute-value");
assert.equal(ctx.attr?.name, "Disposition");
assert.equal(ctx.valuePrefix, "");
assert.equal(ctx.element?.name, "CreateObject");
});
test("multi-line unterminated value prefix includes typed flags", () => {
const text =
`<AssetDeclaration>\n` +
` <ObjectCreationList id="OCL_CrateSpawn">\n` +
` <CreateObject\n` +
` Options="IGNORE_ALL_OBJECTS"\n` +
` Disposition="RANDOM_FORCE `;
const cursor = text.length;
const doc = parseXml(text);
const ctx = analyzeContext(doc, text, cursor);
assert.equal(ctx.kind, "attribute-value");
assert.equal(ctx.attr?.name, "Disposition");
assert.equal(ctx.valuePrefix, "RANDOM_FORCE ");
});
test("cursor after a closed quote is an attribute-name context", () => {
const text = `<Locomotor id="x" Surfaces="GROUND">\n</Locomotor>`;
const cursor = text.indexOf('GROUND"') + 'GROUND"'.length;
const doc = parseXml(text);
const ctx = analyzeContext(doc, text, cursor);
assert.equal(ctx.kind, "attribute-name");
assert.equal(ctx.attr, null);
});
test("cursor exactly after an opening tag with a closing tag is content", () => {
const text = `<CreateObject></CreateObject>`;
const cursor = text.indexOf(">") + 1;
const doc = parseXml(text);
const ctx = analyzeContext(doc, text, cursor);
assert.equal(ctx.kind, "content");
assert.equal(ctx.element?.name, "CreateObject");
});
test("cursor after a typed > but before the closing tag is content too", () => {
const text = `<CreateObject>`;
const cursor = text.length;
const doc = parseXml(text);
const ctx = analyzeContext(doc, text, cursor);
assert.equal(ctx.kind, "content");
assert.equal(ctx.element?.name, "CreateObject");
});
test("cursor after a closed child element belongs to the parent content", () => {
const text =
`<AssetDeclaration>` +
`<ObjectCreationList>` +
`<CreateObject>X</CreateObject>` +
`</ObjectCreationList>` +
`</AssetDeclaration>`;
const cursor = text.indexOf("</CreateObject>") + "</CreateObject>".length;
const doc = parseXml(text);
const ctx = analyzeContext(doc, text, cursor);
assert.equal(ctx.kind, "content");
assert.equal(ctx.element?.name, "ObjectCreationList");
});
test("splitListValuePrefix isolates the token being edited", () => {
assert.deepEqual(splitListValuePrefix("GROUND WA"), { token: "WA", start: 7 });
assert.deepEqual(splitListValuePrefix("GROUND "), { token: "", start: 7 });
+192
View File
@@ -0,0 +1,192 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { join } from "node:path";
import fs from "node:fs";
import os from "node:os";
import { DiskRecordsCache, diskCacheKey } from "../out/indexer/diskCache.js";
const identity = {
projectDir: "C:/proj",
sdkDir: "C:/sdk",
indexSageXml: true,
additionalDataSearchPaths: [],
builtmodsDirs: ["C:/sdk/builtmods"],
};
const sampleRecords = {
assets: [{ type: "GameObject", id: "TankA", line: 3 }],
defines: [{ name: "HP", value: "100", line: 2 }],
includes: [{ type: "all", source: "Units.xml", line: 4 }],
rootXiIncludes: [],
nestedXiIncludes: [],
references: [],
};
function stampOf(file) {
const s = fs.statSync(file);
return {
mtimeMs: s.mtimeMs,
size: s.size,
birthtimeMs: s.birthtimeMs,
ctimeMs: s.ctimeMs,
};
}
function makeTmp(t) {
const tmp = fs.mkdtempSync(join(os.tmpdir(), "ra3-diskcache-"));
t.after(() => fs.rmSync(tmp, { recursive: true, force: true }));
return tmp;
}
test("disk cache roundtrip keeps records and leaves no temp file", async (t) => {
const tmp = makeTmp(t);
const file = join(tmp, "a.xml");
fs.writeFileSync(file, "0123456789");
const filePath = join(tmp, "index-records.json.gz");
const cache = new DiskRecordsCache(filePath, identity);
await cache.save([
[
file.toLowerCase(),
{
stat: stampOf(file),
records: sampleRecords,
kind: "full",
contentHash: "abc123",
},
],
]);
assert.equal(fs.existsSync(`${filePath}.tmp`), false, "atomic write leaves no temp");
const { records, stats } = await cache.loadValidated();
assert.equal(stats.fileExists, true);
assert.equal(stats.keyMatched, true);
assert.equal(stats.loaded, 1);
assert.equal(stats.validated, 1);
assert.equal(stats.dropped, 0);
assert.equal(records.length, 1);
assert.deepEqual(records[0].records, sampleRecords);
assert.equal(records[0].contentHash, "abc123");
});
test("stat mismatch drops the cached entry", async (t) => {
const tmp = makeTmp(t);
const file = join(tmp, "a.xml");
fs.writeFileSync(file, "0123456789");
const filePath = join(tmp, "index-records.json.gz");
const cache = new DiskRecordsCache(filePath, identity);
await cache.save([
[file.toLowerCase(), { stat: stampOf(file), records: sampleRecords, kind: "full" }],
]);
const past = new Date(Date.now() - 60000);
fs.utimesSync(file, past, past);
const { records, stats } = await cache.loadValidated();
assert.equal(stats.validated, 0);
assert.equal(stats.dropped, 1);
assert.equal(records.length, 0);
});
test("identity mismatch ignores the cache", async (t) => {
const tmp = makeTmp(t);
const file = join(tmp, "a.xml");
fs.writeFileSync(file, "0123456789");
const filePath = join(tmp, "index-records.json.gz");
const cache = new DiskRecordsCache(filePath, identity);
await cache.save([
[file.toLowerCase(), { stat: stampOf(file), records: sampleRecords, kind: "full" }],
]);
const other = new DiskRecordsCache(filePath, {
...identity,
sdkDir: "D:/other-sdk",
});
const { records, stats } = await other.loadValidated();
assert.equal(stats.fileExists, true);
assert.equal(stats.keyMatched, false);
assert.equal(records.length, 0);
});
test("corrupt cache file yields an empty result", async (t) => {
const tmp = makeTmp(t);
const filePath = join(tmp, "index-records.json.gz");
fs.writeFileSync(filePath, "this is not gzip json");
const cache = new DiskRecordsCache(filePath, identity);
const { records, stats } = await cache.loadValidated();
assert.equal(stats.fileExists, true);
assert.equal(records.length, 0);
});
test("clear removes the cache file", async (t) => {
const tmp = makeTmp(t);
const file = join(tmp, "a.xml");
fs.writeFileSync(file, "0123456789");
const filePath = join(tmp, "index-records.json.gz");
const cache = new DiskRecordsCache(filePath, identity);
await cache.save([
[file.toLowerCase(), { stat: stampOf(file), records: sampleRecords, kind: "full" }],
]);
assert.ok(fs.existsSync(filePath));
await cache.clear();
assert.equal(fs.existsSync(filePath), false);
});
test("diskCacheKey differs when the identity changes", () => {
const a = diskCacheKey(identity);
const b = diskCacheKey({ ...identity, indexSageXml: false });
assert.notEqual(a, b);
assert.equal(a, diskCacheKey(identity));
});
test("load returns records without stat validation", async (t) => {
const tmp = makeTmp(t);
const file = join(tmp, "a.xml");
fs.writeFileSync(file, "0123456789");
const filePath = join(tmp, "index-records.json.gz");
const cache = new DiskRecordsCache(filePath, identity);
await cache.save([
[
file.toLowerCase(),
{ stat: stampOf(file), records: sampleRecords, kind: "full" },
],
]);
const { records, stats } = await cache.load();
assert.equal(records.length, 1);
assert.equal(stats.fileExists, true);
assert.equal(stats.keyMatched, true);
assert.equal(stats.loaded, 1);
assert.equal(stats.validated, 0);
assert.equal(stats.dropped, 0);
assert.ok(stats.loadMs >= 0);
});
test("validate reports changed/missing entries and keeps valid ones", async (t) => {
const tmp = makeTmp(t);
const a = join(tmp, "a.xml");
const b = join(tmp, "b.xml");
fs.writeFileSync(a, "0123456789");
fs.writeFileSync(b, "0123456789");
const filePath = join(tmp, "index-records.json.gz");
const cache = new DiskRecordsCache(filePath, identity);
await cache.save([
[a.toLowerCase(), { stat: stampOf(a), records: sampleRecords, kind: "full" }],
[b.toLowerCase(), { stat: stampOf(b), records: sampleRecords, kind: "full" }],
]);
const { records } = await cache.load();
const past = new Date(Date.now() - 60000);
fs.utimesSync(b, past, past);
const progress = [];
const { stats, kept, invalidKeys } = await cache.validate(records, (done, total) => {
progress.push([done, total]);
});
assert.equal(stats.validated, 1);
assert.equal(stats.dropped, 1);
assert.equal(kept.length, 1);
assert.equal(kept[0].key, a.toLowerCase());
assert.deepEqual(invalidKeys, [b.toLowerCase()]);
assert.ok(stats.validateMs >= 0);
assert.deepEqual(progress[progress.length - 1], [1, 2]);
assert.ok(progress.every(([done], i) => i === 0 || done >= progress[i - 1][0]));
});
+102
View File
@@ -0,0 +1,102 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { join, parse, resolve } from "node:path";
import fs from "node:fs";
import os from "node:os";
import { resolveSource } from "../out/indexer/includeResolver.js";
import {
ExistenceSnapshot,
buildExistenceSnapshot,
isDriveRoot,
} from "../out/indexer/existence.js";
function makeTmp(t) {
const tmp = fs.mkdtempSync(join(os.tmpdir(), "ra3-existence-"));
t.after(() => fs.rmSync(tmp, { recursive: true, force: true }));
return tmp;
}
test("isDriveRoot detects filesystem roots", () => {
assert.equal(isDriveRoot(parse(process.cwd()).root), true);
assert.equal(isDriveRoot(process.cwd()), false);
});
test("ExistenceSnapshot answers covered paths and falls back outside roots", (t) => {
const tmp = makeTmp(t);
const dataDir = join(tmp, "data");
fs.mkdirSync(dataDir);
const existing = join(dataDir, "Units.xml");
fs.writeFileSync(existing, "<x/>");
const snap = new ExistenceSnapshot([dataDir]);
assert.equal(snap.has(existing), true);
assert.equal(snap.has(join(dataDir, "Missing.xml")), false);
assert.equal(snap.has(join(tmp, "outside.xml")), null, "outside roots is unknown");
assert.ok(snap.hits >= 2, "covered lookups counted as hits");
assert.equal(snap.fallbacks, 1);
if (process.platform === "win32") {
assert.equal(
snap.has(existing.toUpperCase()),
true,
"lookup is case-insensitive on Windows",
);
}
});
test("buildExistenceSnapshot covers bounded search bases lazily", async (t) => {
const tmp = makeTmp(t);
const dataDir = join(tmp, "data");
const artDir = join(tmp, "art");
fs.mkdirSync(join(dataDir, "sub"), { recursive: true });
fs.mkdirSync(artDir);
fs.writeFileSync(join(dataDir, "Units.xml"), "<x/>");
fs.writeFileSync(join(dataDir, "sub", "Nested.xml"), "<x/>");
fs.writeFileSync(join(artDir, "Tank.w3x"), "<x/>");
const snap = buildExistenceSnapshot({
DATA: [dataDir],
ART: [artDir],
AUDIO: [],
});
assert.equal(snap.has(join(dataDir, "Units.xml")), true);
assert.equal(snap.has(join(dataDir, "sub", "Nested.xml")), true);
assert.equal(snap.has(join(artDir, "Tank.w3x")), true);
assert.equal(snap.has(join(dataDir, "Missing.xml")), false);
});
test("resolveSource uses the snapshot and falls back to statSync outside it", async (t) => {
const tmp = makeTmp(t);
const dataDir = join(tmp, "data");
const outsideDir = join(tmp, "outside");
fs.mkdirSync(dataDir);
fs.mkdirSync(outsideDir);
const units = join(dataDir, "Units.xml");
const outside = join(outsideDir, "Extra.xml");
fs.writeFileSync(units, "<x/>");
fs.writeFileSync(outside, "<x/>");
const searchPaths = { DATA: [dataDir], ART: [], AUDIO: [] };
const snap = buildExistenceSnapshot(searchPaths);
const found = resolveSource("DATA:Units.xml", null, searchPaths, snap);
assert.equal(found.path, units);
assert.ok(snap.hits > 0, "covered lookup served by the snapshot");
const missing = resolveSource("DATA:Missing.xml", null, searchPaths, snap);
assert.equal(missing.path, null);
const emptySearchPaths = { DATA: [], ART: [], AUDIO: [] };
const outsideResolved = resolveSource(
outside,
outsideDir,
emptySearchPaths,
snap,
);
assert.equal(
resolve(outsideResolved.path ?? ""),
resolve(outside),
"uncovered path falls back to statSync",
);
assert.ok(snap.fallbacks > 0, "fallback counted");
});
+72
View File
@@ -0,0 +1,72 @@
import { test } from "node:test";
import assert from "node:assert/strict";
import { join } from "node:path";
import {
isContentRelevantPath,
isWatcherNoisePath,
} from "../out/indexer/fileScanner.js";
test("isWatcherNoisePath filters .git internals", () => {
assert.equal(
isWatcherNoisePath(join("C:/proj", ".git", "index")),
true,
".git files are noise",
);
assert.equal(
isWatcherNoisePath(join("C:/proj", "data", ".git", "FETCH_HEAD")),
true,
"nested .git directories are noise",
);
assert.equal(
isWatcherNoisePath(join("C:/proj", "Data", "Mod.xml")),
false,
"project XML is not noise",
);
assert.equal(
isWatcherNoisePath(join("C:/proj", ".gitignore")),
false,
".gitignore is a real project file",
);
assert.equal(
isWatcherNoisePath(join("C:/proj", "Data", "UnitCrate.xml.git")),
true,
"editor temp files ending in .git are noise",
);
assert.equal(
isWatcherNoisePath(join("C:/proj", "Data", "UnitCrate.xml.tmp")),
true,
".tmp files are noise",
);
assert.equal(
isWatcherNoisePath(join("C:/proj", "Data", "Mod.xml~")),
true,
"backup files ending in ~ are noise",
);
assert.equal(
isWatcherNoisePath(join("C:/proj", "Data", ".#Mod.xml")),
true,
"lock files starting with .# are noise",
);
});
test("isContentRelevantPath only reacts to XML-ish content", () => {
assert.equal(isContentRelevantPath("a.xml"), true);
assert.equal(isContentRelevantPath("a.w3x"), true);
assert.equal(
isContentRelevantPath("a.manifestxml"),
false,
"there is no .manifestxml source format",
);
assert.equal(
isContentRelevantPath("a.w3d"),
false,
".w3d is binary art, not text XML",
);
assert.equal(isContentRelevantPath("a.dds"), false);
assert.equal(isContentRelevantPath("a.xml.git"), false);
assert.equal(
isContentRelevantPath("a.lua"),
false,
"lua is not indexed yet",
);
});
+1
View File
@@ -0,0 +1 @@
+2
View File
@@ -0,0 +1,2 @@
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" />
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<HeadlightDraw2>
<TruckDraw id="ModuleTag_Headlight" />
</HeadlightDraw2>
</AssetDeclaration>
@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<GameObject id="StandaloneBase" Side="Allies" />
</AssetDeclaration>
+1 -1
View File
@@ -2,7 +2,7 @@
<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<Includes>
<Include type="all" source="Models/Tank_SKN.w3x" />
<Include type="all" source="Models/Tank_FP.w3d" />
<Include type="all" source="Models/Tank_FP.dat" />
<Include type="all" source="Models/Tank_Damaged.dds" />
</Includes>
</AssetDeclaration>
+20
View File
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
<AssetDeclaration xmlns="uri:ea.com:eala:asset">
<Includes>
<Include type="instance" source="Includes/StandaloneBase.xml" />
</Includes>
<Defines>
<Define name="STANDALONE_HEALTH" value="200.0" />
</Defines>
<GameObject id="StandaloneTank" inheritFrom="StandaloneBase">
<Draws>
<TruckDraw id="ModuleTag_Draw" />
<xi:include
href="DATA:Includes/HeadlightModules.xml"
xpointer="xmlns(n=uri:ea.com:eala:asset) xpointer(/n:HeadlightDraw2/child::*)" />
</Draws>
<BehaviorModules>
<ReconstituteStateSpecialAbility UpdateModuleId="ModuleTag_Headlight" />
</BehaviorModules>
</GameObject>
</AssetDeclaration>

Some files were not shown because too many files have changed in this diff Show More