🚸 Format CI messages for more visibility

Author: tiulpin

platform/env.go

@@ -55,7 +55,6 @@ const (
 
 // ExtractQodanaEnvironment extracts Qodana environment variables from the current environment.
 func ExtractQodanaEnvironment(setEnvironmentFunc func(string, string)) {
-	ci := cienvironment.DetectCIEnvironment()
 	if license := os.Getenv(QodanaLicense); license != "" {
 		setEnvironmentFunc(QodanaLicense, license)
 	}
@@ -68,9 +67,10 @@ func ExtractQodanaEnvironment(setEnvironmentFunc func(string, string)) {
 	if revision := os.Getenv(QodanaRevision); revision != "" {
 		setEnvironmentFunc(QodanaRevision, revision)
 	}
+	ci := cienvironment.DetectCIEnvironment()
 	qEnv := "cli"
 	if ci != nil {
-		qEnv = strings.ReplaceAll(strings.ToLower(ci.Name), " ", "-")
+		qEnv = getCIName(ci)
 		setEnvironmentFunc(qodanaJobUrl, validateJobUrl(ci.URL, qEnv))
 		if ci.Git != nil {
 			setEnvironmentFunc(QodanaRemoteUrl, validateRemoteUrl(ci.Git.Remote, qEnv))
@@ -94,6 +94,10 @@ func ExtractQodanaEnvironment(setEnvironmentFunc func(string, string)) {
 	setEnvironmentFunc(qodanaEnv, fmt.Sprintf("%s:%s", qEnv, Version))
 }
 
+func getCIName(ci *cienvironment.CiEnvironment) string {
+	return strings.ReplaceAll(strings.ToLower(ci.Name), " ", "-")
+}
+
 func validateRemoteUrl(remote string, qEnv string) string {
 	if strings.HasPrefix(qEnv, "space") {
 		return getSpaceRemoteUrl()

platform/output.go

@@ -19,6 +19,7 @@ package platform
 import (
 	"fmt"
 	"github.com/JetBrains/qodana-cli/v2024/sarif"
+	cienvironment "github.com/cucumber/ci-environment/go"
 	"os"
 	"strings"
 
@@ -108,14 +109,14 @@ func SuccessMessage(message string, a ...interface{}) {
 func WarningMessage(message string, a ...interface{}) {
 	message = fmt.Sprintf(message, a...)
 	icon := warningStyle.Sprint("\n! ")
-	pterm.Println(icon, Primary(message))
+	pterm.Println(formatMessageForCI(icon, Primary(message)))
 }
 
 // ErrorMessage prints an error message with the icon.
 func ErrorMessage(message string, a ...interface{}) {
 	message = fmt.Sprintf(message, a...)
 	icon := errorStyle.Sprint("✗ ")
-	pterm.Println(icon, errorStyle.Sprint(message))
+	pterm.Println(formatMessageForCI(icon, errorStyle.Sprint(message)))
 }
 
 // PrintLinterLog prints the linter logs with color, when needed.
@@ -277,3 +278,18 @@ func getProblemsFoundMessage(newProblems int) string {
 		return fmt.Sprintf("Found %d new problems according to the checks applied", newProblems)
 	}
 }
+
+// formatMessageForCI formats the message for the CI environment.
+func formatMessageForCI(level, format string, a ...interface{}) string {
+	message := fmt.Sprintf(format, a...)
+	ci := cienvironment.DetectCIEnvironment()
+	name := getCIName(ci)
+	if name == "github-actions" {
+		return fmt.Sprintf("::%s::%s", level, message)
+	} else if strings.HasPrefix(name, "azure") {
+		return fmt.Sprintf("##vso[task.logissue type=%s]%s", level, message)
+	} else if strings.HasPrefix(name, "circleci") {
+		return fmt.Sprintf("echo '%s: %s'", level, message)
+	}
+	return message
+}