feat: work with Source chapter and code prepend

Author: heyzec

language-configuration.json

@@ -23,6 +23,12 @@
     { "open": "'", "close": "'" },
     { "open": "\"", "close": "\"" }
   ],
+  "folding": {
+    "markers": {
+      "start": "// PREPEND -- DO NOT EDIT",
+      "end": "// END PREPEND"
+    }
+  },
   "wordPattern": "[_$a-zA-Z][_$a-zA-Z0-9]*",
   "indentationRules": {
     "increaseIndentPattern": "^((?!\\/\\/).)*(\\{[^}\"'`]*|\\([^)\"'`]*|\\[[^\\]\"'`]*)$",

package.json

@@ -107,6 +107,7 @@
     "esbuild-plugin-fileloc": "^0.0.6",
     "esbuild-plugin-ignore": "^1.1.1",
     "esbuild-plugin-polyfill-node": "^0.3.0",
+    "lodash": "^4.17.21",
     "react": "^19.0.0",
     "react-dom": "^19.0.0",
     "vscode-languageclient": "^9.0.1"

src/commands/showPanel.tsx

@@ -12,6 +12,8 @@ import { setWebviewContent } from "../utils/webview";
 import config from "../utils/config";
 import { Editor } from "../utils/editor";
 import { FRONTEND_ELEMENT_ID } from "../constants";
+import { client } from "../extension";
+import _ from "lodash";
 
 let panel: vscode.WebviewPanel | null = null;
 // This needs to be a reference to active
@@ -21,6 +23,8 @@ export let activeEditor: Editor | null = null;
 const messageQueue: MessageType[] = [];
 let handling = false;
 
+// TODO: Remove panel and handling message logic out of the commands/ directory
+
 async function handleMessage(
   context: vscode.ExtensionContext,
   message: MessageType,
@@ -43,8 +47,21 @@ async function handleMessage(
           message.workspaceLocation,
           message.assessmentName,
           message.questionId,
+          message.prepend,
           message.initialCode,
         );
+        activeEditor.uri;
+        const info = context.globalState.get("info") ?? {};
+        if (activeEditor.uri) {
+          // TODO: Write our own wrapper to set nested keys easily, removing lodash
+          // @ts-ignore
+          _.set(info, `["${activeEditor.uri}"].chapter`, message.chapter);
+          const nPrependLines = message.prepend.split("\n").length;
+          _.set(info, `["${activeEditor.uri}"].prepend`, nPrependLines);
+          context.globalState.update("info", info);
+          client.sendNotification("source/publishInfo", info);
+        }
+
         panel?.reveal(vscode.ViewColumn.Two);
         console.log(
           `EXTENSION: NewEditor: activeEditor set to ${activeEditor.assessmentName}_${activeEditor.questionId}`,

src/extension.ts

@@ -5,6 +5,10 @@ import { setupStatusBar } from "./statusbar/status";
 import { evalEditor } from "./commands/evalEditor";
 import { registerAllCommands } from "./commands";
 import { activateLspClient, deactivateLspClient } from "./lsp/client";
+import { LanguageClient } from "vscode-languageclient/node";
+
+// TODO: Don't expose this object directly, create an interface via a wrapper class
+export let client: LanguageClient;
 
 // This method is called when your extension is activated
 // Your extension is activated the very first time the command is executed
@@ -13,7 +17,14 @@ export function activate(context: vscode.ExtensionContext) {
 
   context.subscriptions.push(setupStatusBar(context));
 
-  activateLspClient(context);
+  client = activateLspClient(context);
+
+  // const info = {
+  //   "file:///home/heyzec/.sourceacademy/playground_1.js": { chapter: 4 },
+  // };
+  const info = context.globalState.get("info") ?? {};
+
+  client.sendNotification("source/publishInfo", info);
 }
 
 // This method is called when your extension is deactivated

src/lsp/client.ts

@@ -50,6 +50,7 @@ export function activateLspClient(context: ExtensionContext) {
 
   // Start the client. This will also launch the server
   client.start();
+  return client;
 
   // TODO: Combine this functionality with existing language selector
   // context.subscriptions.push(

src/utils/editor.ts

@@ -12,6 +12,7 @@ export class Editor {
   questionId: number;
   onChangeCallback?: (editor: Editor) => void;
   code: string | null = null;
+  uri: string | null = null;
 
   // For debugging purposes
   replaceTime: number = 0;
@@ -36,10 +37,12 @@ export class Editor {
     return this.editor?.document.getText();
   }
 
+  // TODO: This method is too loaded, it's not obvious it also shows the editor
   static async create(
     workspaceLocation: VscWorkspaceLocation,
     assessmentName: string,
     questionId: number,
+    prepend: string = "",
     initialCode: string = "",
   ): Promise<Editor> {
     const self = new Editor(workspaceLocation, assessmentName, questionId);
@@ -58,24 +61,37 @@ export class Editor {
       workspaceFolder,
       `${assessmentName}_${questionId}.js`,
     );
+
+    const uri = vscode.Uri.file(filePath);
+    self.uri = uri.toString();
+
+    const contents = [
+      "// PREPEND -- DO NOT EDIT",
+      prepend,
+      "// END PREPEND",
+      initialCode,
+    ].join("\n");
+
     await vscode.workspace.fs.readFile(vscode.Uri.file(filePath)).then(
       () => null,
       async () => {
         self.log(`Opening file failed, creating at ${filePath}`);
         await vscode.workspace.fs.writeFile(
-          vscode.Uri.file(filePath),
-          new TextEncoder().encode(initialCode),
+          uri,
+          new TextEncoder().encode(contents),
         );
       },
     );
 
-    const editor = await vscode.window.showTextDocument(
-      vscode.Uri.file(filePath),
-      {
-        preview: false,
-        viewColumn: vscode.ViewColumn.One,
-      },
+    const editor = await vscode.window.showTextDocument(uri, {
+      preview: false,
+      viewColumn: vscode.ViewColumn.One,
+    });
+    editor.selection = new vscode.Selection(
+      editor.document.positionAt(0),
+      editor.document.positionAt(1),
     );
+    vscode.commands.executeCommand("editor.fold");
 
     self.editor = editor;
     vscode.workspace.onDidChangeTextDocument(() => {

src/utils/messages.ts

@@ -22,11 +22,15 @@ const Messages = createMessages({
     workspaceLocation: VscWorkspaceLocation,
     assessmentName: string,
     questionId: number,
+    chapter: number,
+    prepend: string,
     initialCode: string,
   ) => ({
     workspaceLocation,
     assessmentName,
     questionId,
+    chapter,
+    prepend,
     initialCode,
   }),
   Text: (workspaceLocation: VscWorkspaceLocation, code: string) => ({

yarn.lock

@@ -1237,6 +1237,11 @@ lodash.once@^4.0.0:
   resolved "https://registry.yarnpkg.com/lodash.once/-/lodash.once-4.1.1.tgz#0dd3971213c7c56df880977d504c88fb471a97ac"
   integrity sha512-Sb487aTOCr9drQVL8pIxOzVhafOjZN9UU54hiN8PU3uAiSV7lx1yYNpbNmex2PK6dSJoNTSJUUswT651yww3Mg==
 
+lodash@^4.17.21:
+  version "4.17.21"
+  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c"
+  integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==
+
 lru-cache@^11.0.0:
   version "11.0.2"
   resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-11.0.2.tgz#fbd8e7cf8211f5e7e5d91905c415a3f55755ca39"