squiggle/packages/vscode-ext/README.md

# Squiggle For VS Code

## About

This extension provides support for [Squiggle](https://www.squiggle-language.com/) in VS Code. It can be found in the VS code _[marketplace](https://marketplace.visualstudio.com/items?itemName=QURI.vscode-squiggle)_

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.

![](./images/vs-code-install.png)

## Usage

After loading a `.squiggle` file, an "Open Preview" button will appear. If you click it, the squiggle model will be shown, and updated as you edit and save you file.

![](./images/extension-screenshot.png)

### Configuration (optional)

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](https://stackoverflow.com/questions/65908987/how-can-i-open-visual-studio-codes-settings-json-file)) for other operating systems.

![](./images/vs-code-settings.png)

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

## 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.
get rid of generated vscode readme 2022-06-17 19:19:34 +00:00			`# Squiggle For VS Code`
vscode extension also: - don't bundle react and react-dom with webpack - controlled mode for SquigglePlayground 2022-06-16 21:37:20 +00:00
tweak: Better documentation So that even newbies can understand. 2022-07-13 17:29:32 +00:00			`## About`
updated README.md in vscode-ext 2022-06-20 15:59:10 +00:00
tweak: Better documentation So that even newbies can understand. 2022-07-13 17:29:32 +00:00			`This extension provides support for [Squiggle](https://www.squiggle-language.com/) in VS Code. It can be found in the VS code _[marketplace](https://marketplace.visualstudio.com/items?itemName=QURI.vscode-squiggle)_`
updated README.md in vscode-ext 2022-06-20 15:59:10 +00:00
vscode: some docs, squiggleU support 2022-06-20 21:46:12 +00:00			`Features:`

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

`yarn format` compels me 2022-07-28 14:43:59 +00:00			`## Installation`
vscode: some docs, squiggleU support 2022-06-20 21:46:12 +00:00
tweak: Better documentation So that even newbies can understand. 2022-07-13 17:29:32 +00:00			`You can install this extension by going to the "extensions" tab, searching for "Squiggle", and then installing it.`

			`![](./images/vs-code-install.png)`

tweak: Indicate that the configuration step is optional 2022-07-13 17:39:07 +00:00			`## Usage`
tweak: Better documentation So that even newbies can understand. 2022-07-13 17:29:32 +00:00
tweak: Indicate that the configuration step is optional 2022-07-13 17:39:07 +00:00			After loading a `.squiggle` file, an "Open Preview" button will appear. If you click it, the squiggle model will be shown, and updated as you edit and save you file.
tweak: Better documentation So that even newbies can understand. 2022-07-13 17:29:32 +00:00
tweak: Indicate that the configuration step is optional 2022-07-13 17:39:07 +00:00			`![](./images/extension-screenshot.png)`
vscode: some docs, squiggleU support 2022-06-20 21:46:12 +00:00
tweak: Indicate that the configuration step is optional 2022-07-13 17:39:07 +00:00			`### Configuration (optional)`
vscode: some docs, squiggleU support 2022-06-20 21:46:12 +00:00
`yarn format` compels me 2022-07-28 14:43:59 +00:00			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](https://stackoverflow.com/questions/65908987/how-can-i-open-visual-studio-codes-settings-json-file)) for other operating systems.
tweak: Better documentation So that even newbies can understand. 2022-07-13 17:29:32 +00:00
tweak: Indicate that the configuration step is optional 2022-07-13 17:39:07 +00:00			`![](./images/vs-code-settings.png)`
tweak: Show what to click in the extension 2022-07-13 17:37:17 +00:00
tweak: Indicate that the configuration step is optional 2022-07-13 17:39:07 +00:00			`Check out the full list of Squiggle settings in the main VS Code settings.`
tweak: Better documentation So that even newbies can understand. 2022-07-13 17:29:32 +00:00
			`## Build locally`
updated README.md in vscode-ext 2022-06-20 15:59:10 +00:00
			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.