Allow warnings because we use phpdoc

Author: jaapio

.github/workflows/documentation.yml

@@ -37,4 +37,4 @@ jobs:
           dependency-versions: "highest"
 
       - name: "Run guides-cli"
-        run: "vendor/bin/guides -vvv --no-progress docs --output='/tmp/test' --fail-on-log"
+        run: "vendor/bin/guides -vvv --no-progress docs --output='/tmp/test' --fail-on-error"

Makefile

@@ -48,7 +48,7 @@ test-xml: ## Lint all guides.xml
 
 .PHONY: test-docs
 test-docs: ## Generate projects docs without warnings
-	$(PHP_BIN) vendor/bin/guides -vvv --no-progress docs --output="/tmp/test" --fail-on-log
+	$(PHP_BIN) vendor/bin/guides -vvv --no-progress docs --output="/tmp/test" --fail-on-error
 
 .PHONY: cleanup
 cleanup: cleanup-tests cleanup-build cleanup-cache

packages/guides-cli/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"/>

packages/guides-cli/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);
         }
 

packages/guides-cli/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;
     }

packages/guides-cli/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());
     }
 }

packages/guides/src/DependencyInjection/GuidesExtension.php

@@ -21,6 +21,7 @@
 use phpDocumentor\Guides\Settings\SettingsManager;
 use phpDocumentor\Guides\Twig\Theme\ThemeConfig;
 use phpDocumentor\Guides\Twig\Theme\ThemeManager;
+use Psr\Log\LogLevel;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
@@ -105,6 +106,7 @@ static function ($value) {
                 ->end()
                 ->scalarNode('log_path')->end()
                 ->scalarNode('fail_on_log')->end()
+                ->scalarNode('fail_on_error')->end()
                 ->scalarNode('show_progress')->end()
                 ->scalarNode('links_are_relative')->end()
                 ->scalarNode('max_menu_depth')->end()
@@ -223,8 +225,12 @@ public function load(array $configs, ContainerBuilder $container): void
             $projectSettings->setShowProgressBar((bool) $config['show_progress']);
         }
 
+        if (isset($config['fail_on_error'])) {
+            $projectSettings->setFailOnError(LogLevel::ERROR);
+        }
+
         if (isset($config['fail_on_log'])) {
-            $projectSettings->setFailOnError((bool) $config['show_progress']);
+            $projectSettings->setFailOnError(LogLevel::WARNING);
         }
 
         if (isset($config['max_menu_depth'])) {

packages/guides/src/Settings/ProjectSettings.php

@@ -29,7 +29,7 @@ final class ProjectSettings
     /** @var string[]  */
     private array $outputFormats = ['html'];
     private string $logPath = 'php://stder';
-    private bool $failOnError = false;
+    private string|null $failOnError = null;
     private bool $showProgressBar = true;
     private bool $linksRelative = false;
     private string $defaultCodeLanguage = '';
@@ -118,13 +118,18 @@ public function setLogPath(string $logPath): void
     }
 
     public function isFailOnError(): bool
+    {
+        return $this->failOnError !== null;
+    }
+
+    public function getFailOnError(): string|null
     {
         return $this->failOnError;
     }
 
-    public function setFailOnError(bool $failOnError): void
+    public function setFailOnError(string $logLevel): void
     {
-        $this->failOnError = $failOnError;
+        $this->failOnError = $logLevel;
     }
 
     public function isShowProgressBar(): bool