To give you the best possible experience, this site uses cookies and by continuing to use the site you agree that we can save them on your device.

LearningDocumentationCommunityOpen ExchangeGlobal MastersCertificationPartner Directory
Submit application
Submit applicationApplicationsContest
History
NewsAbout
About UsWhat's newMembersDocumentationReport an IssueContact UsDiscord
Create an AccountLogin

VSCode-ObjectScript

Downloads1827
Subscribe
12
Bookmark
18
Details
Releases
Reviews
Issues
Provider

What's new in this version

  • Enhancements

    • Overhaul WorkspaceSymbolProvider (#772)
    • Add Open Shell in Docker option to Server Actions menu (#778)
    • Preliminary web extension support (#782)
    • Check all local folders in multi-root workspace for local copy of file (#785)

  • Fixes

    • Fix FileSystemProvider mtime caching (#770)
    • Comply with new VS Code policy for scoping access to VS Code proposed API (#771)
    • Append .pkg to package name when passed to source control / server command extensions (#776)
    • Improve error messaging for Studio Actions (#784)
    • Upgrade vulnerable dependencies (#787)

  • Fixes

    • Debugger: Breakpoint with no hitCondition cannot be set (#766)

  • 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.

  • 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.

  • 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)

  • Report license starvation connection error properly (#721)

  • Display AfterUserAction errors reported by server-side source control (#701)

  • Preserve user edit if it triggered a successful checkout in server-side source control (#703)

  • Fix failing Go to Definition from CSP file when working with isfs (#727)

  • Support 'Open Document' action by server-side source control (#731)

  • Upgrade vulnerable dependency.

  • 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)

  • Always run isfs dialog's serverInfo request in the %SYS namespace (#682)

  • Fix "Cannot read property 'toLowerCase' of undefined" error on startup (#693)

  • Report problem if isfs workspace definition points to non-existent server definition (#695)

  • Give clearer messages if user has insufficient privilege on the server (#678)

  • Allow opting out of 'Other Studio Action' server-side source control calls (#691)

  • 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)

  • Handle compilation errors better (#673)

  • Improve documentation.

  • Upgrade vulnerable dependencies.

  • 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)

  • Report server-side errors from imports and isfs saves (#391)

  • Use web app token when authenticating with Management Portal and Class Reference.

  • Permit empty argument list in 'Debug this' (#642)

  • Add objectscript.compileOnSave setting to turn off post-save compile (#594)

  • Treat system=1 parameter on non-%SYS isfs folder spec as signal to include %-items (#623)

  • Add objectscript.multilineMethodArgs setting to use UDL parameter supported on servers with API version 4+ (#457)

  • Add snippets for business processes.

  • Prevent leading space in front of Class keyword from blocking import (#613)

  • Import into the correct namespace when working with multi-root workspace (#535)

  • Refactor 'Jump to Line' to use DocumentSymbolProvider.

  • Improve 'View Other' when working with servers supporting API version 4+ (#363)

  • Support Language Server enhancement that opens local copy of file when using 'Go to Definition' in client-side editing mode.

  • Update connections when settings are changed (#608)

  • Improve documentation.

  • Upgrade vulnerable dependencies.

  • 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)

  • Improve information about compiler flags (#532)

  • Add clickable links to compilation error text in Output pane (#386)

  • Relabel Variables folders in debugger to be Private and Public instead of Local and Global (#482)

  • Fix debugging breakpoint command message when class has multiple packages (#597)

  • Support expansion of orefs in debugger Variables pane provided server-side API version implements the necessary support (#598)

  • Improve README.

  • Upgrade vulnerable dependencies.

Known Vulnerabilities Visual Studio Marketplace Version

InterSystems ObjectScript extension for VS Code

InterSystems® ObjectScript language support for Visual Studio Code, from the InterSystems Developer Community.

Features

  • InterSystems ObjectScript code highlighting support.

    example

  • Debugging ObjectScript code.

  • Intellisense support for commands, system functions, and class members.

  • Export of existing server sources into a working folder:

    • open Command Palette (F1 or ⌘/Ctrl+Shift+P)
    • start typing 'ObjectScript'
    • choose ObjectScript: Export Code from Server
    • press Enter

  • Save and compile a class:

    • press ⌘/Ctrl+F7
    • or, select ObjectScript: Import and Compile Current File from Command Palette

  • Direct access to edit or view server code in the VS Code Explorer via isfs and isfs-readonly FileSystemProviders (e.g. using a multi-root workspace). Server-side source control is respected.

  • Server Explorer view (ObjectScript: Explorer) with ability to export items to your working folder.

    ServerExplorer

Installation

Install Visual Studio Code first.

Then to get a set of extensions that collaborate to bring you a great ObjectScript development experience, install the InterSystems ObjectScript Extension Pack.

When you install an extension pack VS Code installs any of its members that you don't already have. Then if you ever need to switch off all of those extensions (for example, in a VS Code workspace on a non-ObjectScript project) simply disable the extension pack at the desired level. Member extensions can still be managed individually.

Open VS Code. Go to Extensions view (⌘/Ctrl+Shift+X), use the search string @id:intersystems-community.objectscript-pack and install it.

Enable Proposed APIs

This extension is able to to take advantage of some VS Code APIs that have not yet been finalized.

The additional features (and the APIs used) are:

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.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 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):

"enable-proposed-api": ["intersystems-community.vscode-objectscript"]
  1. Exit VS Code and relaunch it.
  2. Verify that the ObjectScript channel of the Output panel reports this:
intersystems-community.vscode-objectscript version X.Y.Z-beta.1 activating with proposed APIs available.

After a subsequent update of the extension from Marketplace you will only have to download and install the new vscode-objectscript-X.Y.Z-beta.1 VSIX. None of the other steps above are needed again.

Configure a Connection

To be able to use many features you first need to configure the connection to your IRIS/Caché/Ensemble server(s) in your VS Code settings. If you are unfamiliar with how settings work and how they are edited, use that link.

We recommend you define server connections in the intersystems.servers object whose structure is defined by the InterSystems Server Manager helper extension.

Install that extension and consult its documentation about its UI and commands for easy setup of connections, plus assistance when editing the JSON definition directly.

For more tips about the intersystems.servers object, see the Notes section below.

Client-side Editing

A simple workspace -- a local working folder in which you edit InterSystems source files and manage them using client-side source control (e.g. Git) -- will use the objectscript.conn settings object to import locally-edited code into a namespace on a server, compile it there and run/debug it, and also for initial export of an existing codebase (optional). This settings object is usually defined in Workspace Settings, for example in the .vscode/settings.json file of your working folder.

A quick way to add objectscript.conn to a new working folder is:

  1. Open the folder in VS Code.
  2. Use the InterSystems icon on the activity bar to switch to ObjectScript Explorer view.
  3. Click the 'Choose Server and Namespace' button.
  4. Respond to the sequence of quickpicks. You can also define a new server at the start of this sequence by using the '+' button.

For more about objectscript.conn see the Notes section below.

Server-side Editing

To edit code directly in one or more namespaces on one or more servers (local or remote) we recommend creating a workspace definition file (for example XYZ.code-workspace) where you specify one or more root folders that directly access namespaces via the isfs or isfs-readonly URI schemes. The only difference between these two schemes is that any file opened from a folder using the isfs-readonly scheme will be set as read-only in VS Code and thus protected against being changed.

  1. Start VS Code.
  2. If your last-used folder opens, use 'Close Folder' on the 'File' menu ('Code' menu on macOS). Or if what opened was your last-used workspace, use 'Close Workspace'.
  3. On VS Code's Explorer view (⌘/Ctrl+Shift+E), click the 'Manage Servers' button which is contributed by the Server Manager extension.
  4. Find your target server in the tree, or use the '+' button to add a new server.
  5. Expand the server and its 'Namespaces' folder, then click on the 'pencil' icon for editing access to the namespace or the 'eye' icon for viewing access. If you want to work with web application files rather than classes and routines, hold down the Alt/Option key when clicking the button.
  6. Use 'Save Workspace As...' to store your workspace definition in a file with a .code-workspace extension.

For more about isfs and isfs-readonly folder specifications see the Notes section below.

Reporting Issues

InterSystems ObjectScript for VS Code consists of three collaborating VS Code extensions. This modular architecture also means there are three different GitHub repositories where issues can be created. Fortunately VS Code itself helps with the task. You will need a GitHub account. Here's how:

  1. From the Help menu in VS Code choose 'Report Issue'. Alternatively, open the Command Palette and run Help: Report Issue....

  2. When the dialog appears, use the first dropdown to classify your issue:

    • Bug Report
    • Feature Request
    • Performance Issue

  3. In the second dropdown pick 'An extension'

  4. The third dropdown lets you pick one of your installed extensions. You can type a few characters to find the right entry. For example, isls quickly selects "InterSystems Language Server".

    Which one to choose? Here's a guide:

    • InterSystems Language Server
      • code coloring
      • Intellisense
    • InterSystems ObjectScript
      • export, import and compile
      • ObjectScript Explorer (browsing namespace contents)
      • direct server-side editing using isfs:// folders in a workspace
      • integration with server-side source control etc
    • InterSystems Server Manager
      • Server Browser on the InterSystems Tools view
      • password management in local keychain
      • definition and selection of entries in intersystems.servers

    If unsure, pick InterSystems ObjectScript.

  5. Type a descriptive one-line summary of your issue. The dialog may offer a list of existing issues which could be duplicates. If you don't find one that covers yours, proceed.

  6. Enter details. If your VS Code is authenticated to GitHub the dialog's button is captioned "Create on GitHub" and clicking it will open the issue, then load it in your browser so you can edit it. Otherwise it reads "Preview on GitHub" and launches a browser page where you must complete and submit your report.

    Tips for use on the GitHub page:

    • Paste images from your clipboard directly into the report field. For hard-to-describe issues an animated GIF or a short MP4 gets bonus points. The Developer: Toggle Screencast Mode in VS Code can help your recording make more sense.
    • Link to other issues by prefixing the target number with #
    • Remember that whatever you post here is visible to anyone on the Internet. Mask/remove confidential information. Be polite.

Notes

  • Connection-related output appears in the 'Output' view while switched to the 'ObjectScript' channel using the drop-down menu on the view titlebar.

  • The /api/atelier/ web application used by this extension usually requires the authenticated user to have Use permission on the %Development resource (read more). One way is to assign the %Developer role to the user.

  • If you are getting ERROR # 5540: SQLCODE: -99 Message: User xxx is not privileged for the operation when you try to get or refresh lists of classes, routines or includes, then grant user xxx (or a SQL role they hold) Execute permission for the following SQL Procedure in the target namespace.

GRANT EXECUTE ON %Library.RoutineMgr_StudioOpenDialog TO xxx

More about intersystems.servers

This settings object is useful for both client-side and server-side development.

  • An example server definition named 'local':
  "intersystems.servers": {
    "local": {
      "webServer": {
        "scheme": "http",
        "host": "127.0.0.1",
        "port": 52773
      },
      "description": "My local IRIS",
      "username": "me"
    }
  }

  • By defining connections in your User Settings they become available for use by any workspace you open in VS Code. Alternatively, define them in workspace-specific settings.

  • Setting the username property is optional. If omitted it will be prompted for when connecting, then cached for the session.

  • Setting a plaintext value for the password property is not recommended. Instead, run the InterSystems Server Manager: Store Password in Keychain command from Command Palette.

  • If no password has been set or stored it will be prompted for when connecting, then cached for the session.

More about objectscript.conn

This settings object is primarily relevant when doing client-side development.

  • We recommend that objectscript.conn uses its server property to point to an entry in intersystems.servers. For example:
  "objectscript.conn": {
    "active": true,
    "server": "local",
    "ns": "USER"
  }

  • The mandatory ns property defines which server namespace you will work with.

  • When the server property is set, any username or password properties of objectscript.conn are ignored. Instead these values come from the intersystems.servers entry.

More about isfs and isfs-readonly workspace folders

Server-side development is best done using isfs folders. The read-only variant isfs-readonly is also useful when doing client-side development, since it enables server-side searching of your codebase.

To modify how your folder behaves, edit the JSON of your workspace definition (XYZ.code-workspace file). Get there by using the 'Edit Settings' option from the context menu of Server Manager's 'Servers' view, or by running the 'Preferences: Open Workspace Settings (JSON)' command from the Command Palette. Edit your uri property.

  • The csp query parameter indicates web application files are to be shown. The uri path optionally specifies which application. The namespace suffix on the server name (preferred syntax) or the ns query parameter (deprecated) must specify the same namespace the application is configured to use. In the following example the first folder is for the /csp/user web application in the USER namespace of the server named 'local' and the second gives read-only access to all web applications that reside in the %SYS namespace. The second folder also uses the optional name property:
    {
      "uri": "isfs://local:user/csp/user?csp"
    },
    {
      "name": "local:%SYS web files (read-only)",
      "uri": "isfs-readonly://local/?ns=%SYS&csp"
    }
  • To see only classes in the Xxx.Yyy package, format the uri like this:
    {
      "uri": "isfs://local:user/Xxx/Yyy?type=cls"
    }
  • Other query parameters that can be specified include:
    • type=cls to show only classes, or type=rtn to show only routines.
    • flat=1 to flatten the hierarchy.
    • generated=1 to show generated items.
    • system=1 to show system (%) items. Without this parameter these are only shown for the %SYS namespace.
    • filter=filterspec to use a filter specification formatted in the same way as used in InterSystems Studio's File Open dialog (e.g. filter=Ensem*.inc).

Support and Training

CaretDev provides commercial support services. Request a quote.

On-line course from CaretDev - Developing with VS Code ObjectScript – Easy Start.

Rating
4.75 (2)
Category
Developer Environment
Works with
CachéEnsembleHealthShareInterSystems IRIS
Tags
editoridetool
Info
Publisher
CaretDev
Author
Dmitry Maslennikov
Version
1.2.1
Last updated
2021-12-02
Repository
Open
License
Link

Industries

Finance

Proven speed, scalability and reliability

Health & Life Sciences

Advanced software for healthcare, powered by interoperability

Business

Turning data into sound business decisions

Government

Helping governments serve their citizens

Products

InterSystems IRIS Data Platform

Data Platform for Transactions & Analytics

IRIS for Health

Data Platform for Healthcare Solutions

HealthShare

Unified Care Record

TrakCare

Unified Healthcare Information System

Caché

High-Performance Database

Ensemble

Integration Engine

Engage

Find a Partner

Find a Product

InterSystems Blogs

Events

Contact us

Support & Learning

For Immediate Help

Learning Services

Report an issue