Merge pull request #867 from isc-bsaviano/fix-864

Generate content when a new local class or routine is created

Author: gjsjohnmurray

src/extension.ts

@@ -18,6 +18,7 @@ export const schemas = [
 export const filesystemSchemas = [FILESYSTEM_SCHEMA, FILESYSTEM_READONLY_SCHEMA];
 
 import * as url from "url";
+import path = require("path");
 import {
   importAndCompile,
   importFolder as importFileOrFolder,
@@ -27,7 +28,7 @@ import {
   compileOnly,
 } from "./commands/compile";
 import { deleteExplorerItems } from "./commands/delete";
-import { exportAll, exportCurrentFile, exportExplorerItems } from "./commands/export";
+import { exportAll, exportCurrentFile, exportExplorerItems, getCategory } from "./commands/export";
 import { serverActions } from "./commands/serverActions";
 import { subclass } from "./commands/subclass";
 import { superclass } from "./commands/superclass";
@@ -66,7 +67,7 @@ import { ObjectScriptDebugAdapterDescriptorFactory } from "./debug/debugAdapterF
 import { ObjectScriptConfigurationProvider } from "./debug/debugConfProvider";
 import { ObjectScriptExplorerProvider, registerExplorerOpen } from "./explorer/explorer";
 import { WorkspaceNode } from "./explorer/models/workspaceNode";
-import { FileSystemProvider } from "./providers/FileSystemProvider/FileSystemProvider";
+import { FileSystemProvider, generateFileContent } from "./providers/FileSystemProvider/FileSystemProvider";
 import { WorkspaceSymbolProvider } from "./providers/WorkspaceSymbolProvider";
 import {
   connectionTarget,
@@ -78,6 +79,8 @@ import {
   currentFile,
   InputBoxManager,
   isImportableLocalFile,
+  workspaceFolderOfUri,
+  uriOfWorkspaceFolder,
 } from "./utils";
 import { ObjectScriptDiagnosticProvider } from "./providers/ObjectScriptDiagnosticProvider";
 import { DocumentRangeFormattingEditProvider } from "./providers/DocumentRangeFormattingEditProvider";
@@ -938,6 +941,33 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
       DocumaticPreviewPanel.create(context.extensionUri)
     ),
     vscode.commands.registerCommand("vscode-objectscript.exportCurrentFile", exportCurrentFile),
+    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) => {
+            // Determine the file name
+            const workspace = workspaceFolderOfUri(f);
+            const workspacePath = uriOfWorkspaceFolder(workspace).fsPath;
+            const filePathNoWorkspaceArr = f.fsPath.replace(workspacePath + path.sep, "").split(path.sep);
+            const { folder, addCategory } = config("export", workspace);
+            const expectedFolder = typeof folder === "string" && folder.length ? folder : null;
+            if (expectedFolder !== null && filePathNoWorkspaceArr[0] === expectedFolder) {
+              filePathNoWorkspaceArr.shift();
+            }
+            const expectedCat = addCategory ? getCategory(f.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)));
+            // Write the new content to the file
+            return vscode.workspace.fs.writeFile(f, new TextEncoder().encode(newContent.content.join("\n")));
+          })
+      )
+    ),
 
     /* Anything we use from the VS Code proposed API */
     ...proposed

src/providers/FileSystemProvider/FileSystemProvider.ts

@@ -14,6 +14,46 @@ 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 } {
+  const sourceLines = sourceContent.toString().split("\n");
+  const fileExt = fileName.split(".").pop().toLowerCase();
+  if (fileExt === "cls") {
+    const className = fileName.split(".").slice(0, -1).join(".");
+    const content: string[] = [];
+    const preamble: string[] = [];
+
+    // If content was provided (e.g. when copying a file), use all lines except for
+    // the Class x.y one. Replace that with one to match fileName.
+    while (sourceLines.length > 0) {
+      const nextLine = sourceLines.shift();
+      if (nextLine.startsWith("Class ")) {
+        content.push(...preamble, `Class ${className}`, ...sourceLines);
+        break;
+      }
+      preamble.push(nextLine);
+    }
+    if (content.length === 0) {
+      content.push(`Class ${className}`, "{", "}");
+    }
+    return {
+      content,
+      enc: false,
+    };
+  } else if (["int", "inc", "mac"].includes(fileExt)) {
+    sourceLines.shift();
+    const routineName = fileName.split(".").slice(0, -1).join(".");
+    const routineType = `[ type = ${fileExt}]`;
+    return {
+      content: [`ROUTINE ${routineName} ${routineType}`, ...sourceLines],
+      enc: false,
+    };
+  }
+  return {
+    content: [sourceContent.toString("base64")],
+    enc: true,
+  };
+}
+
 export class FileSystemProvider implements vscode.FileSystemProvider {
   private superRoot = new Directory("", "");
 
@@ -151,46 +191,6 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
     });
   }
 
-  private generateFileContent(fileName: string, sourceContent: Buffer): { content: string[]; enc: boolean } {
-    const sourceLines = sourceContent.toString().split("\n");
-    const fileExt = fileName.split(".").pop().toLowerCase();
-    if (fileExt === "cls") {
-      const className = fileName.split(".").slice(0, -1).join(".");
-      const content: string[] = [];
-      const preamble: string[] = [];
-
-      // If content was provided (e.g. when copying a file), use all lines except for
-      // the Class x.y one. Replace that with one to match fileName.
-      while (sourceLines.length > 0) {
-        const nextLine = sourceLines.shift();
-        if (nextLine.startsWith("Class ")) {
-          content.push(...preamble, `Class ${className}`, ...sourceLines);
-          break;
-        }
-        preamble.push(nextLine);
-      }
-      if (content.length === 0) {
-        content.push(`Class ${className}`, "{", "}");
-      }
-      return {
-        content,
-        enc: false,
-      };
-    } else if (["int", "inc", "mac"].includes(fileExt)) {
-      sourceLines.shift();
-      const routineName = fileName.split(".").slice(0, -1).join(".");
-      const routineType = `[ type = ${fileExt}]`;
-      return {
-        content: [`ROUTINE ${routineName} ${routineType}`, ...sourceLines],
-        enc: false,
-      };
-    }
-    return {
-      content: [sourceContent.toString("base64")],
-      enc: true,
-    };
-  }
-
   public writeFile(
     uri: vscode.Uri,
     content: Buffer,
@@ -250,7 +250,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).
-        const newContent = this.generateFileContent(fileName, content);
+        const newContent = generateFileContent(fileName, content);
 
         // Write it to the server
         return api