Smithy VS Code extension
Smithy is an open-source protocol-agnostic interface definition language maintained and published by AWS.
This VSCode extension provides syntax coloring and rich editor features when editing .smithy files.
It works by communicating to a language-server published in
This extension contains:
- Client code to communicate with a Smithy LSP server. In particular, this should handle :
- Jump to definition
- Basic auto-completion
- Simple grammar for Smithy syntax highlighting
You can configure your Smithy projects using a Smithy build file.
The name of the file is
smithy-build.json. This build file is a JSON file has the following structure:
Array[String] - a list of path to directories or file to include in the Smithy model - default:
Array[String] - maven dependencies that contains Smithy definitions - default:
Array[String] - maven repositories to fetch mavenDependencies from - default:
m2local and maven central
An example Smithy build file looks like this: