Skip to content
generated from melaasar/template

Project Code for UCLA CS 130 (Software Engineering) Spring 23 Offering

License

Notifications You must be signed in to change notification settings

0x65-e/oml-alexandria

Repository files navigation

OML Alexandria Extension for Visual Studio Code

Release Installs License Build Status

A proof-of-concept extension to support OML in VSCode-compatible IDEs. Unlike OML Luxor, this extension is designed from the ground up to support web-based IDEs by running the language server through the extension instead of requiring a separate executable.

Getting Started

Install nvm:

  curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

Install npm and node:

  nvm install latest
  nvm use latest

Install yarn:

  npm install -g yarn

Install vsce if you plan on packaging the extension:

  npm install -g @vscode/vsce

Clone the repository

  git clone --recurse-submodules https://github.com/0x65-e/oml-alexandria.git
  cd oml-alexandria

Build

  npm install
  npm run build

This will build the development extension for debugging.

If you'd like to build the production packaged extension, run:

  vsce package --no-yarn

This will build the oml-alexandria-<version>.vsix extension file.

You can clean up the build artifacts using npm run clean.

Install in VSCode

You can install the vsix file by searching for "OML Luxor" in the Extensions Marketplace or manually through the Extensions tab. If a previous version of the extension is already installed, uninstall it first.

Install in Gitpod or GitHub Codespaces

Launch your repo with gitpod.io or GitHub Codespaces, then open the Extension area to drag and drop the vsix file to install it. If a previous version of the extension is already installed, uninstall it first.

Support for vscode.dev

OML Alexandria is not a web extension, and is not compatible with vscode.dev (which includes github.dev and any other VS Code for the Web instance).

OML Version

Alexandria OML
0.0.2 1.4.1
0.0.1 1.4.0

License

See LICENSE.