Hi @Luc Morningstar, if VS Code is not meeting your needs then I would be happy to hear about how we can improve it. We take bug reports and feature requests via GitHub issues. Please see these docs on how to report issues from VS Code and which types of issues go to which extension. I would also like to note that VS Code will fail to save a class if its name differs from another class name only in case.
Hi @Olivier Caudron, The InterSystems VS Code extensions do support editing files on your local file system that are tracked by Git. The documentation for the extensions can be found here. Note that we have some major enhancements to this workflow coming in the next month or so, see this DC post for more info.
Hi @Daniele Monti, if there's no error message in the ObjectScript Output channel then you will need to capture a network trace. This will capture all REST traffic between VS Code and IRIS, so we can see the whole response to that request. I suggest you use wireshark or the Web Gateway's HTTP Trace tool. With the tool enabled, reproduce your issue. The turn the tool off and find the request that corresponds to that action. It will be a PUT on a URL like /api/atelier/v6/doc/UITXXPIEPAAdm.mac. The find the corresponding response. It should be a 40X or 500 response. Copy the entire body and post it here (hiding any sensitive information). That should tell us what the issue is.
@Jeffrey Drumm This is caused by a known IRIS bug. The fix is in IRIS 2022.1.4+, 2023.1.2+, and 2023.3+.
If possible, you should use VS Code on a developer laptop that can be kept up to date instead of the server that IRIS/Cache is running on. The extension versions you are using are well over a year old and you'll be missing out on major new features, like the one you requested in this post. VS Code can connect to servers that are on a different machine.
@David Hockenbroch
I suggest you open a WRC case to request a different way to enable SMTP tracing if the subclass or IRISLIB mounting approaches don't work for your case.
@LI LINFENG
I also noticed that versions of the extensions that you have are very old. You should make sure VS Code and its extensions are able to auto-update so you can take advantage of bug fixes and new features.
@LI LINFENG
The vscode-objectscript extension does not support this yet, but an enhancement that adds this feature is currently under review. You can read more about it, and download a version of the extension to test the enhancements with, on this DC post.
@Pietro Di Leo
If you find Wireshark intimidating you can use the Web Gateway's HTTP trace facility. If you're using Wireshark and the server is on the same machine as VS Code select the loopback capture device and add an http filter. This will help you filter out unwanted packets. If you use the Web Gateway's HTTP Trace, you can simply turn it on, attempt to save the class, turn the trace off, and then click refresh to see all the packets. You will be looking for a PUT request to the /api/atelier/v#/doc/<class_name> endpoint. We want to see what the full response is to that request.
@Pietro Di Leo
That error is a red herring. That's coming from the Codeium AI extension which doesn't like our isfs URI format. This will not affect saving the files on the server. The best way to determine why your server saves are failing would be to get a network trace using a tool like Wireshark or the Web Gateway's HTTP trace tool.
@Pietro Di Leo
That error has nothing to do with compilation. It didn't even get that far. VS Code tried to save that file on the server, but it failed. There should be an error in the ObjectScript Output channel. If not, a network trace will show us the HTTP error response.
Hi everyone, I have updated this post and the linked extension VSIX to reflect changes I have made. Please try this again using the new version and let me know your feedback!
Studio is still available from the WRC as an independent download. See this DC post for more details. I am happy to help you get VS Code working, but to know what is wrong I will need to see your code-workpsace file, server connection info and possibly a network trace since VS Code talks to IRIS via HTTP(S). If you're more comfortable doing that in private you can open a WRC case and they will help you. You can link this post there so they have more context. This feature has existed in VS Code for 4.5+ years so I think there's some sort of configuration issue and not a product defect. Also, any feedback on how we can make VS Code better can be communicated to WRC, your account team, or by posting an issue on GitHub.
Are you using client-side editing (your ObjectScript classes are in a local folder that you have open in VS Code), or server-side editing (files are edited directly on the server, like Studio)? This is important so I can give you the best advice for troubleshooting the problem. Which steps in the documentation did you follow to get this set up?
@Paul Hula
Do you have in the InterSystems ObjectScript Extension Pack installed? The InterSystems Language Server provides autocomplete support for class names and class members. If you already have the extensions installed and are still experiencing this issue then you probably don't have a server connection configured. The documentation for doing so can be found here.
VS Code allows you to change the colors used in the editor via Themes. Documentation is here. If you're on Windows you can also load your custom colors from Studio using the "Load Studio Syntax Colors" command.
Hi Joel, thanks for the feedback! There's no reason why you couldn't have Prettier format your local files. It just won't work as well as it does for other languages because there's isn't an ObjectScript plugin (AFAIK), and some elements of class definitions (everything that isn't implementation code) is re-rendered after syncing with the server. I have looked at the "objectscriptQuality" rules before to see if there's anything that I should add to the Language Server extension and I came to the conclusion that it wasn't doing anything that was really valuable. If there are specific rules that you find useful I'd be happy to hear your thoughts, but I've resisted adding a bunch of Diagnostics/formatting options for "code style" issues because many ObjectScript developers don't agree on them!
@Alessandra Carena
What error did you get? If it was <PROTECT> then your user doesn't have permission to access %SYS.
Thanks for the detailed post @Joel Solon! #Dim isn't necessary for many system percent variables because the Language Server already knows their types. The full list currently supported can be found here. %sqlcontext is not one of them, so please open a feature request to add that and any others that I might have missed. I also wanted to note that coming soon is support for variables passed by reference as method arguments, so even that case won't require #Dim.
Integration with the BPL and DTL will be available when the new versions of those editors are released. The VS Code integration will support client-side editing as well. The Rule Editor integration already does so.
You're mixing up what we mean by "client-side editing" and what git-source-control does to maintain files in Git. In VS Code, client-side editing means "editing files on my locla file system directly". git-source-control is used when you're editing files directly on an IRIS server, and it handles the projection to the file system so Git can pick up changes. These are fundamentally different development models that shouldn't be mixed. Mixing them can lead to files being out of sync and changes being lost or overwritten.
1. Connecting to any server is pretty easy so I'm not sure why we'd need to add a special case for dockerized IRIS.
2. Can you elaborate please? Are you referring to the lack of BPL/DTL UI integration?
3. This is incorrect. git-source-control is a server-side source control solution. You must use server-side editing to work with it. We do not and will not support the use of server-side source control classes with local files.
Thanks for the feedback! The current functionality does not handle that case. This PR decouples the file path from the document name, so you could re-name the classes without changing the file paths.
Thanks for the feedback! The export issue is definitely worth addressing before I merge the PR. The updating of modified files might make sense as a separate followup PR.
@Mohamed Oukani
VS Code documentation has been moved to docs.intersystems.com. Here's the link to the "Migrate from Studio" page: https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cl…
Hi @Gramen Tontchev, for non-classes and routines on the local file system the main extension needs to use the file name to determine the name of the document on the server. There's no guarantee that all "other" document types will have the name of the document stored in the text, and even if that were true, it would be very difficult for the extension to know how to extract that info from each one. I have a PR open that will improve the client-side editing workflow, but this behavior remains the same.
TL;DR: The name of the file must match the name of the document on the server.
@David Hockenbroch
This functionality exists in VS Code. It's provided by the Language Server extension. Here's the description of the feature from that extension's README:
To invoke the command, right-click in a blank line of a class definition body and select the Override Class Members row in the menu that appears. The command will insert the selected class member definition(s) at the cursor position where the command was invoked.
VS Code does as well. The Language Server extension provides a formatter that does this, among other features.
@Igor Barboza
You can use %Library.SyntaxColor to parse ObjectScript. Here's some code to get you started:
ClassMethod WriteAllCommands()
{
Set syn = ##class(%SyntaxColor).%New(), in = ##class(%Stream.TmpCharacter).%New(), out = ##class(%Stream.TmpCharacter).%New()
#; TODO Put your document's contents into "in"
Do syn.Color(in,out,"COS" /* or "INT" or "CLS" */,"KE" /* K means JSON output, E means keep empty lines */)
#; Format of the JSON output:
#; [
#; #; One array for each source line
#; [
#; {
#; #; Language of the token. See Languages() in %Library.SyntaxColor.
#; "l": %Integer,
#; #; Attribute of the token. See Attributes() in %Library.SyntaxColor.
#; "s": %Integer,
#; #; Zero-indexed start position of the token on the line
#; "p": %Integer,
#; #; Length of the token in characters
#; "c": %Integer
#; }
#; ]
#; ]
Set json = ##class(%DynamicArray).%FromJSON(out), lineIter = json.%GetIterator()
While lineIter.%GetNext(.lineNum,.lineTokens) {
Set tokensIter = lineTokens.%GetIterator()
While tokensIter.%GetNext(,.token) {
If (
#; COS
(token.l = 1) && (
#; Command
(token.s = 32) ||
#; User-defined Z command
(token.s = 52)
)
) {
Write "Command starting in column ",token.p + 1," of line ",lineNum + 1,!
}
}
}
}@Mary George
There are two ways you could do this:
@David Marinkovic
VS Code uses REST to connect to IRIS. If you're using a version without the private web server, you need to configure an external web server. This is needed for the management portal as well. Since you're on Windows, your installer probably configured IIS to serve web applications for IRIS. Documentation can be found here.
@Stefan Cronje
You can open the classes in VS Code and and it will notify you when you use deprecated classes or methods. There isn't a programmatic way to get that information (for example, by calling a ClassMethod) but it would be possible to write one using %SyntaxColor.