Skip to content

README.md

Latest commit

 

History

History
73 lines (59 loc) · 4.33 KB

README.md

File metadata and controls

73 lines (59 loc) · 4.33 KB

ra
vscode-rascript

RAScript extension for Visual Studio Code

The Visual Studio Code RAScript extension provides language support for the RATools scripting language.

GitHub License pipeline GitHub Tag GitHub repo size

Available on the Visual Studio Marketplace and Open VSX Registry

Requirements

  • VSCode
  • NPM
  • Make

Quickstart

To start, install all dependencies using npm install. Once installed the extension should be available to run in VSCode by pressing F5 to launch a new window running the extension.

Feature Highlights

  • Syntax Highlighting - Custom RAScript syntax highlighting using TextMate.
  • Function navigation - Jump to a functions defintion.
  • Code Completion - Completion results appear for symbols as you type.
  • Hover Info - Documentation appears when you hover over a function or class.

Language Server

This extension has a language server available. You can begin by downloading the latest release of the language server file for your operating system and place it in a location you remember on your computer. The VSCode extension has an extension setting to specify the location of the langauge server binary. Open the settings menu using Ctrl+, then go to User > Commonly Used > Extensions and find the RAScript Language Server section. Underneath this youll find a string field called Language Server that you need to specify the full path to the binary, if it is not set or the file is not found the extension will default to some basic functionality (code jump, function hover text, code completion) without any RATools errors/Code Note hover text. You may need to restart VSCode after setting this value. Make sure the file path is correct otherwise the extension will show errors. Below are some examples of what the filepath could look like on different operating systems:

Linux/MacOS:

/home/joshraphael/rascript-language-server_v0.0.1_linux-x64

Windows:

C:\Users\joshraphael\rascript-language-server_v0.0.1_win-x64.exe

Token Generation

OpenVSX

  1. Navigate to the OpenVSX homepage
  2. Select the user icon in the top right hand corner
  3. Select Settings
  4. Select Access Tokens
  5. Select Generate New Token
  6. Enter a name you can recognize
  7. Click Generate Token and copy the token to your deployment script

VSCode Marketplace

  1. Navigate to the Azure DevOps dashboard and log into your profile.
  2. Select the user icon in the top right hand corner
  3. Select Personal access tokens
  4. In the Access scope dropdown, select All accessible organizations
  5. At this point you can tell if your token has expired or not if you do not see any tokens.
  6. Generate a new token by clicking the blue New Token button
  7. Enter a name you can recognize
  8. In the Organization drop down select All accessible organizations
  9. Expiration set to specific date (one year max allowed)
  10. In the Scopes choice select Custom defined
  11. Find the Marketplace scope section and select only Manage
  12. Click Create and copy the token to your deployment script

Make commands

Title Command Parameters Description
Setup make setup None Clean env and download dependencies
Syntax make syntax None Download the syntax file
Check Exetension make check None Check the extensions for lint and format errors
Apply Style make style None Apply linting and formatting to extension code
Run In Browser make browser None Run the extension in the browser version of VSCode