[Yaml][Lint] Add line numbers to JSON output. #23294
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Sounds good to me. |
xabbuh
reviewed
Jun 26, 2017
| @@ -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()); | |||
There was a problem hiding this comment.
getParsedLine() can return -1. Should we add special handling for that case?
There was a problem hiding this comment.
Yes I've noticed that while working with this. I want to research it a little more because the message will have a line number sometimes, so I will try to find out why it is not returning for getParsedLine().
There was a problem hiding this comment.
IMO, displaying the line number here all the time is fine. For cases having -1, the right handling would be to give them the right line number if we can
There was a problem hiding this comment.
I've added getLastLineNumberBeforeDeprecation to get the last line read before the deprecation was triggered. Do you think this is the way to go? The only other way I see to get line numbers from these trigger_error is by adding them into the $error_msg and parse them out.. But this seems clearer even though not perfect (it's a very specific method). Maybe you think we should make getRealCurrentLineNb public?
stof
approved these changes
Jun 26, 2017
fabpot
requested changes
Jun 29, 2017
| @@ -75,6 +75,14 @@ public function parse($value, $flags = 0) | |||
| return $data; | |||
| } | |||
|
|
|||
| /** | |||
| * @return int | |||
There was a problem hiding this comment.
I would tag this with @internal.
There was a problem hiding this comment.
👍 fixed. I've also added the line number to the Twig Lint output.
fabpot
approved these changes
Jun 29, 2017
|
Thank you @WybrenKoelmans. |
fabpot
added a commit
that referenced
this pull request
Jun 29, 2017
…oelmans)
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.
xabbuh
pushed a commit
to xabbuh/symfony
that referenced
this pull request
Jun 30, 2017
…WybrenKoelmans)
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.
fabpot
added a commit
that referenced
this pull request
Jun 30, 2017
This PR was merged into the 3.4 branch. Discussion ---------- [Yaml] fix the displayed line number | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #23294 | License | MIT | Doc PR | First, this PR backports #23294 to the `3.4` branch. Secondly, `getRealCurrentLineNb()` returns line numbers index by 0 (as they serve as array indexes internally). I removed the `getLastLineNumberBeforeDeprecation()` method added in #23294 as we can just expose the already existing `getRealCurrentLineNb()` method. Commits ------- a2ae6bf [Yaml] fix the displayed line number 1baac5a feature #23294 [Yaml][Lint] Add line numbers to JSON output. (WybrenKoelmans)
fabpot
added a commit
that referenced
this pull request
Jun 30, 2017
* 3.4: [Yaml] fix the displayed line number feature #23294 [Yaml][Lint] Add line numbers to JSON output. (WybrenKoelmans)
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Before: