@kubohiroya/turbowarp-plus-editor-project-folder 0.9.2 → 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.
- package/README.ja.md +2 -1
- package/README.md +2 -1
- package/dist/explorer-state.d.ts +22 -0
- package/dist/explorer.d.ts +5 -0
- package/dist/explorer.js +283 -74
- package/dist/file-preview.d.ts +14 -4
- package/dist/index.d.ts +6 -1
- package/dist/index.js +99 -12
- package/dist/session.d.ts +18 -0
- package/dist/{shared-Dco5rGKE.js → shared-teFlHQ2X.js} +15 -4
- package/dist/{shared-Dz9dzxQF.js → shared-zlHgCKDG.js} +33 -1
- package/dist/text-file-editor.d.ts +5 -0
- package/package.json +1 -1
- package/src/explorer-files.ts +2 -1
- package/src/explorer-menu.tsx +1 -1
- package/src/explorer-state.ts +50 -0
- package/src/explorer.tsx +191 -43
- package/src/file-preview.ts +22 -4
- package/src/index.ts +6 -1
- package/src/session.ts +112 -10
- package/src/text-file-editor.ts +16 -3
package/src/session.ts
CHANGED
|
@@ -6,6 +6,58 @@ import type {ReloadTarget} from './block-reload.js';
|
|
|
6
6
|
import {applyScriptReload, planScriptReload} from './script-reload.js';
|
|
7
7
|
import type {DeserializeBlocks, ScriptReloadTarget} from './script-reload.js';
|
|
8
8
|
import {createProjectFolder} from './create-folder.js';
|
|
9
|
+
import {editorDirectory, parseExplorerState, readExplorerState, screenStateFile, writeExplorerState} from './explorer-state.js';
|
|
10
|
+
import type {ExplorerTreeState} from './explorer-state.js';
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* The Editor's screen state, such as `installProjectScreenState` of the workbench gives it. A project folder is not
|
|
14
|
+
* an SB3, so the folder keeps the state as `.tw-plus/workspace.json` and gives it back when it opens.
|
|
15
|
+
*/
|
|
16
|
+
export interface FolderScreenState {
|
|
17
|
+
/** The text to write, or nothing to leave the file as it is. */
|
|
18
|
+
serialize(): string | undefined;
|
|
19
|
+
/** Use this text for the next project load. */
|
|
20
|
+
prepareLoad(text: string | undefined): void;
|
|
21
|
+
/** Add a slice, here the explorer's tree. Returns a function that removes it. */
|
|
22
|
+
register?(key: string, slice: {capture(): unknown; apply?(value: unknown): void}): () => void;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
const screenStateMaxBytes = 512 * 1024;
|
|
26
|
+
const notFound = (error: unknown) => error instanceof DOMException && ['NotFoundError', 'TypeMismatchError'].includes(error.name);
|
|
27
|
+
|
|
28
|
+
/** The screen state the folder was saved with, or nothing. */
|
|
29
|
+
async function readScreenStateText(directory: FileSystemDirectoryHandle) {
|
|
30
|
+
try {
|
|
31
|
+
const file = await (await (await directory.getDirectoryHandle(editorDirectory)).getFileHandle(screenStateFile)).getFile();
|
|
32
|
+
return file.size > screenStateMaxBytes ? undefined : await file.text();
|
|
33
|
+
} catch (error) {
|
|
34
|
+
if (!notFound(error)) console.warn('The screen state of the project folder could not be read', error);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/** The slices of a screen state, to tell whether only the time of the save changed. */
|
|
39
|
+
const slicesOf = (text: string | undefined) => {
|
|
40
|
+
try { return JSON.stringify(JSON.parse(text!).slices); } catch { return undefined; }
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
/** Write the screen state next to the project. Failing to write it never fails the save. */
|
|
44
|
+
async function writeScreenStateText(directory: FileSystemDirectoryHandle, text: string) {
|
|
45
|
+
try {
|
|
46
|
+
if (slicesOf(await readScreenStateText(directory)) === slicesOf(text)) return;
|
|
47
|
+
const handle = await (await directory.getDirectoryHandle(editorDirectory, {create: true}))
|
|
48
|
+
.getFileHandle(screenStateFile, {create: true});
|
|
49
|
+
const writable = await handle.createWritable();
|
|
50
|
+
try {
|
|
51
|
+
await writable.write(new TextEncoder().encode(text));
|
|
52
|
+
await writable.close();
|
|
53
|
+
} catch (error) {
|
|
54
|
+
await writable.abort().catch(() => {});
|
|
55
|
+
throw error;
|
|
56
|
+
}
|
|
57
|
+
} catch (error) {
|
|
58
|
+
console.warn('The screen state of the project folder could not be saved', error);
|
|
59
|
+
}
|
|
60
|
+
}
|
|
9
61
|
|
|
10
62
|
export interface FolderVM {
|
|
11
63
|
runtime: {
|
|
@@ -61,6 +113,7 @@ export interface FolderHost {
|
|
|
61
113
|
*/
|
|
62
114
|
compareChanges?(request: ComparisonRequest): Promise<string | null>;
|
|
63
115
|
};
|
|
116
|
+
screenState?: FolderScreenState;
|
|
64
117
|
}
|
|
65
118
|
|
|
66
119
|
/** A titled comparison of two project.source.json texts; `null` stands for a version that cannot be shown. */
|
|
@@ -90,6 +143,13 @@ type SaveResult = {status: 'saved' | 'unchanged'; sourceRemoved: string[]};
|
|
|
90
143
|
type SaveDirectory = {directory: FileSystemDirectoryHandle; files: Map<string, Uint8Array>; prefix: string};
|
|
91
144
|
|
|
92
145
|
type VMAsset = {assetId: string; dataFormat: string; data?: Uint8Array};
|
|
146
|
+
const encodeJson = (value: unknown) => new TextEncoder().encode(`${JSON.stringify(value, null, 2)}\n`);
|
|
147
|
+
|
|
148
|
+
function saveManifest(source: FolderSource, added: Iterable<string>, removed: readonly string[]) {
|
|
149
|
+
const value = JSON.parse(new TextDecoder().decode(source.files.get(manifestFile))) as JsonObject;
|
|
150
|
+
const entries = (value.archiveEntries as string[]).filter(name => !removed.includes(name));
|
|
151
|
+
return encodeJson({...value, archiveEntries: [...entries, ...added]});
|
|
152
|
+
}
|
|
93
153
|
|
|
94
154
|
export function createFolderSession(vm: FolderVM, host: FolderHost) {
|
|
95
155
|
let current: Session | null = null;
|
|
@@ -163,6 +223,22 @@ export function createFolderSession(vm: FolderVM, host: FolderHost) {
|
|
|
163
223
|
const removed = [...source.bytes.keys()].filter(name => !needed.has(name));
|
|
164
224
|
return {result, extensionSave, added, removed};
|
|
165
225
|
};
|
|
226
|
+
// The explorer's tree from the folder's screen state. It can arrive before or after the folder is current.
|
|
227
|
+
let expectingTree = false;
|
|
228
|
+
let pendingTree: ExplorerTreeState | undefined;
|
|
229
|
+
const unregisterTree = host.screenState?.register?.('projectFolder', {
|
|
230
|
+
capture: () => current ? readExplorerState(current.source.directory) : undefined,
|
|
231
|
+
apply(value) {
|
|
232
|
+
const tree = parseExplorerState(value);
|
|
233
|
+
if (!tree) return;
|
|
234
|
+
if (current) writeExplorerState(current.source.directory, tree, true);
|
|
235
|
+
else if (expectingTree) pendingTree = tree;
|
|
236
|
+
}
|
|
237
|
+
});
|
|
238
|
+
const saveScreenState = async (directory: FileSystemDirectoryHandle) => {
|
|
239
|
+
const text = host.screenState?.serialize();
|
|
240
|
+
if (text !== undefined) await writeScreenStateText(directory, text);
|
|
241
|
+
};
|
|
166
242
|
const loaded = () => setCurrent(null);
|
|
167
243
|
vm.runtime.on('PROJECT_LOADED', loaded);
|
|
168
244
|
vm.on('PROJECT_CHANGED', changed);
|
|
@@ -178,6 +254,7 @@ export function createFolderSession(vm: FolderVM, host: FolderHost) {
|
|
|
178
254
|
editListeners.clear();
|
|
179
255
|
vm.runtime.off('PROJECT_LOADED', loaded);
|
|
180
256
|
vm.off('PROJECT_CHANGED', changed);
|
|
257
|
+
unregisterTree?.();
|
|
181
258
|
};
|
|
182
259
|
const openFrom = async (
|
|
183
260
|
getDirectory: () => Promise<FileSystemDirectoryHandle | null>,
|
|
@@ -202,7 +279,10 @@ export function createFolderSession(vm: FolderVM, host: FolderHost) {
|
|
|
202
279
|
const assets = source.storageAssets;
|
|
203
280
|
reader.assets = assets;
|
|
204
281
|
let stage: object | null;
|
|
282
|
+
pendingTree = undefined;
|
|
283
|
+
expectingTree = true;
|
|
205
284
|
try {
|
|
285
|
+
if (host.screenState) host.screenState.prepareLoad(await readScreenStateText(directory));
|
|
206
286
|
vm.quit();
|
|
207
287
|
await vm.loadProject(source.loadText, {replaceLegacyExtensions: true});
|
|
208
288
|
stage = vm.runtime.getTargetForStage();
|
|
@@ -213,6 +293,10 @@ export function createFolderSession(vm: FolderVM, host: FolderHost) {
|
|
|
213
293
|
host.onOpened(directory.name);
|
|
214
294
|
const baseline = snapshot();
|
|
215
295
|
setCurrent({source, stage, baseline, ids: identify(baseline), pending: null});
|
|
296
|
+
// The tree may come with the load or right after it; once the folder is current, it is written there.
|
|
297
|
+
expectingTree = false;
|
|
298
|
+
if (pendingTree) writeExplorerState(directory, pendingTree, true);
|
|
299
|
+
pendingTree = undefined;
|
|
216
300
|
vm.renderer?.draw();
|
|
217
301
|
return 'opened';
|
|
218
302
|
} finally {
|
|
@@ -285,6 +369,29 @@ export function createFolderSession(vm: FolderVM, host: FolderHost) {
|
|
|
285
369
|
}
|
|
286
370
|
return paths;
|
|
287
371
|
},
|
|
372
|
+
/** The bytes the next save would write, null for a deletion, or undefined when no preview is available. */
|
|
373
|
+
readUnsavedFile(path: string): Uint8Array | null | undefined {
|
|
374
|
+
if (!current || busy) return;
|
|
375
|
+
try {
|
|
376
|
+
const {result, extensionSave, added, removed} = planSave(current, snapshot());
|
|
377
|
+
if (path === projectFile && result) return encodeJson(extensionSave.project);
|
|
378
|
+
if (path === extensionsFile && extensionSave.manifestChanged) return encodeJson(extensionSave.embedded);
|
|
379
|
+
if (path === manifestFile && (added.length || removed.length))
|
|
380
|
+
return saveManifest(current.source, added.map(([name]) => name), removed);
|
|
381
|
+
if (path.startsWith('assets/')) {
|
|
382
|
+
const name = path.slice('assets/'.length);
|
|
383
|
+
if (removed.includes(name)) return null;
|
|
384
|
+
const kind = added.find(([asset]) => asset === name)?.[1];
|
|
385
|
+
if (kind) return assetData(name, kind) ?? undefined;
|
|
386
|
+
}
|
|
387
|
+
if (path.startsWith('extensions/')) {
|
|
388
|
+
const name = path.slice('extensions/'.length);
|
|
389
|
+
return extensionSave.removed.includes(name) ? null : extensionSave.writes.get(name);
|
|
390
|
+
}
|
|
391
|
+
} catch (error) {
|
|
392
|
+
if (!(error instanceof FolderError)) throw error;
|
|
393
|
+
}
|
|
394
|
+
},
|
|
288
395
|
get canSave() {return current !== null;},
|
|
289
396
|
get busy() {return busy;},
|
|
290
397
|
get reloadState() {return reloadState();},
|
|
@@ -459,18 +566,12 @@ export function createFolderSession(vm: FolderVM, host: FolderHost) {
|
|
|
459
566
|
added.set(name, data);
|
|
460
567
|
}
|
|
461
568
|
if (!result && !removed.length && !extensionSave.removed.length) {
|
|
569
|
+
await saveScreenState(source.directory);
|
|
462
570
|
if (revision === saveRevision) host.onSaved();
|
|
463
571
|
notify();
|
|
464
572
|
return {status: 'unchanged', sourceRemoved: []};
|
|
465
573
|
}
|
|
466
|
-
const
|
|
467
|
-
let manifest: Uint8Array | null = null;
|
|
468
|
-
if (added.size || removed.length) {
|
|
469
|
-
const value = JSON.parse(new TextDecoder().decode(source.files.get(manifestFile))) as JsonObject;
|
|
470
|
-
const entries = (value.archiveEntries as string[]).filter(name => !removed.includes(name));
|
|
471
|
-
value.archiveEntries = [...entries, ...added.keys()];
|
|
472
|
-
manifest = encoder.encode(`${JSON.stringify(value, null, 2)}\n`);
|
|
473
|
-
}
|
|
574
|
+
const manifest = added.size || removed.length ? saveManifest(source, added.keys(), removed) : null;
|
|
474
575
|
const root = {directory: source.directory, files: source.files, prefix: ''};
|
|
475
576
|
const assets = {directory: await source.directory.getDirectoryHandle('assets', {create: true}), files: source.bytes, prefix: 'assets/'};
|
|
476
577
|
const extensions = {directory: await source.directory.getDirectoryHandle('extensions', {create: true}),
|
|
@@ -527,9 +628,9 @@ export function createFolderSession(vm: FolderVM, host: FolderHost) {
|
|
|
527
628
|
for (const [name, data] of extensionSave.writes) await write(extensions, name, data);
|
|
528
629
|
if (manifest) await write(root, manifestFile, manifest);
|
|
529
630
|
if (extensionSave.manifestChanged) {
|
|
530
|
-
await write(root, extensionsFile,
|
|
631
|
+
await write(root, extensionsFile, encodeJson(extensionSave.embedded));
|
|
531
632
|
}
|
|
532
|
-
if (result) await write(root, projectFile,
|
|
633
|
+
if (result) await write(root, projectFile, encodeJson(extensionSave.project));
|
|
533
634
|
} catch (error) {
|
|
534
635
|
for (const restore of undo.reverse()) await restore().catch(() => {});
|
|
535
636
|
throw error;
|
|
@@ -553,6 +654,7 @@ export function createFolderSession(vm: FolderVM, host: FolderHost) {
|
|
|
553
654
|
session.baseline = edited;
|
|
554
655
|
session.ids = ids;
|
|
555
656
|
session.pending = null;
|
|
657
|
+
await saveScreenState(source.directory);
|
|
556
658
|
if (current === session && revision === saveRevision) host.onSaved();
|
|
557
659
|
notify();
|
|
558
660
|
return {status: 'saved', sourceRemoved: extensionSave.sourceRemoved};
|
package/src/text-file-editor.ts
CHANGED
|
@@ -120,6 +120,8 @@ type TextFileOptions = {
|
|
|
120
120
|
readHandle(): Promise<FileSystemFileHandle>;
|
|
121
121
|
readBaseline?(): Promise<FileBaseline | null>;
|
|
122
122
|
close(): void;
|
|
123
|
+
hostSaveShortcut?: boolean;
|
|
124
|
+
onDirtyChange?(): void;
|
|
123
125
|
};
|
|
124
126
|
|
|
125
127
|
export function mountTextFile(parent: HTMLElement, options: TextFileOptions) {
|
|
@@ -199,15 +201,21 @@ export function mountTextFile(parent: HTMLElement, options: TextFileOptions) {
|
|
|
199
201
|
common, mixed ? EditorState.lineSeparator.of('\n') : [], history(), drawSelection(), highlightSpecialChars(),
|
|
200
202
|
highlightActiveLine(), EditorView.contentAttributes.of({'aria-label': options.path}),
|
|
201
203
|
keymap.of([...defaultKeymap, ...historyKeymap]),
|
|
202
|
-
EditorView.updateListener.of(update => {if (update.docChanged) updateSaveState();})
|
|
204
|
+
EditorView.updateListener.of(update => {if (update.docChanged) updateSaveState(undefined, true);})
|
|
203
205
|
]
|
|
204
206
|
});
|
|
205
207
|
const dirty = () => !view.state.doc.eq(savedDoc);
|
|
206
208
|
const serialize = () => bom + (newline === '\n' ? view.state.doc.toString() : view.state.doc.toString().replace(/\n/gu, newline));
|
|
207
209
|
|
|
208
|
-
|
|
209
|
-
|
|
210
|
+
let wasDirty = false;
|
|
211
|
+
function updateSaveState(text = saving ? message.saving : dirty() ? message.unsaved : '', contentChanged = false) {
|
|
212
|
+
const isDirty = dirty();
|
|
213
|
+
saveButton.disabled = saving || !isDirty;
|
|
210
214
|
setStatus(status, text);
|
|
215
|
+
if (isDirty !== wasDirty || contentChanged && isDirty) {
|
|
216
|
+
wasDirty = isDirty;
|
|
217
|
+
options.onDirtyChange?.();
|
|
218
|
+
}
|
|
211
219
|
}
|
|
212
220
|
|
|
213
221
|
async function unchanged(handle: FileSystemFileHandle) {
|
|
@@ -334,6 +342,8 @@ export function mountTextFile(parent: HTMLElement, options: TextFileOptions) {
|
|
|
334
342
|
};
|
|
335
343
|
panel.addEventListener('keydown', event => {
|
|
336
344
|
if (!(event.metaKey || event.ctrlKey) || event.key.toLowerCase() !== 's') return;
|
|
345
|
+
// Let the main window's save shortcut choose the target when the host manages it.
|
|
346
|
+
if (options.hostSaveShortcut && panel.ownerDocument === document) return;
|
|
337
347
|
event.preventDefault();
|
|
338
348
|
event.stopPropagation();
|
|
339
349
|
void save();
|
|
@@ -342,6 +352,9 @@ export function mountTextFile(parent: HTMLElement, options: TextFileOptions) {
|
|
|
342
352
|
showDiff(false);
|
|
343
353
|
updateSaveState();
|
|
344
354
|
return {
|
|
355
|
+
save,
|
|
356
|
+
isDirty: dirty,
|
|
357
|
+
readUnsaved: () => !disposed && dirty() ? encoder.encode(serialize()) : undefined,
|
|
345
358
|
requestClose() {
|
|
346
359
|
if (!saving && (!dirty() || browser?.confirm(message.close))) options.close();
|
|
347
360
|
},
|