Skate Plugin Settings Checkbox Enhancement #448

kateliu20 · 2023-07-07T23:30:45Z

This is just a simple enhancement for the Skate Plugin Settings UI Panel.

Before, the checkbox text would not wrap and would require users to scroll horizontally:

Now, the text is wrapped:

This is just a simple enhancement for user readability, and I added documentation to the SkateConfigUI.kt file as well.

Co-authored-by: Zac Sweers <[email protected]>

…ange_log_parser # Conflicts: # skate-plugin/src/test/kotlin/com/slack/sgp/intellij/ChangeLogParserTest.kt

… two entries

…and added docs

Co-authored-by: Zac Sweers <[email protected]>

…arkdown_rendering

github-actions · 2023-07-07T23:31:16Z

In build.gradle.kts, instead of using plugins.set(listOf(/* Plugin Dependencies */ )), you can use plugins { id("org.intellij.plugins.markdown") } to add the Markdown plugin dependency.

-intellij {
+intellij {
   version.set("2022.2.5")
   type.set("IC") // Target IDE Platform
 
   plugins.add("org.intellij.plugins.markdown")
 }

In ChangelogParser.kt, you can remove the empty line before the comment to improve code readability.

     .trimEnd()
-
 // If the changelog substring is blank, set it as null
 // If the previous entry equals to the latest entry, or if no date is found,
 // use the previous entry date as the latest date instead of the current date.

In SkateService.kt, you can remove the unused import statement import com.slack.sgp.intellij.ui.WhatsNewPanelFactory.
In SkateService.kt, you can remove the commented out code and the unused variable changeLogString.
In SkateService.kt, you can remove the unused import statement import com.intellij.openapi.util.Disposer.
In SkateService.kt, you can move the creation of parentDisposable outside the invokeLater block to improve code readability.

   toolWindowManager.invokeLater {
     val toolWindow =
       toolWindowManager.registerToolWindow("skate-whats-new") {
         stripeTitle = Supplier { "What's New in Slack!" }
         anchor = ToolWindowAnchor.RIGHT
       }
-    val parentDisposable = Disposer.newDisposable()
+
+    // The Disposable is necessary to prevent a substantial memory leak while working with
+    // MarkdownJCEFHtmlPanel
+    val parentDisposable = Disposer.newDisposable()
+
     WhatsNewPanelFactory()
-      .createToolWindowContent(toolWindow, project, changeLogString, parentDisposable)
+      .createToolWindowContent(toolWindow, project, changeLogString, parentDisposable)
 
     toolWindow.show()
   }

In SkateConfigUI.kt, you can remove the unused import statement import java.io.File.
In SkateConfigUI.kt, you can use HTML tags to format the description text in the checkbox label.

   row(SkateBundle.message("skate.configuration.enableWhatsNew.title")) {
-    checkBox(SkateBundle.message("skate.configuration.enableWhatsNew.description"))
+    checkBox(
+        "<html>${SkateBundle.message("skate.configuration.enableWhatsNew.description")}</html>"
+      )
       .bindSelected(
         getter = { settings.isWhatsNewEnabled },
         setter = { settings.isWhatsNewEnabled = it }

In WhatsNewPanelFactory.kt, you can remove the unused import statements import org.intellij.lang.annotations.Language and import javax.swing.JComponent.
In WhatsNewPanelFactory.kt, you can remove the commented out code for parsing the changelog and the unused variable parsedChangelog.
In WhatsNewPanelFactory.kt, you can remove the Disposer.register(parentDisposable, panel) line as it's not necessary.
In WhatsNewPanelFactory.kt, you can remove the runReadAction block and directly pass markdownFileString to MarkdownUtil.generateMarkdownHtml.

   val file = LightVirtualFile("changelog.md", markdownFileString)
 
   val panel = MarkdownJCEFHtmlPanel(project, file)
-  Disposer.register(parentDisposable, panel)
-  val html = runReadAction {
-    MarkdownUtil.generateMarkdownHtml(file, markdownFileString, project)
-  }
+  val html = MarkdownUtil.generateMarkdownHtml(file, markdownFileString, project)
 
   panel.setHtml(html, 0)
   return panel.component

In plugin.xml, you can add the dependency on the Markdown plugin by adding <depends>org.intellij.plugins.markdown</depends>.

   <!-- Product and plugin compatibility requirements.
        Read more: https://plugins.jetbrains.com/docs/intellij/plugin-compatibility.html -->
   <depends>com.intellij.modules.platform</depends>
+  <depends>org.intellij.plugins.markdown</depends>
 
   <!-- Extension points defined by the plugin.
        Read more: https://plugins.jetbrains.com/docs/intellij/plugin-extension-points.html -->

In skateBundle.properties, you can use <br> tag to add a line break in the description text.

 skate.configuration.enableWhatsNew.description=If enabled, shows the What's New Panel if there are new changes detected <br> in a specified changelog file.

Overall, the code looks good and the suggested changes are mainly for improving code readability and removing unused code.

Katherine Liu and others added 30 commits June 27, 2023 14:50

Add ChangelogParser

9ee9356

Write tests for ChangelogParser

f9a0fcf

More test cases with changelog and previous latest entry components.

cb8dab5

Test case for if previous entry is not null but present in the changelog

a8bdc6b

Add comments

9a04906

spotless Apply

4ff0d3c

Update ChangeLogParser.kt readability.

7839e03

Co-authored-by: Zac Sweers <[email protected]>

Using Raw Strings for readability

e88b058

Co-authored-by: Zac Sweers <[email protected]>

merge comments and function names

c7bcdaf

Merge remote-tracking branch 'origin/kl/change_log_parser' into kl/ch…

85f12da

…ange_log_parser # Conflicts: # skate-plugin/src/test/kotlin/com/slack/sgp/intellij/ChangeLogParserTest.kt

merge comments and function names

0e4f3be

remove the word "test" in all the test functions

06f3b2a

Documentation added for ChangelogParser

37f1b00

Raw Strings

8bd4eea

Change test for one entry but no previous entries, original input had…

af7b9b5

… two entries

allow for html parsing

25b11bd

change css for markdown file

b1bd591

add italics

4068600

markdown style with css style sheet rules

cad5bba

add codeblock formatting

7caf5b1

fix padding / margins

d45568a

merge conflicts

61b1957

run spotless

0a62c70

extended the Markdown plugin extension using MarkdownJCEFHtmlPanel

e26d91e

Deleted MarkdownStyle.kt because it is now unnecessary, ran spotless …

2a4348d

…and added docs

Remove java versions

1580f11

Update skate-plugin/build.gradle.kts to .add

728a44a

Co-authored-by: Zac Sweers <[email protected]>

Added clearer comments, removed nits

ef81fb1

Merge remote-tracking branch 'origin/kl/markdown_rendering' into kl/m…

c153bb4

…arkdown_rendering

Add disposable for when tool window is closed

89e8992

Katherine Liu added 2 commits July 7, 2023 16:26

Checkbox text wraps onto the next line

fd03bf1

Added doc to SkateConfigUI

7cc88fd

kateliu20 closed this Jul 7, 2023

kateliu20 deleted the kl/skate_settings_checkbox_enhancement branch July 7, 2023 23:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Skate Plugin Settings Checkbox Enhancement #448

Skate Plugin Settings Checkbox Enhancement #448

kateliu20 commented Jul 7, 2023 •

edited

Loading

github-actions bot commented Jul 7, 2023

Skate Plugin Settings Checkbox Enhancement #448

Skate Plugin Settings Checkbox Enhancement #448

Conversation

kateliu20 commented Jul 7, 2023 • edited Loading

github-actions bot commented Jul 7, 2023

kateliu20 commented Jul 7, 2023 •

edited

Loading