feat: add a new $/snyk.scanSummary notificiation [IDE-868] (#758)

snyk · Jan 20, 2025 · b692957 · b692957
1 parent 5facb0f
commit b692957
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -232,6 +232,15 @@ Right now the language server supports the following actions:
     },
   }
   ```
+  - Summary Panel Status Notification
+  - method: `$/snyk.scanSummary`
+  - params: `types.ScanSummary`
+  - example:
+  ```json5
+  {
+    "scanSummary": "<html><body<p> Summary </p></body></html>"
+  }
+  ```
 
 ### Commands
 

diff --git a/application/server/notification.go b/application/server/notification.go
@@ -125,6 +125,9 @@ func registerNotifier(c *config.Config, srv types.Server) {
 				Interface("source", source).
 				Interface("diagnosticCount", len(params.Diagnostics)).
 				Msg("publishing diagnostics")
+		case types.ScanSummary:
+			notifier(c, srv, "$/snyk.scanSummary", params)
+			logger.Debug().Msg("sending scan summary to client")
 		case types.ApplyWorkspaceEditParams:
 			handleApplyWorkspaceEdit(srv, params, &logger)
 			logger.Debug().

diff --git a/internal/types/lsp.go b/internal/types/lsp.go
@@ -626,6 +626,10 @@ type SnykIsAvailableCli struct {
 	CliPath string `json:"cliPath"`
 }
 
+type ScanSummary struct {
+	ScanSummary string `json:"scanSummary"`
+}
+
 type ProgressToken string
 
 type ProgressParams struct {