@kabmo-labs/kabmo 0.9.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (180) hide show
  1. package/README.md +45 -0
  2. package/dist/client/index.html +1 -1
  3. package/dist/client/index.js +333 -333
  4. package/dist/client/static/js/index-18xe7655.css +1 -0
  5. package/dist/client/static/js/{index-bpptfkz2.js → index-nxpe7835.js} +768 -763
  6. package/package.json +3 -1
  7. package/src/client/components/common/code-surface/bracket-guide.test.ts +249 -0
  8. package/src/client/components/common/code-surface/bracket-guide.ts +131 -0
  9. package/src/client/components/common/code-surface/documents.test.ts +5 -3
  10. package/src/client/components/common/code-surface/documents.ts +85 -0
  11. package/src/client/components/common/code-surface/extensions.test.ts +5 -0
  12. package/src/client/components/common/code-surface/extensions.ts +140 -7
  13. package/src/client/components/common/code-surface/fold-stack.test.ts +218 -0
  14. package/src/client/components/common/code-surface/fold.test.ts +148 -0
  15. package/src/client/components/common/code-surface/fold.ts +118 -0
  16. package/src/client/components/common/code-surface/indent-guide.ts +104 -0
  17. package/src/client/components/common/code-surface/indent.test.ts +239 -0
  18. package/src/client/components/common/code-surface/indent.ts +124 -0
  19. package/src/client/components/common/code-surface/index.tsx +76 -46
  20. package/src/client/components/common/code-surface/keymap.ts +12 -23
  21. package/src/client/components/common/code-surface/line-commands.test.ts +90 -0
  22. package/src/client/components/common/code-surface/line-commands.ts +103 -0
  23. package/src/client/components/common/code-surface/props.ts +87 -0
  24. package/src/client/components/common/code-surface/stream-language.test.ts +118 -0
  25. package/src/client/components/common/code-surface/stream-language.ts +123 -0
  26. package/src/client/components/common/code-surface/theme.test.ts +40 -5
  27. package/src/client/components/common/code-surface/theme.ts +113 -0
  28. package/src/client/components/common/code-surface/typing.test.ts +97 -0
  29. package/src/client/components/common/code-surface/typing.ts +111 -0
  30. package/src/client/components/common/toolbar-row/index.test.tsx +53 -4
  31. package/src/client/components/common/toolbar-row/index.tsx +101 -30
  32. package/src/client/components/layout/desktop-layout/WorkspacePanels.tsx +17 -0
  33. package/src/client/components/layout/desktop-layout/index.tsx +18 -0
  34. package/src/client/components/mobile/mobile-right-sidebar/FullEditor.tsx +35 -33
  35. package/src/client/components/mobile/mobile-right-sidebar/Header.tsx +20 -1
  36. package/src/client/components/mobile/mobile-right-sidebar/editor-props.ts +25 -0
  37. package/src/client/components/settings/categories/AppearanceSettings.tsx +6 -0
  38. package/src/client/components/settings/categories/appearance-settings/EditorIndentSection.tsx +87 -0
  39. package/src/client/components/settings/categories/appearance-settings/EditorTypingSection.tsx +99 -0
  40. package/src/client/components/workspace/chat-timeline/chat-input/expansion.ts +9 -4
  41. package/src/client/components/workspace/chat-timeline/chat-input/index.tsx +15 -11
  42. package/src/client/components/workspace/chat-timeline/chat-input/stretch-send.test.tsx +165 -0
  43. package/src/client/components/workspace/chat-timeline/tool-renderers/shared/DiffView.test.ts +17 -3
  44. package/src/client/components/workspace/chat-timeline/tool-renderers/shared/DiffView.tsx +10 -6
  45. package/src/client/components/workspace/editor/Body.tsx +24 -0
  46. package/src/client/components/workspace/editor/CommandPalette.tsx +4 -4
  47. package/src/client/components/workspace/editor/ConflictStrip.tsx +77 -0
  48. package/src/client/components/workspace/editor/Dialogs.tsx +53 -0
  49. package/src/client/components/workspace/editor/EmptyEditor.tsx +23 -0
  50. package/src/client/components/workspace/editor/ExternalChangeStrip.tsx +61 -0
  51. package/src/client/components/workspace/editor/FileDocument.tsx +89 -1
  52. package/src/client/components/workspace/editor/FilePane.tsx +43 -0
  53. package/src/client/components/workspace/editor/FindWidget.test.ts +9 -5
  54. package/src/client/components/workspace/editor/FindWidget.tsx +29 -0
  55. package/src/client/components/workspace/editor/GoToLineModal.tsx +123 -0
  56. package/src/client/components/workspace/editor/Notices.tsx +71 -0
  57. package/src/client/components/workspace/editor/Pane.tsx +118 -0
  58. package/src/client/components/workspace/editor/PluginColumn.tsx +32 -0
  59. package/src/client/components/workspace/editor/QuickOpenModal.tsx +146 -0
  60. package/src/client/components/workspace/editor/SaveAsModal.tsx +175 -0
  61. package/src/client/components/workspace/editor/SplitColumn.tsx +98 -0
  62. package/src/client/components/workspace/editor/SplitPane.tsx +57 -0
  63. package/src/client/components/workspace/editor/StatusBar.tsx +106 -0
  64. package/src/client/components/workspace/editor/TabContextMenu.tsx +75 -0
  65. package/src/client/components/workspace/editor/Tabs.tsx +195 -18
  66. package/src/client/components/workspace/editor/Toolbar.tsx +54 -181
  67. package/src/client/components/workspace/editor/index.tsx +199 -189
  68. package/src/client/components/workspace/editor/props.ts +64 -0
  69. package/src/client/components/workspace/editor/toolbar-clusters.tsx +300 -0
  70. package/src/client/components/workspace/file-explorer/Modals.tsx +14 -1
  71. package/src/client/components/workspace/file-explorer/TreeItem.tsx +2 -1
  72. package/src/client/components/workspace/file-explorer/clipboard.test.ts +3 -1
  73. package/src/client/components/workspace/file-explorer/index.test.ts +61 -0
  74. package/src/client/components/workspace/file-explorer/index.tsx +10 -48
  75. package/src/client/components/workspace/file-explorer/local-edit.test.ts +8 -3
  76. package/src/client/components/workspace/search-panel/Body.tsx +6 -1
  77. package/src/client/hooks/chat/composer/file-drop.ts +22 -37
  78. package/src/client/hooks/chat/composer/pipeline.test.ts +76 -0
  79. package/src/client/hooks/chat/composer/pipeline.ts +12 -1
  80. package/src/client/hooks/editor/caret-position.test.ts +58 -0
  81. package/src/client/hooks/editor/caret-position.ts +48 -0
  82. package/src/client/hooks/editor/file-editor-types.ts +200 -0
  83. package/src/client/hooks/editor/find-history.test.ts +132 -0
  84. package/src/client/hooks/editor/find-history.ts +46 -0
  85. package/src/client/hooks/editor/find-selection-range.test.ts +100 -0
  86. package/src/client/hooks/editor/find-selection-range.ts +49 -0
  87. package/src/client/hooks/editor/find-state.ts +13 -0
  88. package/src/client/hooks/editor/font.test.ts +0 -93
  89. package/src/client/hooks/editor/indent-settings.test.ts +104 -0
  90. package/src/client/hooks/editor/indent-settings.ts +88 -0
  91. package/src/client/hooks/editor/quick-open.test.ts +141 -0
  92. package/src/client/hooks/editor/quick-open.ts +127 -0
  93. package/src/client/hooks/editor/save-as.test.ts +156 -0
  94. package/src/client/hooks/editor/save-as.ts +122 -0
  95. package/src/client/hooks/editor/save-file.test.ts +179 -0
  96. package/src/client/hooks/editor/save-file.ts +73 -28
  97. package/src/client/hooks/editor/typing-settings.test.ts +73 -0
  98. package/src/client/hooks/editor/typing-settings.ts +65 -0
  99. package/src/client/hooks/editor/use-close-guard.ts +98 -0
  100. package/src/client/hooks/editor/use-editor-drop-overlay.test.ts +159 -0
  101. package/src/client/hooks/editor/use-editor-drop.shell.test.ts +224 -0
  102. package/src/client/hooks/editor/use-editor-drop.ts +58 -68
  103. package/src/client/hooks/editor/use-editor-find.test.ts +2 -2
  104. package/src/client/hooks/editor/use-editor-find.ts +38 -3
  105. package/src/client/hooks/editor/use-editor-panel-keys.ts +152 -0
  106. package/src/client/hooks/editor/use-editor-tab-state.ts +71 -0
  107. package/src/client/hooks/editor/use-external-change-notice.ts +71 -0
  108. package/src/client/hooks/editor/use-external-change.test.ts +88 -0
  109. package/src/client/hooks/editor/use-external-change.ts +146 -0
  110. package/src/client/hooks/editor/use-file-editor.ts +83 -116
  111. package/src/client/hooks/editor/use-file-read.ts +16 -8
  112. package/src/client/hooks/editor/use-file-writes.ts +28 -3
  113. package/src/client/hooks/editor/use-mobile-editor-find.ts +69 -0
  114. package/src/client/hooks/editor/use-mobile-reveal.ts +53 -0
  115. package/src/client/hooks/editor/use-search-reveal-jump.ts +57 -0
  116. package/src/client/hooks/editor/use-split-editor.test.tsx +169 -0
  117. package/src/client/hooks/editor/use-split-editor.ts +91 -0
  118. package/src/client/hooks/editor/use-unload-guard.tsx +117 -0
  119. package/src/client/hooks/editor/use-write-conflict.test.ts +164 -0
  120. package/src/client/hooks/editor/use-write-conflict.ts +152 -0
  121. package/src/client/hooks/editor/wheel-zoom.test.ts +141 -0
  122. package/src/client/hooks/editor/wheel-zoom.ts +96 -0
  123. package/src/client/hooks/ui/drag-presence.test.ts +193 -0
  124. package/src/client/hooks/ui/drag-presence.ts +108 -0
  125. package/src/client/hooks/ui/settings-modal.test.ts +115 -0
  126. package/src/client/hooks/workspace/file-listing.ts +36 -24
  127. package/src/client/hooks/workspace/file-tabs.test.ts +90 -0
  128. package/src/client/hooks/workspace/file-tabs.ts +46 -0
  129. package/src/client/hooks/workspace/file-tree-edits.ts +103 -0
  130. package/src/client/lib/desktop/dropped-paths.ts +83 -0
  131. package/src/client/lib/editor/tab-menu.test.ts +127 -0
  132. package/src/client/lib/editor/tab-menu.ts +127 -0
  133. package/src/client/lib/editor-dirty-tabs.test.ts +102 -0
  134. package/src/client/lib/editor-dirty-tabs.ts +103 -0
  135. package/src/client/lib/native/resume.test.ts +66 -0
  136. package/src/client/lib/native/resume.ts +42 -0
  137. package/src/client/main.tsx +8 -0
  138. package/src/client/tailwind.css +38 -0
  139. package/src/server/lib/bundler/css.test.ts +31 -0
  140. package/src/server/lib/fs/listing.test.ts +81 -16
  141. package/src/server/lib/fs/listing.ts +72 -5
  142. package/src/server/lib/fs/write-conflict.test.ts +68 -0
  143. package/src/server/lib/fs/write-conflict.ts +84 -0
  144. package/src/server/routes/fs/action-save-as.test.ts +82 -0
  145. package/src/server/routes/fs/action.test.ts +82 -0
  146. package/src/server/routes/fs/action.ts +54 -1
  147. package/src/server/routes/fs/exists.ts +11 -1
  148. package/src/server/routes/fs/read.ts +6 -1
  149. package/src/shared/lib/code/editor/find-replace.test.ts +1 -1
  150. package/src/shared/lib/code/editor/find-scan.test.ts +1 -1
  151. package/src/shared/lib/code/editor/find-scan.ts +22 -1
  152. package/src/shared/lib/code/editor/find-selection.test.ts +56 -0
  153. package/src/shared/lib/code/editor/indent-guide-rule.test.ts +65 -0
  154. package/src/shared/lib/code/editor/indent-guide-rule.ts +47 -0
  155. package/src/shared/lib/code/editor/indent-rules.test.ts +219 -0
  156. package/src/shared/lib/code/editor/indent-rules.ts +198 -0
  157. package/src/shared/lib/code/editor/keymap.test.ts +23 -0
  158. package/src/shared/lib/code/editor/keymap.ts +40 -3
  159. package/src/shared/lib/code/editor/palette.test.ts +25 -2
  160. package/src/shared/lib/code/editor/palette.ts +10 -0
  161. package/src/shared/lib/code/editor/stream-modes.ts +225 -0
  162. package/src/shared/lib/code/syntax-highlight.test.ts +1 -1
  163. package/src/shared/lib/fs/file-tree.test.ts +41 -0
  164. package/src/shared/lib/fs/file-tree.ts +126 -34
  165. package/src/shared/lib/fs/folder-chain.test.ts +87 -0
  166. package/src/shared/lib/fs/folder-chain.ts +91 -0
  167. package/src/shared/lib/fs/fs-helpers.test.ts +4 -50
  168. package/src/shared/lib/realtime/connection.test.ts +5 -1
  169. package/src/shared/lib/realtime/connection.ts +25 -119
  170. package/src/shared/lib/realtime/frozen-recovery.test.ts +93 -0
  171. package/src/shared/lib/realtime/resume.ts +223 -0
  172. package/src/shared/lib/realtime/state.ts +22 -0
  173. package/src/shared/lib/realtime/watchdog-wiring.test.ts +224 -0
  174. package/src/shared/lib/realtime/watchdog.test.ts +99 -0
  175. package/src/shared/lib/realtime/watchdog.ts +72 -0
  176. package/src/shared/lib/workspace/split-editor.test.ts +104 -0
  177. package/src/shared/lib/workspace/split-editor.ts +129 -0
  178. package/src/test-support/file-explorer-disk.test-util.ts +30 -3
  179. package/src/test-support/pristine-globals.ts +7 -0
  180. package/dist/client/static/js/index-k315p1e8.css +0 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kabmo-labs/kabmo",
3
- "version": "0.9.0",
3
+ "version": "0.10.0",
4
4
  "description": "Web console and diagnostic workbench for AI coding agents — Elysia + Preact on Bun.",
5
5
  "license": "UNLICENSED",
6
6
  "author": "Wijanarko Putra Rajeb <wijanarko.rajeb@gmail.com>",
@@ -61,8 +61,10 @@
61
61
  "publish:plugins": "bash .github/scripts/publish-plugin-packages.sh packages/kabmo-sdk packages/kabmo-ui"
62
62
  },
63
63
  "dependencies": {
64
+ "@codemirror/autocomplete": "6.20.4",
64
65
  "@codemirror/commands": "6.11.1",
65
66
  "@codemirror/language": "6.13.1",
67
+ "@codemirror/legacy-modes": "^6.5.5",
66
68
  "@codemirror/merge": "6.12.3",
67
69
  "@codemirror/search": "6.7.2",
68
70
  "@codemirror/state": "6.7.6",
@@ -0,0 +1,249 @@
1
+ /**
2
+ * @license
3
+ * SPDX-License-Identifier: Apache-2.0
4
+ */
5
+
6
+ /**
7
+ * The bracket pair guide, and the mode table that makes pairing token-aware.
8
+ *
9
+ * Three failure modes are silent here and each is a test:
10
+ *
11
+ * - A guide drawn at the line's LEFT edge instead of under the opening brace
12
+ * looks like an indent guide, which is a different feature. The column is a
13
+ * decoration attribute, so the assertion is on the emitted style.
14
+ * - A guide through a BLANK line makes a block read as if it continued across
15
+ * the gap between two functions.
16
+ * - A mode table entry that does not exist in `@codemirror/legacy-modes` fails
17
+ * only when a user opens that language — so every entry is resolved here.
18
+ */
19
+
20
+ import { describe, expect, test } from 'bun:test';
21
+ import { EditorState } from '@codemirror/state';
22
+ import { Decoration } from '@codemirror/view';
23
+
24
+ import {
25
+ bracketGuideDecorations,
26
+ bracketPairAt,
27
+ MAX_GUIDE_LINES,
28
+ } from '@/client/components/common/code-surface/bracket-guide';
29
+ import {
30
+ STREAM_MODE_EXPORTS,
31
+ STREAM_MODE_LOADERS,
32
+ TEXTUAL_ONLY_LANGS,
33
+ streamModeFor,
34
+ } from '@/shared/lib/code/editor/stream-modes';
35
+ import { LANG_LOADERS } from '@/shared/lib/code/shiki-langs';
36
+
37
+ function stateOf(doc: string, caret: number): EditorState {
38
+ return EditorState.create({ doc, selection: { anchor: caret } });
39
+ }
40
+
41
+ /** The lines a guide decorates, as 1-based numbers. */
42
+ function guidedLines(state: EditorState): number[] {
43
+ const lines: number[] = [];
44
+ const set = bracketGuideDecorations(state);
45
+ const iter = set.iter();
46
+ while (iter.value) {
47
+ lines.push(state.doc.lineAt(iter.from).number);
48
+ iter.next();
49
+ }
50
+ return lines;
51
+ }
52
+
53
+ /** The column each guide carries, from the emitted attribute. */
54
+ function guideColumns(state: EditorState): string[] {
55
+ const columns: string[] = [];
56
+ const iter = bracketGuideDecorations(state).iter();
57
+ while (iter.value) {
58
+ const spec = iter.value.spec as { attributes?: Record<string, string> };
59
+ columns.push(spec.attributes?.style ?? '');
60
+ iter.next();
61
+ }
62
+ return columns;
63
+ }
64
+
65
+ const DOC = [
66
+ 'function outer() {',
67
+ ' if (a) {',
68
+ ' inner();',
69
+ ' }',
70
+ ' return 1;',
71
+ '}',
72
+ ].join('\n');
73
+
74
+ describe('bracketPairAt', () => {
75
+ test('the caret beside an opening brace finds its pair', () => {
76
+ const open = DOC.indexOf('{', DOC.indexOf('if'));
77
+ const state = stateOf(DOC, open + 1);
78
+ const pair = bracketPairAt(state);
79
+ expect(pair).not.toBeNull();
80
+ expect(pair?.open).toBe(open);
81
+ // `close` is the offset just PAST the closing brace: `bracketPairAt` stores
82
+ // `match.end.to` so the guide's span covers the brace glyph itself.
83
+ expect(pair?.close).toBe(DOC.indexOf('}', DOC.indexOf('inner')) + 1);
84
+ expect(DOC[pair!.close - 1]).toBe('}');
85
+ });
86
+
87
+ test('the caret beside the CLOSING brace finds the same pair', () => {
88
+ const close = DOC.indexOf('\n}', DOC.indexOf('return 1')) + 1;
89
+ const state = stateOf(DOC, close);
90
+ expect(bracketPairAt(state)?.open).toBe(DOC.indexOf('{'));
91
+ });
92
+
93
+ test('a caret in ordinary text has no pair', () => {
94
+ expect(bracketPairAt(stateOf(DOC, DOC.indexOf('inner')))).toBeNull();
95
+ });
96
+ });
97
+
98
+ describe('bracketGuideDecorations', () => {
99
+ test('every non-blank line between the braces gets a guide', () => {
100
+ const open = DOC.indexOf('{', DOC.indexOf('if'));
101
+ // Lines 3 (`inner();`) and 4 (`}`) sit between the `if` opener (line 2) and
102
+ // its closing brace (line 4) — line 4 is the closing brace's own line, so
103
+ // only line 3 is strictly between.
104
+ expect(guidedLines(stateOf(DOC, open + 1))).toEqual([3]);
105
+ });
106
+
107
+ test('the OUTER pair guides every row of its body', () => {
108
+ // `function outer() {` … `}` spans lines 2-5.
109
+ expect(guidedLines(stateOf(DOC, DOC.indexOf('{') + 1))).toEqual([2, 3, 4, 5]);
110
+ });
111
+
112
+ test('a blank line gets no guide, so a gap reads as a gap', () => {
113
+ const doc = 'function f() {\n a();\n\n b();\n}\n';
114
+ expect(guidedLines(stateOf(doc, doc.indexOf('{') + 1))).toEqual([2, 4]);
115
+ });
116
+
117
+ test('a one-line pair draws nothing — there is no span to connect', () => {
118
+ const doc = 'if (a) { b(); }\n';
119
+ expect(guidedLines(stateOf(doc, doc.indexOf('{') + 1))).toEqual([]);
120
+ });
121
+
122
+ test('a caret with no pair draws nothing', () => {
123
+ expect(guidedLines(stateOf(DOC, DOC.indexOf('inner')))).toEqual([]);
124
+ });
125
+
126
+ test('the column is the OPENING BRACE’s, not the line’s left edge', () => {
127
+ // `function outer() {` is 18 characters and the brace is the 18th, so its
128
+ // zero-based offset is 17. A guide at the line's left edge would be 0 —
129
+ // which is an INDENT guide, a different feature.
130
+ const columns = guideColumns(stateOf(DOC, DOC.indexOf('{') + 1));
131
+ expect(columns.length).toBeGreaterThan(0);
132
+ expect(columns[0]).toBe('--bracket-guide-col: 17');
133
+ // Every row of one pair shares one column, or the rule would not be straight.
134
+ expect(new Set(columns).size).toBe(1);
135
+ });
136
+
137
+ test('a pair spanning more than MAX_GUIDE_LINES is refused rather than drawn', () => {
138
+ const body = ' x();\n'.repeat(MAX_GUIDE_LINES + 5);
139
+ const doc = `function f() {\n${body}}\n`;
140
+ expect(guidedLines(stateOf(doc, doc.indexOf('{') + 1))).toEqual([]);
141
+ });
142
+
143
+ test('a pair just inside the cap still draws', () => {
144
+ const body = ' x();\n'.repeat(20);
145
+ const doc = `function f() {\n${body}}\n`;
146
+ expect(guidedLines(stateOf(doc, doc.indexOf('{') + 1)).length).toBe(20);
147
+ });
148
+
149
+ test('the decoration is a LINE decoration, not a mark', () => {
150
+ // A mark would paint the text; the guide is a rule beside it.
151
+ const iter = bracketGuideDecorations(stateOf(DOC, DOC.indexOf('{') + 1)).iter();
152
+ const spec = iter.value?.spec as { class?: string } | undefined;
153
+ expect(spec?.class).toBe('cm-bracket-guide');
154
+ });
155
+ });
156
+
157
+ describe('stream mode table', () => {
158
+ test('every entry resolves to a real mode, through its own literal loader', async () => {
159
+ // The whole point: a typo here fails only when a user opens that language.
160
+ // Resolved through the LOADER rather than a template specifier, because that
161
+ // is the path the app takes — and the template form is exactly what never
162
+ // resolved at runtime (measured in the dev server).
163
+ const broken: string[] = [];
164
+ for (const [language, loader] of Object.entries(STREAM_MODE_LOADERS)) {
165
+ const exportName = STREAM_MODE_EXPORTS[language];
166
+ if (!exportName) {
167
+ broken.push(`${language} has a loader but no export name`);
168
+ continue;
169
+ }
170
+ try {
171
+ const module = await loader();
172
+ const mode = (module as Record<string, unknown>)[exportName];
173
+ const isMode = mode !== null && typeof mode === 'object' && typeof (mode as { token?: unknown }).token === 'function';
174
+ if (!isMode) broken.push(`${language} → export "${exportName}" is not a mode`);
175
+ } catch (error) {
176
+ broken.push(`${language} loader failed: ${error instanceof Error ? error.message : String(error)}`);
177
+ }
178
+ }
179
+ expect(broken).toEqual([]);
180
+ });
181
+
182
+ test('every Shiki language this app names is either parsed or explicitly textual', () => {
183
+ // A language added to `LANG_LOADERS` without a decision here would silently
184
+ // fall back to the textual matcher, and nothing would say so.
185
+ const decided = new Set([...Object.keys(STREAM_MODE_LOADERS), ...TEXTUAL_ONLY_LANGS]);
186
+ const undecided = Object.keys(LANG_LOADERS).filter((language) => !decided.has(language));
187
+ expect(undecided).toEqual([]);
188
+ });
189
+
190
+ test('the two sets do not overlap', () => {
191
+ const both = Object.keys(STREAM_MODE_LOADERS).filter((language) => TEXTUAL_ONLY_LANGS.includes(language));
192
+ expect(both).toEqual([]);
193
+ });
194
+
195
+ test('streamModeFor answers null for a language with no mode', () => {
196
+ expect(streamModeFor('markdown')).toBeNull();
197
+ expect(streamModeFor('graphql')).toBeNull();
198
+ expect(streamModeFor('text')).toBeNull();
199
+ });
200
+
201
+ test('streamModeFor answers the export for a covered language', () => {
202
+ // The MODULE is the loader's own literal specifier; `module` here names the
203
+ // language key, which is what the loader table is indexed by.
204
+ expect(streamModeFor('typescript')?.export).toBe('typescript');
205
+ expect(streamModeFor('bash')?.export).toBe('shell');
206
+ // And an export that does NOT match the id, which is the case a table of
207
+ // "same name" would get wrong.
208
+ expect(streamModeFor('scss')?.export).toBe('sCSS');
209
+ expect(streamModeFor('objective-c')?.export).toBe('objectiveC');
210
+ });
211
+ });
212
+
213
+ describe('a stream language makes pairing token-aware', () => {
214
+ test('a brace inside a string is not paired with the real closing brace', async () => {
215
+ // The measured failure of the textual matcher: without a mode it pairs the
216
+ // `{` with the `}` inside a string 14 characters away.
217
+ const { StreamLanguage, matchBrackets } = await import('@codemirror/language');
218
+ const rust = await import('@codemirror/legacy-modes/mode/rust');
219
+ const doc = 'fn f() {\n let s = "}";\n g();\n}\n';
220
+ const open = doc.indexOf('{');
221
+
222
+ const textual = stateOf(doc, open);
223
+ const textualMatch = matchBrackets(textual, open, 1);
224
+ expect(textualMatch?.end?.from).toBe(doc.indexOf('"}') + 1);
225
+
226
+ const parsed = EditorState.create({
227
+ doc,
228
+ extensions: [StreamLanguage.define(rust.rust as never)],
229
+ });
230
+ const parsedMatch = matchBrackets(parsed, open, 1);
231
+ expect(parsedMatch?.matched).toBe(true);
232
+ expect(parsedMatch?.end?.from).toBe(doc.lastIndexOf('}'));
233
+ });
234
+
235
+ test('the tree exists synchronously, so the guide is right on the first paint', async () => {
236
+ const { StreamLanguage, syntaxTree } = await import('@codemirror/language');
237
+ const rust = await import('@codemirror/legacy-modes/mode/rust');
238
+ const doc = 'fn f() {\n g();\n}\n';
239
+ const state = EditorState.create({ doc, extensions: [StreamLanguage.define(rust.rust as never)] });
240
+ // No `ensureSyntaxTree`, no worker: a StreamLanguage parses from the token
241
+ // stream as the state is read. Measured against a lezer grammar, whose tree
242
+ // is 3 KB until its lazy parse catches up.
243
+ expect(syntaxTree(state).length).toBe(doc.length);
244
+ });
245
+ });
246
+
247
+ // Keep the import used: `Decoration` is what the guide builds, and a test that
248
+ // asserts the class is the one that proves it.
249
+ void Decoration;
@@ -0,0 +1,131 @@
1
+ /**
2
+ * @license
3
+ * SPDX-License-Identifier: Apache-2.0
4
+ */
5
+
6
+ /**
7
+ * The bracket pair GUIDE: the vertical line from the caret's brace to its pair.
8
+ *
9
+ * `bracketMatching()` paints two characters and nothing between them. What a
10
+ * reader actually needs on a 300-line block is the SPAN — where the block ends —
11
+ * and that is a line decoration on every row in between.
12
+ *
13
+ * Three decisions, each because the alternative was measured and worse.
14
+ *
15
+ * **The guide is driven by the CARET, not by every pair in the viewport.** A
16
+ * viewport-wide version (VS Code's `bracketPairGuides`) draws a rule for every
17
+ * brace on screen: on a 337-line component that is dozens of overlapping lines,
18
+ * which is the same noise as a permanently-on indent guide and hides the one
19
+ * pair the reader is looking at. This shows the pair the caret is IN.
20
+ *
21
+ * **It reads `matchBrackets`, the same call `bracketMatching()` makes.** A second
22
+ * pairing rule would eventually disagree with the highlight, and a guide that
23
+ * points somewhere the highlight does not is worse than none.
24
+ *
25
+ * **Blank lines get no guide.** A rule through the blank line between two
26
+ * functions reads as if the block continued through it; the gap is the signal.
27
+ *
28
+ * The cost is one decoration per line of the block, rebuilt on selection and
29
+ * document changes — 4 decorations for a typical block, and the span is capped
30
+ * by `MAX_GUIDE_LINES` so a 5 000-line block cannot turn a caret move into
31
+ * thousands of ranges.
32
+ */
33
+
34
+ import { RangeSetBuilder, type EditorState } from '@codemirror/state';
35
+ import { Decoration, ViewPlugin, type DecorationSet, type EditorView } from '@codemirror/view';
36
+ import { matchBrackets } from '@codemirror/language';
37
+
38
+ /**
39
+ * How many lines a guide may span.
40
+ *
41
+ * A guide longer than this is not a block a reader is following, it is a
42
+ * container whose closing brace is off screen — and drawing it would mean one
43
+ * decoration per row of the whole file on every caret move.
44
+ */
45
+ export const MAX_GUIDE_LINES = 400;
46
+
47
+ /**
48
+ * The column the guide is drawn in: the opening brace's own, in CH.
49
+ *
50
+ * The line's text is indented, and the brace sits after whatever precedes it
51
+ * (`function f() {`), so a rule at the line's left edge would point at nothing.
52
+ * `ch` is right because the editor is monospace — measured: the surface sets
53
+ * `font-family: inherit` from a host that carries Fira Code, so one character is
54
+ * one `ch` on every row.
55
+ */
56
+ function guideColumn(state: EditorState, openPos: number): number {
57
+ const line = state.doc.lineAt(openPos);
58
+ return openPos - line.from;
59
+ }
60
+
61
+ /**
62
+ * The bracket pair the caret sits in, or null.
63
+ *
64
+ * Tries the four positions `bracketDeco` tries, in the same order, so the guide
65
+ * and the highlight can never point at different pairs.
66
+ */
67
+ export function bracketPairAt(state: EditorState): { open: number; close: number } | null {
68
+ const head = state.selection.main.head;
69
+ const attempts: Array<[number, 1 | -1]> = [
70
+ [head, -1],
71
+ [head - 1, 1],
72
+ [head, 1],
73
+ [head + 1, -1],
74
+ ];
75
+ for (const [pos, dir] of attempts) {
76
+ if (pos < 0 || pos > state.doc.length) continue;
77
+ const match = matchBrackets(state, pos, dir);
78
+ if (match?.matched && match.end) {
79
+ return { open: Math.min(match.start.from, match.end.from), close: Math.max(match.start.to, match.end.to) };
80
+ }
81
+ }
82
+ return null;
83
+ }
84
+
85
+ /** One line decoration per row the pair spans, carrying its own column. */
86
+ function guideLine(column: number): Decoration {
87
+ return Decoration.line({
88
+ class: 'cm-bracket-guide',
89
+ attributes: { style: `--bracket-guide-col: ${column}` },
90
+ });
91
+ }
92
+
93
+ /** The guide decorations for a state. Exported so a test can assert the rule. */
94
+ export function bracketGuideDecorations(state: EditorState): DecorationSet {
95
+ const pair = bracketPairAt(state);
96
+ if (!pair) return Decoration.none;
97
+
98
+ const openLine = state.doc.lineAt(pair.open);
99
+ const closeLine = state.doc.lineAt(pair.close);
100
+ // A one-line pair has nothing between its braces to connect.
101
+ if (closeLine.number - openLine.number <= 1) return Decoration.none;
102
+ if (closeLine.number - openLine.number > MAX_GUIDE_LINES) return Decoration.none;
103
+
104
+ const column = guideColumn(state, pair.open);
105
+ const decoration = guideLine(column);
106
+ const builder = new RangeSetBuilder<Decoration>();
107
+ for (let number = openLine.number + 1; number < closeLine.number; number++) {
108
+ const line = state.doc.line(number);
109
+ if (!line.text.trim()) continue;
110
+ builder.add(line.from, line.from, decoration);
111
+ }
112
+ return builder.finish();
113
+ }
114
+
115
+ const guidePlugin = ViewPlugin.fromClass(
116
+ class {
117
+ decorations: DecorationSet;
118
+
119
+ constructor(view: EditorView) {
120
+ this.decorations = bracketGuideDecorations(view.state);
121
+ }
122
+
123
+ update(update: { docChanged: boolean; selectionSet: boolean; viewportChanged: boolean; state: EditorState }) {
124
+ if (update.docChanged || update.selectionSet) this.decorations = bracketGuideDecorations(update.state);
125
+ }
126
+ },
127
+ { decorations: (plugin) => plugin.decorations },
128
+ );
129
+
130
+ /** The guide, as one extension. */
131
+ export const bracketGuide = guidePlugin;
@@ -30,6 +30,8 @@ function cache(overrides: Partial<Parameters<typeof createDocumentCache>[0]> = {
30
30
  wordWrap: false,
31
31
  readOnly: false,
32
32
  themes: SHIKI_THEMES,
33
+ indentUnitText: ' ',
34
+ typing: { autoCloseBrackets: false, autocomplete: false },
33
35
  onDocChange: () => {},
34
36
  onState: () => {},
35
37
  ...overrides,
@@ -104,9 +106,9 @@ describe('document cache', () => {
104
106
  const documents = cache({ wordWrap: true, readOnly: false });
105
107
  documents.stateFor('a', 'typescript', 'x');
106
108
 
107
- expect(documents.optionsEffects({ wordWrap: true, readOnly: false, themes: SHIKI_THEMES })).toEqual([]);
108
- expect(documents.optionsEffects({ wordWrap: false, readOnly: false, themes: SHIKI_THEMES })).toHaveLength(1);
109
- expect(documents.optionsEffects({ wordWrap: false, readOnly: true, themes: SHIKI_THEMES })).toHaveLength(1);
109
+ expect(documents.optionsEffects({ wordWrap: true, readOnly: false, themes: SHIKI_THEMES, indentUnitText: ' ', typing: { autoCloseBrackets: false, autocomplete: false } })).toEqual([]);
110
+ expect(documents.optionsEffects({ wordWrap: false, readOnly: false, themes: SHIKI_THEMES, indentUnitText: ' ', typing: { autoCloseBrackets: false, autocomplete: false } })).toHaveLength(1);
111
+ expect(documents.optionsEffects({ wordWrap: false, readOnly: true, themes: SHIKI_THEMES, indentUnitText: ' ', typing: { autoCloseBrackets: false, autocomplete: false } })).toHaveLength(1);
110
112
  });
111
113
 
112
114
  test('a new document is created read-only when that is the current setting', () => {
@@ -26,9 +26,11 @@
26
26
  */
27
27
 
28
28
  import { Compartment, EditorState, type Extension, type StateEffect } from '@codemirror/state';
29
+ import { indentExtension } from '@/client/components/common/code-surface/extensions';
29
30
 
30
31
  import type { EditorCommand } from '@/shared/lib/code/editor/keymap';
31
32
  import { readOnlyExtension, surfaceExtensions, wrapExtension } from '@/client/components/common/code-surface/extensions';
33
+ import { typingExtensions, type EditorTypingOptions } from '@/client/components/common/code-surface/typing';
32
34
  import { shikiHighlight, type ShikiThemeNames } from '@/client/components/common/code-surface/shiki';
33
35
 
34
36
  /** States kept alive; past this the least recently used one is dropped. */
@@ -37,6 +39,22 @@ const MAX_CACHED = 12;
37
39
  export interface SurfaceOptions {
38
40
  wordWrap: boolean;
39
41
  readOnly: boolean;
42
+ /**
43
+ * One indentation level, as a whitespace string.
44
+ *
45
+ * Part of the live options rather than the document key: an indentation setting is
46
+ * one choice for every tab, so a new key per width would throw away every open
47
+ * tab's undo history when the user picked 4 spaces.
48
+ */
49
+ indentUnitText: string;
50
+ /**
51
+ * Auto-close brackets and the completer.
52
+ *
53
+ * Part of the live options, and it needs a RECONFIGURE rather than a value baked into
54
+ * the state: a setting changed while a tab is open must reach it, and a re-mount would
55
+ * drop the undo history.
56
+ */
57
+ typing: EditorTypingOptions;
40
58
  /**
41
59
  * The tokenizer's two theme names.
42
60
  *
@@ -55,6 +73,8 @@ export interface DocumentCacheDeps extends SurfaceOptions {
55
73
  onDocChange: (value: string) => void;
56
74
  /** Every state worth remembering (an edit or a selection move). */
57
75
  onState: (state: EditorState) => void;
76
+ /** The caret's line and column, for a status readout. */
77
+ onCaret?: (position: { line: number; column: number }) => void;
58
78
  }
59
79
 
60
80
  export interface DocumentCache {
@@ -81,6 +101,14 @@ export interface DocumentCache {
81
101
  * a document switch owes.
82
102
  */
83
103
  currentEffects(key?: string): StateEffect<unknown>[];
104
+ /**
105
+ * Effects that install a stream language on `key`'s document.
106
+ *
107
+ * The mode is a lazy import, so a document is created WITHOUT one and gets it
108
+ * here when the module lands. Reconfiguring the compartment keeps the
109
+ * document, the selection and the undo history — it only swaps the parser.
110
+ */
111
+ languageEffects(key: string, language: Extension): StateEffect<unknown>[];
84
112
  }
85
113
 
86
114
  /** Whether two theme pairs name the same Shiki themes. */
@@ -94,10 +122,23 @@ export function createDocumentCache(deps: DocumentCacheDeps): DocumentCache {
94
122
  wordWrap: deps.wordWrap,
95
123
  readOnly: deps.readOnly,
96
124
  themes: deps.themes,
125
+ indentUnitText: deps.indentUnitText,
126
+ typing: deps.typing,
97
127
  };
98
128
  const wordWrapCompartment = new Compartment();
99
129
  const readOnlyCompartment = new Compartment();
130
+ const indentCompartment = new Compartment();
131
+ const typingCompartment = new Compartment();
100
132
  const themeCompartment = new Compartment();
133
+ /**
134
+ * The stream language, when its module has loaded.
135
+ *
136
+ * Per DOCUMENT rather than per view: two tabs in different languages are two
137
+ * states, and a reconfigure of one must not touch the other's tree. It starts
138
+ * empty and is filled by `languageEffects`, which is what the loader's
139
+ * notification drives.
140
+ */
141
+ const languageCompartment = new Compartment();
101
142
  /** The language each cached state was built for, so a theme reconfigure can
102
143
  * rebuild its tokenizer with the SAME grammar. */
103
144
  const languages = new Map<string, string>();
@@ -110,6 +151,14 @@ export function createDocumentCache(deps: DocumentCacheDeps): DocumentCache {
110
151
  * nothing — 2.1 ms on a 20 000-line file, every switch.
111
152
  */
112
153
  const themesByKey = new Map<string, ShikiThemeNames>();
154
+ /**
155
+ * The indentation unit each cached state currently holds.
156
+ *
157
+ * Tracked for the same reason as `themesByKey`: `currentEffects` runs on every tab
158
+ * switch, and reconfiguring a compartment with the value it already has is work
159
+ * for nothing on a file with a large gutter.
160
+ */
161
+ const indentByKey = new Map<string, string>();
113
162
 
114
163
  const extensionsFor = (language: string): Extension[] =>
115
164
  surfaceExtensions({
@@ -117,9 +166,13 @@ export function createDocumentCache(deps: DocumentCacheDeps): DocumentCache {
117
166
  wordWrapCompartment,
118
167
  readOnlyCompartment,
119
168
  themeCompartment,
169
+ languageCompartment,
170
+ indentCompartment,
171
+ typingCompartment,
120
172
  onCommand: deps.onCommand,
121
173
  onDocChange: deps.onDocChange,
122
174
  onState: deps.onState,
175
+ onCaret: deps.onCaret,
123
176
  ...options,
124
177
  });
125
178
 
@@ -148,6 +201,7 @@ export function createDocumentCache(deps: DocumentCacheDeps): DocumentCache {
148
201
  states.set(key, state);
149
202
  languages.set(key, language);
150
203
  themesByKey.set(key, options.themes);
204
+ indentByKey.set(key, options.indentUnitText);
151
205
  evict();
152
206
  return state;
153
207
  },
@@ -160,18 +214,35 @@ export function createDocumentCache(deps: DocumentCacheDeps): DocumentCache {
160
214
  states.delete(key);
161
215
  languages.delete(key);
162
216
  themesByKey.delete(key);
217
+ indentByKey.delete(key);
163
218
  },
164
219
 
165
220
  optionsEffects(next, key) {
166
221
  const wrapChanged = next.wordWrap !== options.wordWrap;
167
222
  const readOnlyChanged = next.readOnly !== options.readOnly;
223
+ const indentChanged = next.indentUnitText !== options.indentUnitText;
224
+ const typingChanged =
225
+ next.typing.autoCloseBrackets !== options.typing.autoCloseBrackets ||
226
+ next.typing.autocomplete !== options.typing.autocomplete;
168
227
  const themeChanged = next.themes.light !== options.themes.light || next.themes.dark !== options.themes.dark;
169
228
  options.wordWrap = next.wordWrap;
170
229
  options.readOnly = next.readOnly;
171
230
  options.themes = next.themes;
231
+ options.indentUnitText = next.indentUnitText;
232
+ options.typing = next.typing;
172
233
  const effects: StateEffect<unknown>[] = [];
173
234
  if (wrapChanged) effects.push(wordWrapCompartment.reconfigure(wrapExtension(options.wordWrap)));
174
235
  if (readOnlyChanged) effects.push(readOnlyCompartment.reconfigure(readOnlyExtension(options.readOnly)));
236
+ // The indent unit AND the tab size move together: a tab-indented setting is
237
+ // one column wide as a unit, and `getIndentUnit` reads `tabSize` to measure
238
+ // it — so a reconfigure of one without the other would measure a level wrong.
239
+ if (indentChanged) {
240
+ effects.push(indentCompartment.reconfigure(indentExtension(options.indentUnitText)));
241
+ if (key) indentByKey.set(key, options.indentUnitText);
242
+ }
243
+ // A BEHAVIOUR toggle reconfigures rather than re-mounts, so an open tab keeps its
244
+ // undo history when the user flips auto-close or the completer.
245
+ if (typingChanged) effects.push(typingCompartment.reconfigure(typingExtensions(options.typing)));
175
246
  // The plugin carries the language, so the tokenizer is rebuilt from THIS
176
247
  // document's grammar. Other cached states are handled by `currentEffects`
177
248
  // when they are applied, which is the moment they need it.
@@ -187,8 +258,15 @@ export function createDocumentCache(deps: DocumentCacheDeps): DocumentCache {
187
258
  const effects: StateEffect<unknown>[] = [
188
259
  wordWrapCompartment.reconfigure(wrapExtension(options.wordWrap)),
189
260
  readOnlyCompartment.reconfigure(readOnlyExtension(options.readOnly)),
261
+
190
262
  ];
191
263
  const language = key ? languages.get(key) : undefined;
264
+ // A cached state carries the unit it was CREATED with, so a tab opened before
265
+ // the setting changed would indent by the old width for its whole life.
266
+ if (key && indentByKey.get(key) !== options.indentUnitText) {
267
+ effects.push(indentCompartment.reconfigure(indentExtension(options.indentUnitText)));
268
+ indentByKey.set(key, options.indentUnitText);
269
+ }
192
270
  // Only when this state's tokenizer still holds another theme: a switch
193
271
  // back to a tab that already has it must not re-tokenize.
194
272
  if (key && language && !sameThemes(themesByKey.get(key), options.themes)) {
@@ -197,5 +275,12 @@ export function createDocumentCache(deps: DocumentCacheDeps): DocumentCache {
197
275
  }
198
276
  return effects;
199
277
  },
278
+
279
+ languageEffects(key, language) {
280
+ // Only a document this cache owns can be reconfigured; a key it has never
281
+ // seen is a caller asking about a tab that closed while the mode loaded.
282
+ if (!states.has(key)) return [];
283
+ return [languageCompartment.reconfigure(language)];
284
+ },
200
285
  };
201
286
  }
@@ -31,6 +31,11 @@ function stateFor(language: string, doc = 'const alpha = 1;\n') {
31
31
  wordWrapCompartment: new Compartment(),
32
32
  readOnlyCompartment: new Compartment(),
33
33
  themeCompartment: new Compartment(),
34
+ languageCompartment: new Compartment(),
35
+ indentCompartment: new Compartment(),
36
+ typingCompartment: new Compartment(),
37
+ indentUnitText: ' ',
38
+ typing: { autoCloseBrackets: false, autocomplete: false },
34
39
  wordWrap: false,
35
40
  readOnly: false,
36
41
  themes: SHIKI_THEMES,