feat: better association of .js to Source (#25)

* refactor: handle workspace setting better

* feat: programatically set editor language

* feat: set program language with settings.json

Author: heyzec

package.json

@@ -37,6 +37,11 @@
           "type": "string",
           "default": "https://frontend.cloud.heyzec.dedyn.io",
           "description": "URL to the Source Academy frontend"
+        },
+        "source-academy.workspaceFolder": {
+          "type": "string",
+          "default": ".sourceacademy",
+          "description": "Location to store code locally. If not absolute, it will be relative to the home directory."
         }
       }
     },

src/extension.ts

@@ -6,6 +6,8 @@ import { setupStatusBar } from "./statusbar/status";
 import { registerAllCommands } from "./commands";
 import { activateLspClient, deactivateLspClient } from "./lsp/client";
 import { LanguageClient } from "vscode-languageclient/node";
+import { canonicaliseLocation } from "./utils/misc";
+import config from "./utils/config";
 
 // TODO: Don't expose this object directly, create an interface via a wrapper class
 export let client: LanguageClient;
@@ -34,6 +36,21 @@ export function activate(context: vscode.ExtensionContext) {
     "assets",
     "icon.svg",
   );
+
+  // TODO: Prompt the user to make this folder the default, and then set back to the config store.
+
+  // Update user's workspace settings to associate .js to Source
+  const workspaceFolder = canonicaliseLocation(config.workspaceFolder);
+  if (
+    vscode.workspace.workspaceFolders
+      ?.map((wf) => wf.uri.fsPath)
+      .includes(workspaceFolder)
+  ) {
+    const workspaceConfig = vscode.workspace.getConfiguration();
+    workspaceConfig.update("files.associations", {
+      "*.js": "source",
+    });
+  }
 }
 
 // This method is called when your extension is deactivated

src/utils/config/schema.ts

@@ -5,5 +5,8 @@ export default {
     type: "string",
     default: "https://frontend.cloud.heyzec.dedyn.io",
   },
-  workspaceFolder: { type: "string", default: "" },
+  workspaceFolder: {
+    type: "string",
+    default: ".sourceacademy",
+  },
 } satisfies Record<string, ConfigSchemaUnion>;

src/utils/editor.ts

@@ -4,6 +4,7 @@ import * as os from "os";
 import config from "../utils/config";
 import { VscWorkspaceLocation } from "./messages";
 import path from "path";
+import { canonicaliseLocation } from "./misc";
 
 export class Editor {
   editor?: vscode.TextEditor;
@@ -49,13 +50,7 @@ export class Editor {
     self.assessmentName = assessmentName;
     self.questionId = questionId;
 
-    let workspaceFolder = config.workspaceFolder;
-    if (!workspaceFolder) {
-      workspaceFolder = path.join(os.homedir(), ".sourceacademy");
-      // TODO: Prompt the user to make this folder the default, and then set back to the config store.
-    } else if (!path.isAbsolute(workspaceFolder)) {
-      workspaceFolder = path.join(os.homedir(), workspaceFolder);
-    }
+    const workspaceFolder = canonicaliseLocation(config.workspaceFolder);
 
     const filePath = path.join(
       workspaceFolder,
@@ -90,6 +85,7 @@ export class Editor {
       preview: false,
       viewColumn: vscode.ViewColumn.One,
     });
+    vscode.languages.setTextDocumentLanguage(editor.document, "source");
     editor.selection = new vscode.Selection(
       editor.document.positionAt(0),
       editor.document.positionAt(1),

src/utils/misc.ts

@@ -0,0 +1,9 @@
+import path from "path";
+import * as os from "os";
+
+export function canonicaliseLocation(location: string) {
+  if (path.isAbsolute(location)) {
+    return location;
+  }
+  return path.join(os.homedir(), location);
+}