Uploaded image for project: 'SonarLint Core Library'
  1. SonarLint Core Library
  2. SLCORE-186

Optionally include rule details in codeAction

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.5
    • Component/s: Language Server (LSP)
    • Labels:
      None

      Description

      Currently it's not clear what is the best way to pass rule details to clients to display on "code actions". The language client library implementations work inconsistently in VSCode and Atom:

      • VSCode requires all rule details to be included in code actions
      • Atom requires only the rule key in the code action. Then the client can execute the code action, passing just the rule key, and the server can use a custom action to respond with rule details. The client can listen to such custom actions and trigger opening a pane with the rule details.

      Until the discussion settles down on the desired behavior of the language server protocol, we need to support both mechanisms. Let's add a boolean setting includeRuleDetailsInCodeAction, which sonarlint-vscode can use to get the full details included, without breaking sonarlint-atom.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              janos.gyerik Janos Gyerik (Inactive)
              Reporter:
              janos.gyerik Janos Gyerik (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Due:
                Created:
                Updated:
                Resolved: