squiggle/packages/vscode-ext/README.md

Squiggle For VS Code

About

This extension provides support for Squiggle in VS Code. It can be found in the VS code marketplace

Features:

• Preview .squiggle files in a preview pane
• Syntax highlighting for .squiggle and .squiggleU files

Installation

You can install this extension by going to the "extensions" tab, searching for "Squiggle", and then installing it.

Configuration

Some preview settings, e.g. whether to show the summary table or types of outputs, can be configurable on in the VS Code settings and persist between different preview sessions. The VS Code settings can be accessed with the shortcut Ctrl+, with Ctrl+Shift+P + searching "Open Settings", or by accessing a file like $HOME/.config/Code/User/settings.json in Linux (see here) for other operating systems.

Check out the full list of Squiggle settings in the main VS Code settings.

Usage

Build locally

We assume you ran yarn at the monorepo level for all dependencies.

Then, simply yarn compile at the vscode-ext package level. It will build squiggle-lang, squiggle-components, and the VS Code extension source code.