Improve the MAC and INT server-side new file stubs (intersystems-community#1218)

Author: gjsjohnmurray

src/extension.ts

@@ -1048,17 +1048,17 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
     vscode.workspace.onDidCreateFiles((e: vscode.FileCreateEvent) =>
       Promise.all(
         e.files
-          .filter((f) => !filesystemSchemas.includes(f.scheme))
-          .filter((f) => ["cls", "inc", "int", "mac"].includes(f.path.split(".").pop().toLowerCase()))
-          .map(async (f) => {
+          .filter((uri) => !filesystemSchemas.includes(uri.scheme))
+          .filter((uri) => ["cls", "inc", "int", "mac"].includes(uri.path.split(".").pop().toLowerCase()))
+          .map(async (uri) => {
             // Determine the file name
-            const workspace = workspaceFolderOfUri(f);
+            const workspace = workspaceFolderOfUri(uri);
             if (!workspace) {
               // No workspace folders are open
               return null;
             }
             const workspacePath = uriOfWorkspaceFolder(workspace).fsPath;
-            const filePathNoWorkspaceArr = f.fsPath.replace(workspacePath + path.sep, "").split(path.sep);
+            const filePathNoWorkspaceArr = uri.fsPath.replace(workspacePath + path.sep, "").split(path.sep);
             const { folder, addCategory } = config("export", workspace);
             const expectedFolder = typeof folder === "string" && folder.length ? folder : null;
             const expectedFolderArr = expectedFolder.split(path.sep);
@@ -1068,15 +1068,15 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
             ) {
               filePathNoWorkspaceArr.splice(0, expectedFolderArr.length);
             }
-            const expectedCat = addCategory ? getCategory(f.fsPath, addCategory) : null;
+            const expectedCat = addCategory ? getCategory(uri.fsPath, addCategory) : null;
             if (expectedCat !== null && filePathNoWorkspaceArr[0] === expectedCat) {
               filePathNoWorkspaceArr.shift();
             }
             const fileName = filePathNoWorkspaceArr.join(".");
             // Generate the new content
-            const newContent = generateFileContent(fileName, Buffer.from(await vscode.workspace.fs.readFile(f)));
+            const newContent = generateFileContent(uri, fileName, Buffer.from(await vscode.workspace.fs.readFile(uri)));
             // Write the new content to the file
-            return vscode.workspace.fs.writeFile(f, new TextEncoder().encode(newContent.content.join("\n")));
+            return vscode.workspace.fs.writeFile(uri, new TextEncoder().encode(newContent.content.join("\n")));
           })
       )
     ),

src/providers/FileSystemProvider/FileSystemProvider.ts

@@ -21,7 +21,11 @@ declare function setTimeout(callback: (...args: any[]) => void, ms: number, ...a
 
 export type Entry = File | Directory;
 
-export function generateFileContent(fileName: string, sourceContent: Buffer): { content: string[]; enc: boolean } {
+export function generateFileContent(
+  uri: vscode.Uri,
+  fileName: string,
+  sourceContent: Buffer
+): { content: string[]; enc: boolean } {
   const sourceLines = sourceContent.toString().split("\n");
   const fileExt = fileName.split(".").pop().toLowerCase();
   const csp = fileName.startsWith("/");
@@ -53,6 +57,19 @@ export function generateFileContent(fileName: string, sourceContent: Buffer): {
     sourceLines.shift();
     const routineName = fileName.split(".").slice(0, -1).join(".");
     const routineType = fileExt != "mac" ? `[Type=${fileExt.toUpperCase()}]` : "";
+    if (sourceLines.length === 0 && fileExt !== "inc") {
+      const languageId = fileExt === "mac" ? "objectscript" : "objectscript-int";
+
+      // Labels cannot contain dots
+      const firstLabel = routineName.replaceAll(".", "");
+
+      // Be smart about whether to use a Tab or a space between label and comment.
+      // Doing this will help autodetect to do the right thing.
+      const lineStart = vscode.workspace.getConfiguration("editor", { languageId, uri }).get("insertSpaces")
+        ? " "
+        : "\t";
+      sourceLines.push(`${firstLabel}${lineStart};`);
+    }
     return {
       content: [`ROUTINE ${routineName} ${routineType}`, ...sourceLines],
       enc: false,
@@ -354,7 +371,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
         }
         // File doesn't exist on the server, and we are allowed to create it.
         // Create content (typically a stub, unless the write-phase of a copy operation).
-        const newContent = generateFileContent(fileName, content);
+        const newContent = generateFileContent(uri, fileName, content);
 
         // Write it to the server
         return api
@@ -388,6 +405,12 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
             this._lookupAsFile(uri).then(() => {
               this._fireSoon({ type: vscode.FileChangeType.Changed, uri });
             });
+
+            // Ask to put cursor at start of 3rd line.
+            // For CLS stub this will be where properties and methods need to be inserted.
+            // For MAC and INT stubs there is no 3rd line, so cursor goes to the end of the 2nd, which is 1st of actual routine and is ready for comment text.
+            const editor = await vscode.window.showTextDocument(uri);
+            editor.selection = new vscode.Selection(2, 0, 2, 0);
           });
       }
     );
@@ -555,7 +578,11 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
     const newCsp = newParams.has("csp") && ["", "1"].includes(newParams.get("csp"));
     const newFileName = newCsp ? newUri.path : newUri.path.slice(1).replace(/\//g, ".");
     // Generate content for the new file
-    const newContent = generateFileContent(newFileName, Buffer.from(await vscode.workspace.fs.readFile(oldUri)));
+    const newContent = generateFileContent(
+      newUri,
+      newFileName,
+      Buffer.from(await vscode.workspace.fs.readFile(oldUri))
+    );
     if (newFileStat) {
       // We're overwriting an existing file so prompt the user to check it out
       await fireOtherStudioAction(OtherStudioAction.AttemptedEdit, newUri);