Skip to content

Commit

Permalink
Create README.md for sway-lsp (FuelLabs#5303)
Browse files Browse the repository at this point in the history
## Description


## Checklist

- [ ] I have linked to any relevant issues.
- [ ] I have commented my code, particularly in hard-to-understand
areas.
- [ ] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [ ] I have added tests that prove my fix is effective or that my
feature works.
- [ ] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [ ] I have requested a review from the relevant team or maintainers.
  • Loading branch information
sdankel authored Nov 28, 2023
1 parent 4fa2fdf commit 4408285
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions sway-lsp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

# Sway Language Server

[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/FuelLabs.sway-vscode-plugin)](https://marketplace.visualstudio.com/items?itemName=FuelLabs.sway-vscode-plugin)
[![discord](https://img.shields.io/badge/chat%20on-discord-orange?&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xfpK4Pe)

This extension provides LSP support for the Sway smart contract programming language.

## Features

- goto type definition
- types and documentation on hover
- inlay hints for types and parameter names
- semantic syntax highlighting
- symbol renaming
- code actions
- imports insertion


_Coming Soon_
- code completion
- apply suggestions from errors
- find all references, workspace symbol search
- ... and many more

## Quick start

1. Install the [Fuel toolchain](https://fuellabs.github.io/fuelup/master/installation/index.html).
1. Ensure `forc-lsp` is installed correctly by entering `forc-lsp --version` into your terminal.
1. Install the [Sway VSCode plugin](https://marketplace.visualstudio.com/items?itemName=FuelLabs.sway-vscode-plugin).

0 comments on commit 4408285

Please sign in to comment.