refactor(plugins-api)!: Make PluginDescriptor.id the first argument

The unique `id` of a plugin is the most important property in the `PluginDescriptor`, so move it to the first place. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
oss-review-toolkit · Sep 2, 2024 · d782466 · d782466
1 parent d15eaa1
commit d782466
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/advisor/src/test/kotlin/AdvisorTest.kt b/advisor/src/test/kotlin/AdvisorTest.kt
@@ -148,7 +148,7 @@ private fun createPackage(index: Int): Package =
 
 private fun mockkAdviceProvider(): AdviceProvider =
     mockk<AdviceProvider>().apply {
-        every { descriptor } returns PluginDescriptor("provider", "Provider", "", emptyList())
+        every { descriptor } returns PluginDescriptor("Provider", "provider", "", emptyList())
     }
 
 private fun mockkAdvisorResult(): AdvisorResult =

diff --git a/plugins/api/src/main/kotlin/PluginDescriptor.kt b/plugins/api/src/main/kotlin/PluginDescriptor.kt
@@ -24,14 +24,14 @@ package org.ossreviewtoolkit.plugins.api
  */
 data class PluginDescriptor(
     /**
-     * The display name of the plugin.
+     * The name of the plugin class. Must be unique among all plugins for the same factory class.
      */
-    val displayName: String,
+    val id: String,
 
     /**
-     * The name of the plugin class. Must be unique among all plugins for the same factory class.
+     * The display name of the plugin.
      */
-    val id: String,
+    val displayName: String,
 
     /**
      * The description of the plugin.

diff --git a/plugins/compiler/src/main/kotlin/JsonSpecGenerator.kt b/plugins/compiler/src/main/kotlin/JsonSpecGenerator.kt
@@ -40,8 +40,8 @@ class JsonSpecGenerator(private val codeGenerator: CodeGenerator) {
     fun generate(pluginSpec: PluginSpec) {
         val jsonObject = buildJsonObject {
             putJsonObject("descriptor") {
-                put("displayName", pluginSpec.descriptor.displayName)
                 put("id", pluginSpec.descriptor.id)
+                put("displayName", pluginSpec.descriptor.displayName)
                 put("description", pluginSpec.descriptor.description)
 
                 putJsonArray("options") {

diff --git a/plugins/compiler/src/main/kotlin/PluginFactoryGenerator.kt b/plugins/compiler/src/main/kotlin/PluginFactoryGenerator.kt
@@ -148,14 +148,14 @@ class PluginFactoryGenerator(private val codeGenerator: CodeGenerator) {
             add(
                 """
                 PluginDescriptor(
-                    displayName = %S,
                     id = %S,
+                    displayName = %S,
                     description = %S,
                     options = listOf(
             
                 """.trimIndent(),
-                descriptor.displayName,
                 descriptor.id,
+                descriptor.displayName,
                 descriptor.description
             )
 

diff --git a/plugins/compiler/src/main/kotlin/PluginSpecFactory.kt b/plugins/compiler/src/main/kotlin/PluginSpecFactory.kt
@@ -63,8 +63,8 @@ class PluginSpecFactory {
         return PluginSpec(
             containingFile = pluginClass.containingFile,
             descriptor = PluginDescriptor(
-                displayName = ortPlugin.name,
                 id = pluginClass.simpleName.asString(),
+                displayName = ortPlugin.name,
                 description = ortPlugin.description,
                 options = pluginOptions
             ),