Merge pull request #829 from gjsjohnmurray/pre-sync-1.4.1

Merge 1.4.1 release changes into prerelease branch

Author: gjsjohnmurray

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change Log
 
+## [1.4.1] 14-Jan-2022
+- Fixes
+  - Version 1.4.0 is failing to activate (#827)
+
+## [1.4.0] 14-Jan-2022
+- Enhancements
+  - Make `Ctrl / Cmd+T` lookup (Open Symbol by Name) check all servers connected to a multi-root workspace (#815)
+  - Improve exporting (#818)
+  - Improve client-side DFI workflow (#808)
+  - Improve behavior when no Source Control class is enabled (#171)
+- Fixes
+  - Displace incorrectly-published pre-release version.
+  - Point to correct line when debugging through code with multi-line method arguments (#804)
+  - Show menu options from correct namespace for `Studio Actions` in ObjectScript Explorer (#812)
+  - Fix `Attempted Edit` Studio Action handling (#781)
+  - Properly return options for the Server Command menu for isfs-readonly files (#811)
+  - Remove `vscode-objectscript-output` language from selector (#805)
+
 ## [1.2.2] 07-Dec-2021
 - Fixes
   - Exporting not working with new version 1.2.1 (#799)

README.md

@@ -30,7 +30,7 @@ This is a pre-release which improves security as follows:
 - Export of existing server sources into a working folder:
   - open Command Palette (<kbd>F1</kbd> or <kbd>⌘</kbd>/<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>)
   - start typing 'ObjectScript'
-  - choose `ObjectScript: Export Sources`
+  - choose `ObjectScript: Export Code from Server`
   - press <kbd>Enter</kbd>
 - Save and compile a class:
   - press <kbd>⌘</kbd>/<kbd>Ctrl</kbd>+<kbd>F7</kbd>
@@ -62,8 +62,8 @@ To unlock these features (optional):
 
 1. Download and install a beta version from GitHub. This is necessary because Marketplace does not allow publication of extensions that use proposed APIs.
 	- Go to https://github.com/intersystems-community/vscode-objectscript/releases
-	- Locate the beta immediately above the release you installed from Marketplace. For instance, if you installed `1.2.2`, look for `1.2.3-beta.1`. This will be functionally identical to the Marketplace version apart from being able to use proposed APIs.
-	- Download the VSIX file (for example `vscode-objectscript-1.2.3-beta.1.vsix`) and install it. One way to install a VSIX is to drag it from your download folder and drop it onto the list of extensions in the Extensions view of VS Code.
+	- Locate the beta immediately above the release you installed from Marketplace. For instance, if you installed `1.4.1`, look for `1.4.2-beta.1`. This will be functionally identical to the Marketplace version apart from being able to use proposed APIs.
+	- Download the VSIX file (for example `vscode-objectscript-1.4.2-beta.1.vsix`) and install it. One way to install a VSIX is to drag it from your download folder and drop it onto the list of extensions in the Extensions view of VS Code.
 
 2. From [Command Palette](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_command-palette) choose `Preferences: Configure Runtime Arguments`.
 3. In the argv.json file that opens, add this line (required for both Stable and Insiders versions of VS Code):

docs/SettingsReference.md

@@ -45,7 +45,7 @@ The extensions in the InterSystems ObjectScript Extension Pack provide many sett
 | `"objectscript.export.atelier"` | Export source code as Atelier did it, with packages as subfolders. | `boolean` | `true` | |
 | `"objectscript.export.category"` | Category of source code to export: `CLS` = classes; `RTN` = routines; `CSP` = csp files; `OTH` = other. Default is `*` = all. | `string` or `object` | `"*"` | |
 | `"objectscript.export.dontExportIfNoChanges"` | Do not rewrite the local file if the content is identical to what came from the server. | `boolean` | `false` | |
-| `"objectscript.export.filter"` | SQL filter to limit what to export. | `string` | `""` | |
+| `"objectscript.export.filter"` | SQL filter to limit what to export. | `string` | `""` | The filter is applied to document names using the [LIKE predicate](https://irisdocs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=RSQL_like) (i.e. `Name LIKE '%filter%'`). |
 | `"objectscript.export.folder"` | Folder for exported source code within workspace. | `string` | `"src"` | |
 | `"objectscript.export.generated"` | Export generated source code files, such as INTs generated from classes. | `boolean` | `false` | |
 | `"objectscript.export.map"` | Map file names before export, with regexp pattern as a key and replacement as a value. | `object` | `{}` | For example, `{  \"%(.*)\": \"_$1\" }` to make % classes or routines use underscore prefix instead. |

package-lock.json

@@ -2,7 +2,7 @@
   "name": "vscode-objectscript",
   "displayName": "InterSystems ObjectScript",
   "description": "InterSystems ObjectScript language support for Visual Studio Code",
-  "version": "1.3.2022011401",
+  "version": "1.5.2022011402",
   "icon": "images/logo.png",
   "aiKey": "9cd75d51-697c-406c-a929-2bcf46e97c64",
   "categories": [
@@ -232,6 +232,10 @@
         {
           "command": "vscode-objectscript.showClassDocumentationPreview",
           "when": "editorLangId == objectscript-class"
+        },
+        {
+          "command": "vscode-objectscript.exportCurrentFile",
+          "when": "resourceScheme == objectscript && vscode-objectscript.connectActive"
         }
       ],
       "view/title": [
@@ -332,6 +336,11 @@
           "command": "vscode-objectscript.compileOnly",
           "when": "editorLangId =~ /^objectscript/ && vscode-objectscript.connectActive",
           "group": "objectscript@7"
+        },
+        {
+          "command": "vscode-objectscript.exportCurrentFile",
+          "when": "resourceScheme == objectscript && vscode-objectscript.connectActive",
+          "group": "objectscript@8"
         }
       ],
       "editor/title": [
@@ -439,6 +448,7 @@
       },
       {
         "id": "vscode-objectscript-output",
+        "aliases": [],
         "mimetypes": [
           "text/x-code-output"
         ]
@@ -495,7 +505,7 @@
       {
         "category": "ObjectScript",
         "command": "vscode-objectscript.export",
-        "title": "Export Sources",
+        "title": "Export Code from Server",
         "enablement": "!isWeb"
       },
       {
@@ -693,6 +703,12 @@
         "title": "Show Class Documentation Preview",
         "enablement": "!isWeb",
         "icon": "$(open-preview)"
+      },
+      {
+        "category": "ObjectScript",
+        "command": "vscode-objectscript.exportCurrentFile",
+        "title": "Export Current File from Server",
+        "enablement": "!isWeb"
       }
     ],
     "keybindings": [
@@ -893,7 +909,7 @@
               "type": "boolean"
             },
             "filter": {
-              "description": "SQL filter to limit what to export.",
+              "markdownDescription": "SQL filter to limit what to export. The filter is applied to document names using the [LIKE predicate](https://irisdocs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=RSQL_like) (i.e. `Name LIKE '%filter%'`).",
               "type": "string"
             },
             "category": {

package.json

@@ -2,17 +2,10 @@ import fs = require("fs");
 import path = require("path");
 import * as vscode from "vscode";
 import { AtelierAPI } from "../api";
-import { config, explorerProvider } from "../extension";
-import { mkdirSyncRecursive, notNull, outputChannel, uriOfWorkspaceFolder } from "../utils";
+import { config, explorerProvider, OBJECTSCRIPT_FILE_SCHEMA, schemas } from "../extension";
+import { currentFile, mkdirSyncRecursive, notNull, outputChannel, uriOfWorkspaceFolder } from "../utils";
 import { NodeBase } from "../explorer/models/nodeBase";
 
-const filesFilter = (file: any) => {
-  if (file.cat === "CSP" || file.name.startsWith("%") || file.name.startsWith("INFORMATION.")) {
-    return false;
-  }
-  return true;
-};
-
 export const getCategory = (fileName: string, addCategory: any | boolean): string => {
   const fileExt = fileName.split(".").pop().toLowerCase();
   if (typeof addCategory === "object") {
@@ -30,6 +23,7 @@ export const getCategory = (fileName: string, addCategory: any | boolean): strin
     case "int":
     case "inc":
     case "mac":
+    case "dfi":
       return fileExt;
     default:
       return "oth";
@@ -51,17 +45,26 @@ export const getFileName = (
     const cat = addCategory ? getCategory(name, addCategory) : null;
     return [folder, cat, ...nameArr].filter(notNull).join(path.sep);
   } else {
-    // This is a class, routine or include file
-    if (map) {
-      for (const pattern of Object.keys(map)) {
-        if (new RegExp(`^${pattern}$`).test(name)) {
-          name = name.replace(new RegExp(`^${pattern}$`), map[pattern]);
-          break;
+    let fileNameArray: string[];
+    let fileExt: string;
+    if (/\.dfi$/i.test(name)) {
+      // This is a DFI file
+      fileNameArray = name.split("-");
+      fileNameArray.push(fileNameArray.pop().slice(0, -4));
+      fileExt = "dfi";
+    } else {
+      // This is a class, routine or include file
+      if (map) {
+        for (const pattern of Object.keys(map)) {
+          if (new RegExp(`^${pattern}$`).test(name)) {
+            name = name.replace(new RegExp(`^${pattern}$`), map[pattern]);
+            break;
+          }
         }
       }
+      fileNameArray = name.split(".");
+      fileExt = fileNameArray.pop().toLowerCase();
     }
-    const fileNameArray: string[] = name.split(".");
-    const fileExt = fileNameArray.pop().toLowerCase();
     const cat = addCategory ? getCategory(name, addCategory) : null;
     if (split) {
       const fileName = [folder, cat, ...fileNameArray].filter(notNull).join(path.sep);
@@ -216,27 +219,86 @@ export async function exportList(files: string[], workspaceFolder: string, names
   );
 }
 
-export async function exportAll(workspaceFolder?: string): Promise<any> {
-  if (!workspaceFolder) {
-    const list = vscode.workspace.workspaceFolders
-      .filter((folder) => config("conn", folder.name).active)
-      .map((el) => el.name);
-    if (list.length > 1) {
-      return vscode.window.showQuickPick(list).then((folder) => (folder ? exportAll : null));
-    } else {
-      workspaceFolder = list.pop();
+export async function exportAll(): Promise<any> {
+  let workspaceFolder: string;
+  const workspaceList = vscode.workspace.workspaceFolders
+    .filter((folder) => !schemas.includes(folder.uri.scheme) && config("conn", folder.name).active)
+    .map((el) => el.name);
+  if (workspaceList.length > 1) {
+    const selection = await vscode.window.showQuickPick(workspaceList, {
+      placeHolder: "Select the workspace folder to export files to.",
+    });
+    if (selection === undefined) {
+      return;
     }
+    workspaceFolder = selection;
+  } else if (workspaceList.length === 1) {
+    workspaceFolder = workspaceList.pop();
+  } else {
+    vscode.window.showInformationMessage(
+      "There are no folders in the current workspace that code can be exported to.",
+      "Dismiss"
+    );
+    return;
   }
   if (!config("conn", workspaceFolder).active) {
     return;
   }
   const api = new AtelierAPI(workspaceFolder);
   outputChannel.show(true);
-  const { category, generated, filter, ns } = config("export", workspaceFolder);
-  const files = (data) => data.result.content.filter(filesFilter).map((file) => file.name);
-  return api.getDocNames({ category, generated, filter }).then((data) => {
-    return exportList(files(data), workspaceFolder, ns);
-  });
+  const { category, generated, filter } = config("export", workspaceFolder);
+  // Replicate the behavior of getDocNames() but use StudioOpenDialog for better performance
+  let filterStr = "";
+  switch (category) {
+    case "CLS":
+      filterStr = "Type = 4";
+      break;
+    case "CSP":
+      filterStr = "Type %INLIST $LISTFROMSTRING('5,6')";
+      break;
+    case "OTH":
+      filterStr = "Type NOT %INLIST $LISTFROMSTRING('0,1,2,3,4,5,6,11,12')";
+      break;
+    case "RTN":
+      filterStr = "Type %INLIST $LISTFROMSTRING('0,1,2,3,11,12')";
+      break;
+  }
+  if (filter !== "") {
+    if (filterStr !== "") {
+      filterStr += " AND ";
+    }
+    filterStr += `Name LIKE '%${filter}%'`;
+  }
+  return api
+    .actionQuery("SELECT Name FROM %Library.RoutineMgr_StudioOpenDialog(?,?,?,?,?,?,?,?)", [
+      "*",
+      "1",
+      "1",
+      api.config.ns.toLowerCase() === "%sys" ? "1" : "0",
+      "1",
+      "0",
+      generated ? "1" : "0",
+      filterStr,
+    ])
+    .then(async (data) => {
+      let files: vscode.QuickPickItem[] = data.result.content.map((file) => {
+        return { label: file.Name, picked: true };
+      });
+      files = await vscode.window.showQuickPick(files, {
+        canPickMany: true,
+        ignoreFocusOut: true,
+        placeHolder: "Uncheck a file to exclude it. Press 'Escape' to cancel export.",
+        title: "Files to Export",
+      });
+      if (files === undefined) {
+        return;
+      }
+      return exportList(
+        files.map((file) => file.label),
+        workspaceFolder,
+        api.config.ns
+      );
+    });
 }
 
 export async function exportExplorerItems(nodes: NodeBase[]): Promise<any> {
@@ -264,3 +326,18 @@ Would you like to continue?`,
     return exportList(items.flat(), workspaceFolder, namespace).then(() => explorerProvider.refresh());
   });
 }
+
+export async function exportCurrentFile(): Promise<any> {
+  const openEditor = vscode.window.activeTextEditor;
+  if (openEditor === undefined) {
+    // Need an open document to export
+    return;
+  }
+  const openDoc = openEditor.document;
+  if (openDoc.uri.scheme !== OBJECTSCRIPT_FILE_SCHEMA) {
+    // Only export files opened from the explorer
+    return;
+  }
+  const api = new AtelierAPI(openDoc.uri);
+  return exportList([currentFile(openDoc).name], api.configName, api.config.ns);
+}