Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 1.55 KB
Raw

Contributing

This document explains the developer workflow for making changes to the Scala Syntax (official) extension for Visual Studio Code.

To contribute, make sure you have signed the Scala CLA, if not, please sign it.

Prerequisites

Make sure you have the following binaries installed:

  • yarn: to build the project
  • code: to launch VS Code from the terminal.

Building the project

First, install library dependencies. This step needs to re-run every time a new dependency is added to package.json.

yarn install

Next, open the source language file src/typescript/Scala.tmlanguage.ts to make changes to the code. To generate the the syntax definition file syntaxes/Scala.tmLanguage.json with your local changes, run the following command:

yarn build

The output tmLanguage file syntaxes/Scala.tmLanguage.json is tracked by git, and is committed on every release (see #23). The output file is validated against the json schema before being written.

To run the tests, run the following command:

yarn test

Installing the extension locally

Run the following commands to globally install this extension with your local changes.

yarn install
yarn build

# replace `*` below with the version of the generated vsix file
code --install-extension scala-*.vsix