Release v2.5.0

massivemadness · Mar 10, 2023 · 353e21e · 353e21e
1 parent 11a8766
commit 353e21e
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 39 deletions.
diff --git a/MIGRATION-GUIDE.md b/MIGRATION-GUIDE.md
@@ -3,16 +3,36 @@
 This migration guide will help you adapt your existing code to match the
 latest version of [EditorKit](README.md#editorkit) library.
 
-1. [v2.3.0 -> v2.4.0](#v230---v240)
-1. [v2.2.0 -> v2.3.0](#v220---v230)
-1. [v2.1.2 -> v2.1.3](#v212---v213)
-2. [v2.0.0 -> v2.1.0](#v200---v210)
-3. [v1.3.0 -> v2.0.0](#v130---v200)
-4. [v1.2.1 -> v1.3.0](#v121---v130)
-5. [v1.2.0 -> v1.2.1](#v120---v121)
-6. [v1.1.0 -> v1.2.0](#v110---v120)
-7. [v1.0.1 -> v1.1.0](#v101---v110)
-8. [v1.0.0 -> v1.0.1](#v100---v101)
+* [v2.4.0 -> v2.5.0](#v240---v250)
+* [v2.3.0 -> v2.4.0](#v230---v240)
+* [v2.2.0 -> v2.3.0](#v220---v230)
+* [v2.1.2 -> v2.1.3](#v212---v213)
+* [v2.0.0 -> v2.1.0](#v200---v210)
+* [v1.3.0 -> v2.0.0](#v130---v200)
+* [v1.2.1 -> v1.3.0](#v121---v130)
+* [v1.2.0 -> v1.2.1](#v120---v121)
+* [v1.1.0 -> v1.2.0](#v110---v120)
+* [v1.0.1 -> v1.1.0](#v101---v110)
+* [v1.0.0 -> v1.0.1](#v100---v101)
+
+---
+
+## v2.4.0 -> v2.5.0
+
+Migration steps:
+
+1. If you're using custom plugin DSL, change `PluginSupplier#plugin()` signature:
+   ```kotlin
+   // Before
+   fun PluginSupplier.codeCompletion(block: AutoCompletePlugin.() -> Unit = {}) {
+       plugin(AutoCompletePlugin(), block)
+   }
+
+   // After
+   fun PluginSupplier.codeCompletion(block: AutoCompletePlugin.() -> Unit = {}) {
+       plugin(AutoCompletePlugin().apply(block))
+   }
+   ```
 
 ---
 

diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ Add this to your module's `build.gradle` file:
 ```gradle
 dependencies {
   ...
-  implementation 'com.blacksquircle.ui:editorkit:2.4.0'
+  implementation 'com.blacksquircle.ui:editorkit:2.5.0'
 }
 ```
 
@@ -537,33 +537,33 @@ Select your language and add it's dependency to your module's
 ```gradle
 dependencies {
   ...
-  implementation 'com.blacksquircle.ui:language-actionscript:2.4.0'
-  implementation 'com.blacksquircle.ui:language-base:2.4.0' // for custom language
-  implementation 'com.blacksquircle.ui:language-c:2.4.0'
-  implementation 'com.blacksquircle.ui:language-cpp:2.4.0'
-  implementation 'com.blacksquircle.ui:language-csharp:2.4.0'
-  implementation 'com.blacksquircle.ui:language-groovy:2.4.0'
-  implementation 'com.blacksquircle.ui:language-html:2.4.0'
-  implementation 'com.blacksquircle.ui:language-java:2.4.0'
-  implementation 'com.blacksquircle.ui:language-javascript:2.4.0'
-  implementation 'com.blacksquircle.ui:language-json:2.4.0'
-  implementation 'com.blacksquircle.ui:language-julia:2.4.0'
-  implementation 'com.blacksquircle.ui:language-kotlin:2.4.0'
-  implementation 'com.blacksquircle.ui:language-lisp:2.4.0'
-  implementation 'com.blacksquircle.ui:language-lua:2.4.0'
-  implementation 'com.blacksquircle.ui:language-markdown:2.4.0'
-  implementation 'com.blacksquircle.ui:language-php:2.4.0'
-  implementation 'com.blacksquircle.ui:language-plaintext:2.4.0'
-  implementation 'com.blacksquircle.ui:language-python:2.4.0'
-  implementation 'com.blacksquircle.ui:language-ruby:2.4.0'
-  implementation 'com.blacksquircle.ui:language-shell:2.4.0'
-  implementation 'com.blacksquircle.ui:language-smali:2.4.0'
-  implementation 'com.blacksquircle.ui:language-sql:2.4.0'
-  implementation 'com.blacksquircle.ui:language-toml:2.4.0'
-  implementation 'com.blacksquircle.ui:language-typescript:2.4.0'
-  implementation 'com.blacksquircle.ui:language-visualbasic:2.4.0'
-  implementation 'com.blacksquircle.ui:language-xml:2.4.0'
-  implementation 'com.blacksquircle.ui:language-yaml:2.4.0'
+  implementation 'com.blacksquircle.ui:language-actionscript:2.5.0'
+  implementation 'com.blacksquircle.ui:language-base:2.5.0' // for custom language
+  implementation 'com.blacksquircle.ui:language-c:2.5.0'
+  implementation 'com.blacksquircle.ui:language-cpp:2.5.0'
+  implementation 'com.blacksquircle.ui:language-csharp:2.5.0'
+  implementation 'com.blacksquircle.ui:language-groovy:2.5.0'
+  implementation 'com.blacksquircle.ui:language-html:2.5.0'
+  implementation 'com.blacksquircle.ui:language-java:2.5.0'
+  implementation 'com.blacksquircle.ui:language-javascript:2.5.0'
+  implementation 'com.blacksquircle.ui:language-json:2.5.0'
+  implementation 'com.blacksquircle.ui:language-julia:2.5.0'
+  implementation 'com.blacksquircle.ui:language-kotlin:2.5.0'
+  implementation 'com.blacksquircle.ui:language-lisp:2.5.0'
+  implementation 'com.blacksquircle.ui:language-lua:2.5.0'
+  implementation 'com.blacksquircle.ui:language-markdown:2.5.0'
+  implementation 'com.blacksquircle.ui:language-php:2.5.0'
+  implementation 'com.blacksquircle.ui:language-plaintext:2.5.0'
+  implementation 'com.blacksquircle.ui:language-python:2.5.0'
+  implementation 'com.blacksquircle.ui:language-ruby:2.5.0'
+  implementation 'com.blacksquircle.ui:language-shell:2.5.0'
+  implementation 'com.blacksquircle.ui:language-smali:2.5.0'
+  implementation 'com.blacksquircle.ui:language-sql:2.5.0'
+  implementation 'com.blacksquircle.ui:language-toml:2.5.0'
+  implementation 'com.blacksquircle.ui:language-typescript:2.5.0'
+  implementation 'com.blacksquircle.ui:language-visualbasic:2.5.0'
+  implementation 'com.blacksquircle.ui:language-xml:2.5.0'
+  implementation 'com.blacksquircle.ui:language-yaml:2.5.0'
 }
 ```
 
@@ -576,7 +576,7 @@ dependencies {
 ```gradle
 dependencies {
   ...
-  implementation 'com.blacksquircle.ui:language-base:2.4.0'
+  implementation 'com.blacksquircle.ui:language-base:2.5.0'
 }
 ```