Update README on running and configuring the language server for user. #205
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joewyz
changed the title
milesziemer
requested changes
Mar 13, 2025
| @@ -4,11 +4,179 @@ | |||
| A [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) | |||
| implementation for the [Smithy IDL](https://smithy.io). | |||
|
|
|||
| Smithy is a protocol-agnostic interface definition language and set of tools for generating clients, servers, and documentation for any programming language. | |||
|
|
|||
| ## Features | |||
There was a problem hiding this comment.
I'd like to somehow highlight how we support hover, completions, and diagnostics for smithy-build.json. Maybe make this say "provides the following features for the Smithy IDL", then have another list below saying what's supported for smithy-build.json.
README.md
Outdated
Comment on lines
38
to
39
| java -jar /path/to/unziped/folder/smithy-language-server-0.x.x.jar [port-number] | ||
| // Usually the default port-number is set to 0 |
There was a problem hiding this comment.
I think we should make an update to Main.java that just defaults the port to 0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Issue #170 , Issue #171
Description of changes:
Added instruction on how to run and configure the Smithy Language Server based on the idea Miles proposed from the above issues.
For running lsp section, added instruction for vscode users and neovim users.
For configuring lsp section, added documentation of fields supported by lsp and the brief explanation of two types of build files used by lsp.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.