Skip to content

Fix formatter spacing for JSON path operators (->, ->>) #637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
williamdes merged 2 commits into from
Apr 1, 2026
Merged

Fix formatter spacing for JSON path operators (->, ->>) #637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a7c59a
Fix formatter spacing for JSON path operators (->, ->>)
Sea-n Jan 21, 2026
caf6693
Merge #637 - Fix formatter spacing for JSON path operators (->, ->>)
williamdes Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/Context.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,8 @@ abstract class Context
')' => 16,
'.' => 16,
',' => 16,
'->' => 16,
'->>' => 16,
';' => 16,
];

Expand Down
20 changes: 11 additions & 9 deletions src/Utils/Formatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,19 +533,21 @@ public function formatList($list)

$lineEnded = false;
} else {
// If the line ended there is no point in adding whitespaces.
// If the line ended, there is no point in adding whitespaces.
// Also, some tokens do not have spaces before or after them.
if (
// A space after delimiters that are longer than 2 characters.
$prev->keyword === 'DELIMITER'
|| ! (
($prev->type === Token::TYPE_OPERATOR && ($prev->value === '.' || $prev->value === '('))
// No space after . (
|| ($curr->type === Token::TYPE_OPERATOR
&& ($curr->value === '.' || $curr->value === ','
|| $curr->value === '(' || $curr->value === ')'))
// No space before . , ( )
|| $curr->type === Token::TYPE_DELIMITER && mb_strlen((string) $curr->value, 'UTF-8') < 2
($prev->type === Token::TYPE_OPERATOR
&& ($prev->value === '.' || $prev->value === '('
|| $prev->value === '->' || $prev->value === '->>'))
// No space after punctuation and JSON operators.
|| ($curr->type === Token::TYPE_OPERATOR
&& ($curr->value === '.' || $curr->value === ','
|| $curr->value === '(' || $curr->value === ')'
|| $curr->value === '->' || $curr->value === '->>'))
// No space before punctuation and JSON operators.
|| $curr->type === Token::TYPE_DELIMITER && mb_strlen((string) $curr->value, 'UTF-8') < 2
)
) {
$ret .= ' ';
Expand Down
30 changes: 30 additions & 0 deletions tests/Utils/FormatterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,36 @@ public static function formatQueriesProviders(): array
'<span class="sql-reserved">WHERE</span><br/>' .
'&nbsp;&nbsp;&nbsp;&nbsp;<span class="sql-number">1</span>',
],
'json operator' => [
'query' => 'SELECT details->\'$."first_name"\' FROM users',
'text' => 'SELECT' . "\n" .
' details->\'$."first_name"\'' . "\n" .
'FROM' . "\n" .
' users',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[39mdetails->\x1b[91m'$.\"first_name\"'\n" .
"\x1b[35mFROM\n" .
" \x1b[39musers\x1b[0m",
'html' => '<span class="sql-reserved">SELECT</span><br/>' .
'&nbsp;&nbsp;&nbsp;&nbsp;details-&gt;<span class="sql-string">\'$."first_name"\'</span><br/>' .
'<span class="sql-reserved">FROM</span><br/>' .
'&nbsp;&nbsp;&nbsp;&nbsp;users',
],
'json operator (unquoted)' => [
'query' => 'SELECT metadata->>"$.url" FROM `alerts`;',
'text' => 'SELECT' . "\n" .
' metadata->>"$.url"' . "\n" .
'FROM' . "\n" .
' `alerts`;',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[39mmetadata->>\x1b[91m\"$.url\"\n" .
"\x1b[35mFROM\n" .
" \x1b[36m`alerts`\x1b[39m;\x1b[0m",
'html' => '<span class="sql-reserved">SELECT</span><br/>' .
'&nbsp;&nbsp;&nbsp;&nbsp;metadata-&gt;&gt;<span class="sql-string">"$.url"</span><br/>' .
'<span class="sql-reserved">FROM</span><br/>' .
'&nbsp;&nbsp;&nbsp;&nbsp;<span class="sql-variable">`alerts`</span>;',
],
'typical' => [
'query' => 'SELECT id, if(id=1,"Si","No") from `tbl` where id = 0 or ' .
'id = 1 group by id order by id desc limit 1 offset 0',
Expand Down
Loading