Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add formatting instructions #99

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add formatting instructions #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@ bundle in TextMate and [IntelliJ using a third-party plugin](https://www.jetbrai

## Features

This extension provides basic syntax highlighting of ".smithy" files.

Additionally, it provides [Snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets).
This extension provides basic syntax highlighting of ".smithy" files, [Snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets),
and [Formatting](https://code.visualstudio.com/docs/editor/codebasics#_formatting).

## Installation

Expand Down Expand Up @@ -44,6 +43,19 @@ github.password=<YOUR_GITHUB_TOKEN>
github.host=maven.pkg.github.com
```

## Formatting

Set this extension as the default formatter for the Smithy language and format
from the command palette or on save.

```json
{
"[smithy]": {
"editor.defaultFormatter": "smithy.smithy-vscode-extension"
}
}
```

## Use with IntelliJ

You can use this extension for syntax highlighting in IntelliJ by installing the
Expand Down