mast README

An extension for developing missions for Artemis Cosmos. It is intended to facilitate developing mission scripts using the MAST language.

MAST references:
sbs_utils repository
LegendaryMissions repository
MAST Starter repository
Artemis Cosmos bug reporting

Features (Non-exhaustive!)

Includes:

• Basic formatting and coloring, based on Python
• Error checking
  • Checks if labels are defined, and defined properly
  • Checks for proper route label usage
  • Proper f-string usage
  • Checks if label names are overriden by a variable name
  • Some possible syntax errors
• Autocompletion and hover information for applicable functions within the sbs and sbs_utils packages, as well as built-in python functions
• Autocompletion for variables etc in current file and files in scope
  • NOTE: It's very difficult to determine the type of a variable programmatically for python (and, therefore, MAST). The extension can't really do it, so you'll have to keep track of what each variable represents. The extension will try to give you options that show the object type associated with that option.
• Autocompletion for labels in current file and files in scope
• Autocompletion for roles, inventory keys, data set (blob) keys, and link keys.
• Function signature information (i.e. notes on argument types)
• Go To Definition functionality for sbs_utils and modules for functions and labels in scope.
• Hover information functionality
• Rename Symbol functionality for variables in the current label
• Find References functionality (functions, inventory, data set, and link keys, and roles)
• Checks for module versions
  • Can update all to latest version, or manually update
• In mission folders, checks for __init__.mast in the folder you're working in. If it doesn't exist, will promt with an option to auto-generate the file, with all .mast and .py files included automatically.
• Autocompletion of filenames for __init__.mast
• Checks for root artemis directory existence - most functionality requires the opened folder to be in the artemis mission directory

Requirements

Dependencies should be packaged with the extension. If you encounter an issue with a dependency, or it is not included, please let me know ASAP. Included dependencies:

• adm-zip
• hjson
• python-shell
• vscode-uri

Known Issues

• See GitHub for documented issues, or to create a new issue.

Planned Features

• Additional error checking
• Check that functions contain the correct number of arguments
• Variable type checking in functions

Release Notes

See the Changelog

Contributions

Contributions are more than welcome! I am by no means an expert when it comes to language servers, VS Code extensions, or even programming in general - I'm just able to muddle through and figure things out as I go. I will not claim that this extension is optimized in any way, I'm just trying to make it functional. Help would be great!

Extension Settings

Include if your extension adds any VS Code settings through the contributes.configuration extension point.

For example:

This extension contributes the following settings:

• myExtension.enable: Enable/disable this extension.

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!