Add FileDecoration for Generated files (#1035)

Author: isc-bsaviano

docs/SettingsReference.md

@@ -76,6 +76,7 @@ The extensions in the InterSystems ObjectScript Extension Pack provide many sett
 | `"objectscript.serverSideEditing"` | Allow editing code directly on the server after opening it from ObjectScript Explorer. | `boolean` | `false` | |
 | `"objectscript.serverSourceControl .disableOtherActionTriggers"` | Prevent server-side source control 'other action' triggers from firing. | `boolean` | `false` | |
 | `"objectscript.showExplorer"` | Show the ObjectScript Explorer view. | `boolean` | `true` | |
+| `"objectscript.showGeneratedFileDecorations"` | Controls whether a badge is shown in the file explorer and open editors view for generated files. | `boolean` | `true` | |
 | `"objectscript.studioActionDebugOutput"` | Log in JSON format the action that VS Code should perform as requested by the server. | `boolean` | `false` | Actions will be logged to the `ObjectScript` Output channel. |
 | `"objectscript.suppressCompileErrorMessages"` | Suppress popup messages about errors during compile, but still focus on Output view. | `boolean` | `false` | |
 | `"objectscript.suppressCompileMessages"` | Suppress popup messages about successful compile. | `boolean` | `true` | |

package.json

@@ -1416,6 +1416,11 @@
           "description": "Automatically save a client-side InterSystems file on the server when saved in the editor.",
           "type": "boolean",
           "default": true
+        },
+        "objectscript.showGeneratedFileDecorations": {
+          "description": "Controls whether a badge is shown in the file explorer and open editors view for generated files.",
+          "type": "boolean",
+          "default": true
         }
       }
     },

src/extension.ts

@@ -114,6 +114,7 @@ import {
 import { NodeBase } from "./explorer/models/nodeBase";
 import { loadStudioColors, loadStudioSnippets } from "./commands/studioMigration";
 import { newFile, NewFileType } from "./commands/newFile";
+import { FileDecorationProvider } from "./providers/FileDecorationProvider";
 
 const packageJson = vscode.extensions.getExtension(extensionId).packageJSON;
 const extensionVersion = packageJson.version;
@@ -737,6 +738,9 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
 
   openedClasses = workspaceState.get("openedClasses") ?? [];
 
+  // Create this here so we can fire its event
+  const fileDecorationProvider = new FileDecorationProvider();
+
   context.subscriptions.push(
     reporter,
     panel,
@@ -1182,6 +1186,8 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
       newFile(NewFileType.BusinessService)
     ),
     vscode.commands.registerCommand("vscode-objectscript.newFile.dtl", () => newFile(NewFileType.DTL)),
+    vscode.window.registerFileDecorationProvider(fileDecorationProvider),
+    vscode.workspace.onDidOpenTextDocument((doc) => !doc.isUntitled && fileDecorationProvider.emitter.fire(doc.uri)),
     vscode.commands.registerCommand("vscode-objectscript.importLocalFilesServerSide", (wsFolderUri) => {
       if (
         wsFolderUri instanceof vscode.Uri &&

src/providers/FileDecorationProvider.ts

@@ -0,0 +1,65 @@
+import * as vscode from "vscode";
+import { currentFile } from "../utils";
+
+export class FileDecorationProvider implements vscode.FileDecorationProvider {
+  private _genBadge = String.fromCharCode(9965); // Gear
+  private _genTooltip = "Generated";
+  onDidChangeFileDecorations: vscode.Event<vscode.Uri>;
+
+  emitter = new vscode.EventEmitter<vscode.Uri>();
+
+  public constructor() {
+    this.onDidChangeFileDecorations = this.emitter.event;
+  }
+
+  provideFileDecoration(uri: vscode.Uri): vscode.FileDecoration | undefined {
+    let result: vscode.FileDecoration | undefined = undefined;
+
+    // Only provide decorations for files that are open and not untitled
+    const doc = vscode.workspace.textDocuments.find((d) => d.uri.toString() == uri.toString());
+    if (
+      doc != undefined &&
+      !doc.isUntitled &&
+      ["objectscript", "objectscript-class", "objectscript-int", "objectscript-macros"].includes(doc.languageId) &&
+      vscode.workspace
+        .getConfiguration("objectscript", vscode.workspace.getWorkspaceFolder(uri))
+        .get<boolean>("showGeneratedFileDecorations")
+    ) {
+      // Use the file's contents to check if it's generated
+      if (doc.languageId == "objectscript-class") {
+        for (let line = 0; line < doc.lineCount; line++) {
+          const lineText = doc.lineAt(line).text;
+          if (lineText.startsWith("Class ")) {
+            const clsMatch = lineText.match(/[[, ]{1}GeneratedBy *= *([^,\] ]+)/i);
+            if (clsMatch) {
+              // This class is generated
+              result = new vscode.FileDecoration(this._genBadge, `${this._genTooltip} by ${clsMatch[1]}`);
+            }
+            break;
+          }
+        }
+      } else {
+        const firstLine = doc.lineAt(0).text;
+        if (firstLine.startsWith("ROUTINE ") && firstLine.includes("Generated]")) {
+          // This routine is generated
+          let tooltip = this._genTooltip;
+          const file = currentFile(doc)?.name;
+          if (file) {
+            const macMatch = file.match(/^(.*)\.G[0-9]+\.mac$/);
+            const intMatch = file.match(/^(.*)\.[0-9]+\.int$/);
+            if (macMatch) {
+              tooltip += ` by ${macMatch[1]}.cls`;
+            } else if (intMatch) {
+              tooltip += ` by ${intMatch[1]}.cls`;
+            } else if (doc.languageId == "objectscript-int") {
+              tooltip += ` by ${file.slice(0, -3)}mac`;
+            }
+          }
+          result = new vscode.FileDecoration(this._genBadge, tooltip);
+        }
+      }
+    }
+
+    return result;
+  }
+}