Added support for Github output

doctrine · Apr 26, 2021 · 0282b66 · 0282b66
1 parent 13d640c
commit 0282b66
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 3 deletions.
diff --git a/lib/Configuration.php b/lib/Configuration.php
@@ -28,6 +28,8 @@
 class Configuration
 {
     public const THEME_DEFAULT = 'default';
+    public const OUTPUT_FORMAT_CONSOLE = 'console';
+    public const OUTPUT_FORMAT_GITHUB = 'github';
 
     /** @var string */
     private $cacheDir;
@@ -52,6 +54,9 @@ class Configuration
 
     /** @var bool */
     private $warningsAsError = false;
+
+    /** @var string */
+    private $outputFormat = self::OUTPUT_FORMAT_CONSOLE;
 
     /** @var bool */
     private $ignoreInvalidReferences = false;
@@ -227,6 +232,16 @@ public function isWarningsAsError(): bool
         return $this->warningsAsError;
     }
 
+    public function getOutputFormat(): string
+    {
+        return $this->outputFormat;
+    }
+
+    public function setOutputFormat(string $outputFormat): void
+    {
+        $this->outputFormat = $outputFormat;
+    }
+
     public function getIgnoreInvalidReferences(): bool
     {
         return $this->ignoreInvalidReferences;

diff --git a/lib/Error.php b/lib/Error.php
@@ -33,7 +33,7 @@ public function __construct(string $message, ?string $file = null, ?int $line =
     public function asString(): string
     {
         $output = $this->message;
-        if ($this->file !== null && $this->file !== '') {
+        if ($this->getFile() !== null) {
             $output .= sprintf(' in "%s"', $this->file);
 
             if ($this->line !== null) {
@@ -51,6 +51,10 @@ public function getMessage(): string
 
     public function getFile(): ?string
     {
+        if ('' === $this->file) {
+            return null;
+        }
+
         return $this->file;
     }
 

diff --git a/lib/ErrorManager.php b/lib/ErrorManager.php
@@ -25,7 +25,17 @@ public function addError(string $message, ?string $file = null, ?int $line = nul
         $this->errors[] = $error = new Error($message, $file, $line, $throwable);
 
         if (! $this->configuration->isSilentOnError()) {
-            echo '⚠️ ' . $error->__toString() . "\n";
+            if ($this->configuration->getOutputFormat() === Configuration::OUTPUT_FORMAT_GITHUB) {
+                $file = $error->getFile();
+                echo sprintf(
+                    '::error %s%s::%s',
+                    $file !== null ? 'file='.$file : '',
+                    $file !== null && $error->getLine() !== null ? ',linefile='.$error->getLine() : '',
+                    $error->getMessage()
+                );
+            } else {
+                echo '⚠️ ' . $error->__toString() . "\n";
+            }
         }
 
         if ($this->configuration->isAbortOnError()) {
@@ -45,7 +55,18 @@ public function addWarning(string $message, ?string $file = null, ?int $line = n
             return;
         }
 
-        echo (new Error($message, $file, $line, $throwable))->asString() . "\n";
+        $error = new Error($message, $file, $line, $throwable);
+        if ($this->configuration->getOutputFormat() === Configuration::OUTPUT_FORMAT_GITHUB) {
+            $file = $error->getFile();
+            echo sprintf(
+                '::warning %s%s::%s',
+                $file !== null ? 'file='.$file : '',
+                $file !== null && $error->getLine() !== null ? ',linefile='.$error->getLine() : '',
+                $error->getMessage()
+            );
+        } else {
+            echo ($error)->asString() . "\n";
+        }
     }
 
     /**