Skip to content

Add extra new line between separate queries #124

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
merged 2 commits into from
Jun 6, 2024
Merged

Add extra new line between separate queries #124

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
027ca22
Add extra new line between queries
mvorisek Jun 4, 2024
c0254f2
Also within query statement block
mvorisek Jun 4, 2024
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
15 changes: 13 additions & 2 deletions src/SqlFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,12 @@ public function format(string $string, string $indentString = ' '): string
return;
}

$return = substr($return, 0, -($indentLevel + 1)) . str_repeat($tab, $indentLevel);
$rtrimLength = $indentLevel + 1;
while (substr($return, -($rtrimLength + 2), 1) === "\n") {
$rtrimLength++;
}

$return = substr($return, 0, -$rtrimLength) . str_repeat($tab, $indentLevel);
};

// Tokenize String
Expand Down Expand Up @@ -115,7 +120,13 @@ public function format(string $string, string $indentString = ' '): string

// If we need a new line before the token
if ($newline) {
$return = rtrim($return, ' ');
$return = rtrim($return, ' ');

$prevNotWhitespaceToken = $cursor->subCursor()->previous(Token::TOKEN_TYPE_WHITESPACE);
if ($prevNotWhitespaceToken !== null && $prevNotWhitespaceToken->value() === ';') {
$return .= "\n";
}

$return .= "\n" . str_repeat($tab, $indentLevel);
$newline = false;
$addedNewline = true;
Expand Down
12 changes: 12 additions & 0 deletions tests/clihighlight.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -798,6 +798,7 @@
*
LIMIT
1;

SELECT
a,
b,
Expand All @@ -807,6 +808,7 @@
e
LIMIT
1, 2;

SELECT
1,
2,
Expand Down Expand Up @@ -1014,19 +1016,25 @@
---
-- semicolon must decrease special indentation level
MY_NON_TOP_LEVEL_KEYWORD_FX_1();

MY_NON_TOP_LEVEL_KEYWORD_FX_2();

SELECT
x
FROM
(
SELECT
1 as x
);

MY_NON_TOP_LEVEL_KEYWORD_FX_3();

BEGIN
MY_NON_TOP_LEVEL_KEYWORD_FX_4();

MY_NON_TOP_LEVEL_KEYWORD_FX_5();
END;

BEGIN
SELECT
x
Expand All @@ -1035,6 +1043,7 @@ MY_NON_TOP_LEVEL_KEYWORD_FX_3();
SELECT
1 as x
);

MY_NON_TOP_LEVEL_KEYWORD_FX_6();
END;
---
Expand Down Expand Up @@ -1143,16 +1152,19 @@ MY_NON_TOP_LEVEL_KEYWORD_FX_3();
catch if ERROR_NUMBER() = 544 begin
set
IDENTITY_INSERT [t] on;

begin
try insert into [t] ([name], [int], [float], [null])
values
(N 'Ewa', 1, 1.0, null);

set
IDENTITY_INSERT [t] off;
end try begin
catch
set
IDENTITY_INSERT [t] off;

throw;
end catch
end
Expand Down
12 changes: 12 additions & 0 deletions tests/format-highlight.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -798,6 +798,7 @@
<span >*</span>
<span style="font-weight:bold;">LIMIT</span>
<span style="color: green;">1</span><span >;</span>

<span style="font-weight:bold;">SELECT</span>
<span style="color: #333;">a</span><span >,</span>
<span style="color: #333;">b</span><span >,</span>
Expand All @@ -807,6 +808,7 @@
<span style="color: #333;">e</span>
<span style="font-weight:bold;">LIMIT</span>
<span style="color: green;">1</span><span >,</span> <span style="color: green;">2</span><span >;</span>

<span style="font-weight:bold;">SELECT</span>
<span style="color: green;">1</span><span >,</span>
<span style="color: green;">2</span><span >,</span>
Expand Down Expand Up @@ -1014,19 +1016,25 @@
---
<pre style="color: black; background-color: white;"><span style="color: #aaa;">-- semicolon must decrease special indentation level</span>
<span style="color: #333;">MY_NON_TOP_LEVEL_KEYWORD_FX_1</span>()<span >;</span>

<span style="color: #333;">MY_NON_TOP_LEVEL_KEYWORD_FX_2</span>()<span >;</span>

<span style="font-weight:bold;">SELECT</span>
<span style="color: #333;">x</span>
<span style="font-weight:bold;">FROM</span>
(
<span style="font-weight:bold;">SELECT</span>
<span style="color: green;">1</span> <span style="font-weight:bold;">as</span> <span style="color: #333;">x</span>
)<span >;</span>

<span style="color: #333;">MY_NON_TOP_LEVEL_KEYWORD_FX_3</span>()<span >;</span>

<span style="font-weight:bold;">BEGIN</span>
<span style="color: #333;">MY_NON_TOP_LEVEL_KEYWORD_FX_4</span>()<span >;</span>

<span style="color: #333;">MY_NON_TOP_LEVEL_KEYWORD_FX_5</span>()<span >;</span>
<span style="font-weight:bold;">END</span><span >;</span>

<span style="font-weight:bold;">BEGIN</span>
<span style="font-weight:bold;">SELECT</span>
<span style="color: #333;">x</span>
Expand All @@ -1035,6 +1043,7 @@
<span style="font-weight:bold;">SELECT</span>
<span style="color: green;">1</span> <span style="font-weight:bold;">as</span> <span style="color: #333;">x</span>
)<span >;</span>

<span style="color: #333;">MY_NON_TOP_LEVEL_KEYWORD_FX_6</span>()<span >;</span>
<span style="font-weight:bold;">END</span><span >;</span></pre>
---
Expand Down Expand Up @@ -1143,16 +1152,19 @@
<span style="color: #333;">catch</span> <span style="font-weight:bold;">if</span> <span style="color: #333;">ERROR_NUMBER</span>() <span >=</span> <span style="color: green;">544</span> <span style="font-weight:bold;">begin</span>
<span style="font-weight:bold;">set</span>
<span style="color: #333;">IDENTITY_INSERT</span> <span style="color: purple;">[t]</span> <span style="font-weight:bold;">on</span><span >;</span>

<span style="font-weight:bold;">begin</span>
<span style="color: #333;">try</span> <span style="font-weight:bold;">insert</span> <span style="font-weight:bold;">into</span> <span style="color: purple;">[t]</span> (<span style="color: purple;">[name]</span><span >,</span> <span style="color: purple;">[int]</span><span >,</span> <span style="color: purple;">[float]</span><span >,</span> <span style="color: purple;">[null]</span>)
<span style="font-weight:bold;">values</span>
(<span style="color: #333;">N</span> <span style="color: blue;">'Ewa'</span><span >,</span> <span style="color: green;">1</span><span >,</span> <span style="color: green;">1.0</span><span >,</span> <span style="font-weight:bold;">null</span>)<span >;</span>

<span style="font-weight:bold;">set</span>
<span style="color: #333;">IDENTITY_INSERT</span> <span style="color: purple;">[t]</span> <span style="color: #333;">off</span><span >;</span>
<span style="font-weight:bold;">end</span> <span style="color: #333;">try</span> <span style="font-weight:bold;">begin</span>
<span style="color: #333;">catch</span>
<span style="font-weight:bold;">set</span>
<span style="color: #333;">IDENTITY_INSERT</span> <span style="color: purple;">[t]</span> <span style="color: #333;">off</span><span >;</span>

<span style="color: #333;">throw</span><span >;</span>
<span style="font-weight:bold;">end</span> <span style="color: #333;">catch</span>
<span style="font-weight:bold;">end</span>
Expand Down
12 changes: 12 additions & 0 deletions tests/format.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -796,6 +796,7 @@ SELECT
*
LIMIT
1;

SELECT
a,
b,
Expand All @@ -805,6 +806,7 @@ FROM
e
LIMIT
1, 2;

SELECT
1,
2,
Expand Down Expand Up @@ -1012,19 +1014,25 @@ SELECT
---
-- semicolon must decrease special indentation level
MY_NON_TOP_LEVEL_KEYWORD_FX_1();

MY_NON_TOP_LEVEL_KEYWORD_FX_2();

SELECT
x
FROM
(
SELECT
1 as x
);

MY_NON_TOP_LEVEL_KEYWORD_FX_3();

BEGIN
MY_NON_TOP_LEVEL_KEYWORD_FX_4();

MY_NON_TOP_LEVEL_KEYWORD_FX_5();
END;

BEGIN
SELECT
x
Expand All @@ -1033,6 +1041,7 @@ BEGIN
SELECT
1 as x
);

MY_NON_TOP_LEVEL_KEYWORD_FX_6();
END;
---
Expand Down Expand Up @@ -1141,16 +1150,19 @@ end try begin
catch if ERROR_NUMBER() = 544 begin
set
IDENTITY_INSERT [t] on;

begin
try insert into [t] ([name], [int], [float], [null])
values
(N 'Ewa', 1, 1.0, null);

set
IDENTITY_INSERT [t] off;
end try begin
catch
set
IDENTITY_INSERT [t] off;

throw;
end catch
end
Expand Down