Skip to content

Commit 1f2242c

Browse files
committed
docs: finish the dialog preview to editor rename
1 parent 3dd75a7 commit 1f2242c

11 files changed

Lines changed: 21 additions & 24 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ VSCode extension providing IDE features for niche scripting languages used in cl
4040
- **SCS SSL/SLB** - Sword Coast Stratagems scripting (Infinity Engine AI mods)
4141
- **Transpilers** - TypeScript-like languages compiling to the above: TSSL->SSL, TBAF->BAF, TD->D
4242

43-
**Features:** Completion, hover, go-to-definition, find references, rename, document symbols, formatting, inlay hints (translation string previews from .msg/.tra), diagnostics (via sslc/weidu), JSDoc, signature help, dialog tree preview (webview), binary file editor (Fallout `.pro` / `.map`, Infinity Engine `.itm` / `.spl` / `.eff` / `.cre`).
43+
**Features:** Completion, hover, go-to-definition, find references, rename, document symbols, formatting, inlay hints (translation string previews from .msg/.tra), diagnostics (via sslc/weidu), JSDoc, signature help, dialog editor (webview), binary file editor (Fallout `.pro` / `.map`, Infinity Engine `.itm` / `.spl` / `.eff` / `.cre`).
4444

4545
**How it works:**
4646

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,19 @@ Originally a VS Code extension, it now also works with various other editors. Se
3838
| Diagnostics |||||
3939
| JSDoc || |||
4040
| Folding |||||
41-
| Dialog preview || || |
41+
| Dialog editor || || |
4242

4343
## Transpilers
4444

4545
These are TypeScript-like language subsets that compile to the scripting formats above.
4646

4747
They bring the TypeScript type system, many TypeScript features, and better tooling to modding.
4848

49-
| Transpiler | Extension | Target | Inlay Hints | Dialog Preview |
50-
| ---------- | --------- | ------ | :---------: | :------------: |
51-
| TSSL | .tssl | .ssl | .msg | |
52-
| TBAF | .tbaf | .baf | .tra | |
53-
| TD | .td | .d | .tra | |
49+
| Transpiler | Extension | Target | Inlay Hints | Dialog Editor |
50+
| ---------- | --------- | ------ | :---------: | :-----------: |
51+
| TSSL | .tssl | .ssl | .msg ||
52+
| TBAF | .tbaf | .baf | .tra | |
53+
| TD | .td | .d | .tra ||
5454

5555
**[TSSL](transpilers/tssl/docs/README.md)** (.tssl) compiles to Fallout SSL. Companion project: [FOlib](https://github.com/BGforgeNet/folib).
5656

@@ -109,7 +109,7 @@ Fallout PRO and MAP files, and Infinity Engine ITM, SPL, EFF, and CRE files, hav
109109

110110
Visual dialog editor for SSL, TSSL, D, and TD files. Open with `CTRL+SHIFT+V` or the command palette. Shows states, transitions, and resolved translation strings.
111111

112-
![dialog editor example](docs/dialog_preview.png)
112+
![dialog editor example](docs/dialog_editor.png)
113113

114114
### Error reporting
115115

client/src/webview-utils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export interface FatalErrorHandlerOptions {
1717
/** The `acquireVsCodeApi()` handle, used to report the error to the host. */
1818
readonly vscode: VsCodeApi;
1919
/**
20-
* Human label for this webview ("Dialog preview" / "Binary editor"). Drives
20+
* Human label for this webview ("Dialog editor" / "Binary editor"). Drives
2121
* the console prefix and the default messages for uncaught errors; the
2222
* lowercased form is spliced into the "Unhandled ... error" defaults.
2323
*/

client/test/webview-error.test.ts

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,13 @@ describe("surfaceWebviewRuntimeError", () => {
4949

5050
test("logs to console.error with stack for Developer Tools", () => {
5151
surfaceWebviewRuntimeError({
52-
label: "Dialog preview for x.ssl",
52+
label: "Dialog editor for x.ssl",
5353
userFacingFile: "x.ssl",
5454
message: "oops",
5555
stack: "stack trace",
5656
});
5757

58-
expect(consoleErrorSpy).toHaveBeenCalledWith(
59-
expect.stringContaining("Dialog preview for x.ssl"),
60-
"stack trace",
61-
);
58+
expect(consoleErrorSpy).toHaveBeenCalledWith(expect.stringContaining("Dialog editor for x.ssl"), "stack trace");
6259
});
6360

6461
test("calls showErrorMessage with the user-facing filename and the error message", () => {

docs/architecture.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -444,11 +444,11 @@ structured IR (`BAFBlock/Condition/Action`) with condition algebra (boolean to
444444
CNF conversion for BAF OR groups). TD has the richest IR (20+ construct types)
445445
with state machines, method chain parsing, and dual-pass orphan detection.
446446

447-
| Transpiler | Input | Output | Key Features |
448-
| ---------- | ------- | ------ | ------------------------------------------------------------------------------------------------------------- |
449-
| TSSL | `.tssl` | `.ssl` | const/let, loops, functions, enum pre-transform |
450-
| TBAF | `.tbaf` | `.baf` | for/for-of, arrays, spread, destructuring, function inlining, point tuples |
451-
| TD | `.td` | `.d` | All TBAF features + conditionals, method chains, transitive state collection, orphan warnings, dialog preview |
447+
| Transpiler | Input | Output | Key Features |
448+
| ---------- | ------- | ------ | ------------------------------------------------------------------------------------------------------------ |
449+
| TSSL | `.tssl` | `.ssl` | const/let, loops, functions, enum pre-transform |
450+
| TBAF | `.tbaf` | `.baf` | for/for-of, arrays, spread, destructuring, function inlining, point tuples |
451+
| TD | `.td` | `.d` | All TBAF features + conditionals, method chains, transitive state collection, orphan warnings, dialog editor |
452452

453453
**TD module structure** (`transpilers/td/src/`):
454454

@@ -880,7 +880,7 @@ worthwhile.
880880
The feature matrix appears in two forms serving different audiences; both are maintained.
881881

882882
- **README** - user-facing languages ("Fallout SSL", "WeiDU TP2"), ✓ marks, includes a
883-
"Dialog preview" row. Optimized for someone deciding whether the extension supports
883+
"Dialog editor" row. Optimized for someone deciding whether the extension supports
884884
their workflow.
885885
- **`server/INTERNALS.md#feature-matrix`** - provider names (`fallout-ssl`, `weidu-tp2`),
886886
`Y`/`n/a`/blank distinction, covers extra providers (`weidu-log`, `worldmap`, `weidu-tra`,

docs/dialog_editor.png

317 KB
Loading

docs/dialog_preview.png

-159 KB
Binary file not shown.

docs/lsp-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Supported sources:
6969
- TD (`.td`)
7070
- TSSL (`.tssl`)
7171

72-
This command is intended for clients that implement a dialog preview UI.
72+
This command is intended for clients that implement a dialog editor or preview UI.
7373

7474
## VS Code Extension Commands
7575

scripts/build-base-webviews.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
set -eu -o pipefail
44

5-
# Build webview bundles (binary editor [Svelte], dialog tree preview) via esbuild's JS API
5+
# Build webview bundles (binary editor [Svelte], dialog editor) via esbuild's JS API
66
# so the esbuild-svelte plugin can run (the CLI cannot load plugins). Forwards --sourcemap/--minify.
77
node ./scripts/build-webviews.mjs "$@"

server/INTERNALS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ server/src/
144144
| +-- symbol.ts # DocumentSymbol extraction
145145
| +-- ast-utils.ts # Tree-sitter helpers
146146
| +-- file-parser.ts # .d file parser (drives indexer)
147-
| +-- dialog.ts # Dialog preview integration (server/td/dialog.ts mirror)
147+
| +-- dialog.ts # Dialog editor integration (server/td/dialog.ts mirror)
148148
| +-- dialog-utils.ts # Dialog-tree shape helpers
149149
| +-- dialog-modify.ts # Dialog-tree mutators (used by webview-driven edits)
150150
+-- weidu-tp2/ # WeiDU mod installers

0 commit comments

Comments
 (0)