Allow warnings because we use phpdoc

phpDocumentor · Feb 18, 2024 · 403a325 · 403a325
1 parent 7a65053
commit 403a325
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 4 deletions.
diff --git a/resources/schema/guides.xsd b/resources/schema/guides.xsd
@@ -24,6 +24,7 @@
         <xsd:attribute name="input-format" type="xsd:string"/>
         <xsd:attribute name="log-path" type="xsd:string"/>
         <xsd:attribute name="fail-on-log" type="xsd:string"/>
+        <xsd:attribute name="fail-on-error" type="xsd:string"/>
         <xsd:attribute name="show-progress" type="xsd:string"/>
         <xsd:attribute name="theme" type="xsd:string"/>
         <xsd:attribute name="default-code-language" type="xsd:string"/>

diff --git a/src/Command/Run.php b/src/Command/Run.php
@@ -40,6 +40,7 @@
 use phpDocumentor\Guides\Settings\SettingsManager;
 use phpDocumentor\Guides\Twig\Theme\ThemeManager;
 use Psr\Clock\ClockInterface;
+use Psr\Log\LogLevel;
 use RuntimeException;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\ProgressBar;
@@ -117,6 +118,13 @@ public function __construct(
             'If set, returns a non-zero exit code as soon as any warnings/errors occur',
         );
 
+        $this->addOption(
+            'fail-on-error',
+            null,
+            InputOption::VALUE_NONE,
+            'If set, returns a non-zero exit code as soon as any errors occur',
+        );
+
         $this->addOption(
             'theme',
             null,
@@ -240,8 +248,12 @@ private function getSettingsOverriddenWithInput(InputInterface $input): ProjectS
             $settings->setLogPath((string) $input->getOption('log-path'));
         }
 
+        if ($input->getOption('fail-on-error')) {
+            $settings->setFailOnError(LogLevel::ERROR);
+        }
+
         if ($input->getOption('fail-on-log')) {
-            $settings->setFailOnError(true);
+            $settings->setFailOnError(LogLevel::WARNING);
         }
 
         if (count($input->getOption('output-format')) > 0) {
@@ -290,7 +302,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         if ($settings->isFailOnError()) {
-            $spyProcessor = new SpyProcessor();
+            $spyProcessor = new SpyProcessor($settings->getFailOnError());
             $this->logger->pushProcessor($spyProcessor);
         }
 

diff --git a/src/Logger/SpyProcessor.php b/src/Logger/SpyProcessor.php
@@ -15,6 +15,9 @@
 
 use Monolog\LogRecord;
 use Monolog\Processor\ProcessorInterface;
+use Psr\Log\LogLevel;
+
+use function strtolower;
 
 /**
  * This decorator has an extra method to check whether anything was logged
@@ -25,14 +28,20 @@ final class SpyProcessor implements ProcessorInterface
 {
     private bool $hasBeenCalled = false;
 
+    public function __construct(private string|null $level = LogLevel::WARNING)
+    {
+    }
+
     public function hasBeenCalled(): bool
     {
         return $this->hasBeenCalled;
     }
 
     public function __invoke(array|LogRecord $record): array|LogRecord
     {
-        $this->hasBeenCalled = true;
+        if (strtolower($record['level_name']) === $this->level) {
+            $this->hasBeenCalled = true;
+        }
 
         return $record;
     }

diff --git a/tests/unit/Logger/SpyProcessorTest.php b/tests/unit/Logger/SpyProcessorTest.php
@@ -27,7 +27,7 @@ public function testHasBeenCalledReturnsFalseByDefault(): void
     public function testItKnowsWhenALogIsEmitted(): void
     {
         $process = new SpyProcessor();
-        $process(['channel' => 'test']);
+        $process(['channel' => 'test', 'level_name' => 'warning']);
         self::assertTrue($process->hasBeenCalled());
     }
 }