Skip to content

Commit

Permalink
Merge pull request #7 from jabraham17/improve-readme
Browse files Browse the repository at this point in the history
Improve readme to include experimental features
  • Loading branch information
jabraham17 authored Mar 6, 2024
2 parents 57cac4e + 5e01b27 commit 2380d70
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,35 @@
# chapel-vscode extension

## Features
## Core Features

- Intellisense
- GotoDefinition: jump to a symbols definition
- Go to Definition: jump to or peek a symbol's definition
- Hover: hover over a symbol to view its signature and documentation
- References: view all mentions of a symbol across a workspace
- Code Completion: suggest completion for symbols in the current file
- Symbol List: see all symbols for a file
- Symbol List: see all symbols in a file
- Errors/Warning: see Chapel errors and warnings
- Linting
- see Chapel linter warnings on potential errors and style suggestions
- Snippets
- Syntax Highlighting

### Experimental Features

- Intellisense
- Inlays: view values, types, and named call arguments inline with code
- Generic Instantiations: inspect generic code with helpful annotations
- Dead Code: highlight dead code that will never execute

> **_:warning: CAUTION:_**
> These features use a work-in-progress resolver for Chapel called Dyno to further
> inspect your code. To enable these features, use Dyno by setting
> `chapel.chpl-language-server.resolver` to `true`. Enabling the Dyno resolver
> for most Chapel projects will likely result in a crash.
## Setup

After installing the extension, follow these steps to make sure VSCode is setup to use the extension.
After installing the extension, follow these steps to make sure VSCode is set up to use the extension.

### From an existing Chapel build

Expand Down

0 comments on commit 2380d70

Please sign in to comment.