Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Scene Preview ergonomics #665

Merged
merged 7 commits into from
Jun 23, 2024
Merged

Improve Scene Preview ergonomics #665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d96b0e9
Rename Scene Preview "pinning" to "locking"
DaelonSuzuka Jun 13, 2024
e438e35
Add "refresh scene preview" command as button
DaelonSuzuka Jun 13, 2024
78f3a32
Expose scene preview commands to command palette
DaelonSuzuka Jun 13, 2024
330a871
Format file
DaelonSuzuka Jun 13, 2024
0491a22
Fix lint errors
DaelonSuzuka Jun 13, 2024
33578b9
Fix last reference to "pinning"
DaelonSuzuka Jun 13, 2024
227602c
Add openCurrentScene and openMainScript commands
DaelonSuzuka Jun 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 56 additions & 25 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,19 +149,47 @@
{
"category": "Godot Tools",
"command": "godotTools.scenePreview.refresh",
"title": "Refresh Scene Preview"
"title": "Refresh Scene Preview",
"icon": {
"light": "resources/godot_icons/light/Reload.svg",
"dark": "resources/godot_icons/dark/Reload.svg"
}
},
{
"category": "Godot Tools",
"command": "godotTools.scenePreview.pin",
"title": "Pin Scene Preview",
"icon": "resources/pin_off.svg"
"command": "godotTools.scenePreview.openCurrentScene",
"title": "Open the Scene Preview's current scene",
"icon": {
"light": "resources/godot_icons/light/PackedScene.svg",
"dark": "resources/godot_icons/dark/PackedScene.svg"
}
},
{
"category": "Godot Tools",
"command": "godotTools.scenePreview.unpin",
"title": "Unpin Scene Preview",
"icon": "resources/pin_on.svg"
"command": "godotTools.scenePreview.openMainScript",
"title": "Open the main script of the Scene Preview's current scene",
"icon": {
"light": "resources/godot_icons/light/Script.svg",
"dark": "resources/godot_icons/dark/Script.svg"
}
},
{
"category": "Godot Tools",
"command": "godotTools.scenePreview.lock",
"title": "Lock Scene Preview",
"icon": {
"light": "resources/godot_icons/light/Unlock.svg",
"dark": "resources/godot_icons/dark/Unlock.svg"
}
},
{
"category": "Godot Tools",
"command": "godotTools.scenePreview.unlock",
"title": "Unlock Scene Preview",
"icon": {
"light": "resources/godot_icons/light/Lock.svg",
"dark": "resources/godot_icons/dark/Lock.svg"
}
},
{
"category": "Godot Tools",
Expand Down Expand Up @@ -628,10 +656,6 @@
"command": "godotTools.listGodotClasses",
"when": "godotTools.context.connectedToLSP"
},
{
"command": "godotTools.scenePreview.refresh",
"when": "false"
},
{
"command": "godotTools.scenePreview.goToDefinition",
"when": "false"
Expand All @@ -640,14 +664,6 @@
"command": "godotTools.scenePreview.openDocumentation",
"when": "false"
},
{
"command": "godotTools.scenePreview.pin",
"when": "false"
},
{
"command": "godotTools.scenePreview.unpin",
"when": "false"
},
{
"command": "godotTools.scenePreview.copyNodePath",
"when": "false"
Expand Down Expand Up @@ -693,14 +709,29 @@
"group": "navigation"
},
{
"command": "godotTools.scenePreview.pin",
"when": "view == scenePreview && !godotTools.context.scenePreview.pinned",
"group": "navigation"
"command": "godotTools.scenePreview.lock",
"when": "view == scenePreview && !godotTools.context.scenePreview.locked",
"group": "navigation@1"
},
{
"command": "godotTools.scenePreview.unpin",
"when": "view == scenePreview && godotTools.context.scenePreview.pinned",
"group": "navigation"
"command": "godotTools.scenePreview.unlock",
"when": "view == scenePreview && godotTools.context.scenePreview.locked",
"group": "navigation@1"
},
{
"command": "godotTools.scenePreview.refresh",
"when": "view == scenePreview",
"group": "navigation@2"
},
{
"command": "godotTools.scenePreview.openMainScript",
"when": "view == scenePreview",
"group": "navigation@3"
},
{
"command": "godotTools.scenePreview.openCurrentScene",
"when": "view == scenePreview",
"group": "navigation@4"
}
],
"view/item/context": [
Expand Down
112 changes: 71 additions & 41 deletions src/scene_tools/preview.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
import * as vscode from "vscode";
import {
TreeDataProvider,
TreeDragAndDropController,
ExtensionContext,
type TreeDataProvider,
type TreeDragAndDropController,
type ExtensionContext,
EventEmitter,
Event,
TreeView,
ProviderResult,
TreeItem,
type Event,
type TreeView,
type ProviderResult,
type TreeItem,
TreeItemCollapsibleState,
window,
languages,
Uri,
CancellationToken,
FileDecoration,
DocumentDropEditProvider,
type Uri,
type CancellationToken,
type FileDecoration,
type DocumentDropEditProvider,
workspace,
} from "vscode";
import * as fs from "fs";
import * as fs from "node:fs";
import {
get_configuration,
find_file,
Expand All @@ -28,15 +28,17 @@ import {
make_docs_uri,
} from "../utils";
import { SceneParser } from "./parser";
import { SceneNode, Scene } from "./types";
import type { SceneNode, Scene } from "./types";

const log = createLogger("scenes.preview");

export class ScenePreviewProvider implements TreeDataProvider<SceneNode>, TreeDragAndDropController<SceneNode>, DocumentDropEditProvider {
export class ScenePreviewProvider
implements TreeDataProvider<SceneNode>, TreeDragAndDropController<SceneNode>, DocumentDropEditProvider
{
public dropMimeTypes = [];
public dragMimeTypes = [];
private tree: TreeView<SceneNode>;
private scenePreviewPinned = false;
private scenePreviewLocked = false;
private currentScene = "";
public parser = new SceneParser();
public scene: Scene;
Expand All @@ -52,20 +54,22 @@ export class ScenePreviewProvider implements TreeDataProvider<SceneNode>, TreeDr
constructor(private context: ExtensionContext) {
this.tree = vscode.window.createTreeView("scenePreview", {
treeDataProvider: this,
dragAndDropController: this
dragAndDropController: this,
});

const selector = [
{ language: "csharp", scheme: "file" },
{ language: "gdscript", scheme: "file" },
];
context.subscriptions.push(
register_command("scenePreview.pin", this.pin_preview.bind(this)),
register_command("scenePreview.unpin", this.unpin_preview.bind(this)),
register_command("scenePreview.lock", this.lock_preview.bind(this)),
register_command("scenePreview.unlock", this.unlock_preview.bind(this)),
register_command("scenePreview.copyNodePath", this.copy_node_path.bind(this)),
register_command("scenePreview.copyResourcePath", this.copy_resource_path.bind(this)),
register_command("scenePreview.openScene", this.open_scene.bind(this)),
register_command("scenePreview.openScript", this.open_script.bind(this)),
register_command("scenePreview.openCurrentScene", this.open_current_scene.bind(this)),
register_command("scenePreview.openCurrentScript", this.open_main_script.bind(this)),
register_command("scenePreview.goToDefinition", this.go_to_definition.bind(this)),
register_command("scenePreview.openDocumentation", this.open_documentation.bind(this)),
register_command("scenePreview.refresh", this.refresh.bind(this)),
Expand All @@ -82,12 +86,21 @@ export class ScenePreviewProvider implements TreeDataProvider<SceneNode>, TreeDr
this.refresh();
}

public handleDrag(source: readonly SceneNode[], data: vscode.DataTransfer, token: vscode.CancellationToken): void | Thenable<void> {
public handleDrag(
source: readonly SceneNode[],
data: vscode.DataTransfer,
token: vscode.CancellationToken,
): void | Thenable<void> {
data.set("godot/path", new vscode.DataTransferItem(source[0].relativePath));
data.set("godot/class", new vscode.DataTransferItem(source[0].className));
}

public provideDocumentDropEdits(document: vscode.TextDocument, position: vscode.Position, dataTransfer: vscode.DataTransfer, token: vscode.CancellationToken): vscode.ProviderResult<vscode.DocumentDropEdit> {
public provideDocumentDropEdits(
document: vscode.TextDocument,
position: vscode.Position,
dataTransfer: vscode.DataTransfer,
token: vscode.CancellationToken,
): vscode.ProviderResult<vscode.DocumentDropEdit> {
const path = dataTransfer.get("godot/path").value;
const className = dataTransfer.get("godot/class").value;

Expand All @@ -106,7 +119,7 @@ export class ScenePreviewProvider implements TreeDataProvider<SceneNode>, TreeDr
return;
}
setTimeout(async () => {
if (uri.fsPath == this.currentScene) {
if (uri.fsPath === this.currentScene) {
this.refresh();
} else {
const document = await vscode.workspace.openTextDocument(uri);
Expand All @@ -116,7 +129,7 @@ export class ScenePreviewProvider implements TreeDataProvider<SceneNode>, TreeDr
}

public async refresh() {
if (this.scenePreviewPinned) {
if (this.scenePreviewLocked) {
return;
}

Expand All @@ -128,22 +141,22 @@ export class ScenePreviewProvider implements TreeDataProvider<SceneNode>, TreeDr
if (!fileName.endsWith(".tscn")) {
const searchName = fileName.replace(".gd", ".tscn").replace(".cs", ".tscn");

if (mode == "anyFolder") {
if (mode === "anyFolder") {
const relatedScene = await find_file(searchName);
if (!relatedScene) {
return;
}
fileName = relatedScene.fsPath;
}

if (mode == "sameFolder") {
if (mode === "sameFolder") {
if (fs.existsSync(searchName)) {
fileName = searchName;
} else {
return;
}
}
if (mode == "off") {
if (mode === "off") {
return;
}
}
Expand All @@ -162,20 +175,20 @@ export class ScenePreviewProvider implements TreeDataProvider<SceneNode>, TreeDr
}
}

private pin_preview() {
this.scenePreviewPinned = true;
set_context("scenePreview.pinned", true);
private lock_preview() {
this.scenePreviewLocked = true;
set_context("scenePreview.locked", true);
}

private unpin_preview() {
this.scenePreviewPinned = false;
set_context("scenePreview.pinned", false);
private unlock_preview() {
this.scenePreviewLocked = false;
set_context("scenePreview.locked", false);
this.refresh();
}

private copy_node_path(item: SceneNode) {
if (item.unique) {
vscode.env.clipboard.writeText("%" + item.label);
vscode.env.clipboard.writeText(`%${item.label}`);
return;
}
vscode.env.clipboard.writeText(item.relativePath);
Expand All @@ -201,6 +214,26 @@ export class ScenePreviewProvider implements TreeDataProvider<SceneNode>, TreeDr
}
}

private async open_current_scene() {
if (this.currentScene) {
const document = await vscode.workspace.openTextDocument(this.currentScene);
vscode.window.showTextDocument(document);
}
}

private async open_main_script() {
if (this.currentScene) {
const root = this.scene.root;
if (root?.hasScript) {
const path = this.scene.externalResources[root.scriptId].path;
const uri = await convert_resource_path_to_uri(path);
if (uri) {
vscode.window.showTextDocument(uri, { preview: true });
}
}
}
}

private async go_to_definition(item: SceneNode) {
const document = await vscode.workspace.openTextDocument(this.currentScene);
const start = document.positionAt(item.position);
Expand All @@ -216,7 +249,6 @@ export class ScenePreviewProvider implements TreeDataProvider<SceneNode>, TreeDr
private tree_selection_changed(event: vscode.TreeViewSelectionChangeEvent<SceneNode>) {
// const item = event.selection[0];
// log(item.body);

// const editor = vscode.window.activeTextEditor;
// const range = editor.document.getText()
// editor.revealRange(range)
Expand All @@ -226,12 +258,10 @@ export class ScenePreviewProvider implements TreeDataProvider<SceneNode>, TreeDr
if (!element) {
if (!this.scene?.root) {
return Promise.resolve([]);
} else {
return Promise.resolve([this.scene?.root]);
}
} else {
return Promise.resolve(element.children);
return Promise.resolve([this.scene?.root]);
}
return Promise.resolve(element.children);
}

public getTreeItem(element: SceneNode): TreeItem | Thenable<TreeItem> {
Expand All @@ -254,13 +284,13 @@ class UniqueDecorationProvider implements vscode.FileDecorationProvider {
return this.changeDecorationsEvent.event;
}

constructor(private previewer: ScenePreviewProvider) { }
constructor(private previewer: ScenePreviewProvider) {}

provideFileDecoration(uri: Uri, token: CancellationToken): FileDecoration | undefined {
if (uri.scheme !== "godot") return undefined;

const node = this.previewer.scene?.nodes.get(uri.path);
if (node && node.unique) {
if (node?.unique) {
return {
badge: "%",
};
Expand All @@ -274,13 +304,13 @@ class ScriptDecorationProvider implements vscode.FileDecorationProvider {
return this.changeDecorationsEvent.event;
}

constructor(private previewer: ScenePreviewProvider) { }
constructor(private previewer: ScenePreviewProvider) {}

provideFileDecoration(uri: Uri, token: CancellationToken): FileDecoration | undefined {
if (uri.scheme !== "godot") return undefined;

const node = this.previewer.scene?.nodes.get(uri.path);
if (node && node.hasScript) {
if (node?.hasScript) {
return {
badge: "S",
};
Expand Down
Loading