MethodScriptVSC README

This is the official Visual Studio Code IDE for MethodScript. Generally, this code should not be used directly, the extension should be downloaded directly from the Marketplace. First, download Visual Studio Code, then find the MethodScriptVSC extension.

On first run, you will be prompted to link to your jar. This will need to be re-linked if you wish to compile against a different jar, or if the file is moved. If no profile is selected, the plugin should prompt you, but to manually select the profile, use ctrl+shift+p and run "Choose Global MethodScript Profile". You may be prompted to update the jar if you are on a very old version, as this extension only works with the latest versions.

In some cases, you may wish to use a different profile just for this workspace. This can happen, for instance, if you're programming a remote server. In that case, you can choose the workspace profile instead, using the "Choose Workspace MethodScript Profile" command. This will override the global profile, but just for this workspace. The global profile is always used when opening single ms files, however.

Features

The IDE allows you to more easily code in MethodScript. More than just syntax highlighting, the IDE will highlight errors for you as you code, so you don't need to compile the code just to find out something is wrong. Get information about functions, events, and objects, all without leaving the IDE. The functions and highlighting are based on your local copy of MethodScript, which will also include help for extensions and whatever version you're currently running, even if the information on methodscript.com is for another version.

Requirements

You must be able to run MethodScript from the commandline to get this to work. Java must be installed, and you must have already downloaded the MethodScript/CommandHelper jar file.

If you are using Remote - SSH, place the following in your user settings.json:

"remote.extensionKind": {
    "MethodScriptVSC.methodscriptvsc": "ui"
}

Release Notes

See CHANGELOG.md for release notes.

Dev Info

• Download Visual Studio Code (Free Download for Mac, Linux, and Windows)
• Install node.js and npm (Mac, Windows/Debian-based: sudo apt-get install nodejs npm)
• Run npm install in the root of the project
• Open the project in Visual Studio Code
• Press F5 to open a new window with the extension installed

Debugging

Debugging langserv

Open VSC settings (Ctrl+,) and go to the Extension->MethodScript settings. You will see an option to start the language server in debug mode. Check this option, and set the port you wish to use, then reload the window (Ctrl+Shift+P -> Reload Window). The langserv will start in debug mode, and will await a debug connection.

Debugging extension

To debug the extension, set a breakpoint in the VSC window, and then run with debugging (F5).

Installing globally

To install the extension in your main Visual Studio Code installation, you must first create a VSIX package. Make sure you install and run from within the sandbox first, then

• npm install -g vsce
• From within the project directory: vsce package
• This creates methodscript-<version>.vsix in the project root
• Run code --install-extension methodscript-<version>.vsix to install in your main installation of Visual Studio Code
• Reload Visual Studio Code

Uninstalling globally

• Delete the extension folder at the specified location:
  • Windows: %USERPROFILE%\.vscode\extensions
  • Mac/Linux: ~/.vscode/extentions

Publishing

To publish the version on the marketplace, first ensure that the vsce command is up to date, so it doesn't fail midway through: npm install -g vsce

Then run vsce publish <version> where <version> is one of major, minor, or patch. You'll need the Personal Access Token from your organization.

(See https://code.visualstudio.com/api/working-with-extensions/publishing-extension#get-a-personal-access-token)

This will publish the version, and create a new commit and release tag. Push the changes afterwards, git push.