chore(commands): Tweak plugin display names

sschuberth · sschuberth · commit 46c7f94bcf8a · 2025-04-18T08:47:14.000+02:00
Capitalize them and make longer names more readable.

Signed-off-by: Sebastian Schuberth &lt;sebastian@doubleopen.org&gt;
diff --git a/plugins/commands/advisor/src/main/kotlin/AdviseCommand.kt b/plugins/commands/advisor/src/main/kotlin/AdviseCommand.kt
@@ -62,7 +62,7 @@ import org.ossreviewtoolkit.utils.ort.ortConfigDirectory
 
 @OrtPlugin(
     id = "advise",
-    displayName = "advise",
+    displayName = "Advise",
     description = "Check dependencies for security vulnerabilities.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/analyzer/src/main/kotlin/AnalyzeCommand.kt b/plugins/commands/analyzer/src/main/kotlin/AnalyzeCommand.kt
@@ -67,7 +67,7 @@ import org.ossreviewtoolkit.utils.ort.ortConfigDirectory
 
 @OrtPlugin(
     id = "analyze",
-    displayName = "analyze",
+    displayName = "Analyze",
     description = "Determine dependencies of a software project.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/compare/src/main/kotlin/CompareCommand.kt b/plugins/commands/compare/src/main/kotlin/CompareCommand.kt
@@ -53,7 +53,7 @@ import org.ossreviewtoolkit.utils.ort.Environment
 
 @OrtPlugin(
     id = "compare",
-    displayName = "compare",
+    displayName = "Compare",
     description = "Compare two ORT results with various methods.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/config/src/main/kotlin/ConfigCommand.kt b/plugins/commands/config/src/main/kotlin/ConfigCommand.kt
@@ -40,7 +40,7 @@ import org.ossreviewtoolkit.utils.ort.ORT_REFERENCE_CONFIG_FILENAME
 
 @OrtPlugin(
     id = "config",
-    displayName = "config",
+    displayName = "Config",
     description = "Show different ORT configurations.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/downloader/src/main/kotlin/DownloadCommand.kt b/plugins/commands/downloader/src/main/kotlin/DownloadCommand.kt
@@ -108,7 +108,7 @@ import org.ossreviewtoolkit.utils.spdx.SpdxLicenseChoice
 
 @OrtPlugin(
     id = "download",
-    displayName = "download",
+    displayName = "Download",
     description = "Fetch source code from a remote location.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/evaluator/src/main/kotlin/EvaluateCommand.kt b/plugins/commands/evaluator/src/main/kotlin/EvaluateCommand.kt
@@ -86,7 +86,7 @@ import org.ossreviewtoolkit.utils.ort.ortConfigDirectory
 
 @OrtPlugin(
     id = "evaluate",
-    displayName = "evaluate",
+    displayName = "Evaluate",
     description = "Evaluate ORT result files against policy rules.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/migrate/src/main/kotlin/MigrateCommand.kt b/plugins/commands/migrate/src/main/kotlin/MigrateCommand.kt
@@ -45,7 +45,7 @@ import org.ossreviewtoolkit.utils.common.safeMkdirs
 
 @OrtPlugin(
     id = "migrate",
-    displayName = "migrate",
+    displayName = "Migrate",
     description = "Assist with migrating ORT configuration to newer ORT versions.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/notifier/src/main/kotlin/NotifyCommand.kt b/plugins/commands/notifier/src/main/kotlin/NotifyCommand.kt
@@ -44,7 +44,7 @@ import org.ossreviewtoolkit.utils.ort.ortConfigDirectory
 
 @OrtPlugin(
     id = "notify",
-    displayName = "notify",
+    displayName = "Notify",
     description = "Create notifications based on an ORT result.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/plugins/src/main/kotlin/PluginsCommand.kt b/plugins/commands/plugins/src/main/kotlin/PluginsCommand.kt
@@ -39,7 +39,7 @@ import org.ossreviewtoolkit.scanner.ScannerWrapperFactory
 
 @OrtPlugin(
     id = "plugins",
-    displayName = "plugins",
+    displayName = "Plugins",
     description = "Print information about the installed ORT plugins.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/reporter/src/main/kotlin/ReportCommand.kt b/plugins/commands/reporter/src/main/kotlin/ReportCommand.kt
@@ -86,7 +86,7 @@ import org.ossreviewtoolkit.utils.spdx.SpdxConstants.LICENSE_REF_PREFIX
 
 @OrtPlugin(
     id = "report",
-    displayName = "report",
+    displayName = "Report",
     description = "Present Analyzer, Scanner and Evaluator results in various formats.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/requirements/src/main/kotlin/RequirementsCommand.kt b/plugins/commands/requirements/src/main/kotlin/RequirementsCommand.kt
@@ -50,7 +50,7 @@ private val SUCCESS_PREFIX = "\t${Theme.Default.success("*")} "
 
 @OrtPlugin(
     id = "requirements",
-    displayName = "requirements",
+    displayName = "Requirements",
     description = "Check for the command line tools required by ORT.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/scanner/src/main/kotlin/ScanCommand.kt b/plugins/commands/scanner/src/main/kotlin/ScanCommand.kt
@@ -76,7 +76,7 @@ import org.ossreviewtoolkit.utils.ort.ortConfigDirectory
 
 @OrtPlugin(
     id = "scan",
-    displayName = "scan",
+    displayName = "Scan",
     description = "Run external license / copyright scanners.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/upload-curations/src/main/kotlin/UploadCurationsCommand.kt b/plugins/commands/upload-curations/src/main/kotlin/UploadCurationsCommand.kt
@@ -61,7 +61,7 @@ import org.ossreviewtoolkit.utils.ort.runBlocking
 
 @OrtPlugin(
     id = "upload-curations",
-    displayName = "upload-curations",
+    displayName = "Upload Curations",
     description = "Upload ORT package curations to ClearlyDefined.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/upload-result-to-postgres/src/main/kotlin/UploadResultToPostgresCommand.kt b/plugins/commands/upload-result-to-postgres/src/main/kotlin/UploadResultToPostgresCommand.kt
@@ -52,7 +52,7 @@ import org.ossreviewtoolkit.utils.ort.showStackTrace
 
 @OrtPlugin(
     id = "upload-result-to-postgres",
-    displayName = "upload-result-to-postgres",
+    displayName = "Upload Result to Postgres",
     description = "Upload an ORT result to a PostgreSQL database.",
     factory = OrtCommandFactory::class
 )
diff --git a/plugins/commands/upload-result-to-sw360/src/main/kotlin/UploadResultToSw360Command.kt b/plugins/commands/upload-result-to-sw360/src/main/kotlin/UploadResultToSw360Command.kt
@@ -58,7 +58,7 @@ import org.ossreviewtoolkit.utils.ort.createOrtTempDir
 
 @OrtPlugin(
     id = "upload-result-to-sw360",
-    displayName = "upload-result-to-sw360",
+    displayName = "Upload Result to SW360",
     description = "Upload an ORT result to SW360.",
     factory = OrtCommandFactory::class
 )

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ import org.ossreviewtoolkit.utils.ort.ortConfigDirectory`
`62`	`62`
`63`	`63`	`@OrtPlugin(`
`64`	`64`	`id = "advise",`
`65`		`- displayName = "advise",`
	`65`	`+ displayName = "Advise",`
`66`	`66`	`description = "Check dependencies for security vulnerabilities.",`
`67`	`67`	`factory = OrtCommandFactory::class`
`68`	`68`	`)`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ import org.ossreviewtoolkit.utils.ort.ortConfigDirectory`
`67`	`67`
`68`	`68`	`@OrtPlugin(`
`69`	`69`	`id = "analyze",`
`70`		`- displayName = "analyze",`
	`70`	`+ displayName = "Analyze",`
`71`	`71`	`description = "Determine dependencies of a software project.",`
`72`	`72`	`factory = OrtCommandFactory::class`
`73`	`73`	`)`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ import org.ossreviewtoolkit.utils.ort.Environment`
`53`	`53`
`54`	`54`	`@OrtPlugin(`
`55`	`55`	`id = "compare",`
`56`		`- displayName = "compare",`
	`56`	`+ displayName = "Compare",`
`57`	`57`	`description = "Compare two ORT results with various methods.",`
`58`	`58`	`factory = OrtCommandFactory::class`
`59`	`59`	`)`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ import org.ossreviewtoolkit.utils.ort.ORT_REFERENCE_CONFIG_FILENAME`
`40`	`40`
`41`	`41`	`@OrtPlugin(`
`42`	`42`	`id = "config",`
`43`		`- displayName = "config",`
	`43`	`+ displayName = "Config",`
`44`	`44`	`description = "Show different ORT configurations.",`
`45`	`45`	`factory = OrtCommandFactory::class`
`46`	`46`	`)`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ import org.ossreviewtoolkit.utils.spdx.SpdxLicenseChoice`
`108`	`108`
`109`	`109`	`@OrtPlugin(`
`110`	`110`	`id = "download",`
`111`		`- displayName = "download",`
	`111`	`+ displayName = "Download",`
`112`	`112`	`description = "Fetch source code from a remote location.",`
`113`	`113`	`factory = OrtCommandFactory::class`
`114`	`114`	`)`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ import org.ossreviewtoolkit.utils.ort.ortConfigDirectory`
`86`	`86`
`87`	`87`	`@OrtPlugin(`
`88`	`88`	`id = "evaluate",`
`89`		`- displayName = "evaluate",`
	`89`	`+ displayName = "Evaluate",`
`90`	`90`	`description = "Evaluate ORT result files against policy rules.",`
`91`	`91`	`factory = OrtCommandFactory::class`
`92`	`92`	`)`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ import org.ossreviewtoolkit.utils.common.safeMkdirs`
`45`	`45`
`46`	`46`	`@OrtPlugin(`
`47`	`47`	`id = "migrate",`
`48`		`- displayName = "migrate",`
	`48`	`+ displayName = "Migrate",`
`49`	`49`	`description = "Assist with migrating ORT configuration to newer ORT versions.",`
`50`	`50`	`factory = OrtCommandFactory::class`
`51`	`51`	`)`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ import org.ossreviewtoolkit.utils.ort.ortConfigDirectory`
`44`	`44`
`45`	`45`	`@OrtPlugin(`
`46`	`46`	`id = "notify",`
`47`		`- displayName = "notify",`
	`47`	`+ displayName = "Notify",`
`48`	`48`	`description = "Create notifications based on an ORT result.",`
`49`	`49`	`factory = OrtCommandFactory::class`
`50`	`50`	`)`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ import org.ossreviewtoolkit.scanner.ScannerWrapperFactory`
`39`	`39`
`40`	`40`	`@OrtPlugin(`
`41`	`41`	`id = "plugins",`
`42`		`- displayName = "plugins",`
	`42`	`+ displayName = "Plugins",`
`43`	`43`	`description = "Print information about the installed ORT plugins.",`
`44`	`44`	`factory = OrtCommandFactory::class`
`45`	`45`	`)`