Magik for Visual Studio Code

The VS Code Magik extension provides rich support for the Magik programming language used in the GE Vernova Smallworld Geo Network Management (GNM) platform.

Requirements

• Smallworld version 4 or 5
• Visual Studio Code 1.75 or newer (or editors compatible with VS Code 1.75+ APIs)

Quick Start

Welcome to the world of Magik programming for Smallworld GNM!

Whether you are new to Magik or a long time veteran, you will find features of this extension that can improve your development experience.

Here is the quickest way to get started Programming Magik.

1. Install the version of Smallworld GNM (formerly Smallworld) that corresponds to your needs (including Smallworld GNM components and custom code).
2. Install the VS Code Magik extension.
3. Start a Smallworld session by typing the sequence <F2> then Z and follow the instructions to start the session (to start a product session) or start your custom session from the command line of a terminal using the runalias.exe application (typically found in core\bin\x86 of your Smallworld installation). See the topic Launcher program on the Smallworld GNM documentation website for more details.
4. Once the session has started, while a Magik code file editor has the focus, type <CTRL>+<ALT>+M to initialize the interface with the running Magik session.

What's Next

Once you are able to start a Magik session and associate the session with your editor, you are ready to start programming Magik. If you are new to programming Magik in Smallworld GNM, go over to the Application Development section on the Smallworld GNM documentation web sight.

If you are already familiar with Magik and Smallworld, read through the feature highlights below for more information on using the VS Code extension to help you write Magik code.

The hotkey <CTRL>+<SHFT>+P is used to open the command palette in Visual Studio Code. You can first open the command palette, then type magik to discover the features of the VS Code Magic extension.

Feature highlights

• See Compiling code and running tests to understand how to compile code in your session.
• See Using the class browser to understand how to use the class browser tool and navigate in VS Code.
• See Using the magik console to understand how to use a Magik Console
• See Formatting and Editing for information on formatting Magik code and using editing templates.
• See Linting and Debugging for information on finding code problems with the Magik Linter and using the Magik debugger.
• See Development Tools for information on available development tools.

Setting up your environment

For more on how to start a Magik session and configuring your Magik environment see the Getting Started documentation.

Contributing

We welcome your contributions and thank you for working to improve the Magik development experience in VS Code. If you would like to help work on the VS Code Magik extension, see our contribution guide to learn how to build and run the VS Code Magik extension locally and contribute to the project.

License

Apache License, Version 2.0 (the "License")