Add objectscript.openClassContracted setting (#882)

Author: isc-bsaviano

docs/SettingsReference.md

@@ -55,6 +55,7 @@ The extensions in the InterSystems ObjectScript Extension Pack provide many sett
 | `"objectscript.format.functionCase"` | Case for system functions and system variables. | `"upper"`, `"lower"` or `"word"` | `"word"` | Has no effect if the `InterSystems Language Server` extension is installed and enabled. |
 | `"objectscript.ignoreInstallServerManager"` | Do not offer to install the [intersystems-community.servermanager](https://marketplace.visualstudio.com/items?itemName=intersystems-community.servermanager) extension. | `boolean` | `false` | |
 | `"objectscript.multilineMethodArgs"` | List method arguments on multiple lines, if the server supports it. | `boolean` | `false` | Only supported on IRIS 2019.1.2, 2020.1.1+, 2021.1.0+ and subsequent versions! On all other versions, this setting will have no effect. |
+| `"objectscript.openClassContracted"` | Automatically collapse all folding ranges when a class is opened for the first time. | `boolean` | `false` | |
 | `"objectscript.overwriteServerChanges"` | Overwrite a changed server version without confirmation when importing the local file. | `boolean` | `false` | |
 | `"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` | |

package.json

@@ -1067,6 +1067,11 @@
           "markdownDescription": "List method arguments on multiple lines, if the server supports it. **NOTE:** Only supported on IRIS 2019.1.2, 2020.1.1+, 2021.1.0+ and subsequent versions! On all other versions, this setting will have no effect.",
           "type": "boolean",
           "default": false
+        },
+        "objectscript.openClassContracted": {
+          "description": "Automatically collapse all folding ranges when a class is opened for the first time.",
+          "type": "boolean",
+          "default": false
         }
       }
     },

src/extension.ts

@@ -449,6 +449,9 @@ function languageServer(install = true): vscode.Extension<any> {
   return extension;
 }
 
+// The URIs of all classes that have been opened. Used when objectscript.openClassContracted is true.
+let openedClasses: string[];
+
 export async function activate(context: vscode.ExtensionContext): Promise<any> {
   if (!packageJson.version.includes("SNAPSHOT")) {
     try {
@@ -738,6 +741,8 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
     }
   }
 
+  openedClasses = workspaceState.get("openedClasses") ?? [];
+
   context.subscriptions.push(
     reporter,
     panel,
@@ -968,6 +973,25 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
           })
       )
     ),
+    vscode.window.onDidChangeActiveTextEditor((editor: vscode.TextEditor) => {
+      const uri: string = editor.document.uri.toString();
+      if (
+        config("openClassContracted") &&
+        editor &&
+        editor.document.languageId === "objectscript-class" &&
+        !openedClasses.includes(uri)
+      ) {
+        vscode.commands.executeCommand("editor.foldAll");
+        openedClasses.push(uri);
+      }
+    }),
+    vscode.workspace.onDidCloseTextDocument((doc: vscode.TextDocument) => {
+      const uri: string = doc.uri.toString();
+      const idx: number = openedClasses.indexOf(uri);
+      if (idx > -1) {
+        openedClasses.splice(idx, 1);
+      }
+    }),
 
     /* Anything we use from the VS Code proposed API */
     ...proposed
@@ -1036,6 +1060,9 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
 }
 
 export function deactivate(): void {
+  if (workspaceState) {
+    workspaceState.update("openedClasses", openedClasses);
+  }
   // This will ensure all pending events get flushed
   reporter && reporter.dispose();
   if (terminals) {