Hypatia-VSCode

Hypatia Language Support for VSCode

Table of Contents

1. The Extension
2. Language Styling
3. HLS Commands
4. Configuration
5. Versioning
6. Installation
7. Change Log
8. To Do
9. Support
10. Contributing
11. Contributors

The Extension

Hypatia-VSCode provides language and editor support for Hypatia documents in VSCode. Files with the .hyp and .hypatia extensions are recognised as Hypatia documents and receive Hypatia-specific syntax highlighting, styling, editor configuration, and command support.

The extension also bundles the Hypatia Light and Hypatia Dark themes. They can be selected as ordinary VSCode colour themes, while their token palettes are used to style Hypatia syntax under arbitrary VSCode themes.

Language Styling

The extension provides TextMate syntax highlighting for Hypatia files and dedicated light and dark token palettes.

The grammar follows the current Hypatia syntax as closely as possible within the limitations of TextMate, including escaped syntax, comments, qualified references, Sifr constructs, and best-effort object-language highlighting. Object-language highlighting currently recognises the inclusor pair “ ... ”.

Hypatia token colours are scoped to Hypatia documents, so they can coexist with other languages and editor groups. The hypatia.style.variant setting selects the light or dark palette, or follows the active VSCode theme when set to auto.

The extension also provides Hypatia-specific editor support for comments, surrounding pairs, auto-closing pairs, brackets, and folding.

HLS Commands

The extension reserves the following commands for Hypatia Language Server integration:

• Hypatia: Toggle HLS;
• Hypatia: Restart HLS (Ctrl+K Ctrl+Enter in a Hypatia editor);
• Hypatia: Validate Current Editor (Ctrl+K Ctrl+V in a Hypatia editor).

The current HLS integration is an initial stub: invoking these commands records the invocation in the Hypatia HLS output channel. The command identifiers and keybindings provide the interface for the future Pythia language-server client.

Configuration

The extension currently exposes the following style settings:

• hypatia.style.variant: selects light, dark, or auto for Hypatia token colours;
• hypatia.style.trace: enables diagnostic logging for Hypatia styling.

HLS configuration options are available under hypatia.hls.* in the VSCode settings interface, in preparation for the language-server integration.

Versioning

For details on the versioning scheme used for this extension, please refer to the Versioning Policy.

Installation

You can install Hypatia-VSCode in one of the following ways.

Install from the VSCode Marketplace

1. Open the Extensions view (Ctrl+Shift+X).
2. Search for Hypatia-VSCode (or Hypatia).
3. Click Install and reload VSCode if prompted.

Install from a VSIX package

If you have a .vsix release file (for example from the GitHub Releases page):

• In VSCode:

  open the Extensions view → click the ... menu → Install from VSIX…

• From the terminal:

  code --install-extension hypatia-<version>.vsix
  

Change Log

For a complete history of updates and modifications, please refer to the Change Log file.

To Do

The list of upcoming features and improvements is tracked in the To Do file.

Support

For support with Hypatia-VSCode, please refer to the Support Guidelines.

For general discussions, check out GitHub Discussions on the Hypatia Organisation page.

Contributing

We welcome contributions of all kinds, from bug reports and feature requests to documentation improvements and code enhancements. If you would like to contribute, please read the Contributing Guidelines and consult the repository To Do and organisation To Do files.

Contributors

For the list of contributors, please refer to the Contributors file.