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.

Sign up for GitHub

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

Jump to bottom

SLI-1788 SLI-1784 SLI-1796 Create Walkthrough for SonarQube for IDE #1280

Merged

eray-felek-sonarsource merged 12 commits into feature/ef/intellij-walkthrough from feature/ef/SLI-1784

Jan 22, 2025

Contributor

eray-felek-sonarsource commented Jan 7, 2025 •

edited

Loading

4 Page walkthrough the let user get familiar with the SonarQube IDE functionalities

eray-felek-sonarsource force-pushed the feature/ef/SLI-1784 branch from 6b802ef to 514515f Compare

January 7, 2025 16:25

eray-felek-sonarsource requested a review from thahnen

January 9, 2025 12:29

eray-felek-sonarsource changed the title ~~Feature/ef/sli 1784~~ SLI-1788 SLI-1784 SLI-1796 Create Walkthrough for SonarQube for IDE

eray-felek-sonarsource requested a review from sophio-japharidze-sonarsource

January 9, 2025 12:41

sophio-japharidze-sonarsource requested changes

View reviewed changes

sophio-japharidze-sonarsource left a comment

The SonarLintWalkthroughToolWindow file is huge and very hard to follow, and I feel like has lots of duplications. I would suggest to either deduplicate common logic and object creations by extracting them to methods, or separate each walkthrough step in a separate file.

I also added some suggestions about wording and capitalization.

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated

+                    SONARQUBE_FOR_IDE + " supports the analysis of 15+ languages including Python, Java, Javascript, IaC domains along with secrets " +
+                    "detection. " +
+                    "<a href=\"" + RULE_SECTION_LINK + "\">Learn more</a>.<br><br>" +
+                    "Detect issues while you code in an open files or run the analysis on more file in the <a href=\"#reportView\">report view</a>" +

sophio-japharidze-sonarsource Jan 9, 2025

Suggested change

      
                  "Detect issues while you code in an open files or run the analysis on more file in the <a href=\"#reportView\">report view</a>" +
          
                  "Detect issues in open files while you code, or run the analysis of more files from the <a href=\"#reportView\">Report view</a>" +

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated

+                    "<a href=\"" + RULE_SECTION_LINK + "\">Learn more</a>.<br><br>" +
+                    "Detect issues while you code in an open files or run the analysis on more file in the <a href=\"#reportView\">report view</a>" +
+                    ".<br><br>" +
+                    "Open a file and start your clean code journey.</body></html>");

sophio-japharidze-sonarsource Jan 9, 2025

Suggested change

      
                  "Open a file and start your clean code journey.</body></html>");
          
                  "Open a file and start your Clean Code journey.</body></html>");

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated

+                    "Apply the same set of rules as your team by using " + SONARQUBE_FOR_IDE + " in Connected Mode with SonarQube Cloud or SonarQube " +
+                    "Server" +
+                    ".<br><br>" +
+                    "With connected mode, benefit from advanced analysis like <a href=\"#taintVulnerabilities\">Taint Vulnerabilities</a> and open " +

sophio-japharidze-sonarsource Jan 9, 2025

Suggested change

      
                  "With connected mode, benefit from advanced analysis like <a href=\"#taintVulnerabilities\">Taint Vulnerabilities</a> and open " +
          
                  "With Connected Mode, benefit from advanced analysis like <a href=\"#taintVulnerabilities\">Taint Vulnerabilities</a> and open " +

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated Show resolved Hide resolved

thahnen requested changes

View reviewed changes

Member

thahnen left a comment

I second Sophio here that this needs some de-duplication and documentation as well.

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/SonarLintWalkthroughToolWindow.java Outdated Show resolved Hide resolved

eray-felek-sonarsource force-pushed the feature/ef/SLI-1784 branch from 062931f to 03ec2a6 Compare

January 10, 2025 11:01

sonarqube-next bot commented Jan 10, 2025

Quality Gate failed

Failed conditions
4 New issues

See analysis details on SonarQube

Catch issues before they fail your Quality Gate with our IDE extension SonarQube IDE

nquinquenel reviewed

View reviewed changes

Member

nquinquenel left a comment

It has been a long-standing practice to create new classes in Kotlin rather than Java. I'd recommend doing so, as it would help increase the code's readability (Swing is quite heavy to write).

I'd also move every related page to a dedicated directory, as the UI package is already quite packed.

Other than that, there are a few more comments (most of them are applicable to all the **Page classes), but the result is already quite visible and working, it's almost good!

src/main/java/org/sonarlint/intellij/ui/ConnectWithYourTeamPage.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/ConnectWithYourTeamPage.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/LearnAsYouCodePage.java Outdated

+                  var font = UIUtil.getLabelFont();
+                  learnAsYouCodePagePanel = new JPanel(new BorderLayout());
+                  var icon = new ImageIcon(Objects.requireNonNull(getClass().getResource("/images/sonarqube-for-ide-mark.png")));

Member

nquinquenel Jan 18, 2025

Same here, get the image icon from SonarLintIcon. Also I'd recommend using SVG as much as possible

Contributor Author

eray-felek-sonarsource Jan 22, 2025

When the new images arrive I will convert if there are not in svg

src/main/java/org/sonarlint/intellij/ui/LearnAsYouCodePage.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/ReachOutToUsPage.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/WelcomePage.java Outdated

+                }
+                private static JEditorPane createWelcomePageText(Font font, Project project) {
+                  var descriptionPane = new JEditorPane(SonarLintWalkthroughToolWindow.EDITOR_PANE_TYPE,

Member

nquinquenel Jan 18, 2025

It may be personal, but I'm not a big fan of using huge blocks of HTML in Java Swing components. I'd rather have a clean layout and structure with proper layout

Contributor Author

eray-felek-sonarsource Jan 20, 2025

I used SwingHelper.createHtmlViewer as discussed

src/main/java/org/sonarlint/intellij/ui/LearnAsYouCodePage.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/WelcomePage.java Outdated

+                  descriptionPane.addHyperlinkListener(new HyperlinkAdapter() {
+                    @Override
+                    protected void hyperlinkActivated(HyperlinkEvent e) {

Member

nquinquenel Jan 18, 2025

I find this link management a bit dirty, I think breaking down the big HTML block into Swing components would help with this

Contributor Author

eray-felek-sonarsource Jan 20, 2025

As discussed I used SwingHelper.createHtmlViewer

src/main/java/org/sonarlint/intellij/ui/WelcomePage.java Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/OpenWelcomePageOnceOneProjectOpened.java Show resolved Hide resolved

eray-felek-sonarsource force-pushed the feature/ef/SLI-1784 branch from 8c281e1 to 29ae573 Compare

January 20, 2025 16:48

eray-felek-sonarsource requested a review from nquinquenel

January 20, 2025 16:49

thahnen reviewed

View reviewed changes

src/main/java/org/sonarlint/intellij/ui/walkthrough/SonarLintWalkthroughToolWindow.kt Outdated Show resolved Hide resolved

thahnen reviewed

View reviewed changes

src/main/java/org/sonarlint/intellij/ui/walkthrough/ReachOutToUsPanel.kt Outdated Show resolved Hide resolved

eray-felek-sonarsource added 11 commits

January 21, 2025 09:10


          SLI-1784 SLI-1711 Implement first 2 pages of the walktrough

9b534bd


          SLI-1796 implement connected mode page

d3fa2a1


          SLI-1796 add 3rd and 4th page to the walktrough

bb815ee


          SLI-1784 Add AI fix suggestions telemetry

bbe2949


          SLI-1784 Adjust UI

baab687


          SLI-1784 Adjust docs

acc4b08


          refactor

0d2747b


          rename

2ff9a07


          Do refactor

05f4e62


          Automatically open the talkthrough after installation

870564c


          Create different pages of the walkthrough separately

2fff44b

eray-felek-sonarsource force-pushed the feature/ef/SLI-1784 branch from 29ae573 to 552828c Compare

January 21, 2025 08:11

nquinquenel reviewed

View reviewed changes

Member

nquinquenel left a comment

Another round of comments following the kotlin refactoring, it's looking better!

src/main/java/org/sonarlint/intellij/ui/walkthrough/LearnAsYouCodePanel.kt Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/walkthrough/LearnAsYouCodePanel.kt Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/walkthrough/LearnAsYouCodePanel.kt Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/walkthrough/LearnAsYouCodePanel.kt Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/walkthrough/LearnAsYouCodePanel.kt Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/walkthrough/SonarLintWalkthroughUtils.kt Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/walkthrough/SonarLintWalkthroughUtils.kt Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/walkthrough/SonarLintWalkthroughUtils.kt Outdated Show resolved Hide resolved

src/main/resources/META-INF/plugin.xml Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/documentation/SonarLintDocumentation.kt Show resolved Hide resolved

eray-felek-sonarsource force-pushed the feature/ef/SLI-1784 branch 4 times, most recently from 60b1159 to 37ae04a Compare

January 21, 2025 15:15

eray-felek-sonarsource force-pushed the feature/ef/SLI-1784 branch 2 times, most recently from 4e9449f to 535e78b Compare

January 21, 2025 17:02

eray-felek-sonarsource requested a review from nquinquenel

January 21, 2025 17:02

eray-felek-sonarsource changed the base branch from master to feature/ef/intellij-walkthrough

January 22, 2025 08:33

nquinquenel approved these changes

View reviewed changes

Member

nquinquenel left a comment

Let's merge it in the feature branch for now

eray-felek-sonarsource requested review from thahnen and sophio-japharidze-sonarsource

January 22, 2025 10:42

thahnen requested changes

View reviewed changes

Member

thahnen left a comment

LGTM, please fix these two typos.

src/main/java/org/sonarlint/intellij/ui/walkthrough/WelcomePanel.kt Outdated Show resolved Hide resolved

src/main/java/org/sonarlint/intellij/ui/walkthrough/ReachOutToUsPanel.kt Outdated Show resolved Hide resolved


          Make changes for the comments

d7c3a42

eray-felek-sonarsource force-pushed the feature/ef/SLI-1784 branch from 535e78b to d7c3a42 Compare

January 22, 2025 11:02

thahnen approved these changes

View reviewed changes

Member

thahnen left a comment

LGTM

sonarqube-next bot commented Jan 22, 2025

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
2.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

eray-felek-sonarsource merged commit 514c750 into feature/ef/intellij-walkthrough

30 checks passed

eray-felek-sonarsource deleted the feature/ef/SLI-1784 branch

January 22, 2025 11:28

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet