Feature/add option to disable for long lines (#23)

* Update Gradle and plugin configurations

Upgraded Gradle version to 8.14 and updated plugin settings, including Kotlin (2.1.20) and IntelliJ Platform (2.5.0) versions. Removed deprecated properties and cleaned up unused configurations to ensure compatibility with the updated platform version.

* Add support for disabling the plugin for large files

Introduce `BracketsSettingsState` with options to disable the plugin for files exceeding a configurable line count. Refactor services and annotators to use a `BracketColorizerServiceFactory` for improved modularity and performance. Update plugin metadata and changelog to reflect the changes.

* Add settings for bracket pair colorization and large files

Introduced a settings section in the README to guide users on configuring bracket pair colorization. Enhanced the settings UI to allow disabling colorization for large files and adjusting the line count threshold. These changes improve customization and usability.

* Reverted pluginUntilBuild

* Remove redundant code and refine plugin verification logic.

Deleted unused `Run Verifications` Gradle run configuration and the `withCustomBrackets` function from `BracketColorizerService`. Enhanced plugin verification to limit IDE versions processed, optimizing for a smaller subset of releases.

* Update workflows and enhance plugin verification logging

Updated GitHub Actions workflow to disable handling of large packages in free-disk-space action. Improved logging in plugin verification to provide clearer details about available and selected builds for verification.

* Updated change log.

* Reverted build and changelog steps

* Bumped version

Author: j-d-ha

.github/workflows/build.yml

@@ -157,6 +157,7 @@ jobs:
         uses: jlumbroso/free-disk-space@main
         with:
           tool-cache: false
+          large-packages: false
 
       # Check out the current repository
       - name: Fetch Sources
@@ -190,6 +191,7 @@ jobs:
         uses: jlumbroso/free-disk-space@main
         with:
           tool-cache: false
+          large-packages: false
 
       # Check out the current repository
       - name: Fetch Sources

.run/Run Verifications.run.xml

@@ -4,11 +4,17 @@
 
 ## [Unreleased]
 
-## [0.0.1] - 2022-11-09
+### Added
+
+- Added an option to disable the plugin for large files.
+- Added service optimizations for performance gains.
+
+## [0.0.1] - 2024-11-09
 
 ### Added
 
 - Initial release
 
 [Unreleased]: https://github.com/j-d-ha/brackets/compare/v0.0.1...HEAD
+
 [0.0.1]: https://github.com/j-d-ha/brackets/commits/v0.0.1

CHANGELOG.md

@@ -18,6 +18,17 @@ match VSCode.
 
 > Note: As of now, I don't plan on adding support for any other languages.
 
+## Settings
+
+Plugin settings can be found in <kbd>Settings/Preferences</kbd> > <kbd>Tools</kbd> > <kbd>
+Brackets</kbd>.
+
+Bellow is a list available settings:
+
+- Matching bracket pair colorization can be disabled for large files. This functionality and the
+  line
+  count threshold for large files can be updated in settings.
+
 <!-- Plugin description end -->
 
 ## Installation

README.md

@@ -1,6 +1,5 @@
 import java.io.FileReader
 import java.util.Properties
-import org.gradle.kotlin.dsl.assign
 import org.jetbrains.changelog.Changelog
 import org.jetbrains.changelog.markdownToHTML
 import org.jetbrains.intellij.platform.gradle.TestFrameworkType
@@ -15,19 +14,19 @@ File(".env").takeIf(File::exists)?.let {
 
 plugins {
     id("java") // Java support
-    alias(libs.plugins.kotlin) version "2.0.21" // Kotlin support
-    alias(libs.plugins.intelliJPlatform) version "2.1.0" // IntelliJ Platform Gradle Plugin
+    alias(libs.plugins.kotlin) // Kotlin support
+    alias(libs.plugins.intelliJPlatform) // IntelliJ Platform Gradle Plugin
     alias(libs.plugins.changelog) // Gradle Changelog Plugin
     alias(libs.plugins.qodana) // Gradle Qodana Plugin
     alias(libs.plugins.kover) // Gradle Kover Plugin
 }
 
 group = providers.gradleProperty("pluginGroup").get()
 
-version = project.changelog.getAll().keys.toList().first { Regex("""\d+\.\d+\.\d+""").matches(it) }
+version = providers.gradleProperty("pluginVersion").get()
 
 // Set the JVM language level used to build the project.
-kotlin { jvmToolchain(17) }
+kotlin { jvmToolchain(21) }
 
 // Configure project's dependencies
 repositories {
@@ -51,8 +50,6 @@ dependencies {
             providers.gradleProperty("platformVersion"),
         )
 
-        // local(file("/Users/jonasha/Applications/Rider.app/Contents"))
-
         // Plugin Dependencies. Uses `platformBundledPlugins` property from the gradle.properties
         // file for bundled IntelliJ Platform plugins.
         bundledPlugins(providers.gradleProperty("platformBundledPlugins").map { it.split(',') })
@@ -61,27 +58,16 @@ dependencies {
         // plugin from JetBrains Marketplace.
         plugins(providers.gradleProperty("platformPlugins").map { it.split(',') })
 
-        instrumentationTools()
-        pluginVerifier()
-        zipSigner()
         testFramework(TestFrameworkType.Platform)
     }
 }
 
-idea {
-    module {
-        isDownloadJavadoc = true
-        isDownloadSources = true
-    }
-}
-
 // Configure IntelliJ Platform Gradle Plugin - read more:
 // https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-extension.html
 intellijPlatform {
     pluginConfiguration {
-        val changelog = project.changelog // local variable for configuration cache compatibility
-
-        version = changelog.getAll().keys.toList().first { Regex("""\d+\.\d+\.\d+""").matches(it) }
+        name = providers.gradleProperty("pluginName")
+        version = providers.gradleProperty("pluginVersion")
 
         // Extract the <!-- Plugin description --> section from README.md and provide for the
         // plugin's manifest
@@ -102,6 +88,7 @@ intellijPlatform {
                 }
             }
 
+        val changelog = project.changelog // local variable for configuration cache compatibility
         // Get the latest available change notes from the changelog file
         changeNotes =
             providers.gradleProperty("pluginVersion").map { pluginVersion ->
@@ -122,14 +109,13 @@ intellijPlatform {
     }
 
     signing {
-        password.set(providers.environmentVariable("PRIVATE_KEY_PASSWORD"))
-        certificateChain.set(providers.environmentVariable("CERTIFICATE_CHAIN"))
-        privateKey.set(providers.environmentVariable("PRIVATE_KEY"))
+        certificateChain = providers.environmentVariable("CERTIFICATE_CHAIN")
+        privateKey = providers.environmentVariable("PRIVATE_KEY")
+        password = providers.environmentVariable("PRIVATE_KEY_PASSWORD")
     }
 
     publishing {
-        token.set(providers.environmentVariable("PUBLISH_TOKEN"))
-
+        token = providers.environmentVariable("PUBLISH_TOKEN")
         // The pluginVersion is based on the SemVer (https://semver.org) and supports pre-release
         // labels, like 2.1.7-alpha.3
         // Specify pre-release label to publish the plugin in a custom Release Channel
@@ -141,7 +127,22 @@ intellijPlatform {
             }
     }
 
-    pluginVerification { ides { recommended() } }
+    pluginVerification {
+        ides {
+            val productReleases = ProductReleasesValueSource().get()
+            println(
+                "The following builds are available in the verification range: $productReleases"
+            )
+
+            val reducedProductReleases =
+                if (productReleases.size > 2)
+                    listOf(productReleases.first(), productReleases.last())
+                else productReleases
+            println("Running pluginVerification for the following builds: $reducedProductReleases")
+
+            ides(reducedProductReleases)
+        }
+    }
 }
 
 // Configure Gradle Changelog Plugin - read more:

build.gradle.kts

@@ -3,22 +3,20 @@ pluginGroup=com.github.jdha.brackets
 pluginName=brackets
 pluginRepositoryUrl=https://github.com/j-d-ha/brackets
 # SemVer format -> https://semver.org
-pluginVersion=0.0.1
+pluginVersion=0.0.2
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild=233
-#pluginUntilBuild = 242.*
+#pluginUntilBuild=
 # IntelliJ Platform Properties -> https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#configuration-intellij-extension
 platformType=RD
-platformVersion=2024.2.7
-#platformType=IC
-#platformVersion=2024.2.4
+platformVersion=2025.1
 # Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
 # Example: platformPlugins = com.jetbrains.php:203.4449.22, org.intellij.scala:2023.3.27@EAP
 platformPlugins=
 # Example: platformBundledPlugins = com.intellij.java, com.jetbrains.rider.fsharp
 platformBundledPlugins=
 # Gradle Releases -> https://github.com/gradle/gradle/releases
-gradleVersion=8.10.2
+gradleVersion=8.14
 # Opt-out flag for bundling Kotlin standard library -> https://jb.gg/intellij-platform-kotlin-stdlib
 kotlin.stdlib.default.dependency=false
 # Enable Gradle Configuration Cache -> https://docs.gradle.org/current/userguide/configuration_cache.html

gradle.properties

@@ -17,21 +17,21 @@
 
 package com.github.jdha.brackets.annotator
 
+import com.github.jdha.brackets.services.BracketColorizerServiceFactory
+import com.github.jdha.brackets.services.BracketColorizerType
 import com.intellij.lang.annotation.AnnotationHolder
 import com.intellij.lang.annotation.Annotator
+import com.intellij.openapi.components.service
 import com.intellij.psi.PsiElement
 
-class CSBracketColorizer : Annotator {
-
-    private val colorizer = BracketColorizer.default()
+class CSBracketColorizerAnnotator : Annotator {
 
     /**
      * This function is called by the plugin to annotate a given element of the PSI structure.
      *
      * @param p0 the element to annotate
      * @param p1 the annotation holder to which color annotations are added
      */
-    override fun annotate(p0: PsiElement, p1: AnnotationHolder) {
-        colorizer.colorize(p0, p1)
-    }
+    override fun annotate(p0: PsiElement, p1: AnnotationHolder) =
+        service<BracketColorizerServiceFactory>().get(BracketColorizerType.CSharp).colorize(p0, p1)
 }

src/main/kotlin/com/github/jdha/brackets/annotator/CSBracketColorizer.kt renamed to src/main/kotlin/com/github/jdha/brackets/annotator/CSBracketColorizerAnnotator.kt

@@ -17,21 +17,21 @@
 
 package com.github.jdha.brackets.annotator
 
+import com.github.jdha.brackets.services.BracketColorizerServiceFactory
+import com.github.jdha.brackets.services.BracketColorizerType
 import com.intellij.lang.annotation.AnnotationHolder
 import com.intellij.lang.annotation.Annotator
+import com.intellij.openapi.components.service
 import com.intellij.psi.PsiElement
 
-class FSBracketColorizer : Annotator {
-
-    private val colorizer = BracketColorizer.withAdditionalBrackets(setOf("[<"), setOf(">]"))
+class FSBracketColorizerAnnotator : Annotator {
 
     /**
      * This function is called by the plugin to annotate a given element of the PSI structure.
      *
      * @param p0 the element to annotate
      * @param p1 the annotation holder to which color annotations are added
      */
-    override fun annotate(p0: PsiElement, p1: AnnotationHolder) {
-        colorizer.colorize(p0, p1)
-    }
+    override fun annotate(p0: PsiElement, p1: AnnotationHolder) =
+        service<BracketColorizerServiceFactory>().get(BracketColorizerType.FSharp).colorize(p0, p1)
 }