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.

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

chore: improve custom lsp extension docs #697

Merged
merged 1 commit into from
Oct 11, 2024

Conversation

cmars
Copy link
Contributor

@cmars cmars commented Oct 10, 2024

Description

Update README with more examples of custom notifications and types which may be useful to integrating with the Snyk Language Server.

Rename "payload" to "params", "response" to "example" in notification docs. This is to better align with the wording used in the LSP specification regarding notifications.

Checklist

  • Tests added and all succeed
  • Linted
  • README.md updated, if user-facing
  • License file updated, if new 3rd-party dependency is introduced

Update README with more examples of custom notifications and types which
may be useful to integrating with the Snyk Language Server.

Rename "payload" to "params", "response" to "example" in notification docs.
Copy link
Contributor

@ShawkyZ ShawkyZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💖

@ShawkyZ ShawkyZ merged commit 0ba9106 into main Oct 11, 2024
17 checks passed
@ShawkyZ ShawkyZ deleted the chore/improve-readme-lsp-docs branch October 11, 2024 08:39
"message": "Message",
"tags": ["security"],
"data": {
"scanIssue": {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this correct? I thought it is the struct directly, without json key.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. Correction in #699

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants