org.sonarsource.sonarlint.ls.SonarLintExtendedLanguageServer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonarlint-language-server Show documentation
SonarLint Language Server
There is a newer version: 3.12.0.75621
Show newest version
/*
 * SonarLint Language Server
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonarsource.sonarlint.ls;

import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.stream.Stream;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.eclipse.lsp4j.TextDocumentItem;
import org.eclipse.lsp4j.jsonrpc.services.JsonNotification;
import org.eclipse.lsp4j.jsonrpc.services.JsonRequest;
import org.eclipse.lsp4j.jsonrpc.validation.NonNull;
import org.eclipse.lsp4j.services.LanguageServer;
import org.eclipse.lsp4j.util.Preconditions;
import org.sonarsource.sonarlint.core.rpc.protocol.backend.analysis.GetSupportedFilePatternsResponse;
import org.sonarsource.sonarlint.core.rpc.protocol.backend.binding.GetBindingSuggestionParams;
import org.sonarsource.sonarlint.core.rpc.protocol.backend.binding.GetSharedConnectedModeConfigFileParams;
import org.sonarsource.sonarlint.core.rpc.protocol.backend.binding.GetSharedConnectedModeConfigFileResponse;
import org.sonarsource.sonarlint.core.rpc.protocol.backend.connection.auth.HelpGenerateUserTokenResponse;
import org.sonarsource.sonarlint.core.rpc.protocol.backend.connection.org.OrganizationDto;
import org.sonarsource.sonarlint.core.rpc.protocol.client.binding.GetBindingSuggestionsResponse;

public interface SonarLintExtendedLanguageServer extends LanguageServer {

  @JsonRequest("sonarlint/listAllRules")
  CompletableFuture>> listAllRules();

  @JsonRequest("sonarlint/checkConnection")
  CompletableFuture checkConnection(ConnectionCheckParams connectionId);

  class ConnectionCheckParams {
    @Nullable
    private String connectionId;

    @Nullable
    private String token;

    @Nullable
    private String organization;

    @Nullable
    private String serverUrl;

    public ConnectionCheckParams(String connectionId) {
      this.connectionId = connectionId;
    }

    public ConnectionCheckParams(@Nullable String token, @Nullable String organization, @Nullable String serverUrl) {
      this.token = token;
      this.serverUrl = serverUrl;
      this.organization = organization;
    }

    @Nullable
    public String getToken() {
      return token;
    }

    @Nullable
    public String getOrganization() {
      return organization;
    }

    @Nullable
    public String getServerUrl() {
      return serverUrl;
    }

    @Nullable
    public String getConnectionId() {
      return connectionId;
    }

    public void setConnectionId(String connectionId) {
      this.connectionId = connectionId;
    }
  }

  @JsonRequest("sonarlint/getRemoteProjectsForConnection")
  CompletableFuture> getRemoteProjectsForConnection(GetRemoteProjectsForConnectionParams getRemoteProjectsForConnectionParams);

  class GetRemoteProjectsForConnectionParams {
    private String connectionId;

    public GetRemoteProjectsForConnectionParams(String connectionId) {
      this.connectionId = connectionId;
    }

    public String getConnectionId() {
      return connectionId;
    }

    public void setConnectionId(String connectionId) {
      this.connectionId = connectionId;
    }
  }

  class DidClasspathUpdateParams {

    @NonNull
    private String projectUri;

    public DidClasspathUpdateParams(@NonNull final String projectUri) {
      this.projectUri = Preconditions.checkNotNull(projectUri, "projectUri");
    }

    @NonNull
    public String getProjectUri() {
      return projectUri;
    }

    public void setProjectUri(@NonNull String projectUri) {
      this.projectUri = Preconditions.checkNotNull(projectUri, "projectUri");
    }

  }

  @JsonNotification("sonarlint/didClasspathUpdate")
  void didClasspathUpdate(DidClasspathUpdateParams params);

  /**
   * Possible server modes for the redhat.vscode-java Language Server
   * https://github.com/redhat-developer/vscode-java/blob/5642bf24b89202acf3911fe7a162b6dbcbeea405/src/settings.ts#L198
   */
  enum ServerMode {
    LIGHTWEIGHT("LightWeight"),
    HYBRID("Hybrid"),
    STANDARD("Standard");

    private final String serializedForm;

    ServerMode(String serializedForm) {
      this.serializedForm = serializedForm;
    }

    static ServerMode of(String serializedForm) {
      return Stream.of(values())
        .filter(m -> m.serializedForm.equals(serializedForm))
        .findFirst()
        .orElse(ServerMode.LIGHTWEIGHT);
    }
  }

  class DidJavaServerModeChangeParams {

    @NonNull
    private String serverMode;

    public DidJavaServerModeChangeParams() {
    }

    public DidJavaServerModeChangeParams(@NonNull final String serverMode) {
      this.serverMode = Preconditions.checkNotNull(serverMode, "serverMode");
    }

    @NonNull
    public String getServerMode() {
      return serverMode;
    }

    public void setServerMode(@NonNull String serverMode) {
      this.serverMode = Preconditions.checkNotNull(serverMode, "serverMode");
    }

  }

  @JsonNotification("sonarlint/didJavaServerModeChange")
  void didJavaServerModeChange(DidJavaServerModeChangeParams params);

  class DidLocalBranchNameChangeParams {
    private String folderUri;
    @Nullable
    private String branchName;

    public DidLocalBranchNameChangeParams(String folderUri, @Nullable String branchName) {
      setFolderUri(folderUri);
      setBranchName(branchName);
    }

    public String getFolderUri() {
      return folderUri;
    }

    @CheckForNull
    public String getBranchName() {
      return branchName;
    }

    public void setBranchName(@Nullable String branchName) {
      this.branchName = branchName;
    }

    public void setFolderUri(String folderUri) {
      this.folderUri = folderUri;
    }
  }

  @JsonNotification("sonarlint/didLocalBranchNameChange")
  void didLocalBranchNameChange(DidLocalBranchNameChangeParams params);

  class OnTokenUpdateNotificationParams {
    private final String connectionId;
    private final String token;

    public OnTokenUpdateNotificationParams(String connectionId, String token) {
      this.connectionId = connectionId;
      this.token = token;
    }

    public String getToken() {
      return token;
    }

    public String getConnectionId() {
      return connectionId;
    }
  }

  @JsonNotification("sonarlint/onTokenUpdate")
  void onTokenUpdate(OnTokenUpdateNotificationParams onTokenUpdateNotificationParams);

  class GetRemoteProjectsNamesParams {
    private String connectionId;
    private List projectKeys;

    public GetRemoteProjectsNamesParams(String connectionId, List projectKeys) {
      setConnectionId(connectionId);
      setProjectKeys(projectKeys);
    }

    public List getProjectKeys() {
      return projectKeys;
    }

    public void setProjectKeys(List projectKeys) {
      this.projectKeys = projectKeys;
    }

    public String getConnectionId() {
      return connectionId;
    }

    public void setConnectionId(String connectionId) {
      this.connectionId = connectionId;
    }
  }

  record GetRemoteProjectNamesByKeysParams(String connectionId, List projectKeys) {
  }

  @JsonRequest("sonarlint/getRemoteProjectNamesByProjectKeys")
  CompletableFuture> getRemoteProjectNamesByProjectKeys(GetRemoteProjectNamesByKeysParams params);

  class GenerateTokenParams {
    String baseServerUrl;

    public GenerateTokenParams(String baseServerUrl) {
      setBaseServerUrl(baseServerUrl);
    }

    public String getBaseServerUrl() {
      return baseServerUrl;
    }

    public void setBaseServerUrl(String baseServerUrl) {
      this.baseServerUrl = baseServerUrl;
    }
  }

  @JsonRequest("sonarlint/generateToken")
  CompletableFuture generateToken(GenerateTokenParams params);

  class ShowHotspotLocationsParams {
    String hotspotKey;
    String fileUri;

    public ShowHotspotLocationsParams(String hotspotKey) {
      setHotspotKey(hotspotKey);
    }

    public String getHotspotKey() {
      return hotspotKey;
    }

    public void setHotspotKey(String hotspotKey) {
      this.hotspotKey = hotspotKey;
    }
  }

  @JsonRequest("sonarlint/showHotspotLocations")
  CompletableFuture showHotspotLocations(ShowHotspotLocationsParams hotspotKey);

  class OpenHotspotInBrowserLsParams {
    private String hotspotId;
    private String fileUri;

    public OpenHotspotInBrowserLsParams(String hotspotId, String workspaceFolder) {
      this.hotspotId = hotspotId;
      this.fileUri = workspaceFolder;
    }

    public String getHotspotId() {
      return hotspotId;
    }

    public void setHotspotId(String hotspotId) {
      this.hotspotId = hotspotId;
    }

    public String getFileUri() {
      return fileUri;
    }

    public void setFileUri(String fileUri) {
      this.fileUri = fileUri;
    }
  }

  @JsonNotification("sonarlint/openHotspotInBrowser")
  void openHotspotInBrowser(OpenHotspotInBrowserLsParams params);

  class ShowHotspotRuleDescriptionParams {
    String hotspotId;
    String fileUri;

    public ShowHotspotRuleDescriptionParams(String hotspotId, String fileUri) {
      setFileUri(fileUri);
      setHotspotId(hotspotId);
    }

    public String getHotspotId() {
      return hotspotId;
    }

    public void setHotspotId(String hotspotId) {
      this.hotspotId = hotspotId;
    }

    public void setFileUri(String fileUri) {
      this.fileUri = fileUri;
    }
  }

  @JsonNotification("sonarlint/showHotspotRuleDescription")
  CompletableFuture showHotspotRuleDescription(ShowHotspotRuleDescriptionParams params);

  class HelpAndFeedbackLinkClickedNotificationParams {
    String id;

    public HelpAndFeedbackLinkClickedNotificationParams(String id) {
      this.id = id;
    }

    public String getId() {
      return id;
    }
  }

  @JsonNotification("sonarlint/helpAndFeedbackLinkClicked")
  CompletableFuture helpAndFeedbackLinkClicked(HelpAndFeedbackLinkClickedNotificationParams params);

  class ScanFolderForHotspotsParams {
    private final String folderUri;

    List documents;

    public ScanFolderForHotspotsParams(String folderUri, List documents) {
      this.folderUri = folderUri;
      this.documents = documents;
    }

    public String getFolderUri() {
      return folderUri;
    }

    public List getDocuments() {
      return documents;
    }
  }

  @JsonNotification("sonarlint/scanFolderForHotspots")
  CompletableFuture scanFolderForHotspots(ScanFolderForHotspotsParams params);

  @JsonNotification("sonarlint/forgetFolderHotspots")
  CompletableFuture forgetFolderHotspots();

  class UriParams {
    private final String uri;

    public UriParams(String uri) {
      this.uri = uri;
    }

    public String getUri() {
      return uri;
    }
  }

  @JsonRequest("sonarlint/listSupportedFilePatterns")
  CompletableFuture getFilePatternsForAnalysis(UriParams params);

  @JsonRequest("sonarlint/getBindingSuggestion")
  CompletableFuture getBindingSuggestion(GetBindingSuggestionParams params);

  class ChangeIssueStatusParams {
    private final String configurationScopeId;
    private final String issueId;
    private final String newStatus;
    private final String fileUri;
    private final String comment;
    private final boolean isTaintIssue;

    public ChangeIssueStatusParams(String configurationScopeId, @Nullable String issueId, String newStatus, String fileUri,
      @Nullable String comment, boolean isTaintIssue) {
      this.configurationScopeId = configurationScopeId;
      this.issueId = issueId;
      this.newStatus = newStatus;
      this.fileUri = fileUri;
      this.comment = comment;
      this.isTaintIssue = isTaintIssue;
    }

    public String getConfigurationScopeId() {
      return configurationScopeId;
    }

    @CheckForNull
    public String getIssueId() {
      return issueId;
    }

    public String getNewStatus() {
      return newStatus;
    }

    public String getFileUri() {
      return fileUri;
    }

    public String getComment() {
      return comment;
    }

    public boolean isTaintIssue() {
      return isTaintIssue;
    }
  }

  @JsonRequest("sonarlint/checkIssueStatusChangePermitted")
  CompletableFuture checkIssueStatusChangePermitted(CheckIssueStatusChangePermittedParams params);

  class CheckIssueStatusChangePermittedParams {
    String folderUri;
    String issueKey;

    public CheckIssueStatusChangePermittedParams(String folderUri, String issueKey) {
      this.folderUri = folderUri;
      this.issueKey = issueKey;
    }

    public String getFolderUri() {
      return folderUri;
    }

    public String getIssueKey() {
      return issueKey;
    }
  }

  class CheckIssueStatusChangePermittedResponse {
    private final boolean permitted;
    private final String notPermittedReason;
    private final List allowedStatuses;

    public CheckIssueStatusChangePermittedResponse(boolean permitted, @Nullable String notPermittedReason, List allowedStatuses) {
      this.permitted = permitted;
      this.notPermittedReason = notPermittedReason;
      this.allowedStatuses = allowedStatuses;
    }

    public boolean isPermitted() {
      return permitted;
    }

    @CheckForNull
    public String getNotPermittedReason() {
      return notPermittedReason;
    }

    public List getAllowedStatuses() {
      return allowedStatuses;
    }
  }


  @JsonNotification("sonarlint/changeIssueStatus")
  CompletableFuture changeIssueStatus(ChangeIssueStatusParams params);

  class CheckLocalDetectionSupportedResponse {
    boolean isSupported;
    @Nullable
    String reason;

    public CheckLocalDetectionSupportedResponse(boolean isSupported, @Nullable String reason) {
      this.isSupported = isSupported;
      this.reason = reason;
    }

    public boolean isSupported() {
      return isSupported;
    }

    @CheckForNull
    public String getReason() {
      return reason;
    }
  }

  @JsonRequest("sonarlint/checkLocalDetectionSupported")
  CompletableFuture checkLocalDetectionSupported(UriParams params);


  @JsonRequest("sonarlint/getHotspotDetails")
  CompletableFuture getHotspotDetails(
    SonarLintExtendedLanguageServer.ShowHotspotRuleDescriptionParams getHotspotDetailsParams);

  class ChangeHotspotStatusParams {

    private final String hotspotKey;
    private final String newStatus;
    private final String fileUri;

    public ChangeHotspotStatusParams(String hotspotKey, String newStatus, String fileUri) {
      this.hotspotKey = hotspotKey;
      this.newStatus = newStatus;
      this.fileUri = fileUri;
    }

    public String getHotspotKey() {
      return hotspotKey;
    }

    public String getNewStatus() {
      return newStatus;
    }

    public String getFileUri() {
      return fileUri;
    }

  }

  @JsonNotification("sonarlint/changeHotspotStatus")
  CompletableFuture changeHotspotStatus(ChangeHotspotStatusParams params);

  class GetAllowedHotspotStatusesParams {
    private final String hotspotKey;
    private final String folderUri;
    private final String fileUri;

    public GetAllowedHotspotStatusesParams(String hotspotKey, String folderUri, String fileUri) {
      this.hotspotKey = hotspotKey;
      this.folderUri = folderUri;
      this.fileUri = fileUri;
    }

    public String getHotspotKey() {
      return hotspotKey;
    }

    public String getFolderUri() {
      return folderUri;
    }

    public String getFileUri() {
      return fileUri;
    }
  }

  @JsonRequest("sonarlint/getAllowedHotspotStatuses")
  CompletableFuture getAllowedHotspotStatuses(GetAllowedHotspotStatusesParams params);

  class GetAllowedHotspotStatusesResponse {
    private final boolean permitted;
    private final String notPermittedReason;
    private final List allowedStatuses;

    public GetAllowedHotspotStatusesResponse(boolean permitted, @Nullable String notPermittedReason, List allowedStatuses) {
      this.permitted = permitted;
      this.notPermittedReason = notPermittedReason;
      this.allowedStatuses = allowedStatuses;
    }

    public boolean isPermitted() {
      return this.permitted;
    }

    @CheckForNull
    public String getNotPermittedReason() {
      return this.notPermittedReason;
    }

    public List getAllowedStatuses() {
      return this.allowedStatuses;
    }
  }

  @JsonNotification("sonarlint/reopenResolvedLocalIssues")
  void reopenResolvedLocalIssues(ReopenAllIssuesForFileParams params);

  class ReopenAllIssuesForFileParams {
    private final String relativePath;
    private final String fileUri;
    private final String configurationScopeId;

    public ReopenAllIssuesForFileParams(String relativePath, String fileUri, String configurationScopeId) {
      this.relativePath = relativePath;
      this.fileUri = fileUri;
      this.configurationScopeId = configurationScopeId;
    }

    public String getRelativePath() {
      return relativePath;
    }

    public String getFileUri() {
      return fileUri;
    }

    public String getConfigurationScopeId() {
      return configurationScopeId;
    }
  }

  class AnalyseOpenFileIgnoringExcludesParams {
    private final TextDocumentItem textDocument;
    private final String notebookUri;
    private final Integer notebookVersion;
    private final List notebookCells;

    public AnalyseOpenFileIgnoringExcludesParams(@Nullable TextDocumentItem textDocument,
      @Nullable String notebookUri, @Nullable Integer notebookVersion, @Nullable List notebookCells) {
      this.textDocument = textDocument;
      this.notebookUri = notebookUri;
      this.notebookVersion = notebookVersion;
      this.notebookCells = notebookCells;
    }

    @CheckForNull
    public TextDocumentItem getTextDocument() {
      return textDocument;
    }

    @CheckForNull
    public String getNotebookUri() {
      return notebookUri;
    }

    @CheckForNull
    public Integer getNotebookVersion() {
      return notebookVersion;
    }

    @CheckForNull
    public List getNotebookCells() {
      return notebookCells;
    }
  }

  @JsonNotification("sonarlint/analyseOpenFileIgnoringExcludes")
  CompletableFuture analyseOpenFileIgnoringExcludes(AnalyseOpenFileIgnoringExcludesParams params);

  @JsonRequest("sonarlint/getSharedConnectedModeFileContent")
  CompletableFuture getSharedConnectedModeConfigFileContents(GetSharedConnectedModeConfigFileParams params);

  enum BindingCreationMode {
    AUTOMATIC,
    IMPORTED,
    MANUAL
  }

  @JsonNotification("sonarlint/didCreateBinding")
  void didCreateBinding(BindingCreationMode creationMode);

  @JsonRequest("sonarlint/listUserOrganizations")
  CompletableFuture> listUserOrganizations(String token);

  record FixSuggestionResolvedParams(String suggestionId, boolean accepted) {
  }

  @JsonNotification("sonarlint/fixSuggestionResolved")
  CompletableFuture fixSuggestionResolved(FixSuggestionResolvedParams params);
}