[TASK] Improve warnings to contain line numbers. (#29)

This was previously not possible due to a bug in the directive
TYPO3-Documentation · Dec 13, 2023 · bed620c · bed620c
1 parent e92c96e
commit bed620c
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 24 deletions.
diff --git a/src/Directives/Php/ClassDirective.php b/src/Directives/Php/ClassDirective.php
@@ -53,7 +53,7 @@ protected function processSub(
         $modifiers = $this->modifierService->getModifiersFromDirectiveOptions($directive, $this->allowedModifiers);
 
         if ($directive->hasOption('abstract') && $directive->hasOption('final')) {
-            $this->logger->warning('A PHP class cannot be abstract and final at the same time.', $blockContext->getDocumentParserContext()->getLoggerInformation());
+            $this->logger->warning('A PHP class cannot be abstract and final at the same time.', $blockContext->getLoggerInformation());
         }
 
         return new PhpClassNode(

diff --git a/src/Directives/Php/ConstDirective.php b/src/Directives/Php/ConstDirective.php
@@ -57,7 +57,7 @@ protected function processSub(
 
         foreach ($this->illegalCombinations as $combination) {
             if ($directive->hasOption($combination[0]) && $directive->hasOption($combination[1])) {
-                $this->logger->warning(sprintf('A PHP constant cannot be %s and %s at the same time.', $combination[0], $combination[1]), $blockContext->getDocumentParserContext()->getLoggerInformation());
+                $this->logger->warning(sprintf('A PHP constant cannot be %s and %s at the same time.', $combination[0], $combination[1]), $blockContext->getLoggerInformation());
             }
         }
 

diff --git a/src/Directives/Php/EnumDirective.php b/src/Directives/Php/EnumDirective.php
@@ -45,7 +45,7 @@ protected function processSub(
         if (str_contains($name, ':')) {
             [$name, $type] = explode(':', $name, 2);
             $type = trim($type);
-            $this->logger->warning('Passing the type of a backed enum directly with the name is deprecated. Use option :type: instead.', $blockContext->getDocumentParserContext()->getLoggerInformation());
+            $this->logger->warning('Passing the type of a backed enum directly with the name is deprecated. Use option :type: instead.', $blockContext->getLoggerInformation());
         }
 
         $fqn = $this->fullyQualifiedNameService->getFullyQualifiedName(trim($name), true);
@@ -54,7 +54,7 @@ protected function processSub(
 
         if ($directive->hasOption('type')) {
             if ($type != null) {
-                $this->logger->warning('The type of the backed enum was set twice. The type from the option will be prefered.', $blockContext->getDocumentParserContext()->getLoggerInformation());
+                $this->logger->warning('The type of the backed enum was set twice. The type from the option will be prefered.', $blockContext->getLoggerInformation());
             }
             $type = $directive->getOption('type')->toString();
         }

diff --git a/src/Directives/Php/ExceptionDirective.php b/src/Directives/Php/ExceptionDirective.php
@@ -54,7 +54,7 @@ protected function processSub(
         $modifiers = $this->modifierService->getModifiersFromDirectiveOptions($directive, $this->allowedModifiers);
 
         if ($directive->hasOption('abstract') && $directive->hasOption('final')) {
-            $this->logger->warning('A PHP class cannot be abstract and final at the same time.', $blockContext->getDocumentParserContext()->getLoggerInformation());
+            $this->logger->warning('A PHP class cannot be abstract and final at the same time.', $blockContext->getLoggerInformation());
         }
 
         return new PhpExceptionNode(

diff --git a/src/Directives/Php/MethodDirective.php b/src/Directives/Php/MethodDirective.php
@@ -91,9 +91,9 @@ private function extractReturnDescriptionFromFieldListItem(?CollectionNode $retu
 
                                 ..  :php:method:: %s
                                     :returns: Your Description
-                                ", $name), $blockContext->getDocumentParserContext()->getLoggerInformation());
+                                ", $name), $blockContext->getLoggerInformation());
         } else {
-            $this->logger->warning(sprintf('The return description of method %s has been given multiple times', $name), $blockContext->getDocumentParserContext()->getLoggerInformation());
+            $this->logger->warning(sprintf('The return description of method %s has been given multiple times', $name), $blockContext->getLoggerInformation());
         }
         return $returnInlineNode;
     }
@@ -110,7 +110,7 @@ protected function processSub(
 
         foreach ($this->illegalCombinations as $combination) {
             if ($directive->hasOption($combination[0]) && $directive->hasOption($combination[1])) {
-                $this->logger->warning(sprintf('A PHP method cannot be %s and %s at the same time.', $combination[0], $combination[1]), $blockContext->getDocumentParserContext()->getLoggerInformation());
+                $this->logger->warning(sprintf('A PHP method cannot be %s and %s at the same time.', $combination[0], $combination[1]), $blockContext->getLoggerInformation());
             }
         }
 

diff --git a/src/Directives/Php/PropertyDirective.php b/src/Directives/Php/PropertyDirective.php
@@ -67,12 +67,12 @@ protected function processSub(
         $modifiers = $this->modifierService->getModifiersFromDirectiveOptions($directive, $this->allowedModifiers);
 
         if ($directive->getName() !== 'php:property') {
-            $this->logger->warning(sprintf('Using directive `%s` is deprecated, use directive `php:property` instead.', $directive->getName()), $blockContext->getDocumentParserContext()->getLoggerInformation());
+            $this->logger->warning(sprintf('Using directive `%s` is deprecated, use directive `php:property` instead.', $directive->getName()), $blockContext->getLoggerInformation());
         }
 
         foreach ($this->illegalCombinations as $combination) {
             if ($directive->hasOption($combination[0]) && $directive->hasOption($combination[1])) {
-                $this->logger->warning(sprintf('A PHP property cannot be %s and %s at the same time.', $combination[0], $combination[1]), $blockContext->getDocumentParserContext()->getLoggerInformation());
+                $this->logger->warning(sprintf('A PHP property cannot be %s and %s at the same time.', $combination[0], $combination[1]), $blockContext->getLoggerInformation());
             }
         }
         $type = null;

diff --git a/src/Directives/Php/StaticMethodDirective.php b/src/Directives/Php/StaticMethodDirective.php
@@ -42,7 +42,7 @@ protected function processSub(
     ): Node|null {
         $this->logger->warning(
             'Directive `.. php:staticmethod::` is deprecated use directive `.. php:method::` with option `:static:` instead. ',
-            $blockContext->getDocumentParserContext()->getLoggerInformation()
+            $blockContext->getLoggerInformation()
         );
         $name = $this->methodNameService->getMethodName(trim($directive->getData()));
         $id = $this->anchorReducer->reduceAnchor($name->toString());

diff --git a/tests/integration/class-with-const-illegal-modifier-combinations/expected/logs/warning.log b/tests/integration/class-with-const-illegal-modifier-combinations/expected/logs/warning.log
@@ -1,3 +1,3 @@
-app.WARNING: A PHP constant cannot be private and public at the same time. {"rst-file":"index.rst"} []
-app.WARNING: A PHP constant cannot be protected and public at the same time. {"rst-file":"index.rst"} []
-app.WARNING: A PHP constant cannot be private and protected at the same time. {"rst-file":"index.rst"} []
+app.WARNING: A PHP constant cannot be private and public at the same time. {"rst-file":"index.rst","currentLineNumber":9} []
+app.WARNING: A PHP constant cannot be protected and public at the same time. {"rst-file":"index.rst","currentLineNumber":16} []
+app.WARNING: A PHP constant cannot be private and protected at the same time. {"rst-file":"index.rst","currentLineNumber":22} []
diff --git a/tests/integration/class-with-staticmethod/expected/logs/warning.log b/tests/integration/class-with-staticmethod/expected/logs/warning.log
@@ -1 +1 @@
-app.WARNING: Directive `.. php:staticmethod::` is deprecated use directive `.. php:method::` with option `:static:` instead.  {"rst-file":"index.rst"} []
+app.WARNING: Directive `.. php:staticmethod::` is deprecated use directive `.. php:method::` with option `:static:` instead.  {"rst-file":"index.rst","currentLineNumber":5} []
diff --git a/tests/integration/enum-with-warnings/expected/logs/warning.log b/tests/integration/enum-with-warnings/expected/logs/warning.log
@@ -1,3 +1,3 @@
-app.WARNING: Passing the type of a backed enum directly with the name is deprecated. Use option :type: instead. {"rst-file":"index.rst"} []
-app.WARNING: The type of the backed enum was set twice. The type from the option will be prefered. {"rst-file":"index.rst"} []
-app.WARNING: Passing the type of a backed enum directly with the name is deprecated. Use option :type: instead. {"rst-file":"index.rst"} []
+app.WARNING: Passing the type of a backed enum directly with the name is deprecated. Use option :type: instead. {"rst-file":"index.rst","currentLineNumber":21} []
+app.WARNING: The type of the backed enum was set twice. The type from the option will be prefered. {"rst-file":"index.rst","currentLineNumber":21} []
+app.WARNING: Passing the type of a backed enum directly with the name is deprecated. Use option :type: instead. {"rst-file":"index.rst","currentLineNumber":30} []
diff --git a/tests/integration/method-illegal-combinations/expected/logs/warning.log b/tests/integration/method-illegal-combinations/expected/logs/warning.log
@@ -1,5 +1,5 @@
-app.WARNING: A PHP method cannot be final and abstract at the same time. {"rst-file":"index.rst"} []
-app.WARNING: A PHP method cannot be protected and public at the same time. {"rst-file":"index.rst"} []
-app.WARNING: A PHP method cannot be private and public at the same time. {"rst-file":"index.rst"} []
-app.WARNING: A PHP method cannot be private and protected at the same time. {"rst-file":"index.rst"} []
-app.WARNING: A PHP method cannot be private and abstract at the same time. {"rst-file":"index.rst"} []
+app.WARNING: A PHP method cannot be final and abstract at the same time. {"rst-file":"index.rst","currentLineNumber":10} []
+app.WARNING: A PHP method cannot be protected and public at the same time. {"rst-file":"index.rst","currentLineNumber":16} []
+app.WARNING: A PHP method cannot be private and public at the same time. {"rst-file":"index.rst","currentLineNumber":22} []
+app.WARNING: A PHP method cannot be private and protected at the same time. {"rst-file":"index.rst","currentLineNumber":28} []
+app.WARNING: A PHP method cannot be private and abstract at the same time. {"rst-file":"index.rst","currentLineNumber":33} []
diff --git a/tests/integration/static-method/expected/logs/warning.log b/tests/integration/static-method/expected/logs/warning.log
@@ -1 +1 @@
-app.WARNING: Directive `.. php:staticmethod::` is deprecated use directive `.. php:method::` with option `:static:` instead.  {"rst-file":"index.rst"} []
+app.WARNING: Directive `.. php:staticmethod::` is deprecated use directive `.. php:method::` with option `:static:` instead.  {"rst-file":"index.rst","currentLineNumber":7} []