feature #23294 [Yaml][Lint] Add line numbers to JSON output. (WybrenKoelmans)

fabpot · fabpot · commit 09321838da83 · 2017-06-29T23:22:16.000+02:00
This PR was merged into the 4.0-dev branch. Discussion ---------- [Yaml][Lint] Add line numbers to JSON output. | Q | A | ------------- | --- | Branch? | 2.7? | Bug fix? | no? | New feature? | yes? | BC breaks? | no? | Deprecations? | no? | Tests pass? | Hopefully | Fixed tickets | n/a | License | MIT | Doc PR | TODO? - [ ] Run tests? - [ ] Check if it will break BC? - [ ] Update changelog? The JSON output is not very useful for me without the line number. I don't want to have to parse it from the message. Is this the right way of doing it? With PR: ``` [ { "file": "", "line": 13, "valid": false, "message": "Unable to parse at line 13 (near \"sdf \")." } ] ``` Before: ``` [ { "file": "", "valid": false, "message": "Unable to parse at line 13 (near \"sdf \")." } ] ``` Commits ------- c6d19b1 [Yaml][Twig][Lint] Added line numbers to JSON output.
diff --git a/src/Symfony/Bridge/Twig/Command/LintCommand.php b/src/Symfony/Bridge/Twig/Command/LintCommand.php
@@ -145,7 +145,7 @@ private function validate(Environment $twig, $template, $file)
         } catch (Error $e) {
             $twig->setLoader($realLoader);
 
-            return array('template' => $template, 'file' => $file, 'valid' => false, 'exception' => $e);
+            return array('template' => $template, 'file' => $file, 'line' => $e->getTemplateLine(), 'valid' => false, 'exception' => $e);
         }
 
         return array('template' => $template, 'file' => $file, 'valid' => true);
diff --git a/src/Symfony/Component/Yaml/Command/LintCommand.php b/src/Symfony/Component/Yaml/Command/LintCommand.php
@@ -105,7 +105,7 @@ private function validate($content, $file = null)
     {
         $prevErrorHandler = set_error_handler(function ($level, $message, $file, $line) use (&$prevErrorHandler) {
             if (E_USER_DEPRECATED === $level) {
-                throw new ParseException($message);
+                throw new ParseException($message, $this->getParser()->getLastLineNumberBeforeDeprecation());
             }
 
             return $prevErrorHandler ? $prevErrorHandler($level, $message, $file, $line) : false;
@@ -114,7 +114,7 @@ private function validate($content, $file = null)
         try {
             $this->getParser()->parse($content, Yaml::PARSE_CONSTANT);
         } catch (ParseException $e) {
-            return array('file' => $file, 'valid' => false, 'message' => $e->getMessage());
+            return array('file' => $file, 'line' => $e->getParsedLine(), 'valid' => false, 'message' => $e->getMessage());
         } finally {
             restore_error_handler();
         }
diff --git a/src/Symfony/Component/Yaml/Parser.php b/src/Symfony/Component/Yaml/Parser.php
@@ -75,6 +75,16 @@ public function parse($value, $flags = 0)
         return $data;
     }
 
+    /**
+     * @internal
+     *
+     * @return int
+     */
+    public function getLastLineNumberBeforeDeprecation()
+    {
+        return $this->getRealCurrentLineNb();
+    }
+
     private function doParse($value, $flags)
     {
         $this->currentLineNb = -1;

Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ private function validate(Environment $twig, $template, $file)`
`145`	`145`	`} catch (Error $e) {`
`146`	`146`	`$twig->setLoader($realLoader);`
`147`	`147`
`148`		`- return array('template' => $template, 'file' => $file, 'valid' => false, 'exception' => $e);`
	`148`	`+ return array('template' => $template, 'file' => $file, 'line' => $e->getTemplateLine(), 'valid' => false, 'exception' => $e);`
`149`	`149`	`}`
`150`	`150`
`151`	`151`	`return array('template' => $template, 'file' => $file, 'valid' => true);`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ private function validate($content, $file = null)`
`105`	`105`	`{`
`106`	`106`	`$prevErrorHandler = set_error_handler(function ($level, $message, $file, $line) use (&$prevErrorHandler) {`
`107`	`107`	`if (E_USER_DEPRECATED === $level) {`
`108`		`- throw new ParseException($message);`
	`108`	`+ throw new ParseException($message, $this->getParser()->getLastLineNumberBeforeDeprecation());`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`return $prevErrorHandler ? $prevErrorHandler($level, $message, $file, $line) : false;`
`@@ -114,7 +114,7 @@ private function validate($content, $file = null)`
`114`	`114`	`try {`
`115`	`115`	`$this->getParser()->parse($content, Yaml::PARSE_CONSTANT);`
`116`	`116`	`} catch (ParseException $e) {`
`117`		`- return array('file' => $file, 'valid' => false, 'message' => $e->getMessage());`
	`117`	`+ return array('file' => $file, 'line' => $e->getParsedLine(), 'valid' => false, 'message' => $e->getMessage());`
`118`	`118`	`} finally {`
`119`	`119`	`restore_error_handler();`
`120`	`120`	`}`