diff --git a/CHANGELOG.md b/CHANGELOG.md index 5173f61a..0314d863 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,12 @@ # Change Log +## [3.0.7] 2025-09-21 + +- Enhancements + - Cross-workspace Go to Definition via `objectscript.export.searchOtherWorkspaceFolders` + ## [3.0.6] 09-Sep-2025 + - Enhancements - Add `objectscript.unitTest.enabled` setting (#1627) - Add a `New File...` command for creating an Interoperability Message (#1629) @@ -17,6 +23,7 @@ - Don't append extra trailing newlines when saving server-side web app files (#1648) ## [3.0.5] 21-Jul-2025 + - Enhancements - Better telemetry (#1608) - Output the path to the export file when exporting to an XML file (#1616) @@ -31,6 +38,7 @@ - Fix resolving of server connection for files opened from InterSystems Explorer or XML preview (#1622) ## [3.0.4] 30-Jun-2025 + - Enhancements - Shorten server-side error messages (#1587) - Make it more clear when a server connection failed due to a timeout (#1592) @@ -40,6 +48,7 @@ - Fix comparing of local and server versions of web app files (#1599) ## [3.0.3] 16-Jun-2025 + - Enhancements - Cache the contents of files fetched during a debug session (#1579) - Fixes @@ -62,6 +71,7 @@ - Fix saving and re-opening of server-side documents on VS Code 1.101.0 (#1584) ## [3.0.2] 20-May-2025 + - Enhancements - Allow `objectscript.multilineMethodArgs` to be set per workspace folder (#1534) - Log out of web sessions when VS Code exits (#1540) @@ -81,11 +91,13 @@ - Don't report error when deleting a local file that doesn't exist on the server (#1555) ## [3.0.1] 04-Apr-2025 + - Fixes - Fix issue where `Undo` after a save deletes the file being edited (#1524) - Fix endless save loop when one local workspace folder is a subfolder of another (#1525) ## [3.0.0] 02-Apr-2025 + - Enhancements - Client-side editing overhaul (#1401, #1470, #1515, #1520): - Support the use of client-side editing in any non-isfs workspace folder, not just folders in your local file system. For example, with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). @@ -126,10 +138,12 @@ - Upgrade dependencies ## [2.12.10] 13-Nov-2024 + - Fixes - Prevent overprompting for permission and account (#1456) ## [2.12.9] 29-Oct-2024 + - Enhancements - Add `Launch Lite Terminal` action to Explorer (#1438) - Add timeout to initial connection request (#1440) @@ -141,10 +155,12 @@ - Support for line wrapping in Lite Terminal (#1452) ## [2.12.8] 23-Sep-2024 + - Fixes - Solve 1.93 performance issue (#1428) ## [2.12.7] 05-Aug-2024 + - Enhancements - Fire source control hooks for opened and closed documents (#1414) - Always stop the debug target process when attaching (#1415) @@ -159,7 +175,9 @@ - Don't append CSPCHD for web applications that don't support it by default (#1420) ## [2.12.6] 23-Jul-2024 + Minimum VS Code version is now 1.91.0. + - Enhancements - Support command stepping in debugger (requires InterSystems IRIS 2023.1.5, 2024.1.1+, or 2024.2+) (#1385) - Add `Compile` command to server-side file explorer (#1389) @@ -179,6 +197,7 @@ Minimum VS Code version is now 1.91.0. - Provide Project and User parameters to Studio add-ins (#1402) ## [2.12.5] 29-May-2024 + - Enhancements - [Open symbol by name](https://code.visualstudio.com/docs/editor/editingevolved#_open-symbol-by-name) (`Ctrl/Cmd-T`) improvements (#1366): - Show classes as well as class members @@ -189,6 +208,7 @@ Minimum VS Code version is now 1.91.0. - Show prompt for username if unauthenticated access fails when no username is specified in the server definition (#1372) ## [2.12.4] 14-May-2024 + - Enhancements - Remove `objectscript.ignoreInstallServerManager` setting (#1339) - Make ObjectScript comment tokens configurable (#1353) @@ -200,6 +220,7 @@ Minimum VS Code version is now 1.91.0. - Support trailing slash in `isfs` directory URIs (#1357) ## [2.12.3] 26-Mar-2024 + - Enhancements - Improve `Jump to Tag + Offset` UI (#1325) - Add `Modify Project Metadata...` command (#1326) @@ -213,6 +234,7 @@ Minimum VS Code version is now 1.91.0. - Fix manual refresh of Test Explorer (#1336) (suggested by @ollitanska) ## [2.12.2] 28-Feb-2024 + - Enhancements - Add auto-closing of C-style block comments (#1311) - Server-side source control improvements (#1314): @@ -230,14 +252,17 @@ Minimum VS Code version is now 1.91.0. - Refresh ObjectScript Explorer files when they are re-opened (#1321) ## [2.12.1] 05-Feb-2024 + - Fixes - Don't create unit test items in workspace folders that don't support running tests (#1307) - Update `objectscript.unitTest.relativeTestRoots` validation regex (#1308) - Fix `undefined` errors when building array of unit tests to load (#1308) ## [2.12.0] 29-Jan-2024 + Minimum VS Code version is now 1.83.0. This extension now depends on the [InterSystems Server Manager](https://marketplace.visualstudio.com/items?itemName=intersystems-community.servermanager) extension. + - Enhancements - Add support for running and debugging unit tests (#1269) - Use Server Manager's View Container (#1270) @@ -247,7 +272,7 @@ This extension now depends on the [InterSystems Server Manager](https://marketpl - Add testing link to new KPIs (#1302) - Add CodeLenses for BPLs, DTLs, KPIs and Rules (#1303) - Fixes - - Harden `TextSearchProvider` (#1276, #1294) + - Harden `TextSearchProvider` (#1276, #1294) - Fix WebSocket Terminal del key (#1285) - Make server-side search respect Context Lines feature of Search Editor (#1290) - Better message when WebSocket Terminal can't be started (#1293) @@ -255,6 +280,7 @@ This extension now depends on the [InterSystems Server Manager](https://marketpl - Remove `glob` as a dependency (#1300) ## [2.10.5] 02-Nov-2023 + - Enhancements - Use new Modern themes when loading Studio syntax colors (#1264) - Fixes @@ -262,6 +288,7 @@ This extension now depends on the [InterSystems Server Manager](https://marketpl - Keep file contents when copying class definition if "Class" line not found (#1267) ## [2.10.4] 01-Nov-2023 + - Fixes - Fix sorting of items in Projects Explorer (#1246) - Don't show REST APIs in Explorer CSP Files list (#1248) @@ -274,6 +301,7 @@ This extension now depends on the [InterSystems Server Manager](https://marketpl - Allow users to select no resource in new KPI command (#1261) ## [2.10.3] 25-Sep-2023 + - Enhancements - Put link to editor in class comment when creating new BPL/DTL (#1231) - Make it easier to add namespace from same server to workspace (#1232) @@ -283,6 +311,7 @@ This extension now depends on the [InterSystems Server Manager](https://marketpl - Remove unneeded snippets (#1235) ## [2.10.2] 07-Sep-2023 + - Enhancements - Improve message to help resolve scenario where isfs user lacks `%DB_IRISSYS:READ` (#1211) - Improve MAC and INT stubs created for new server-side routine (#1218) @@ -293,6 +322,7 @@ This extension now depends on the [InterSystems Server Manager](https://marketpl - Display routine members of server-side project correctly (#1226) ## [2.10.1] 10-Aug-2023 + - Enhancements - Only add WebSocket Terminal button to Server Manager 3.4.2+ tree if server is compatible (#1204) - Add `Copy Invocation` CodeLens above query definition in class (#1198) @@ -302,11 +332,13 @@ This extension now depends on the [InterSystems Server Manager](https://marketpl - Properly report search matches for super classes (#1200) ## [2.10.0] 20-Jul-2023 + Minimum VS Code version is now 1.75.0 + - Enhancements - Add WebSocket Terminal support (#1150) - Support a ${project} variable in Server Actions Menu custom entries (#1157) - - Support importing/exporting XML files (#1171) + - Support importing/exporting XML files (#1171) - Support a ${username} variable in Server Actions Menu custom entries (#1173) - Migrate to [official ISC documentation](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO) (#1185) - Fixes @@ -328,6 +360,7 @@ Minimum VS Code version is now 1.75.0 - Upgrade vulnerable dependencies. ## [2.8.1] 15-May-2023 + - Enhancements - Prompt user to enable proposed APIs when server-side folder is opened (#1140) - Show config names of interoperability jobs in `Attach to Process` debug menu (#1089) (contributed by @ollitanska) @@ -337,6 +370,7 @@ Minimum VS Code version is now 1.75.0 - Make folder-specific settings for ISFS folder work again (#1144) ## [2.8.0] 04-Apr-2023 + - Enhancements - Integrate Angular Rule Editor (#1014) - Add command to refresh local file contents (#1066) (contributed by @ollitanska) @@ -349,6 +383,7 @@ Minimum VS Code version is now 1.75.0 - Upgrade vulnerable dependencies. ## [2.6.0] 27-Feb-2023 + - Enhancements - Implement async server-side search (#1045) (requires [proposed API enabled](https://github.com/intersystems-community/vscode-objectscript#enable-proposed-apis) and InterSystems IRIS 2023.1+) - Add `Switch Namespace` option to Server Actions menu for local workspace folders (#1065) (contributed by @ollitanska) @@ -368,11 +403,13 @@ Minimum VS Code version is now 1.75.0 - Upgrade vulnerable dependencies. ## [2.4.3] 02-Feb-2023 + - Fixes - Fix deployed check (#1071) - Fix opening of `isfs` files from ObjectScript Explorer (#1072) ## [2.4.2] 01-Feb-2023 + - Enhancements - Use query instead of index for class Deployed checks (#1054) - Use `docker compose` command if present (#1057) @@ -385,10 +422,12 @@ Minimum VS Code version is now 1.75.0 - Upgrade vulnerable dependencies. ## [2.4.1] 12-Jan-2023 + - Fixes - Fix 'No file system provider found' errors when debugging local file (#1047) ## [2.4.0] 10-Jan-2023 + - Enhancements - Show server name in Status Bar (#1017) - Server-side search: use include/exclude specs (#1021) @@ -401,10 +440,11 @@ Minimum VS Code version is now 1.75.0 - Hide `-injection` languages from selector (#1011) - Properly report matches in Storage definitions (#1025) - Fix debug breakpoint mapping when Language Server is absent (#1031) - - Don't call `openTextDocument` in debugger (#1042) + - Don't call `openTextDocument` in debugger (#1042) - Upgrade vulnerable dependencies. ## [2.2.0] 31-Oct-2022 + - Enhancements - Add features to ease migration from Studio (see [Migrating from Studio documentation page](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_fromstudio) for details) (#1003) - Improve CodeLenses (#1007) @@ -416,12 +456,14 @@ Minimum VS Code version is now 1.75.0 - Upgrade vulnerable dependencies. ## [2.0.0] 04-Oct-2022 + - Enhancements - Use Server Manager version 3's enhanced security for stored passwords. Explicit permission must be given by the user before Server Manager will provide a connection's stored password to this extension. This feature previewed in the 1.x pre-releases, which 2.0.0 supersedes. - Add `Copy Invocation` CodeLens alongside `Debug this Method`. Hideable using the `objectscript.debug.copyToClipboard` setting (#974) - Add `objectscript.importOnSave` setting to control whether saving a client-side file updates code on the connected server. Default is `true` (#985) ## [1.8.2] 08-Aug-2022 + - Enhancements - Support `objectscript` and `objectscript-class` as the info string for [fenced code blocks](https://spec.commonmark.org/0.30/#fenced-code-blocks) when editing Markdown. However coloring does not render in preview (#964) - Fixes @@ -429,6 +471,7 @@ Minimum VS Code version is now 1.75.0 - Dispose of all event handlers when deactivating (#967) ## [1.8.1] 25-Jul-2022 + - Fixes - New class should ignore `objectscript.export.folder` setting (#938) - Get correct host port number for connection to docker-compose with multiple services (#941) @@ -440,13 +483,16 @@ Minimum VS Code version is now 1.75.0 - Upgrade vulnerable dependencies. ## [1.8.0] 20-Apr-2022 + - Enhancements - Add support for server-side projects (#851) - Implement isfs folder rename and deletion (#923, #922) - - Support "mapped" flag for isfs and export filters, to exclude packages mapped from other databases (#931) + - Support "mapped" flag for isfs and export filters, to exclude packages mapped from other databases (#931) ## [1.6.0] 06-Apr-2022 + Minimum VS Code version is now 1.66.0 + - Enhancements - Colorize text in Output channel (API has finalized) (#910) - Add `objectscript.export.exactFilter` setting (#913) @@ -460,6 +506,7 @@ Minimum VS Code version is now 1.66.0 - Upgrade vulnerable dependencies. ## [1.4.4] 21-Mar-2022 + - Enhancements - Compile asynchronously to avoid timing out (#890) - Add `objectscript.explorer.alwaysShowServerCopy` setting to make ObjectScript Explorer always open server-side code, even when local copy exists (#494) @@ -473,12 +520,14 @@ Minimum VS Code version is now 1.66.0 - Upgrade vulnerable dependencies. ## [1.4.3] 28-Feb-2022 + - Enhancements - Add `objectscript.openClassContracted` setting (#876) - Fixes - Fix 1.4.2 regression that broke server-side editing from ObjectScript Explorer and reloading of open documents when reopening isfs workspaces (#879) ## [1.4.2] 23-Feb-2022 + - Enhancements - Generate content when a new local class or routine is created (#867) - Add file icons (#822) @@ -494,10 +543,12 @@ Minimum VS Code version is now 1.66.0 - Upgrade vulnerable dependencies. ## [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) @@ -512,10 +563,12 @@ Minimum VS Code version is now 1.66.0 - 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) ## [1.2.0] 02-Dec-2021 + - Enhancements - Overhaul `WorkspaceSymbolProvider` (#772) - Add `Open Shell in Docker` option to Server Actions menu (#778) @@ -529,28 +582,31 @@ Minimum VS Code version is now 1.66.0 - Upgrade vulnerable dependencies (#787) ## [1.1.1] 09-Nov-2021 + - Fixes - - Debugger: Breakpoint with no hitCondition cannot be set (#766) + - Debugger: Breakpoint with no hitCondition cannot be set (#766) ## [1.1.0] 08-Nov-2021 + - Enhancements - - Add 'Show Class Documentation Preview' button and command. - - Improve how line comment markers carry over when newline is entered (#541) - - Allow server-side source control class UserAction method call with Action=3 to launch an http/s or ftp/s URL in the external browser (contributed by @a-boertien). - - Add support for conditional breakpoints. - - Improve documentation. + - Add 'Show Class Documentation Preview' button and command. + - Improve how line comment markers carry over when newline is entered (#541) + - Allow server-side source control class UserAction method call with Action=3 to launch an http/s or ftp/s URL in the external browser (contributed by @a-boertien). + - Add support for conditional breakpoints. + - Improve documentation. - Fixes - - Prevent save of isfs class if filename doesn't match the class it defines (#410) - - Refresh ObjectScript Explorer after export (#502) - - Improve message when `/api/atelier` web application is disabled or missing (#752) - - Correctly handle dots in routine names, preventing two copies of the same routine from being opened concurrently (#748) - - Handle multiple selections when performing compile or delete from ObjectScript Explorer (#746) - - Revert document instead of attempting an undo when server-side source control signals this is necessary. - - Resolve issue causing unusable authentication page after CSP timeout. - - Fix XML to UDL conversion. - - Upgrade vulnerable dependencies. + - Prevent save of isfs class if filename doesn't match the class it defines (#410) + - Refresh ObjectScript Explorer after export (#502) + - Improve message when `/api/atelier` web application is disabled or missing (#752) + - Correctly handle dots in routine names, preventing two copies of the same routine from being opened concurrently (#748) + - Handle multiple selections when performing compile or delete from ObjectScript Explorer (#746) + - Revert document instead of attempting an undo when server-side source control signals this is necessary. + - Resolve issue causing unusable authentication page after CSP timeout. + - Fix XML to UDL conversion. + - Upgrade vulnerable dependencies. ## [1.0.14] 20-Sep-2021 + - Require confirmation before compiling all code in namespace (#677) - Respect `maxResults` parameter when running server-side search (#713) - Handle multiple spaces between `Class` keyword and classname (#717) @@ -562,6 +618,7 @@ Minimum VS Code version is now 1.66.0 - Upgrade vulnerable dependency. ## [1.0.13] 09-Jul-2021 + - Add Watchpoint support to debugging (#697) - Make QuickOpen respect any `filter=xxx` query parameter on the isfs folder definition (#593) - Fix unexpected alerts about server-side copy being newer when working with isfs (#683) @@ -572,6 +629,7 @@ Minimum VS Code version is now 1.66.0 - Allow opting out of 'Other Studio Action' server-side source control calls (#691) ## [1.0.12] 10-Jun-2021 + - Allow extension to work in untrusted workspaces. - Don't switch to File Explorer view when opening a file from ObjectScript Explorer (#651) - Scroll to correct line after an Output panel link is clicked (#657) @@ -580,6 +638,7 @@ Minimum VS Code version is now 1.66.0 - Upgrade vulnerable dependencies. ## [1.0.11] 12-May-2021 + - Support client-side web app (CSP) workflow as long as web app path is in the `/csp/*` space (#147, #449) - Add compile-only commands 'Compile Current File' and 'Compile Current File with Specified Flags...' (#595) - Add 'Edit Other' command plus menu option below 'View Other' (#309) @@ -600,6 +659,7 @@ Minimum VS Code version is now 1.66.0 - Upgrade vulnerable dependencies. ## [1.0.10] 26-Apr-2021 + - Avoid prompting for already-saved password (#61) - Constrain QuickOpen list contents when `isfs` folder path targets a specific package (#581) - Show `isfs` folder label in breadcrumb even without proposed APIs enabled (#599) @@ -612,26 +672,29 @@ Minimum VS Code version is now 1.66.0 - Upgrade vulnerable dependencies. ## [1.0.9] 22-Mar-2021 + - Allow system files (% classes) to be searched from non-%SYS namespace. - Handle `objectscript.conn.server` referencing non-existent `intersystems.servers` entry (#586) - Improve README. - Upgrade vulnerable dependencies. ## [1.0.8] 15-Jan-2021 + - Implement `isfs://server:namespace/` syntax as an alternative to the `ns=NAMESPACE` query parameter (#450) - Use new isfs notation in entries created by 'Add Server Namespace to Workspace' (#554) - Load server-side (isfs) folder-specific snippets (#552) - Improve snippets: - - Add a ///-comment tabstop at the start of all snippets used in class definitions. - - Add descriptive default text to more tabstops. - - Add third superclass to multi-superclass snippet. - - Uniformly use Capitalized command names and UPPERCASE function names in ObjectScript. - - Standardize body layout in definitions to reflect layout of result. - - Tidy how duplicate tabstops are used. + - Add a ///-comment tabstop at the start of all snippets used in class definitions. + - Add descriptive default text to more tabstops. + - Add third superclass to multi-superclass snippet. + - Uniformly use Capitalized command names and UPPERCASE function names in ObjectScript. + - Standardize body layout in definitions to reflect layout of result. + - Tidy how duplicate tabstops are used. - Support searching all Studio document types when using symbol search (Cmd/Ctrl + T). - Upgrade vulnerable dependency. ## [1.0.7] 4-Jan-2021 + - Fix issue affecting use with Docker on Windows (#516) - Resolve problem debugging in a multi-root workspace using isfs (#387) - Allow 'View Other' from custom Studio documents. @@ -640,6 +703,7 @@ Minimum VS Code version is now 1.66.0 - Upgrade vulnerable dependency. ## [1.0.6] 13-Nov-2020 + - Target current class when opening documentation from Server Actions quickpick, launched by click on ObjectScript panel in status bar (#490) - Improve code snippets (#493) - Update README to state need for manual download and install of beta VSIX in order to use proposed APIs (#478) @@ -649,26 +713,28 @@ Minimum VS Code version is now 1.66.0 - Exclude Studio project documents (.prj) from isfs tree (#501) - Fix variable tree cascade that occurred when value was edited during debugging (#505) - Show clickable url launching graphical editor for BPL and DTL documents opened from isfs folder (#508) - - To show .bpl and .dtl files, add `filter=*` to isfs folder's `uri` property in your `XXX.code-workspace` file. - - Alternatively, use `View Other` from context menu of the corresponding class. + - To show .bpl and .dtl files, add `filter=*` to isfs folder's `uri` property in your `XXX.code-workspace` file. + - Alternatively, use `View Other` from context menu of the corresponding class. - Display supported image files correctly when opened from isfs web application folder (#394) - Prevent import from overwriting class that is in [deployed mode](https://docs.intersystems.com/iris20181/csp/docbook/Doc.View.cls?KEY=GOBJ_classes#GOBJ_deploy_classes) (#382) - Respect `pathPrefix` property of an `intersystems.servers` connection definition in more places: - - debugger connections - - urls on Server Actions menu + - debugger connections + - urls on Server Actions menu ## [1.0.5] 5-Nov-2020 + - Defer to Language Server 1.0.5+ for folding range information (#473) - Add `objectscript.overwriteServerChanges` setting to permit unconditional import from local file (#464) - Fix authentication problem introduced in 1.0.2 (#458) - Handle Unicode characters in identifiers (#337) - Avoid inappropriate transfer of user-level `objectscript.conn` settings into workspace-level settings (#460) - Enhancements available only when proposed APIs are enabled: - - Improve format of results from Quick Open server-side file name search (#467) - - Add root folder label text to label of isfs file (#455) - - Add '(read-only)' suffix to label of non-editable file opened from ObjectScript Explorer (#471) + - Improve format of results from Quick Open server-side file name search (#467) + - Add root folder label text to label of isfs file (#455) + - Add '(read-only)' suffix to label of non-editable file opened from ObjectScript Explorer (#471) ## [1.0.4] 30-Oct-2020 + - Wait for connection checks to complete during activation. - Display debugging values correctly when they contain characters above ASCII 127. - Fix broken server-side .vscode storage mechanism when isfs query string includes other parameters after `ns`. @@ -678,9 +744,11 @@ Minimum VS Code version is now 1.66.0 - Differentiate "Edit" and "View" options better on isfs dialog. ## [1.0.3] 24-Oct-2020 + - Fix problem that prevented 1.0.2 from publishing to Marketplace. ## [1.0.2] 23-Oct-2020 + - Fix problem with excessive license use. - Install language server extension in the background. - Use less status bar space. @@ -688,18 +756,22 @@ Minimum VS Code version is now 1.66.0 - Add `objectscript.export.map` setting. ## [1.0.1] 20-Oct-2020 + - First production release. ## [0.9.5] + - Fix regression in 0.9.4 that broke `Add Server Namespace to Workspace...`. ## [0.9.4] + - Support folder-level settings, snippets and debug configurations for server-side (isfs) workspace folders. This feature requires a `/_vscode` webapp using the %SYS namespace. - Support webapp-type roots referencing a path that is an ancestor of one or more webapps that use the target namespace. For example `isfs://server/?ns=%SYS&csp` gives access to all %SYS webapps from a single root folder. - Enhance `Add Server Namespace to Workspace...` command and quickstart button to add webapp-type roots. - Remove requirement for namespaces to be uppercase in settings. ## [0.9.3] + - Add quickstart button to ObjectScript Explorer view when local folder is open but no `objectscript.conn` settings are available to it. - Add `Jump to Tag + Offset` command for MACs and INTs, and make it available via click on statusbar field. - Support server-side editing of other filetypes such as HL7, LUT. @@ -713,10 +785,12 @@ Minimum VS Code version is now 1.66.0 - Prepare to coexist with upcoming language server extension. ## [0.9.2] + - Implement `Add Server Namespace to Workspace...` command and surface it on folder context menus in VS Code Explorer. - Add `Choose Server and Namespace` button to VS Code Explorer view when no folder or workspace is open. This provides a quick way to get started with server-centric development, particularly when combined with the 'just-in-time' connection definition enhancement that arrived in version 0.0.7 of the Server Manager extension. ## [0.9.1] + - Fix problem that caused isfs-type saves to report incorrectly that server version was newer. - Prevent silent overwrite on retry after an import was initially canceled because of server-side difference. - Serialize and deduplicate initial credential prompting when a multi-server workspace is opened. @@ -728,6 +802,7 @@ Minimum VS Code version is now 1.66.0 - Add missing 0.9.0 CHANGELOG. ## [0.9.0] + - Change publisher id to be 'intersystems-community'. - Refresh correctly from server after isfs-type save and compile. - Swap the two sides displayed by a compare invoked after local file import conflict. Server copy is now on the left, to match convention elsewhere in VS Code. @@ -738,25 +813,27 @@ Minimum VS Code version is now 1.66.0 - Upgrade vulnerable dependencies. ## [0.8.9] + - Fix saving of isfs-type server-side editing, broken in 0.8.8. - Implement double-click opening from ObjectScript Explorer. - Make ObjectScript Explorer handle non-isfs multi-server multi-root workspace correctly. - Reload VS Code Explorer tree after successful connection. - Fix some issues with `export.addCategory` setting: - - Resolve error when non-string was used as folder value. - - If setting contains multiple patterns, check all of them, in given order. + - Resolve error when non-string was used as folder value. + - If setting contains multiple patterns, check all of them, in given order. - Fix server-side searching of isfs-type root that uses `intersystems.servers` for its connection. - - Server-side searching uses a VS Code API that is still (1.48) at "proposed" stage. See [here](https://github.com/intersystems-community/vscode-objectscript/issues/126#issuecomment-674089387) for instructions on how to use this pre-release feature. + - Server-side searching uses a VS Code API that is still (1.48) at "proposed" stage. See [here](https://github.com/intersystems-community/vscode-objectscript/issues/126#issuecomment-674089387) for instructions on how to use this pre-release feature. - No longer use progress indicator when server-side source control displays a page. - Do not call server-side AfterUserAction if not necessary. - Upgrade vulnerable dependencies. ## [0.8.8] + - Fix retrieval of password when `objectscript.conn.server` defers to Server Manager. - Fix command completions, broken in 0.8.7. - Improve ObjectScript Explorer: - - Files that will be loaded from local workspace now show their filetype icon and a full path tooltip. - - Fix rare case where code would load from wrong place. + - Files that will be loaded from local workspace now show their filetype icon and a full path tooltip. + - Fix rare case where code would load from wrong place. - Skip compilation of local CSP files for now. - Improve handling of server modification date comparisons. - Fix incorrect `Studio Action "Changed Namespace" not supported` message in output channel. @@ -765,6 +842,7 @@ Minimum VS Code version is now 1.66.0 - Improve README information about username and password in settings. ## [0.8.7] + - Use `intersystems.servers` object for more flexible connection definitions. - Recommend [intersystems-community.servermanager](https://marketplace.visualstudio.com/items?itemName=intersystems-community.servermanager) extension for management of `intersystems.servers` definitions. - Support server-side source control and other server-side commands. @@ -786,23 +864,28 @@ Minimum VS Code version is now 1.66.0 - Webpack extension to reduce size. ## [0.8.6] - 2020-04-23 + - Support $ETRAP system variable. - Fix opening Docker terminal. ## [0.8.5] - 2020-04-20 + - Fix errors in embedded JS code. - Fix diagnostic error for values in quotes. ## [0.8.3] - 2020-03-23 + - Support for custom address in isfs. - Multi select in explorer view for mass export. ## [0.8.2] - 2020-03-04 + - Show current place (label+pos^routine) in status bar for INT code. - Fix syntax highlighting. - Support for ${namespace} in links. ## [0.8.1] - 2020-02-06 + - Some small fixes in filtering for isfs. - Fixed connection info in Explorer. - Extra links for server. @@ -814,6 +897,7 @@ Minimum VS Code version is now 1.66.0 - Password prompt, live connection status. ## [0.8.0] + - "Debug this ClassMethod" feature added, to quickly debug any classmethod in a class - Change variable value while debugging - When virtual filesystem `isfs://` used, now possible to execute some actions from Studio Source class menu diff --git a/README.md b/README.md index b30f870d..3247a3c3 100644 --- a/README.md +++ b/README.md @@ -48,29 +48,51 @@ Open VS Code. Go to Extensions view (⌘/Ctrl+Shift **Implementation developed and maintained by Consistem Sistemas** + +When working in a multi-root workspace, the extension normally searches the current workspace folder (and any sibling folders connected to the same namespace) for local copies of ObjectScript code before requesting the server version. If you keep shared source code in other workspace folders with different connection settings, set the `objectscript.export.searchOtherWorkspaceFolders` array in the consuming folder's settings so those folders are considered first. Use workspace-folder names, or specify `"*"` to search every non-`isfs` folder. + +```json +{ + "objectscript.export": { + "folder": "src", + "searchOtherWorkspaceFolders": ["shared"] + } +} +``` + +With this setting enabled, features such as Go to Definition resolve to the first matching local file across the configured workspace folders before falling back to the server copy. + ## Notes - Connection-related output appears in the 'Output' view while switched to the 'ObjectScript' channel using the drop-down menu on the view titlebar. diff --git a/package.json b/package.json index 92f69b74..f9267f54 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,9 @@ { "name": "vscode-objectscript", - "displayName": "InterSystems ObjectScript", + "displayName": "Consistem InterSystems ObjectScript", "description": "InterSystems ObjectScript language support for Visual Studio Code", "version": "3.0.7-SNAPSHOT", "icon": "images/logo.png", - "aiKey": "InstrumentationKey=9cd75d51-697c-406c-a929-2bcf46e97c64;IngestionEndpoint=https://eastus2-4.in.applicationinsights.azure.com/;LiveEndpoint=https://eastus2.livediagnostics.monitor.azure.com/;ApplicationId=a431c56f-8ccc-4b99-b5e9-fce3763215b1", "categories": [ "Programming Languages", "Other", @@ -19,11 +18,11 @@ ], "repository": { "type": "git", - "url": "https://github.com/intersystems-community/vscode-objectscript" + "url": "https://github.com/consistem/vscode-objectscript" }, - "homepage": "https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO", + "homepage": "https://github.com/consistem/vscode-objectscript#readme", "license": "MIT", - "publisher": "intersystems-community", + "publisher": "consistem", "capabilities": { "untrustedWorkspaces": { "supported": true @@ -1396,6 +1395,14 @@ }, "additionalProperties": false }, + "searchOtherWorkspaceFolders": { + "markdownDescription": "Additional workspace folders to search for client-side sources when resolving ObjectScript documents. Specify `\"*\"` to search all non-isfs workspace folders in the current multi-root workspace before falling back to the server.", + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, "atelier": { "description": "Export source code as Atelier did it, with packages as subfolders. This setting only affects classes, routines, include files and DFI files.", "type": "boolean" diff --git a/src/commands/unitTest.ts b/src/commands/unitTest.ts index 15cea315..2a56c29f 100644 --- a/src/commands/unitTest.ts +++ b/src/commands/unitTest.ts @@ -917,10 +917,7 @@ async function runHandler( /** The `configureHandler` function for the `TestRunProfile`s. */ function configureHandler(): void { // Open the settings UI and focus on the "objectscript.unitTest" settings - vscode.commands.executeCommand( - "workbench.action.openSettings", - "@ext:intersystems-community.vscode-objectscript unitTest" - ); + vscode.commands.executeCommand("workbench.action.openSettings", "@ext:consistem.vscode-objectscript unitTest"); } /** Set up the `TestController` and all of its dependencies. */ diff --git a/src/extension.ts b/src/extension.ts index 5ed42f0f..5080b983 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -1,4 +1,4 @@ -export const extensionId = "intersystems-community.vscode-objectscript"; +export const extensionId = "consistem.vscode-objectscript"; export const lsExtensionId = "intersystems.language-server"; export const smExtensionId = "intersystems-community.servermanager"; @@ -161,7 +161,7 @@ import { isfsConfig } from "./utils/FileProviderUtil"; const packageJson = vscode.extensions.getExtension(extensionId).packageJSON; const extensionVersion = packageJson.version; -const aiKey = packageJson.aiKey; +const aiKey: string | undefined = packageJson.aiKey; const PANEL_LABEL = "ObjectScript"; const lowCodeEditorViewType = packageJson.contributes.customEditors[0].viewType; @@ -655,7 +655,7 @@ function proposedApiPrompt(active: boolean, added?: readonly vscode.WorkspaceFol switch (action) { case "Yes": vscode.env.openExternal( - vscode.Uri.parse("https://github.com/intersystems-community/vscode-objectscript#enable-proposed-apis") + vscode.Uri.parse("https://github.com/consistem/vscode-objectscript#enable-proposed-apis") ); break; case "Never": @@ -859,7 +859,7 @@ let incLangConf: vscode.Disposable; let intLangConf: vscode.Disposable; export async function activate(context: vscode.ExtensionContext): Promise { - if (!packageJson.version.includes("-") || packageJson.version.includes("-beta.")) { + if (aiKey && (!packageJson.version.includes("-") || packageJson.version.includes("-beta."))) { // Don't send telemetry for development builds try { reporter = new TelemetryReporter(aiKey); @@ -867,6 +867,8 @@ export async function activate(context: vscode.ExtensionContext): Promise { // Run without telemetry reporter = undefined; } + } else { + reporter = undefined; } // workaround for Theia, issue https://github.com/eclipse-theia/theia/issues/8435 diff --git a/src/providers/DocumentContentProvider.ts b/src/providers/DocumentContentProvider.ts index c9eae4a4..24857303 100644 --- a/src/providers/DocumentContentProvider.ts +++ b/src/providers/DocumentContentProvider.ts @@ -165,30 +165,73 @@ export class DocumentContentProvider implements vscode.TextDocumentContentProvid }); } } else { - const conn = config("conn", workspaceFolder); + const conn = config("conn", workspaceFolder) ?? {}; + const exportConfig = + workspaceFolder && workspaceFolder !== "" + ? (config("export", workspaceFolder) as { searchOtherWorkspaceFolders?: string[] }) + : undefined; + const searchOtherWorkspaceFolders = Array.isArray(exportConfig?.searchOtherWorkspaceFolders) + ? exportConfig.searchOtherWorkspaceFolders + .map((value) => (typeof value === "string" ? value.trim() : "")) + .filter((value) => value.length > 0) + : []; + const includeAllFolders = searchOtherWorkspaceFolders.includes("*"); + const explicitAdditionalFolders = new Set( + searchOtherWorkspaceFolders.filter((value) => value !== "*").map((value) => value.toLowerCase()) + ); if (!forceServerCopy) { - // Look for the document in the local file system - const localFile = this.findLocalUri(name, workspaceFolder); - if (localFile && (!namespace || namespace === conn.ns)) { - // Exists as a local file and we aren't viewing a different namespace on the same server, - // so return a uri that will open the local file. + const tryLocalUri = (folderName: string, allowNamespaceMismatch: boolean): vscode.Uri => { + const localFile = this.findLocalUri(name, folderName); + if (!localFile) return; + if (!allowNamespaceMismatch && namespace) { + const folderConn = config("conn", folderName) ?? {}; + if (folderConn.ns && namespace !== folderConn.ns) { + return; + } + } return localFile; - } else { - // The local file doesn't exist in this folder, so check any other - // local folders in this workspace if it's a multi-root workspace - const wFolders = vscode.workspace.workspaceFolders; - if (wFolders && wFolders.length > 1) { - // This is a multi-root workspace + }; + + // Look for the document in the local file system + const primaryLocal = tryLocalUri(workspaceFolder, false); + if (primaryLocal) { + return primaryLocal; + } + + // Check any other eligible local folders in this workspace if it's a multi-root workspace + const wFolders = vscode.workspace.workspaceFolders; + if (wFolders && wFolders.length > 1 && workspaceFolder) { + const candidates: { folder: vscode.WorkspaceFolder; allowNamespaceMismatch: boolean }[] = []; + const seen = new Set(); + const addCandidate = (folder: vscode.WorkspaceFolder, allowNamespaceMismatch: boolean): void => { + if (!notIsfs(folder.uri)) return; + if (folder.name === workspaceFolder) return; + if (seen.has(folder.name)) return; + candidates.push({ folder, allowNamespaceMismatch }); + seen.add(folder.name); + }; + + for (const wFolder of wFolders) { + if (wFolder.name === workspaceFolder) continue; + const wFolderConn = config("conn", wFolder.name) ?? {}; + if (compareConns(conn, wFolderConn) && (!namespace || namespace === wFolderConn.ns)) { + addCandidate(wFolder, false); + } + } + + if (includeAllFolders || explicitAdditionalFolders.size > 0) { for (const wFolder of wFolders) { - if (notIsfs(wFolder.uri) && wFolder.name != workspaceFolder) { - // This isn't the folder that we checked originally - const wFolderConn = config("conn", wFolder.name); - if (compareConns(conn, wFolderConn) && (!namespace || namespace === wFolderConn.ns)) { - // This folder is connected to the same server:ns combination as the original folder - const wFolderFile = this.findLocalUri(name, wFolder.name); - if (wFolderFile) return wFolderFile; - } - } + if (wFolder.name === workspaceFolder) continue; + const shouldInclude = includeAllFolders || explicitAdditionalFolders.has(wFolder.name.toLowerCase()); + if (!shouldInclude) continue; + addCandidate(wFolder, true); + } + } + + for (const candidate of candidates) { + const candidateLocal = tryLocalUri(candidate.folder.name, candidate.allowNamespaceMismatch); + if (candidateLocal) { + return candidateLocal; } } } diff --git a/src/test/runTest.ts b/src/test/runTest.ts index 8bd38c6a..72801dc6 100644 --- a/src/test/runTest.ts +++ b/src/test/runTest.ts @@ -29,7 +29,7 @@ async function main() { installExtension("intersystems-community.servermanager"); installExtension("intersystems.language-server"); - const launchArgs = ["-n", workspace, "--enable-proposed-api", "intersystems-community.vscode-objectscript"]; + const launchArgs = ["-n", workspace, "--enable-proposed-api", "consistem.vscode-objectscript"]; // Download VS Code, unzip it and run the integration test await runTests({ extensionDevelopmentPath, extensionTestsPath, launchArgs }); diff --git a/src/test/suite/extension.test.ts b/src/test/suite/extension.test.ts index e162ec0b..d2cdb1a9 100644 --- a/src/test/suite/extension.test.ts +++ b/src/test/suite/extension.test.ts @@ -1,25 +1,99 @@ import * as assert from "assert"; import { before } from "mocha"; +import * as path from "path"; // You can import and use all API from the 'vscode' module // as well as import your extension to test it -import { window, extensions } from "vscode"; -import { extensionId, smExtensionId } from "../../extension"; +import * as vscode from "vscode"; +import { extensionId, smExtensionId, OBJECTSCRIPT_FILE_SCHEMA } from "../../extension"; +import { getUrisForDocument } from "../../utils/documentIndex"; + +async function waitForIndexedDocument(documentName: string, workspaceFolderName: string): Promise { + const workspaceFolder = vscode.workspace.workspaceFolders?.find((wf) => wf.name === workspaceFolderName); + assert.ok(workspaceFolder, `Workspace folder '${workspaceFolderName}' was not found.`); + const start = Date.now(); + while (Date.now() - start < 10000) { + if (getUrisForDocument(documentName, workspaceFolder).length > 0) { + return; + } + await new Promise((resolve) => setTimeout(resolve, 100)); + } + assert.fail(`Timed out waiting for '${documentName}' to be indexed in workspace folder '${workspaceFolderName}'.`); +} + +function getDefinitionTargets(definitions: (vscode.Location | vscode.DefinitionLink)[]): vscode.Uri[] { + return definitions + .map((definition) => ("targetUri" in definition ? definition.targetUri : definition.uri)) + .filter((uri): uri is vscode.Uri => !!uri); +} suite("Extension Test Suite", () => { suiteSetup(async function () { // make sure extension is activated - const serverManager = extensions.getExtension(smExtensionId); + const serverManager = vscode.extensions.getExtension(smExtensionId); await serverManager?.activate(); - const ext = extensions.getExtension(extensionId); + const ext = vscode.extensions.getExtension(extensionId); await ext?.activate(); }); before(() => { - window.showInformationMessage("Start all tests."); + vscode.window.showInformationMessage("Start all tests."); }); test("Sample test", () => { assert.ok("All good"); }); + + test("Go to Definition resolves to sibling workspace folder", async function () { + this.timeout(10000); + await waitForIndexedDocument("MultiRoot.Shared.cls", "shared"); + const clientFolder = vscode.workspace.workspaceFolders?.find((wf) => wf.name === "client"); + assert.ok(clientFolder, "Client workspace folder not available."); + const callerUri = vscode.Uri.joinPath(clientFolder.uri, "src", "MultiRoot", "Caller.cls"); + const document = await vscode.workspace.openTextDocument(callerUri); + await vscode.window.showTextDocument(document); + + const target = "MultiRoot.Shared"; + const sharedOffset = document.getText().indexOf(target); + assert.notStrictEqual(sharedOffset, -1, "Shared class reference not found in Caller.cls"); + const position = document.positionAt(sharedOffset + target.indexOf("Shared") + 1); + const definitions = (await vscode.commands.executeCommand( + "vscode.executeDefinitionProvider", + callerUri, + position + )) as (vscode.Location | vscode.DefinitionLink)[]; + assert.ok(definitions?.length, "Expected at least one definition result"); + const targetUris = getDefinitionTargets(definitions); + const sharedTargetSuffix = path.join("shared", "src", "MultiRoot", "Shared.cls"); + assert.ok( + targetUris.some((uri) => uri.scheme === "file" && uri.fsPath.endsWith(sharedTargetSuffix)), + "Expected Go to Definition to resolve to the shared workspace folder" + ); + }); + + test("Go to Definition falls back to server URI when local copy missing", async function () { + this.timeout(10000); + await waitForIndexedDocument("MultiRoot.Shared.cls", "shared"); + const clientFolder = vscode.workspace.workspaceFolders?.find((wf) => wf.name === "client"); + assert.ok(clientFolder, "Client workspace folder not available."); + const callerUri = vscode.Uri.joinPath(clientFolder.uri, "src", "MultiRoot", "Caller.cls"); + const document = await vscode.workspace.openTextDocument(callerUri); + await vscode.window.showTextDocument(document); + + const target = "MultiRoot.ServerOnly"; + const offset = document.getText().indexOf(target); + assert.notStrictEqual(offset, -1, "Server-only class reference not found in Caller.cls"); + const position = document.positionAt(offset + target.indexOf("ServerOnly") + 1); + const definitions = (await vscode.commands.executeCommand( + "vscode.executeDefinitionProvider", + callerUri, + position + )) as (vscode.Location | vscode.DefinitionLink)[]; + assert.ok(definitions?.length, "Expected definition result when resolving missing class"); + const targetUris = getDefinitionTargets(definitions); + assert.ok( + targetUris.some((uri) => uri.scheme === OBJECTSCRIPT_FILE_SCHEMA), + "Expected Go to Definition to return a server URI when no local copy exists" + ); + }); }); diff --git a/test-fixtures/multi-root/client/.vscode/settings.json b/test-fixtures/multi-root/client/.vscode/settings.json new file mode 100644 index 00000000..c3b581df --- /dev/null +++ b/test-fixtures/multi-root/client/.vscode/settings.json @@ -0,0 +1,12 @@ +{ + "objectscript.conn": { + "active": true, + "ns": "USER" + }, + "objectscript.export": { + "folder": "src", + "searchOtherWorkspaceFolders": [ + "shared" + ] + } +} diff --git a/test-fixtures/multi-root/client/src/MultiRoot/Caller.cls b/test-fixtures/multi-root/client/src/MultiRoot/Caller.cls new file mode 100644 index 00000000..79cad05b --- /dev/null +++ b/test-fixtures/multi-root/client/src/MultiRoot/Caller.cls @@ -0,0 +1,10 @@ +Class MultiRoot.Caller Extends %RegisteredObject +{ + +ClassMethod Test() +{ + Do ##class(MultiRoot.Shared).Ping() + Do ##class(MultiRoot.ServerOnly).Ping() +} + +} diff --git a/test-fixtures/multi-root/shared/.vscode/settings.json b/test-fixtures/multi-root/shared/.vscode/settings.json new file mode 100644 index 00000000..4753cef3 --- /dev/null +++ b/test-fixtures/multi-root/shared/.vscode/settings.json @@ -0,0 +1,9 @@ +{ + "objectscript.conn": { + "active": false, + "ns": "SAMPLES" + }, + "objectscript.export": { + "folder": "src" + } +} diff --git a/test-fixtures/multi-root/shared/src/MultiRoot/Shared.cls b/test-fixtures/multi-root/shared/src/MultiRoot/Shared.cls new file mode 100644 index 00000000..d176babf --- /dev/null +++ b/test-fixtures/multi-root/shared/src/MultiRoot/Shared.cls @@ -0,0 +1,9 @@ +Class MultiRoot.Shared Extends %RegisteredObject +{ + +ClassMethod Ping() +{ + Quit +} + +} diff --git a/test-fixtures/test.code-workspace b/test-fixtures/test.code-workspace index ba637669..e49cb155 100644 --- a/test-fixtures/test.code-workspace +++ b/test-fixtures/test.code-workspace @@ -1,15 +1,19 @@ { "folders": [ { - "path": "." + "name": "client", + "path": "multi-root/client" }, + { + "name": "shared", + "path": "multi-root/shared" + } ], "settings": { "objectscript.conn": { "active": false }, "objectscript.ignoreInstallServerManager": true, - "intersystems.servers": { - } + "intersystems.servers": {} } }