#292 Update plugin api and changelog documentation

cortinico · Jan 23, 2025 · 00c1a23 · 00c1a23
1 parent e00e417
commit 00c1a23
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ Please add your entries according to this format.
 ## Unreleased
 
 - Add tasks `ktfmtCheckScripts` and `ktfmtFormatScripts` to check and format the `.kts` files in the project folder.
+- Remove transitive ktfmt dependencies from the plugin to avoid conflicts with the project dependencies.
+- Change output format of ktfmtCheck task
+- Add output file for ktfmtFormat task
+- Improve logging messages from ktfmt tasks
 - Kotlin to 2.1.0
 - Gradle to 8.12
 

diff --git a/plugin-build/plugin/api/plugin.api b/plugin-build/plugin/api/plugin.api
@@ -22,17 +22,35 @@ public final class com/ncorti/ktfmt/gradle/KtfmtPlugin$Companion {
 }
 
 public abstract class com/ncorti/ktfmt/gradle/tasks/KtfmtBaseTask : org/gradle/api/tasks/SourceTask {
-	protected abstract fun execute (Lorg/gradle/workers/WorkQueue;)V
 	public abstract fun getIncludeOnly ()Lorg/gradle/api/provider/Property;
+	public final fun getOutput ()Lorg/gradle/api/provider/Provider;
 	public fun getSource ()Lorg/gradle/api/file/FileTree;
+	protected abstract fun handleResultSummary (Lcom/ncorti/ktfmt/gradle/util/KtfmtResultSummary;)V
 }
 
 public abstract class com/ncorti/ktfmt/gradle/tasks/KtfmtCheckTask : com/ncorti/ktfmt/gradle/tasks/KtfmtBaseTask {
-	protected fun execute (Lorg/gradle/workers/WorkQueue;)V
-	public final fun getOutput ()Lorg/gradle/api/provider/Provider;
+	protected fun handleResultSummary (Lcom/ncorti/ktfmt/gradle/util/KtfmtResultSummary;)V
 }
 
 public abstract class com/ncorti/ktfmt/gradle/tasks/KtfmtFormatTask : com/ncorti/ktfmt/gradle/tasks/KtfmtBaseTask {
-	protected fun execute (Lorg/gradle/workers/WorkQueue;)V
+	protected fun handleResultSummary (Lcom/ncorti/ktfmt/gradle/util/KtfmtResultSummary;)V
+}
+
+public final class com/ncorti/ktfmt/gradle/util/KtfmtResultSummary {
+	public fun <init> (Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;)V
+	public final fun component1 ()Ljava/util/List;
+	public final fun component2 ()Ljava/util/List;
+	public final fun component3 ()Ljava/util/List;
+	public final fun component4 ()Ljava/util/List;
+	public final fun copy (Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;)Lcom/ncorti/ktfmt/gradle/util/KtfmtResultSummary;
+	public static synthetic fun copy$default (Lcom/ncorti/ktfmt/gradle/util/KtfmtResultSummary;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;ILjava/lang/Object;)Lcom/ncorti/ktfmt/gradle/util/KtfmtResultSummary;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getFailedFiles ()Ljava/util/List;
+	public final fun getInvalidFormattedFiles ()Ljava/util/List;
+	public final fun getSkippedFiles ()Ljava/util/List;
+	public final fun getValidFormattedFiles ()Ljava/util/List;
+	public fun hashCode ()I
+	public final fun prettyPrint ()Ljava/lang/String;
+	public fun toString ()Ljava/lang/String;
 }